Home

Awesome

<p align="center"> <a href="https://homebridge.io"><img src="https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-color-round-stylized.png" height="140"></a> </p> <span align="center">

Homebridge UI

npm npm npm

:gb: :de: :fr: :poland: :czech_republic: :ru: :cn: :hungary: :jp: :es: :netherlands: :tr: :it: :bulgaria: :sweden: :norway: :finland: :slovenia: :brazil: :portugal: :indonesia: :kr: :macedonia: :thailand: :israel: :ukraine:

</span>

Homebridge UI is a web based management tool for Homebridge that allows you to manage all aspects of your Homebridge setup.

Homebridge UI also provides a tool called hb-service which makes it easy to set up Homebridge as a service on Linux/Raspbian, macOS and Windows 10.

Installation Instructions

For detailed instructions on how to set up Node.js and Homebridge with Homebridge UI as a service, see the guides on the wiki:

If your platform is not listed above, or you want to use your own service manager, see the Manual Configuration wiki article for instructions on setting up the Homebridge UI to run as a Homebridge plugin instead of a service.

The default username is admin and the default password is admin.

The UI can be accessed via web browser by default on port 8581 (e.g. http://localhost:8581).

Usage

Status Screen

This shows an overview of your Homebridge system. The dashboard is widget-based and completely customisable with a number of themes available.

Status

Plugin Screen

This shows you the currently installed plugins and allows you to install, configure, update and remove plugins.

Plugin

You can configure supported plugins using the graphical settings editor, or by editing the config JSON directly.

Plugin Settings

Configuration Screen

The configuration screen allows you to modify your Homebridge config.json. The built-in editor automatically syntax-checks your JSON and makes a backup of your config every time you make a change.

Config

Log Screen

This shows you the Homebridge rolling log. This is helpful for troubleshooting.

Log

Accessories Screen

This shows you the Homebridge accessories for all the Homebridge instances on your network. You can use this to control accessories from a web browser and works well on mobile devices which allows users to control Homebridge from non-Apple devices.

Accessories

Plugin Development

The https://developers.homebridge.io website contains the Homebridge API reference, available service and characteristic types, and plugin examples.

The Homebridge Plugin Template project provides a base you can use to create your own platform plugin.

There are many existing plugins you can study; you might start with the Homebridge Example Plugins or a plugin that already implements the device type you need.

Community

The official Homebridge Discord server and Reddit community are where users can discuss Homebridge and ask for help.

<span align="center">

Homebridge Discord Homebridge Reddit

</span>

HomeKit communities can also be found on both Discord and Reddit.

Limitations

Credits