homebridge-examples
This repo bundles some example implementations for homebridge plugins. They provide some example code to getstarted with. They are also published on npm like regular plugins, so you can easily run them in your localhomebridge instance. Refer to the respective package.json for the plugin name and install them as usual.
The examples are all written in Typescript and thus require at least homebridge v1.0.0.
To build a plugin run the following commands in the respective plugin directory.
Run this command once to install all dependencies required by the plugin:
npm install
After that run the following command to compile the Typescript files into Javascript(repeat this step every time you change something in the code).
npm run build
If you need inspiration for a plugin written in Javascript you can just run the above commands and look at thegenerated Javascript code located in the ./dist folder. You may need to ignore some code at the beginning of the filegenerated by the Typescript compiler.
Examples for different homebridge plugin types
Accessory Plugins
Accessory plugins are the most basic and simplest plugins for homebridge. They should be used if you only want toexpose a single accessory and don't require any special functionality.
- Accessory Plugin: A simple Switch accessory.
Platform Plugins:
Platform plugins are able to expose multiple accessories. Additionally, they are required if you want to use theController API.
- Static Platform Plugin: Static platforms know which accessories they want toexpose on start up. The set of accessories cannot change over the lifespan of the plugin.
- Dynamic Platform Plugin: Dynamic platforms can dynamically add or removeaccessories at runtime. Accessories are fully stored to disk by homebridge, and the exact state is reconstructed ona reboot. The plugin can store additional context as well.
- Independent Platform Plugin: Independent platforms are typically usedwhen the platform intends to only expose external accessories or provides other functionality while not exposingan accessory at all.
Other example plugins
-
Homebridge 是一个轻量级 NodeJS 服务器，它模拟 iOS HomeKit API，提供从 HomeKit 到“智能家居”设备制造商提供的各种第三方 API 的基本桥接。通过 Homebridge 的桥接，可以让 Siri 控制完全不支持 HomeKit 的设备。 此外 Homebridge 支持插件。
-
homebridge-vsx homebridge-vsx is a plugin made for homebridge,which allows switching on and off your Pioneer AV receiver. All AV receivers (VSX and SC),which work with the iControl AV5 App are support
-
homebridge-sesame Control and monitor your Sesame smart lock with HomeKit integration. Prerequisites Installation of Homebridge iOS 11 or later Sesame lock with enabled cloud integration Sesame Wifi A
-
homebridge-panasonictv A homebridge plugin for turning on and off your Panasonic Viera TV. The plugin also has experimental support for changing the volume and channel. These characteristics are not r
-
Quick Start | Contribute A Wake on Lan plugin for Homebridge Turn your PCs, laptops, servers and more on and off through Siri Quick Start To install the plugin, head over to the machine with Homebridg
-
Docker Homebridge This Alpine/Ubuntu Linux based Docker image allows you to run Nfarina's Homebridge on your home network which emulates the iOS HomeKit API. This is a multi-arch image and will also r
-
This Plugin is no longer being maintained. The ST platform removed all of the greatness that made it fun to develop for and I will not rewrite my years of code to adapt. I have moved to Hubitat and al
-
Homebridge myQ myQ garage door and other myQ-enabled device support for Homebridge. homebridge-myq is a Homebridge plugin that makes myQ-enabled devices available to Apple's HomeKit smart home platfor