Homebridge plugin that creates a security system accessory that can be triggered by HomeKit accessories.
If you already have Homebridge installed, skip to step two!
- Install Homebridge.
- Install the plugin using
npm install -g --unsafe-perm homebridge-securitysystem. - Use the Homebridge / HOOBS UI to configure or use the
config.example.jsonfile as an example.
Use Eve or a similar app to create automations like these:
| Trigger | Condition | Scene actions |
|---|---|---|
| Motion is detected | Security system is set to Night |
Turn on Siren |
| Door is opened | Security system is set to Away |
Turn on Siren |
| NFC tag is detected (1) (2) | None | Set security system to Home |
| Security system triggers | None | Play media (1) (3) |
(1) Requires iOS 13 or above.
(2) Shortcuts app is required to create this automation.
(3) AirPlay 2 speaker like HomePod required.
Important: Use an NFC tag to arm/disarm the security system easily and securely without using the Home app.
| Option | Description | Default | Example |
|---|---|---|---|
| default_mode | Initial mode for the security system when running Homebridge. | "off" | "home" |
| disabled_modes | Modes to exclude from the available modes list. | [] | ["night"] |
| arm_seconds | Time in seconds to arm the security system after the user requesting it. | 0 | 60 |
| trigger_seconds | Time in seconds to be able to disarm the security system before triggering it. | 0 | 30 |
| pause_minutes | Time in minutes that the armed state will be paused using the Mode Pause switch. |
0 | 5 |
| reset_minutes | Time in minutes to wait to return to mode set after being triggered. | 10 | 15 |
| reset_off | Reset security system when triggered by passing through the Off mode. |
false | true |
| siren_switch (1) | Shows a switch on the Home app to trigger the security system. | true | false |
| siren_mode_switches | Shows switches on the Home app to trigger the security system for each mode. | false | true |
| siren_sensor | Shows a sensor on the Home app to get multiple notifications during Triggered. |
false | true |
| siren_sensor_seconds | Time in seconds to wait until another notification comes in. | 5 | 10 |
| mode_switches | Shows switches on the Home app for each mode to bypass confirmation. | false | true |
| mode_off_switch | Shows the Mode Off switch on the Home app if you enabled mode switches. |
true | false |
| mode_pause_switch | Shows the Mode Pause switch to temporarily disarm the security system. |
false | true |
| override_off | Allows to trigger the security system while disarmed. | false | true |
| audio | Play audio sounds (requires ffmpeg installed). | false | true |
| audio_path (2) | Use custom sounds from an external directory. | false | /sounds |
| audio_volume | Audio volume for mode audio sounds (except triggered) | 100 | 50 |
| audio_language | Set language used for the audio warnings. | en-US | de-DE |
| audio_alert_looped | Loop alert sound that plays when the security system's countdown has started. | false | true |
| save_state | State persistence for shutdowns and reboots. | false | true |
| test_mode | Enables test mode where the webhook and command for triggered are disabled. | false | true |
(1) A powerful HomeKit app like Eve is required if the siren switch option is disabled to trigger the security system without using a switch accessory.
(2) Intructions will be generated on this path once the configuration has been applied.
Use the options below to start a HTTP server on the device and interact with the security system.
| Option | Description | Default | Example |
|---|---|---|---|
| server_port | Port of the web server that will run on your Homebridge device. | null | 8080 |
| server_code | Code to authenticate requests sent to the security system. | null | 1234 |
After setting the option, you can call these endpoints:
| Method | Endpoint | Description |
|---|---|---|
| GET | /status | Gets current status from the security system. |
| GET | /home | Changes current security system mode to home. |
| GET | /away | Changes current security system mode to away. |
| GET | /night | Changes current security system mode to night. |
| GET | /off | Changes current security system mode to off. |
| GET | /triggered | Changes current security system mode to triggered. |
| Parameter | Description | Default |
|---|---|---|
| code | Code used to authorize your request. | null |
| delay | Add delay to arm or trigger the security system. | false |
Use the options below to send requests to a server when the security system mode changes.
| Option | Description | Example |
|---|---|---|
| webhook_url | Base URL of the webhook server. | http://localhost |
| webhook_target_home | Path of the 'home' mode to call when set as target. | /target/home |
| webhook_target_away | Path of the 'away' mode to call when set as target. | /target/away |
| webhook_target_night | Path of the 'night' mode to call when set as target. | /target/night |
| webhook_target_off | Path of the 'off' mode to call when set as target. | /target/off |
| webhook_current_home | Path of the 'home' mode to call when set as current. | /current/home |
| webhook_current_away | Path of the 'away' mode to call when set as current. | /current/away |
| webhook_current_night | Path of the 'night' mode to call when set as current. | /current/night |
| webhook_current_off | Path of the 'off' mode to call when set as current. | /current/off |
| webhook_alert | Path of the 'alert' event to call when fired. | /alert |
| webhook_triggered | Path of the 'triggered' mode to call when set as current. | /triggered |
Use the options below to execute commands on the device when the security system mode changes.
| Option | Description | Example |
|---|---|---|
| command_target_home | Command of the 'home' mode to execute when set as target. | echo target home |
| command_target_away | Command of the 'away' mode to execute when set as target. | echo target away |
| command_target_night | Command of the 'night' mode to execute when set as target. | echo target night |
| command_target_off | Command of the 'off' mode to execute when set as target. | echo target off |
| command_current_home | Command of the 'home' mode to execute when set as current. | echo current home |
| command_current_away | Command of the 'away' mode to execute when set as current. | echo current away |
| command_current_night | Command of the 'night' mode to execute when set as current. | echo current night |
| command_current_off | Command of the 'off' mode to execute when set as current. | echo current off |
| command_alert | Command of the 'alert' event to execute when fired. | echo event alert |
| command_triggered | Command of the 'triggered' mode to execute when set as current. | echo triggered |