https://github.com/MiguelRipoll23/homebridge-securitysystem

Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.
https://github.com/MiguelRipoll23/homebridge-securitysystem

alarm homebridge homebridge-plugin homekit security

Last synced: about 2 months ago
JSON representation

Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.

• Host: GitHub
• URL: https://github.com/MiguelRipoll23/homebridge-securitysystem
• Owner: MiguelRipoll23
• License: mit
• Created: 2018-12-11T18:11:13.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T18:13:38.000Z (about 2 months ago)
• Last Synced: 2024-11-04T19:24:54.971Z (about 2 months ago)
• Topics: alarm, homebridge, homebridge-plugin, homekit, security
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/homebridge-securitysystem
• Size: 4.87 MB
• Stars: 153
• Watchers: 9
• Forks: 13
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# homebridge-securitysystem

[![npm version](https://badgen.net/npm/v/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)

[![npm downloads](https://badgen.net/npm/dt/homebridge-securitysystem)](https://www.npmjs.com/package/homebridge-securitysystem)

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.

❤️ [One-time donation](https://www.paypal.com/donate/?hosted_button_id=CQTHU44XTXK2L)

## Installation

If you already have [Homebridge](https://github.com/homebridge/homebridge) installed, execute the following command:

`npm i -g --unsafe-perm homebridge-securitysystem`

## Demo



  

  
Want to know how it looks like? It's pretty customizable, you can configure it to show as many switches as you like.

  
What you are seeing at your right is the friendliest configuration that you can start with. Each Trip switch that you see can only trip the security system if the mode is currently set. This allows you to create logic-less automations from the very Home app that comes already installed on iOS.

  
There are also Mode switches which let you run automations that interact with your accessories when a mode is changed or set modes bypassing HomeKit confirmation dialogs.

  
A web server, webhooks or even shell commands are available to integrate the security system with other devices or services plus a plenty of more settings to make this plugin your own DIY security system.

  
Homebridge / HOOBS UI is recommended to configure the plugin, for additional help please check the Wiki page.



## Automations

Using the `Home` app is recommended for regular users, for more advanced users the `Eve` or a similar app will let you make use of the custom options that the security system itself exposes.

Here are some examples of automations that can be created:

| Trigger                  | Actions                       |

| ------------------------ | ----------------------------- |

| Motion is Detected       | Turn on `Trip Night`          |

| Door is Opened           | Turn on `Trip Away`           |

| NFC Tag is Detected (1)  | Set Security system to `Home` |

| Security System Triggers | Play Audio (2)                |

(1) Shortcuts app is required to create this automation.

(2) AirPlay 2 speaker and Apple Music subscription are required.

## Contributions

Pull requests are welcome.