node-red-contrib-alarm-ultimate 0.1.0 → 0.1.2

package/nodes/AlarmUltimateZone.js

@@ -18,10 +18,13 @@ module.exports = function (RED) {
 
     let lastOpen = null;
 
-    function buildTopic(controlTopic) {
+    function buildTopic(controlTopic, zoneTopic) {
       if (configuredTopic) return configuredTopic;
       const base = typeof controlTopic === 'string' && controlTopic.trim().length > 0 ? controlTopic.trim() : 'alarm';
-      const z = zoneId || 'zone';
+      const z =
+        typeof zoneTopic === 'string' && zoneTopic.trim().length > 0
+          ? zoneTopic.trim()
+          : zoneId || 'zone';
       return `${base}/zone/${z}`;
     }
 
@@ -30,8 +33,18 @@ module.exports = function (RED) {
       if (lastOpen === open && reason !== 'init') return;
       lastOpen = open;
 
+      const zoneTopic =
+        evt && evt.zone ? evt.zone.topic || evt.zone.topicPattern || null : null;
+      const statusLabel = zoneTopic || zoneId || 'zone';
+
+      setNodeStatus({
+        fill: open ? 'red' : 'green',
+        shape: 'dot',
+        text: `${statusLabel}: ${open ? 'open' : 'closed'}`,
+      });
+
       const msg = {
-        topic: buildTopic(evt && evt.controlTopic),
+        topic: buildTopic(evt && evt.controlTopic, zoneTopic),
         payload: open,
         alarmId: evt ? evt.alarmId : alarmId,
         zone: evt && evt.zone ? evt.zone : { id: zoneId || null },
@@ -59,8 +72,17 @@ module.exports = function (RED) {
         setNodeStatus({ fill: 'red', shape: 'ring', text: `Unknown zone (${zoneId})` });
         return;
       }
-      setNodeStatus({ fill: 'green', shape: 'dot', text: `Connected (${zoneId}: ${selected.open ? 'open' : 'closed'})` });
-      emitZone(Boolean(selected.open), { alarmId, controlTopic: ui.controlTopic, zone: { id: selected.id, name: selected.name, type: selected.type } }, reason);
+      emitZone(Boolean(selected.open), {
+        alarmId,
+        controlTopic: ui.controlTopic,
+        zone: {
+          id: selected.id,
+          name: selected.name,
+          type: selected.type,
+          topic: selected.topic || null,
+          topicPattern: selected.topicPattern || null,
+        },
+      }, reason);
     }
 
     function onZoneState(evt) {
@@ -88,4 +110,3 @@ module.exports = function (RED) {
 
   RED.nodes.registerType('AlarmUltimateZone', AlarmUltimateZone);
 };
-

package/nodes/icons/alarm-ultimate-siren.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" aria-hidden="true">
+  <path fill="#fff" d="M20 7c-6.1 0-11 4.9-11 11v3.1l-2.3 5c-.9 2 .5 4.3 2.7 4.3h21.2c2.2 0 3.6-2.3 2.7-4.3l-2.3-5V18c0-6.1-4.9-11-11-11z"/>
+  <path fill="#fff" opacity="0.55" d="M20 10.2c-4.3 0-7.8 3.5-7.8 7.8v4.1l-.7 1.5h17l-.7-1.5V18c0-4.3-3.5-7.8-7.8-7.8z"/>
+  <path fill="#fff" d="M14.8 31.2c.3 2.7 2.5 4.8 5.2 4.8s4.9-2.1 5.2-4.8H14.8z"/>
+  <path fill="#fff" opacity="0.75" d="M6.2 16.8c.6-4.2 3.4-7.7 7.3-9.3l.6 1.5c-3.3 1.4-5.7 4.3-6.2 7.9l-1.7-.1zm27.6 0-1.7.1c-.5-3.6-2.9-6.5-6.2-7.9l.6-1.5c3.9 1.6 6.7 5.1 7.3 9.3z"/>
+</svg>

package/nodes/icons/alarm-ultimate-state.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" aria-hidden="true">
+  <path fill="#fff" d="M20 4 32 9v10c0 8.2-5.2 14.7-12 17-6.8-2.3-12-8.8-12-17V9l12-5z"/>
+  <path fill="#fff" opacity="0.55" d="M20 9.5 12.5 13v6.5c0 6 3.6 10.6 7.5 12.4 3.9-1.8 7.5-6.4 7.5-12.4V13L20 9.5z"/>
+  <path fill="#fff" d="M13.6 22.6h4.2l1.4-5.2 2.4 9 1.1-3.8h3.7v1.8h-2.3l-2.4 8.2-2.4-8.9-1.2 4.7h-5.2v-1.8z"/>
+</svg>

package/nodes/icons/alarm-ultimate-zone.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" aria-hidden="true">
+  <path fill="#fff" d="M20 6a14 14 0 1 1 0 28 14 14 0 0 1 0-28zm0 3.2a10.8 10.8 0 1 0 0 21.6 10.8 10.8 0 0 0 0-21.6z"/>
+  <path fill="#fff" d="M20 14a6 6 0 1 1 0 12 6 6 0 0 1 0-12zm0 3.2a2.8 2.8 0 1 0 0 5.6 2.8 2.8 0 0 0 0-5.6z"/>
+  <path fill="#fff" opacity="0.75" d="M20 10.2h1.6v3.2H20zM20 26.6h1.6v3.2H20zM26.6 19.2h3.2v1.6h-3.2zM10.2 19.2h3.2v1.6h-3.2z"/>
+</svg>

package/nodes/icons/alarm-ultimate.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" aria-hidden="true">
+  <path fill="#fff" d="M20 4 32 9v10c0 8.2-5.2 14.7-12 17-6.8-2.3-12-8.8-12-17V9l12-5z"/>
+  <path fill="#fff" opacity="0.55" d="M20 9.5 12.5 13v6.5c0 6 3.6 10.6 7.5 12.4 3.9-1.8 7.5-6.4 7.5-12.4V13L20 9.5z"/>
+  <path fill="#fff" d="M20 13.2 15.2 17v7.6h9.6V17L20 13.2zm-3.2 11.2V18.1L20 15.6l3.2 2.5v6.3h-6.4z"/>
+  <path fill="#fff" d="M19.2 19.6h1.6v4.8h-1.6z"/>
+</svg>

package/nodes/presets/input-adapter/ax-pro-hikvision-ultimate.js

@@ -0,0 +1,34 @@
+module.exports = {
+  id: "axpro_hikvision_ultimate",
+  name: "AX Pro (Hikvision Ultimate)",
+  description:
+    "Maps payload.zoneUpdate from Hikvision-Ultimate AX Pro nodes to {topic,payload} for Alarm zones.",
+  code: `
+if (!msg || typeof msg !== "object") return;
+const zone = msg.payload && msg.payload.zoneUpdate ? msg.payload.zoneUpdate : null;
+if (!zone || typeof zone !== "object") return;
+
+const rawTopic =
+  typeof zone.name === "string" && zone.name.trim()
+    ? zone.name.trim()
+    : zone.id !== undefined && zone.id !== null
+      ? String(zone.id)
+      : "";
+if (!rawTopic) return;
+
+let open;
+if (typeof zone.magnetOpenStatus === "boolean") {
+  open = zone.magnetOpenStatus;
+} else if (typeof zone.alarm === "boolean") {
+  open = zone.alarm;
+} else if (typeof zone.sensorStatus === "string") {
+  const v = zone.sensorStatus.trim().toLowerCase();
+  open = v !== "normal" && v !== "closed" && v !== "ok";
+} else {
+  return;
+}
+
+return { topic: rawTopic, payload: open, zoneUpdate: zone };
+`.trim(),
+};
+

package/nodes/presets/input-adapter/boolean-from-payload.js

@@ -0,0 +1,10 @@
+module.exports = {
+  id: "boolean_from_payload",
+  name: "Boolean from payload",
+  description: "Copies msg.topic and converts msg.payload to boolean.",
+  code: `
+if (typeof msg !== "object" || msg === null) return;
+return { topic: msg.topic, payload: !!msg.payload };
+`.trim(),
+};
+

package/nodes/presets/input-adapter/ha-on-off.js

@@ -0,0 +1,24 @@
+module.exports = {
+  id: "home_assistant_on_off",
+  name: "Home Assistant on/off",
+  description: 'Converts msg.payload "on"/"off" (or boolean) to boolean payload.',
+  code: `
+if (!msg || typeof msg !== "object") return;
+const topic = msg.topic;
+const value = msg.payload;
+let b;
+if (typeof value === "boolean") b = value;
+else if (typeof value === "string") {
+  const v = value.trim().toLowerCase();
+  if (v === "on" || v === "open" || v === "true" || v === "1") b = true;
+  else if (v === "off" || v === "closed" || v === "false" || v === "0") b = false;
+  else return;
+} else if (typeof value === "number") {
+  b = value !== 0;
+} else {
+  return;
+}
+return { topic, payload: b };
+`.trim(),
+};
+

package/nodes/presets/input-adapter/knx-ultimate.js

@@ -0,0 +1,29 @@
+module.exports = {
+  id: "knx_ultimate",
+  name: "KNX Ultimate",
+  description: "Uses knx.destination (fallback msg.topic) and converts payload to boolean.",
+  code: `
+if (!msg || typeof msg !== "object") return;
+const topic =
+  msg.knx && typeof msg.knx.destination === "string" && msg.knx.destination.trim()
+    ? msg.knx.destination.trim()
+    : msg.topic;
+if (typeof topic !== "string" || !topic.trim()) return;
+
+const value = msg.payload;
+let b;
+if (typeof value === "boolean") b = value;
+else if (typeof value === "number") b = value !== 0;
+else if (typeof value === "string") {
+  const v = value.trim().toLowerCase();
+  if (v === "1" || v === "true" || v === "on" || v === "open") b = true;
+  else if (v === "0" || v === "false" || v === "off" || v === "closed") b = false;
+  else return;
+} else {
+  return;
+}
+
+return { topic, payload: b };
+`.trim(),
+};
+

package/nodes/presets/input-adapter/passthrough.js

@@ -0,0 +1,7 @@
+module.exports = {
+  id: "passthrough",
+  name: "Passthrough",
+  description: "Emit the incoming msg unchanged.",
+  code: `return msg;`,
+};
+

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "node-red-contrib-alarm-ultimate",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Alarm System node for Node-RED.",
-  "author": "Supergiovane (https://github.com/Supergiovane)",
+  "author": "MAssimo Saccani (https://github.com/Supergiovane)",
   "license": "MIT",
   "keywords": [
     "node-red",
@@ -11,11 +11,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/Supergiovane/node-red-contrib-alarm-ultimate"
+    "url": "https://github.com/Supergiovane/node-red-contrib-alarm-ultimate.git"
   },
   "node-red": {
     "nodes": {
       "AlarmSystemUltimate": "nodes/AlarmSystemUltimate.js",
+      "AlarmUltimateInputAdapter": "nodes/AlarmUltimateInputAdapter.js",
       "AlarmUltimateState": "nodes/AlarmUltimateState.js",
       "AlarmUltimateZone": "nodes/AlarmUltimateZone.js",
       "AlarmUltimateSiren": "nodes/AlarmUltimateSiren.js"
@@ -30,4 +31,4 @@
   "scripts": {
     "test": "mocha test/**/*.spec.js"
   }
-}
+}

package/test/alarm-system.spec.js

@@ -467,4 +467,55 @@ describe('AlarmSystemUltimate node', function () {
       })
       .catch(done);
   });
+
+  it('emits zone open/close events while disarmed', function (done) {
+    const flowId = 'alarm-zone-events';
+    const flow = [
+      { id: flowId, type: 'tab', label: 'alarm-zone-events' },
+      {
+        id: 'alarm',
+        type: 'AlarmSystemUltimate',
+        z: flowId,
+        controlTopic: 'alarm',
+        requireCodeForDisarm: false,
+        zones: '{"id":"front","name":"Front","topic":"sensor/frontdoor","type":"perimeter","entry":false}',
+        wires: [[], [], [], [], ['zoneEvents']],
+      },
+      { id: 'zoneEvents', type: 'helper', z: flowId },
+    ];
+
+    loadAlarm(flow)
+      .then(() => {
+        const alarm = helper.getNode('alarm');
+        const zoneEvents = helper.getNode('zoneEvents');
+
+        const seen = [];
+        zoneEvents.on('input', (msg) => {
+          seen.push(msg);
+        });
+
+        // Default mode is disarmed. We should still see zone_open/zone_close.
+        alarm.receive({ topic: 'sensor/frontdoor', payload: true });
+        setTimeout(() => {
+          alarm.receive({ topic: 'sensor/frontdoor', payload: false });
+        }, 30);
+
+        setTimeout(() => {
+          try {
+            const events = seen.map((m) => m.event).filter(Boolean);
+            expect(events).to.include('zone_open');
+            expect(events).to.include('zone_close');
+            const openEvt = seen.find((m) => m && m.event === 'zone_open');
+            expect(openEvt).to.be.an('object');
+            expect(openEvt.payload).to.be.an('object');
+            expect(openEvt.payload.zone).to.be.an('object');
+            expect(openEvt.payload.zone.topic).to.equal('sensor/frontdoor');
+            done();
+          } catch (err) {
+            done(err);
+          }
+        }, 120);
+      })
+      .catch(done);
+  });
 });

package/test/input-adapter.spec.js

@@ -0,0 +1,243 @@
+'use strict';
+
+const { expect } = require('chai');
+const { helper } = require('./helpers');
+
+const adapterNode = require('../nodes/AlarmUltimateInputAdapter.js');
+
+function loadAdapter(flow, credentials) {
+  const normalizedFlow = flow.map((node, index) => {
+    if (
+      node &&
+      node.type &&
+      node.type !== 'tab' &&
+      node.type !== 'subflow' &&
+      node.type !== 'group' &&
+      node.z &&
+      !(Object.prototype.hasOwnProperty.call(node, 'x') && Object.prototype.hasOwnProperty.call(node, 'y'))
+    ) {
+      return { ...node, x: 100 + index * 10, y: 100 + index * 10 };
+    }
+    return node;
+  });
+  return helper.load(adapterNode, normalizedFlow, credentials || {});
+}
+
+describe('AlarmUltimateInputAdapter node', function () {
+  this.timeout(5000);
+
+  before(function (done) {
+    helper.startServer(done);
+  });
+
+  after(function (done) {
+    helper.stopServer(done);
+  });
+
+  afterEach(function () {
+    return helper.unload();
+  });
+
+  it('applies built-in preset (Home Assistant on/off)', function (done) {
+    const flowId = 'adapter1';
+    const flow = [
+      { id: flowId, type: 'tab', label: 'adapter1' },
+      {
+        id: 'adapter',
+        type: 'AlarmUltimateInputAdapter',
+        z: flowId,
+        presetSource: 'builtin',
+        presetId: 'home_assistant_on_off',
+        wires: [['out']],
+      },
+      { id: 'out', type: 'helper', z: flowId },
+    ];
+
+    loadAdapter(flow)
+      .then(() => {
+        const adapter = helper.getNode('adapter');
+        const out = helper.getNode('out');
+
+        out.on('input', (msg) => {
+          try {
+            expect(msg).to.be.an('object');
+            expect(msg.topic).to.equal('sensor/frontdoor');
+            expect(msg.payload).to.equal(true);
+            done();
+          } catch (err) {
+            done(err);
+          }
+        });
+
+        adapter.receive({ topic: 'sensor/frontdoor', payload: 'on' });
+      })
+      .catch(done);
+  });
+
+  it('applies built-in preset (KNX Ultimate)', function (done) {
+    const flowId = 'adapter3';
+    const flow = [
+      { id: flowId, type: 'tab', label: 'adapter3' },
+      {
+        id: 'adapter',
+        type: 'AlarmUltimateInputAdapter',
+        z: flowId,
+        presetSource: 'builtin',
+        presetId: 'knx_ultimate',
+        wires: [['out']],
+      },
+      { id: 'out', type: 'helper', z: flowId },
+    ];
+
+    loadAdapter(flow)
+      .then(() => {
+        const adapter = helper.getNode('adapter');
+        const out = helper.getNode('out');
+
+        out.on('input', (msg) => {
+          try {
+            expect(msg).to.be.an('object');
+            expect(msg.topic).to.equal('0/1/2');
+            expect(msg.payload).to.equal(false);
+            done();
+          } catch (err) {
+            done(err);
+          }
+        });
+
+        adapter.receive({
+          topic: '0/1/2',
+          payload: false,
+          previouspayload: true,
+          payloadmeasureunit: '%',
+          payloadsubtypevalue: 'Start',
+          devicename: 'Dinning table lamp',
+          gainfo: {
+            maingroupname: 'Light actuators',
+            middlegroupname: 'First flow lights',
+            ganame: 'Table Light',
+            maingroupnumber: '1',
+            middlegroupnumber: '1',
+            ganumber: '0',
+          },
+          knx: {
+            event: 'GroupValue_Write',
+            dpt: '1.001',
+            dptdesc: 'Humidity',
+            source: '15.15.22',
+            destination: '0/1/2',
+            rawValue: { 0: '0x0' },
+          },
+        });
+      })
+      .catch(done);
+  });
+
+  it('applies built-in preset (AX Pro from Hikvision-Ultimate)', function (done) {
+    const flowId = 'adapter4';
+    const flow = [
+      { id: flowId, type: 'tab', label: 'adapter4' },
+      {
+        id: 'adapter',
+        type: 'AlarmUltimateInputAdapter',
+        z: flowId,
+        presetSource: 'builtin',
+        presetId: 'axpro_hikvision_ultimate',
+        wires: [['out']],
+      },
+      { id: 'out', type: 'helper', z: flowId },
+    ];
+
+    loadAdapter(flow)
+      .then(() => {
+        const adapter = helper.getNode('adapter');
+        const out = helper.getNode('out');
+
+        out.on('input', (msg) => {
+          try {
+            expect(msg).to.be.an('object');
+            expect(msg.topic).to.equal('Cancello#2/7/12');
+            expect(msg.payload).to.equal(false);
+            expect(msg.zoneUpdate).to.be.an('object');
+            expect(msg.zoneUpdate.id).to.equal(9);
+            done();
+          } catch (err) {
+            done(err);
+          }
+        });
+
+        adapter.receive({
+          payload: {
+            zoneUpdate: {
+              id: 9,
+              name: 'Cancello#2/7/12',
+              status: 'online',
+              sensorStatus: 'normal',
+              magnetOpenStatus: false,
+              tamperEvident: false,
+              shielded: false,
+              bypassed: false,
+              armed: false,
+              isArming: false,
+              alarm: false,
+              subSystemNo: 5,
+              linkageSubSystem: [5],
+              detectorType: 'magneticContact',
+              stayAway: false,
+              zoneType: 'Instant',
+              accessModuleType: 'localTransmitter',
+              moduleChannel: 9,
+              zoneAttrib: 'wired',
+              deviceNo: 21,
+              abnormalOrNot: false,
+            },
+          },
+          _msgid: '5f34ea7333772aeb',
+        });
+      })
+      .catch(done);
+  });
+
+  it('applies user preset stored in node config', function (done) {
+    const flowId = 'adapter2';
+    const userCode = [
+      'if (!msg || typeof msg !== "object") return;',
+      'const topic = msg.payload && msg.payload.topic ? msg.payload.topic : msg.topic;',
+      'const open = msg.payload && msg.payload.state === "open";',
+      'return { topic, payload: open };',
+    ].join('\n');
+
+    const flow = [
+      { id: flowId, type: 'tab', label: 'adapter2' },
+      {
+        id: 'adapter',
+        type: 'AlarmUltimateInputAdapter',
+        z: flowId,
+        presetSource: 'user',
+        presetId: 'custom',
+        userCode,
+        wires: [['out']],
+      },
+      { id: 'out', type: 'helper', z: flowId },
+    ];
+
+    loadAdapter(flow)
+      .then(() => {
+        const adapter = helper.getNode('adapter');
+        const out = helper.getNode('out');
+
+        out.on('input', (msg) => {
+          try {
+            expect(msg.topic).to.equal('sensor/door');
+            expect(msg.payload).to.equal(true);
+            done();
+          } catch (err) {
+            done(err);
+          }
+        });
+
+        adapter.receive({ payload: { topic: 'sensor/door', state: 'open' } });
+      })
+      .catch(done);
+  });
+});

package/test/output-nodes.spec.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { expect } = require('chai');
 const { helper } = require('./helpers');
 
 const alarmNode = require('../nodes/AlarmSystemUltimate.js');
@@ -119,9 +120,11 @@ describe('Alarm Ultimate output-only nodes', function () {
           try {
             if (String(msg.reason || '').startsWith('init') && msg.payload === false) {
               seen.initialZoneClosed = true;
+              expect(msg.topic).to.equal('alarm/zone/sensor/frontdoor');
             }
             if (msg.payload === true && msg.zone && msg.zone.id === 'front') {
               seen.zoneOpen = true;
+              expect(msg.topic).to.equal('alarm/zone/sensor/frontdoor');
             }
             maybeDone();
           } catch (err) {