This plugin creates a HomeKit interface for an Olarm alarm system.
npm i -g homebridge-olarm-plugin
{
"platform": "OlarmHomebridgePlugin",
"name": "homebridge-olarm-plugin",
"apiKey": "<YOUR OLARM API KEY>"
}
The plugin will automatically scan all devices on your Olarm account and pull in their areas. Each area will be created as a separate accessory.
Note that HomeKit forces 4 alarm states: Home
, Away
, Night
and Off
which as of writing can't be customised. Hence, the states have been mapped to the following:
Home
-> Armed Stay (and changes to Night
automatically)Away
-> ArmedNight
-> Armed StayOff
-> Disarmed.Triggered / alarm activated states are not yet connected.
Follow the below instructions if you want to fork and evolve this plugin.
Note: YMMV with setup guides below
npm install
to install dependencies.npm run watch
to have nodemon
run and keep it updated. It also runs npm link
.Now to plug it into your Homebridge
npm run build
to build the plugin into /dist
(npm run watch
will do the same)pwd
to get the full path to the plugin (e.g. /home/pi/HomebridgePlugins/olarm-plugin
)npm link
if needed sudo npm link <path from step 2>
config.json
with this platform:
{
"platform": "OlarmHomebridgePlugin",
"name": "homebridge-olarm-plugin",
"apiKey": "<use your olarm api key>"
}
sudo systemctl restart homebridge