Send state: off messages (#142)

* Add "state": "on" to the MQTT messages
Fixes #139

* Send state: off mqtt messages
Fixes #141

* Send state: off mqtt messages
Fixes #141

* 1.7.0

* Update changelog

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 
-## Unreleased
+## Version 1.7.0
+
+- Add a `state` property to the MQTT messages sent on motion detection. This
+  makes it easier to build binary motion sensors based on the MQTT messages in Home Assistant
+  by using `value_template: 'value_json.state'`. The delay before sending an `off` state is
+  configurable with the new `offDelay` setting on `mqtt` triggers. Resolves [issue 139](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/139) and [issue 141](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/141).
 
 - Add a `"state": "on"` property to the MQTT messages sent on motion detection. This
   makes it easier to build binary motion sensors based on the MQTT messages in Home Assistant

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-deepstackai-trigger",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Detects motion using DeepStack AI and calls registered triggers based on trigger rules.",
   "main": "dist/src/main.js",
   "files": [

sampleConfiguration/triggers.json

@@ -36,7 +36,8 @@
           "triggerUris": ["http://localhost:81/admin?trigger&camera=Dog"]
         },
         "mqtt": {
-          "topic": "aimotion/triggers/dog"
+          "topic": "aimotion/triggers/dog",
+          "offDelay": 5
         },
         "telegram": {
           "chatIds": [1],

src/handlers/mqttManager/IMqttConfigJson.ts

@@ -4,4 +4,5 @@
  *--------------------------------------------------------------------------------------------*/
 export default interface IMqttConfigJson {
   topic: string;
+  offDelay: number;
 }

src/handlers/mqttManager/MqttConfig.ts

@@ -5,11 +5,15 @@
 export default class MqttConfig {
   public topic: string;
   public enabled: boolean;
+  public offDelay: number;
 
   constructor(init?: Partial<MqttConfig>) {
     Object.assign(this, init);
 
     // Default for enabled is true if it isn't specified in the config file
     this.enabled = init?.enabled ?? true;
+
+    // Default offDelay is 30 seconds if not specified
+    this.offDelay = init?.offDelay ?? 30;
   }
 }

src/handlers/mqttManager/MqttManager.ts

@@ -1,4 +1,4 @@
-import MQTT from "async-mqtt";
+import MQTT, { IPublishPacket } from "async-mqtt";
 import * as fs from "fs";
 import * as JSONC from "jsonc-parser";
 import path from "path";
@@ -17,6 +17,7 @@ import IMqttManagerConfigJson from "./IMqttManagerConfigJson";
 
 let isEnabled = false;
 let mqttClient: MQTT.AsyncClient;
+const timers = new Map<string, NodeJS.Timeout>();
 
 /**
  * Takes a path to a configuration file and loads all of the triggers from it.
@@ -94,6 +95,22 @@ export async function processTrigger(
 
   log.info("MQTT Manager", `${fileName}: Publishing event to ${trigger.mqttConfig.topic}`);
 
+  // If an off delay is configured set up a timer to send the off message in the requested number of seconds
+  if (trigger?.mqttConfig?.offDelay) {
+    const existingTimer = timers.get(trigger.mqttConfig.topic);
+
+    // Cancel any timer that may still be running for the same topic
+    if (existingTimer) {
+      clearTimeout(existingTimer);
+    }
+
+    // Set the new timer
+    timers.set(
+      trigger.mqttConfig.topic,
+      setTimeout(publishOffEvent, trigger.mqttConfig.offDelay * 1000, trigger.mqttConfig.topic),
+    );
+  }
+
   // Even though this only calls one topic the way this gets used elsewhere
   // the expectation is it returns an array.
   return [
@@ -109,6 +126,10 @@ export async function processTrigger(
   ];
 }
 
+async function publishOffEvent(topic: string): Promise<IPublishPacket> {
+  return await mqttClient.publish(topic, JSON.stringify({ state: "off" }));
+}
+
 /**
  * Loads a trigger configuration file
  * @param configFilePath The path to the configuration file

src/schemas/mqttHandlerConfiguration.schema.json

@@ -12,6 +12,12 @@
       "minLength": 1,
       "examples": ["aimotion/trigger/dog"]
     },
+    "offDelay": {
+      "description": "Number of seconds of no motion to wait before sending an MQTT state off message. Set to 0 to disable sending off messages. Default is 30 seconds.",
+      "type": "number",
+      "default": 30,
+      "examples": ["0", "300"]
+    },
     "enabled": {
       "description": "Enables the MQTT handler on this trigger. Default is true.",
       "type": "boolean",

tests/handlers/MqttConfig.test.ts

@@ -5,9 +5,10 @@
 import MqttConfig from "../../src/handlers/mqttManager/MqttConfig";
 
 test("Verify MQTT handler configuration", () => {
-  // Empty constructor should default to enabled true
+  // Empty constructor should default to enabled true and offDelay 30
   let config = new MqttConfig();
   expect(config.enabled).toBe(true);
+  expect(config.offDelay).toBe(30);
 
   // Undefined enabled should be true
   config = new MqttConfig({ enabled: undefined });
@@ -20,4 +21,16 @@ test("Verify MQTT handler configuration", () => {
   // Explicitly set enabled false should be false
   config = new MqttConfig({ enabled: false });
   expect(config.enabled).toBe(false);
+
+  // Undefined offDelay should default to 30
+  config = new MqttConfig({ offDelay: undefined });
+  expect(config.offDelay).toBe(30);
+
+  // 0 offDelay should be 0
+  config = new MqttConfig({ offDelay: 0 });
+  expect(config.offDelay).toBe(0);
+
+  // 60 offDelay should be 60
+  config = new MqttConfig({ offDelay: 60 });
+  expect(config.offDelay).toBe(60);
 });