homebridge-olarm-plugin
v1.0.1
Published
A HomeKit interface for an [Olarm](https://olarm.co) alarm system.
Downloads
10
Readme
homebridge-olarm-plugin
This plugin creates a HomeKit interface for an Olarm alarm system.
Guide
Installing
- On your Homebridge device, run
npm i -g homebridge-olarm-plugin
- Create an API key on Olarm (here)
- Set up the new platform in your Homebridge config.json
{
"platform": "OlarmHomebridgePlugin",
"name": "homebridge-olarm-plugin",
"apiKey": "<YOUR OLARM API KEY>"
}
- Restart your Homebridge
Usage
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 toNight
automatically)Away
-> ArmedNight
-> Armed StayOff
-> Disarmed.
Triggered / alarm activated states are not yet connected.
Development
Follow the below instructions if you want to fork and evolve this plugin.
Note: YMMV with setup guides below
- Clone the repo onto your device that hosts your Homebridge instance.
- Run
npm install
to install dependencies. - Run
npm run watch
to havenodemon
run and keep it updated. It also runsnpm link
.
Now to plug it into your Homebridge
- Run
npm run build
to build the plugin into/dist
(npm run watch
will do the same) - Run
pwd
to get the full path to the plugin (e.g./home/pi/HomebridgePlugins/olarm-plugin
) - Inside Homebridge's directory, Run
npm link
if neededsudo npm link <path from step 2>
- Update the Homebridge
config.json
with this platform:
{
"platform": "OlarmHomebridgePlugin",
"name": "homebridge-olarm-plugin",
"apiKey": "<use your olarm api key>"
}
- Restart your Homebridge
sudo systemctl restart homebridge