homebridge-lib
Library for Homebridge Plugins
Copyright © 2018-2019 Erik Baauw. All rights reserved.
While developing a number of Homebridge plugins, I find myself duplicating a lot of code. The idea behind this library is to ease developing and maintaining Homebridge plugins by separating this generic code, dealing with HomeKit and Homebridge, from the specific code, dealing with the actual devices being exposed to HomeKit.
Documentation
The documentation, how to develop a plugin using homebridge-lib, is provided in the code and through tutorials in the doc directory.
To generate the documentation, install jsdoc and run jsdoc -c jsdoc.json.
To view the documentation, open index.html in the out directory.
See homebridge-ws for an example plugin based on homebridge-lib.
Command-Line Tools
The homebridge-lib library comes with a number of command-line tools for troubleshooting Homebridge installations.
| Tool | Description |
|---|---|
hap |
Logger for HomeKit accessory announcements. |
json |
JSON formatter. |
upnp |
Logger for UPnP device announcements. |
Each command-line tool takes a -h or --help argument to provide a brief overview of its functionality and command-line arguments.
Installation
This library is not a Homebridge plugin and should not need to be installed manually. Instead, Homebridge plugins using this library should list it as a dependency in their package.json. This way, npm installs homebridge-lib automatically when installing the actual plugin.
To install the command-line tools standalone, without installing a Homebridge plugin, use:
$ sudo npm -g i homebridge-lib
Credits
The logic for handling Eve history was copied from Simone Tisa's fakegato-history repository, copyright © 2017 simont77.