homebridge-lib
v7.3.0
Library for homebridge plugins
3.2K/weekUpdated 2 weeks agoApache-2.0Unpacked: 249.0 KB
Published by Erik Baauw
npm install homebridge-lib
Homebridge Lib
Library for Homebridge Plugins
Copyright © 2018-2026 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.
$3
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.
$3
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.sysinfo | Print hardware and operating system information.upnp | UPnP tool.
Each command-line tool takes a -h or --help argument to provide a brief overview of its functionality and command-line arguments.
$3
This library is _not_ a Homebridge plugin and does 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, use:
``
$ sudo npm -g i hb-lib-tools
This creates symlinks to these tools in or /usr/local/bin (depending on how you installed NodeJS).
$3
The logic for handling Eve history was copied from Simone Tisa's fakegato-history` repository, copyright © 2017 simont77.
$3
Homebridge Lib is a hobby project of mine, provided as-is, with no warranty whatsoever. I've been running it successfully at my home for years, but your mileage might vary.