Add scene trigger : New MQTT message (#1913)

front/src/config/i18n/en.json

@@ -1688,6 +1688,9 @@
       },
       "system": {
         "start": "Gladys starting"
+      },
+      "mqtt": {
+        "received": "Receive message from MQTT"
       }
     },
     "triggersCard": {
@@ -1786,6 +1789,14 @@
       },
       "gladysStart": {
         "description": "This scene will be executed each time Gladys starts"
+      },
+      "mqttReceived": {
+        "description": "This scene will run when a message is received in the selected MQTT topic",
+        "topicLabel": "Topic",
+        "topicPlaceholder": "Enter your topic",
+        "messageLabel": "Message",
+        "messagePlaceholder": "Enter the expected message",
+        "messageDescription": "Enter the expected message or leave blank to run the scene regardless of the message"
       }
     }
   },

front/src/config/i18n/fr.json

@@ -1689,6 +1689,9 @@
       },
       "system": {
         "start": "Gladys démarre"
+      },
+      "mqtt": {
+        "received": "Recevoir un message MQTT"
       }
     },
     "triggersCard": {
@@ -1787,6 +1790,14 @@
       },
       "gladysStart": {
         "description": "Cette scène sera exécutée à chaque démarrage de Gladys"
+      },
+      "mqttReceived": {
+        "description": "Cette scène s'exécutera lorsque un message sera reçu dans le topic MQTT sélectionné",
+        "topicLabel": "Topic",
+        "topicPlaceholder": "Entrez votre topic",
+        "messageLabel": "Message",
+        "messagePlaceholder": "Entrez le message attendu",
+        "messageDescription": "Entrez le message attendu ou laissez vide pour exécuter la scène quelque soit le message"
       }
     }
   },

front/src/routes/scene/edit-scene/TriggerCard.jsx

@@ -1,4 +1,3 @@
-import { h } from 'preact';
 import { Text } from 'preact-i18n';
 import cx from 'classnames';
 
@@ -11,6 +10,7 @@ import HouseEmptyOrNot from './triggers/HouseEmptyOrNot';
 import UserEnteredOrLeftArea from './triggers/UserEnteredOrLeftArea';
 import CalendarEventIsComing from './triggers/CalendarEventIsComing';
 import AlarmModeTrigger from './triggers/AlarmModeTrigger';
+import MQTTReceivedTrigger from './triggers/MQTTReceivedTrigger';
 
 import { EVENTS } from '../../../../../server/utils/constants';
 import GladysStartTrigger from './triggers/GladysStartTrigger';
@@ -32,7 +32,8 @@ const TRIGGER_ICON = {
   [EVENTS.ALARM.DISARM]: 'fe-bell-off',
   [EVENTS.ALARM.PANIC]: 'fe-alert-triangle',
   [EVENTS.ALARM.TOO_MANY_CODES_TESTS]: 'fe-alert-triangle',
-  [EVENTS.SYSTEM.START]: 'fe-activity'
+  [EVENTS.SYSTEM.START]: 'fe-activity',
+  [EVENTS.MQTT.RECEIVED]: 'fe-hash'
 };
 
 const ALARM_TRIGGERS = [
@@ -166,6 +167,13 @@ const TriggerCard = ({ children, ...props }) => (
           trigger={props.trigger}
         />
       )}
+      {props.trigger.type === EVENTS.MQTT.RECEIVED && (
+        <MQTTReceivedTrigger
+          updateTriggerProperty={props.updateTriggerProperty}
+          index={props.index}
+          trigger={props.trigger}
+        />
+      )}
     </div>
   </div>
 );

front/src/routes/scene/edit-scene/triggers/ChooseTriggerTypeCard.jsx

@@ -25,7 +25,8 @@ const TRIGGER_LIST = [
   EVENTS.ALARM.PANIC,
   EVENTS.ALARM.PARTIAL_ARM,
   EVENTS.ALARM.TOO_MANY_CODES_TESTS,
-  EVENTS.SYSTEM.START
+  EVENTS.SYSTEM.START,
+  EVENTS.MQTT.RECEIVED
 ];
 
 class ChooseTriggerType extends Component {

front/src/routes/scene/edit-scene/triggers/MQTTReceivedTrigger.jsx

@@ -0,0 +1,56 @@
+import { Component } from 'preact';
+import { connect } from 'unistore/preact';
+import { Text, Localizer } from 'preact-i18n';
+
+class MQTTReceived extends Component {
+  updateTopicName = e => {
+    this.props.updateTriggerProperty(this.props.index, 'topic', e.target.value);
+  };
+
+  updateMessage = e => {
+    this.props.updateTriggerProperty(this.props.index, 'message', e.target.value);
+  };
+
+  render({}, {}) {
+    return (
+      <div>
+        <p>
+          <Text id="editScene.triggersCard.mqttReceived.description" />
+        </p>
+        <div class="form-group">
+          <label className="form-label">
+            <Text id="editScene.triggersCard.mqttReceived.topicLabel" />
+          </label>
+          <Localizer>
+            <input
+              type="text"
+              value={this.props.trigger.topic}
+              onInput={this.updateTopicName}
+              className="form-control"
+              placeholder={<Text id="editScene.triggersCard.mqttReceived.topicPlaceholder" />}
+            />
+          </Localizer>
+        </div>
+        <div class="form-group">
+          <label className="form-label">
+            <Text id="editScene.triggersCard.mqttReceived.messageLabel" />
+          </label>
+          <div class="mb-1 small">
+            <Text id="editScene.triggersCard.mqttReceived.messageDescription" />
+          </div>
+          <Localizer>
+            <input
+              type="text"
+              value={this.props.trigger.message}
+              onInput={this.updateMessage}
+              className="form-control"
+              placeholder={<Text id="editScene.triggersCard.mqttReceived.messagePlaceholder" />}
+            />
+          </Localizer>
+        </div>
+      </div>
+    );
+  }
+}
+
+export default connect('httpClient,user', {})(MQTTReceived);

server/lib/index.js

@@ -96,6 +96,7 @@ function Gladys(params = {}) {
     gateway,
     scheduler,
     brain,
+    service,
   );
 
   const gladys = {

server/lib/scene/index.js

@@ -34,6 +34,7 @@ const SceneManager = function SceneManager(
   gateway,
   scheduler,
   brain,
+  service,
 ) {
   this.stateManager = stateManager;
   this.event = event;
@@ -45,6 +46,7 @@ const SceneManager = function SceneManager(
   this.http = http;
   this.gateway = gateway;
   this.brain = brain;
+  this.service = service;
   this.scenes = {};
   this.timezone = DEFAULT_TIMEZONE;
   // @ts-ignore

server/lib/scene/scene.addScene.js

@@ -91,6 +91,22 @@ function addScene(sceneRaw) {
         }
         trigger.jsInterval = setInterval(() => this.event.emit(EVENTS.TRIGGERS.CHECK, trigger), intervalMilliseconds);
       }
+
+      if (trigger.type === EVENTS.MQTT.RECEIVED) {
+        const mqttService = this.service.getService('mqtt');
+
+        if (mqttService) {
+          trigger.mqttCallback = (topic, message) => {
+            this.event.emit(EVENTS.TRIGGERS.CHECK, {
+              type: EVENTS.MQTT.RECEIVED,
+              topic,
+              message,
+            });
+          };
+
+          mqttService.device.subscribe(trigger.topic, trigger.mqttCallback);
+        }
+      }
     });
   }
 

server/lib/scene/scene.cancelTriggers.js

@@ -15,6 +15,12 @@ function cancelTriggers(sceneSelector) {
         clearInterval(trigger.jsInterval);
         delete trigger.jsInterval;
       }
+      if (trigger.topic) {
+        const mqttService = this.service.getService('mqtt');
+        if (mqttService) {
+          mqttService.device.unsubscribe(trigger.topic);
+        }
+      }
     });
   }
 }

server/lib/scene/scene.triggers.js

@@ -32,6 +32,8 @@ const triggersFunc = {
   [EVENTS.ALARM.PANIC]: (event, trigger) => event.house === trigger.house,
   [EVENTS.ALARM.TOO_MANY_CODES_TESTS]: (event, trigger) => event.house === trigger.house,
   [EVENTS.SYSTEM.START]: () => true,
+  [EVENTS.MQTT.RECEIVED]: (event, trigger) =>
+    event.topic === trigger.topic && (trigger.message === '' || trigger.message === event.message),
 };
 
 module.exports = {

server/models/scene.js

@@ -99,6 +99,8 @@ const triggersSchema = Joi.array().items(
       .min(1)
       .max(31),
     threshold_only: Joi.boolean(),
+    topic: Joi.string(),
+    message: Joi.string().allow(''),
   }),
 );
 

server/services/usb/package.json

@@ -9,7 +9,8 @@
   "cpu": [
     "x64",
     "arm",
-    "arm64"
+    "arm64",
+    "arm64e"
   ],
   "scripts": {},
   "dependencies": {

server/test/lib/scene/scene.addScene.test.js

@@ -2,6 +2,7 @@ const { expect } = require('chai');
 const sinon = require('sinon');
 
 const { fake, assert } = sinon;
+
 const { EVENTS } = require('../../../utils/constants');
 const { BadParameters } = require('../../../utils/coreErrors');
 const SceneManager = require('../../../lib/scene');
@@ -10,6 +11,10 @@ describe('SceneManager.addScene', () => {
   const house = {};
   const event = {};
   const brain = {};
+  const service = {};
+  const mqttService = {
+    device: {},
+  };
 
   let sceneManager;
 
@@ -19,6 +24,8 @@ describe('SceneManager.addScene', () => {
     event.emit = fake.returns(null);
     brain.addNamedEntity = fake.returns(null);
     brain.removeNamedEntity = fake.returns(null);
+    mqttService.device.subscribe = fake.returns(null);
+    service.getService = fake.returns(mqttService);
 
     const scheduler = {
       scheduleJob: (date, callback) => {
@@ -30,7 +37,7 @@ describe('SceneManager.addScene', () => {
       },
     };
 
-    sceneManager = new SceneManager({}, event, {}, {}, {}, house, {}, {}, {}, scheduler, brain);
+    sceneManager = new SceneManager({}, event, {}, {}, {}, house, {}, {}, {}, scheduler, brain, service);
   });
 
   afterEach(() => {
@@ -229,4 +236,30 @@ describe('SceneManager.addScene', () => {
     });
     expect(sceneManager.scenes[scene.selector].triggers[0]).to.not.have.property('nodeScheduleJob');
   });
+  it('should add a scene with a message received trigger', async () => {
+    const scene = sceneManager.addScene({
+      name: 'a-test-scene',
+      icon: 'bell',
+      active: true,
+      triggers: [
+        {
+          type: EVENTS.MQTT.RECEIVED,
+          topic: 'my/topic',
+        },
+      ],
+      actions: [],
+    });
+    expect(sceneManager.scenes[scene.selector].triggers[0]).to.not.have.property('nodeScheduleJob');
+    expect(sceneManager.scenes[scene.selector].triggers[0]).to.not.have.property('jsInterval');
+    expect(sceneManager.scenes[scene.selector].triggers[0]).to.have.property('mqttCallback');
+    assert.calledWithExactly(service.getService, 'mqtt');
+    assert.calledOnce(mqttService.device.subscribe);
+
+    sceneManager.scenes[scene.selector].triggers[0].mqttCallback('my/topic', 'message');
+    assert.calledOnceWithExactly(event.emit, EVENTS.TRIGGERS.CHECK, {
+      type: EVENTS.MQTT.RECEIVED,
+      topic: 'my/topic',
+      message: 'message',
+    });
+  });
 });

server/test/lib/scene/scene.cancelTriggers.test.js

@@ -1,18 +1,25 @@
 const { expect } = require('chai');
-const EventEmitter = require('events');
 const sinon = require('sinon');
 const { EVENTS } = require('../../../utils/constants');
 const SceneManager = require('../../../lib/scene');
 
-const { fake } = sinon;
-const event = new EventEmitter();
+const { fake, assert } = sinon;
 
 describe('SceneManager.cancelTriggers', () => {
   let sceneManager;
 
   const brain = {};
+  const service = {};
+  const event = {};
+  const mqttService = {
+    device: {},
+  };
 
   beforeEach(() => {
+    mqttService.device.unsubscribe = fake.returns(null);
+    mqttService.device.subscribe = fake.returns(null);
+    service.getService = fake.returns(mqttService);
+
     const house = {
       get: fake.resolves([]),
     };
@@ -30,7 +37,9 @@ describe('SceneManager.cancelTriggers', () => {
     brain.addNamedEntity = fake.returns(null);
     brain.removeNamedEntity = fake.returns(null);
 
-    sceneManager = new SceneManager({}, event, {}, {}, {}, house, {}, {}, {}, scheduler, brain);
+    event.on = fake.returns(null);
+
+    sceneManager = new SceneManager({}, event, {}, {}, {}, house, {}, {}, {}, scheduler, brain, service);
   });
 
   afterEach(() => {
@@ -74,4 +83,22 @@ describe('SceneManager.cancelTriggers', () => {
     sceneManager.cancelTriggers(scene.selector);
     expect(sceneManager.scenes[scene.selector].triggers[0]).not.to.have.property('jsInterval');
   });
+  it('should cancel a message received trigger', async () => {
+    const scene = await sceneManager.create({
+      name: 'a-test-scene',
+      icon: 'bell',
+      triggers: [
+        {
+          type: EVENTS.MQTT.RECEIVED,
+          topic: 'my/topic',
+        },
+      ],
+      actions: [],
+    });
+    expect(sceneManager.scenes[scene.selector].triggers[0]).not.to.have.property('nodeScheduleJob');
+    expect(sceneManager.scenes[scene.selector].triggers[0]).not.to.have.property('jsInterval');
+    sceneManager.cancelTriggers(scene.selector);
+    assert.calledWithExactly(service.getService, 'mqtt');
+    assert.calledWithExactly(mqttService.device.unsubscribe, 'my/topic');
+  });
 });