homebridge-homeqtt-alarm

Homebridge MQTT Security Alarm Plugin

Usage no npm install needed!

<script type="module">
  import homebridgeHomeqttAlarm from 'https://cdn.skypack.dev/homebridge-homeqtt-alarm';
</script>

README

Homebridge Verified

Homeqtt Alarm

Downloads NPM Version License Donate Homebridge MQTT verified-by-homebridge

Homebridge MQTT Security Alarm Plugin for HomeKit.

This plugin sets up an alarm in HomeKit, then allows you to connect Homebridge to an MQTT server and with the received messages trigger the alarm in HomeKit (if it is armed).

Features:

  • Connect Homebridge to MQTT to receive messages to trigger alarm
  • Choose 'armed' states (e.g. Away Arm, Stay Arm, Night Arm)
  • Select sensor types (PIR or Contact Sensor)
  • Give sensors a location (i.e. a nice name)
  • Globally enable/disable individual sensors
  • Set sensors for only certain states
  • Set Away Arm, Stay Arm, Disarm from a keyfob
  • Set Arm / Trigger Delay
  • Trigger HomeKit alarm with the SOS button on a keyfob
  • Enable/Disable a siren

Prerequisites

  1. You have Homebridge Installed

  2. You have an MQTT Server Running

  3. Your MQTT server receives codes when sensors or keyfob button pushes are triggered
    (e.g. via 433Mhz contact sensor to Sonoff RF Bridge - see Recommended Hardware)

  4. You have made a coffee

Installation

There are two methods to this madness...

  1. Automated install and configuration via Homebridge Config UI X [recommended]
  2. Manual install via CLI and manually updating your Homebridge configuration file

Configuration

Once the installation is complete you will need to configure the plugin:

Planned Features

See the Changelog for upcoming/planned features.

Note: NFC Tag Support (arm/disarm via NFC without using the Home app) will not be a feature of this plugin but can natively be activated through iOS Shortcuts app and requires iOS 13 or above.


See the Wiki for more information