Merge pull request #7 from danieljbnz/3.1.0

3.1.0
danieljbnz · Feb 20, 2022 · 0c5e93d · 0c5e93d
2 parents e7a9c6f + 7c61869
commit 0c5e93d
Show file tree

Hide file tree

Showing 8 changed files with 701 additions and 476 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,26 +6,32 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased / Planned Features
-- Time delay before arm
-- Time delay before trigger
 - Sensor zones (group sensors into zones)
 - Enable / disable by zone
 - Option to override topic per sensor (would default to 'messageTopic'). This allows you to get sensor activity from multiple topics.
 - Show sensors in HomeKit as individual items
 
-## [v3.0.9](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.8...v3.0.9) (2020-04-07)
+## [v3.1.0](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.9...v3.1.0) (2022-02-20)
+### Added
+- Alarm Arm/Trigger Delay - enter time delay in seconds. This defaults to 0. 
+  - The Arm Delay only works when using a Keyfob as Homekit switches on immediately when using the switch in the Home app.
+
+### Update 
+- Updated remote NPM dependency versions due to two Security vulnerabilities found in glob-parent and bl.
+
+## [v3.0.9](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.8...v3.0.9) (2020-04-07)
 ### Fixed 
 - Previous v3.0.8 fix introduced an issue whereby if Homebridge is restarted the alarm state would return to DISARMED regardless of current state. This has been fixed and now if there is a current state it will not reset it to DISARMED on Homebridge restart.
 
-## [v3.0.8](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.7...v3.0.8) (2020-04-07)
+## [v3.0.8](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.7...v3.0.8) (2020-04-07)
 ### Fixed 
 - Homeqtt wasn't setting initial state if you've never had it installed before and was crashing. 
   - Resolved - missing single line in index.js to set initial target state.
 
 ### Changed
 - Added default values for alarm/current and alarm/target MQTT Topics
 
-## [v3.0.7](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.6...v3.0.7) (2020-04-04)
+## [v3.0.7](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.6...v3.0.7) (2020-04-04)
 ### Fixed 
 -  If a button state is enabled but the associated alarm state is disabled it would still fire the message. 
    -  This has been fixed and now a log message is received advising that you pushed a button that's associated with a disabled state.
@@ -34,21 +40,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Debug messages are clearer.
 - Only minimal log messages are shown if 'Debug' is not enable in your config.json
 - Lots of code tidy up.
-- Enabled [Wiki](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki) on Github
+- Enabled [Wiki](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki) on Github
 - Updated README to be static and moved detail to Wiki
 
 
-## [v3.0.6](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.5...v3.0.6) (2020-03-27)
+## [v3.0.6](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.5...v3.0.6) (2020-03-27)
 ### Changed
 - Awesome new logo created and designed by [@mxdanger](https://github.com/mxdanger)
 
-<a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/nzbullet/homebridge-homeqtt-alarm/master/media/Homebridge%20x%20Homeqtt%20Alarm.svg?sanitize=true" width="250px"></a>
+<a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/danieljbnz/homebridge-homeqtt-alarm/master/media/Homebridge%20x%20Homeqtt%20Alarm.svg?sanitize=true" width="250px"></a>
 
-## [v3.0.5](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.4...v3.0.5) (2020-03-26)
+## [v3.0.5](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.4...v3.0.5) (2020-03-26)
 ### Fixed 
 -  If an invalid mqtt url is entered it will no longer shutdown Homebridge.
 
-## [v3.0.4](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.1...v3.0.4) (2020-03-26)
+## [v3.0.4](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.1...v3.0.4) (2020-03-26)
 ### Added
 - Errors throw friendly log messages and the process stops gracefully.
 - Added a minimum count of 1 to sensors.
@@ -57,13 +63,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - If config not populated correctly or missing parameters then no Fatal Errors in Homebridge are thrown instead a message advising the config has been created but not populated correctly is added to the log and the process stops gracefully.
 
 
-## [v3.0.1](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v3.0.0...v3.0.1) (2020-03-25)
+## [v3.0.1](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v3.0.0...v3.0.1) (2020-03-25)
 ### Fixed
 #### Keyfobs
 - Keyfobs config not required if no keyfobs
 - Siren config not required if no siren
 
-## [v3.0.0](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v2.0.2...v3.0.0) (2020-03-24)
+## [v3.0.0](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v2.0.2...v3.0.0) (2020-03-24)
 ### Added
 #### Keyfobs
 - Enable/Disable keyfob (without removing config)
@@ -86,42 +92,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update Homebridge Config UI X Settings Panel
 - Update Readme, Changelog and example-config.json
 
-## [v2.0.2](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v2.0.0...v2.0.2) (2020-03-22)
+## [v2.0.2](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v2.0.0...v2.0.2) (2020-03-22)
 ### Fixed
 - Minor keyfob bug fixed where config was not applied
 
 ## Changed
 - Code tidy-up
 - Update Readme, Changelog and example-config.json
 
-## [v2.0.0](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.9...v2.0.0) (2020-03-21)
+## [v2.0.0](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.9...v2.0.0) (2020-03-21)
 ### Added
 Added Keyfob and Siren functionality :
   - Set alarm state from keyfob - Away Arm, Stay Arm, Disarm and Trigger(SOS)
   - Enable or disable siren (from Homebridge)
   - Set and trigger siren if enabled
   - Reset siren when alarm reset
 
-## [v1.0.9](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.8...v1.0.9) (2020-02-25)
+## [v1.0.9](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.8...v1.0.9) (2020-02-25)
 ### Changed
 - Update Serial Number to match NPM Version
 
-## [v1.0.8](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.7...v1.0.8) (2020-02-24)
+## [v1.0.8](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.7...v1.0.8) (2020-02-24)
 ### Changed
 - Update README
 - Add CHANGELOG
 
-## [v1.0.7](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.6...v1.0.7) (2020-02-24)
+## [v1.0.7](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.6...v1.0.7) (2020-02-24)
 ### Fixed
 - Code tidy up in index.js
 - Comment tidy up in index.js
 - Update Keywords in package.json
 
-## [v1.0.1:v1.0.6](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.0...v1.0.6) (2020-02-23)
+## [v1.0.1:v1.0.6](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.0...v1.0.6) (2020-02-23)
 ### Fixed
 - Issue with package.json on NPM
 
-## [v1.0.0](https://github.com/nzbullet/homebridge-homeqtt-alarm/compare/v1.0.0...v1.0.0) (2020-02-23)
+## [v1.0.0](https://github.com/danieljbnz/homebridge-homeqtt-alarm/compare/v1.0.0...v1.0.0) (2020-02-23)
 ### Added
 - Initial Commit
 

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nzbullet@icloud.com. All
+reported by contacting the project team at danieljbnz@icloud.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
 <p align="center">
-  <a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/nzbullet/homebridge-homeqtt-alarm/master/media/Homebridge%20x%20Homeqtt%20Alarm.svg?sanitize=true" width="500px"></a>
+  <a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/danieljbnz/homebridge-homeqtt-alarm/master/media/Homebridge%20x%20Homeqtt%20Alarm.svg?sanitize=true" width="500px"></a>
 </p>
 
 # Homeqtt Alarm
 [![Downloads](https://img.shields.io/npm/dt/homebridge-homeqtt-alarm?color=blue&label=Downloads)](https://www.npmjs.com/package/homebridge-homeqtt-alarm)
 [![NPM Version](https://img.shields.io/npm/v/homebridge-homeqtt-alarm/latest?label=NPM%20Version)](https://www.npmjs.com/package/homebridge-homeqtt-alarm)
-[![License](https://img.shields.io/npm/l/homebridge-homeqtt-alarm?color=blue&label=License)](https://github.com/nzbullet/homebridge-homeqtt-alarm/blob/master/LICENSE)
+[![License](https://img.shields.io/npm/l/homebridge-homeqtt-alarm?color=blue&label=License)](https://github.com/danieljbnz/homebridge-homeqtt-alarm/blob/master/LICENSE)
 [![Donate](https://img.shields.io/badge/Paypal-Donate-blue)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QEFE9CFBZFVS4&currency_code=NZD&source=url)
 [![Homebridge](https://img.shields.io/badge/Platform-Homebridge-blueviolet)](https://homebridge.io/)
 [![MQTT](https://img.shields.io/badge/Platform-MQTT-blueviolet)](http://mqtt.org/)
 [![verified-by-homebridge](https://img.shields.io/badge/Homebridge-Verified-blueviolet)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
 
-<!-- [![Changelog](https://img.shields.io/badge/Github-Changelog-red)](https://github.com/nzbullet/homebridge-homeqtt-alarm/blob/master/CHANGELOG.md) -->
+<!-- [![Changelog](https://img.shields.io/badge/Github-Changelog-red)](https://github.com/danieljbnz/homebridge-homeqtt-alarm/blob/master/CHANGELOG.md) -->
 
 Homebridge MQTT Security Alarm Plugin for HomeKit.
 
@@ -25,31 +25,32 @@ This plugin sets up an alarm in HomeKit, then allows you to connect Homebridge t
 - 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](https://github.com/nfarina/homebridge  "Homebridge") Installed
 2. You have an MQTT Server Running
 3. Your MQTT server receives codes when sensors or keyfob button pushes are triggered
-    <br><sup>(e.g. via 433Mhz contact sensor to Sonoff RF Bridge - see [Recommended Hardware](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki/Recommended-Hardware))</sup>
+    <br><sup>(e.g. via 433Mhz contact sensor to Sonoff RF Bridge - see [Recommended Hardware](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki/Recommended-Hardware))</sup>
 
 4. You have made a coffee
 
 # Installation
 There are two methods to this madness...
-1. [Automated](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki/Installation#automated-installation-with-homebridge-config-ui-x) install and configuration via [Homebridge Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x  "Homebridge Config UI X") [*recommended*]
-2. [Manual](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki/Installation#manual-installation-via-cli) install via CLI and manually updating your Homebridge configuration file
+1. [Automated](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki/Installation#automated-installation-with-homebridge-config-ui-x) install and configuration via [Homebridge Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x  "Homebridge Config UI X") [*recommended*]
+2. [Manual](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki/Installation#manual-installation-via-cli) install via CLI and manually updating your Homebridge configuration file
 
 # Configuration
 Once the installation is complete you will need to configure the plugin: 
-- [Config UI X Settings](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki/Configuration#config-ui-x-configuration) from your Homebridge instance.
-- [Manually](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki/Configuration#manual-configuration) in your config.json.
+- [Config UI X Settings](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki/Configuration#config-ui-x-configuration) from your Homebridge instance.
+- [Manually](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki/Configuration#manual-configuration) in your config.json.
 
 # Planned Features
-See the [Changelog](https://github.com/nzbullet/homebridge-homeqtt-alarm/blob/master/CHANGELOG.md) for upcoming/planned features.
+See the [Changelog](https://github.com/danieljbnz/homebridge-homeqtt-alarm/blob/master/CHANGELOG.md) for upcoming/planned features.
 
 <sup>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.</sup>
 
 ---
-## See the [Wiki](https://github.com/nzbullet/homebridge-homeqtt-alarm/wiki) for more information
+## See the [Wiki](https://github.com/danieljbnz/homebridge-homeqtt-alarm/wiki) for more information
diff --git a/config.schema.json b/config.schema.json
@@ -3,7 +3,7 @@
 	"pluginType": "accessory",
 	"singular": true,
 	"headerDisplay": "MQTT must be installed on your system",
-	"footerDisplay": "For help please see the [README](https://github.com/nzbullet/homebridge-homeqtt-alarm/blob/master/README.md).",
+	"footerDisplay": "For help please see the [README](https://github.com/danieljbnz/homebridge-homeqtt-alarm/blob/master/README.md).",
 	"schema": {
 		"name": {
 			"title": "Name",
@@ -104,6 +104,28 @@
 				}
 			}
 		},
+		"alarmDelay": {
+			"title": "Alarm Delay Timeout (in Seconds)",
+			"type": "object",
+			"properties": {
+				"armDelay": {
+					"title": "Arm Delay",
+					"type": "integer",
+					"default": 0,
+					"description": "Time in seconds before alarm arms",
+					"required": false,
+					"placeholder": "e.g. 5"
+				},
+				"triggerDelay": {
+					"title": "Trigger Delay",
+					"type": "integer",
+					"default": 0,
+					"description": "Time in seconds before alarm triggers",
+					"required": false,
+					"placeholder": "e.g. 5"
+				}
+			}
+		},
 		"sensor": {
 			"type": "array",
 			"items": {
@@ -304,6 +326,15 @@
 				"alarmSettings.targetStates.nightArm"
 			]
 		},
+		{
+			"type": "fieldset",
+			"expandable": true,
+			"title": "Alarm Delay",
+			"items": [
+				"alarmDelay.armDelay",
+				"alarmDelay.triggerDelay"
+			]
+		},
 		{
 			"type": "fieldset",
 			"expandable": true,

diff --git a/example-config.json b/example-config.json
@@ -19,6 +19,10 @@
             "nightArm": true
         }
     },
+    "alarmDelay": {
+        "armDelay": 0,
+        "triggerDelay": 0
+    },
     "sensor": [
         {
             "sensorType": "pirSensor",