forked from LouwHopley/homebridge-olarm-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
Usage
Luke Stephens edited this page Nov 24, 2024
·
4 revisions
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:
Apple | Olarm |
---|---|
Away | Armed |
Night | Sleep |
Home | Stay |
Off | Disarmed |
Triggered / alarm activated states are still being tested.
After installing and configuring the plugin, your Olarm alarm system should be available in HomeKit-enabled apps.
- Arm/Disarm: Control the alarm system's armed state.
- Area Control: Manage different areas (partitions) of your alarm system.
- Status Monitoring: Receive real-time updates of your alarm system's status.
-
Open the Home app on your iOS device.
-
Find your Olarm accessory:
It should appear with the name you specified in the configuration.
-
Change the security state:
- Arm Away: Fully arm the system.
- Arm Stay: Arm the system in stay mode.
- Arm Night: Arm the system in night mode.
- Disarm: Disarm the system.
- The plugin listens to MQTT messages from the Olarm system to update the status in real-time.
- Any changes made outside HomeKit (e.g., using the Olarm app) should be reflected in the Home app.
- If the status does not update immediately, ensure your MQTT connection is stable.
- For issues, see the Troubleshooting page.