Skip to content

Latest commit

 

History

History
executable file
·
170 lines (104 loc) · 9.6 KB

README.md

File metadata and controls

executable file
·
170 lines (104 loc) · 9.6 KB
Raw

Homebridge UI

npm npm Discord Donate

🇬🇧 🇩🇪 🇫🇷 🇵🇱 🇨🇿 🇷🇺 🇨🇳 🇭🇺 🇯🇵 🇪🇸 🇳🇱 🇹🇷 🇮🇹 🇧🇬 🇸🇪 🇳🇴 🇫🇮 🇸🇮 🇧🇷 🇵🇹 🇮🇩 🇰🇷 🇲🇰 🇹🇭 🇮🇱 🇺🇦

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

  • Install and configure Homebridge plugins
  • Edit the Homebridge config.json with advanced JSON syntax checking and structure validation
  • Visual configuration for over 450 plugins (no manual config.json editing required)
  • Monitor your Homebridge server via a fully customisable widget-based dashboard
  • View the Homebridge logs
  • View and control Homebridge accessories
  • Restart Homebridge
  • Backup and Restore your Homebridge instance
  • Set up and manage your Homebridge plugins as child bridges
  • and more...

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.

Status

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, remove and upgrade plugins.

Plugin

You can configure supported plugins using the graphical settings editor, removing the need to manually edit the config.json. Over 165 popular plugins have implemented support for this feature.

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

Supported Browsers

The following browsers are supported by the Homebridge UI:

  • Chrome - latest
  • Edge - latest
  • Firefox - latest
  • Safari - 2 most recent major versions
  • iOS - 2 most recent major versions

MS Internet Explorer (any version) is not supported!

Supported Node.js Version

The Homebridge UI follows the same Node.js support schedule as Homebridge. See the How-To-Update-Node.js page in the Homebridge wiki for currently supported versions.

You can check your current versions using these commands:

# check node version
node -v

# check npm version
npm -v

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.

Common Issues

Errors during installation

Make sure you installed the package with sudo and used the --unsafe-perm flag. Most installation errors can be fixed by removing the Homebridge UI and reinstalling:

# cleanup
sudo npm uninstall -g homebridge-config-ui-x

# reinstall
sudo npm install -g --unsafe-perm homebridge-config-ui-x

Make sure you are running supported versions of node and npm.

Home App Says Accessory Already Added

To fix this, Reset Homebridge.

My iOS App Can't Find Homebridge

Try the following:

  1. Swap between the Bonjour HAP and Ciao mDNS Advertiser options. See the wiki for more details.
  2. iOS DNS cache has gone stale or gotten misconfigured. To fix this, turn airplane mode on and back off to flush the DNS cache.

Community

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

Homebridge Discord Homebridge Reddit

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

Limitations

  • One bridge can only expose 150 accessories due to a HomeKit limit. You can however run your plugins as a Child Bridge or run Multiple Homebridge Instances to get around this limitation.
  • Once an accessory has been added to the Home app, changing its name via Homebridge won't be automatically reflected in iOS. You must change it via the Home app as well.

Credits

  • Homebridge was originally created by Nick Farina.
  • The original HomeKit API work was done by Khaos Tian in his HAP-NodeJS project.
  • Homebridge UI was originally created by oznu.