Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.78 KB

README.md

File metadata and controls

42 lines (26 loc) · 1.78 KB

Homebridge Unifi Protect chimes

This plugin exposes the Unifi-Protect chimes to homebridge. On HomeKit there is a lack of control-types, so I opted to use the Light Brightness to represent the Volume of the Chime. The plugin supports zero or more chimes. Adding chimes works with auto-descovery via the Unifi Protect proxy/protect/api/chimes endpoint, basically when credentials and IP are correct, setup is automatic.

Setup Development Environment

To develop Homebridge plugins you must have Node.js 12 or later installed, and a modern code editor such as VS Code. This plugin template uses TypeScript to make development easier and comes with pre-configured settings for VS Code and ESLint. If you are using VS Code install these extensions:

Install Development Dependencies and Run Locally

Using a terminal, navigate to the project folder and run this command to install the development dependencies:

npm install

TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your src directory and put the resulting code into the dist folder.

npm run build

Run this command so your global install of Homebridge can discover the plugin in your development environment:

npm link

You can now start Homebridge, use the -D flag so you can see debug log messages in your plugin:

homebridge -D

At this point the plugin should show up in your local Homebridge setup.