feat(entity): Rename sensor node to entity and add new entity type sw…

…itch - Add new entity of type swtich to the entity node which can be triggered from the service nodered.trigger
zachowj · Feb 17, 2020 · 059c340 · 059c340
1 parent 4680f75
commit 059c340
Show file tree

Hide file tree

Showing 6 changed files with 153 additions and 49 deletions.
diff --git a/lib/base-node.js b/lib/base-node.js
@@ -186,18 +186,18 @@ class BaseNode {
     }
 
     updateConnectionStatus(additionalText) {
-        this.setConnectionStatus(this.connectionState, additionalText);
+        this.setConnectionStatus(additionalText);
     }
 
-    setConnectionStatus(state, additionalText) {
+    getConnectionStatus() {
         let connectionStatus = {
             shape: 'ring',
             fill: 'red',
             text: 'node-red:common.status.disconnected'
         };
 
         if (this.websocketClient) {
-            switch (state) {
+            switch (this.connectionState) {
                 case this.websocketClient.CONNECTING:
                     connectionStatus = {
                         shape: 'ring',
@@ -222,6 +222,12 @@ class BaseNode {
             }
         }
 
+        return connectionStatus;
+    }
+
+    setConnectionStatus(additionalText) {
+        let connectionStatus = this.getConnectionStatus();
+
         if (
             Object.prototype.hasOwnProperty.call(this, 'isEnabled') &&
             this.isEnabled === false

diff --git a/lib/events-ha-node.js b/lib/events-ha-node.js
@@ -93,7 +93,9 @@ class EventsHaNode extends EventsNode {
         }
 
         const haConfig = {};
-        this.nodeConfig.haConfig
+        // Handle both event node and sensor node switch HA config
+        const config = this.nodeConfig.haConfig || this.nodeConfig.config;
+        config
             .filter(c => c.value.length)
             .forEach(e => (haConfig[e.property] = e.value));
 

diff --git a/nodes/entity/entity.js b/nodes/entity/entity.js
@@ -1,8 +1,7 @@
 const slugify = require('slugify');
+const EventsHaNode = require('../../lib/events-ha-node');
 
 module.exports = function(RED) {
-    const EventsNode = require('../../lib/events-node');
-
     const nodeOptions = {
         config: {
             name: {},
@@ -39,7 +38,7 @@ module.exports = function(RED) {
         }
     };
 
-    class EntityNode extends EventsNode {
+    class EntityNode extends EventsHaNode {
         constructor(nodeDefinition) {
             super(nodeDefinition, RED, nodeOptions);
             this.registered = false;
@@ -60,10 +59,34 @@ module.exports = function(RED) {
             }
         }
 
-        // Disable connection status
-        setConnectionStatus() {}
+        setConnectionStatus(additionalText) {
+            if (this.nodeConfig.entityType === 'switch') {
+                this.node.status({
+                    shape: this.isEnabled ? 'dot' : 'ring',
+                    fill: 'blue',
+                    text: `${
+                        this.isEnabled ? 'on' : 'off'
+                    } at: ${this.getPrettyDate()}`
+                });
+            }
+        }
+
+        setStatus(
+            opts = {
+                shape: 'dot',
+                fill: 'blue',
+                text: ''
+            }
+        ) {
+            this.node.status(opts);
+        }
 
         async registerEntity() {
+            if (this.nodeConfig.entityType === 'switch') {
+                super.registerEntity();
+                return;
+            }
+
             if (this.websocketClient.integrationVersion === 0) {
                 this.error(this.integrationErrorMessage);
                 this.setStatusFailed('Error');
@@ -76,12 +99,8 @@ module.exports = function(RED) {
 
             const config = {};
             this.nodeConfig.config
-                .filter(c => {
-                    return c.value.length;
-                })
-                .forEach(e => {
-                    config[e.property] = e.value;
-                });
+                .filter(c => c.value.length)
+                .forEach(e => (config[e.property] = e.value));
 
             const payload = {
                 type: 'nodered/discovery',
@@ -141,7 +160,23 @@ module.exports = function(RED) {
             }
         }
 
+        handleSwitchInput(message) {
+            if (this.isEnabled) {
+                this.setStatusSuccess('input');
+                this.send([message, null]);
+            } else {
+                this.setStatusFailed('input');
+                this.send([null, message]);
+            }
+        }
+
         async onInput({ parsedMessage, message }) {
+            // Handle entity node type switch
+            if (this.nodeConfig.entityType === 'switch') {
+                this.handleSwitchInput(message);
+                return;
+            }
+
             if (!this.isConnected) {
                 this.setStatusFailed('No Connection');
                 this.error(
@@ -274,6 +309,21 @@ module.exports = function(RED) {
                 });
         }
 
+        handleTriggerMessage(data = {}) {
+            const msg = {
+                topic: 'triggered',
+                payload: data.payload
+            };
+
+            if (this.isEnabled) {
+                this.setStatusSuccess('triggered');
+                this.send([msg, null]);
+            } else {
+                this.setStatusFailed('triggered');
+                this.send([null, msg]);
+            }
+        }
+
         getValue(value, valueType, msg) {
             let val;
             switch (valueType) {
@@ -312,16 +362,24 @@ module.exports = function(RED) {
         }
 
         async loadPersistedData() {
+            let data;
             try {
-                const data = await this.getNodeData();
-                if (
-                    data &&
-                    Object.prototype.hasOwnProperty.call(data, 'lastPayload')
-                ) {
-                    this.lastPayload = data.lastPayload;
-                }
+                data = await this.getNodeData();
             } catch (e) {
-                this.error(e.message);
+                this.error(e.message, {});
+            }
+
+            if (!data) return;
+
+            if (
+                this.nodeConfig.entityType === 'switch' &&
+                Object.prototype.hasOwnProperty.call(data, 'isEnabled')
+            ) {
+                this.isEnabled = data.isEnabled;
+                this.updateConnectionStatus();
+            }
+            if (Object.prototype.hasOwnProperty.call(data, 'lastPayload')) {
+                this.lastPayload = data.lastPayload;
             }
         }
     }

diff --git a/nodes/entity/ui-entity.html b/nodes/entity/ui-entity.html
@@ -3,7 +3,6 @@
 <div class="form-row">
     <label for="node-input-name">Name</label>
     <input type="text" id="node-input-name" placeholder="Name" />
-    <input type="hidden" id="node-input-outputs" />
 </div>
 
 <div class="form-row">
@@ -14,32 +13,33 @@
 <div class="form-row">
     <label for="node-input-entityType">Type</label>
     <select id="node-input-entityType" style="width: 70%;">
-        <option value="sensor">Sensor</option>
         <option value="binary_sensor">Binary Sensor</option>
+        <option value="sensor">Sensor</option>
+        <option value="switch">Switch</option>
     </select>
 </div>
 
-<div class="form-row">
+<div id="state-row" class="form-row">
     <label for="node-input-state">State</label>
     <input type="text" id="node-input-state" style="width: 68%;" />
     <input type="hidden" id="node-input-stateType" />
 </div>
 
-<div class="form-row">
+<div id="attributes-row" class="form-row">
     <ol id="attributes"></ol>
 </div>
 
-<div class="form-row">
+<div id="config-row" class="form-row">
     <ol id="config"></ol>
 </div>
 
-<div class="form-row">
+<div id="output-location-row" class="form-row">
     <label for="node-input-outputLocation">Output Location</label>
     <input type="hidden" id="node-input-outputLocationType" />
     <input type="text" id="node-input-outputLocation" style="width: 68%;" />
 </div>
 
-<div class="form-row">
+<div id="input-override-row" class="form-row">
     <label for="node-input-inputOverride">Input Override</label>
     <select id="node-input-inputOverride" style="width: 68%;">
         <option value="allow">Allow</option>
@@ -48,12 +48,12 @@
     </select>
 </div>
 
-<div class="form-row checkbox-option">
+<div id="resend-row" class="form-row checkbox-option">
     <input type="checkbox" id="node-input-resend" />
     <label for="node-input-resend">Resend state and attributes</label>
 </div>
 
-<div class="form-row checkbox-option">
+<div id="debug-row" class="form-row checkbox-option">
     <input type="checkbox" id="node-input-debugenabled" />
     <label for="node-input-debugenabled">Show Debug Information</label>
 </div>
diff --git a/nodes/entity/ui-entity.js b/nodes/entity/ui-entity.js
@@ -5,7 +5,7 @@ RED.nodes.registerType('ha-entity', {
     outputs: 1,
     icon: 'font-awesome/fa-genderless',
     align: 'right',
-    paletteLabel: 'sensor',
+    paletteLabel: 'entity',
     label: function() {
         return this.name || `type: ${this.entityType}`;
     },
@@ -37,25 +37,36 @@ RED.nodes.registerType('ha-entity', {
         nodeVersion.check(this);
         const node = this;
         const stateTypes = {
-            sensor: [
+            binary_sensor: [
                 'msg',
                 'flow',
                 'global',
                 'jsonata',
                 'str',
                 'num',
-                'bool',
-                'date'
+                'bool'
             ],
-            binary_sensor: [
+            sensor: [
                 'msg',
                 'flow',
                 'global',
                 'jsonata',
                 'str',
                 'num',
-                'bool'
-            ]
+                'bool',
+                'date'
+            ],
+            switch: ['msg']
+        };
+        const haConfigOptions = {
+            binary_sensor: [
+                'name',
+                'device_class',
+                'icon',
+                'unit_of_measurement'
+            ],
+            sensor: ['name', 'device_class', 'icon', 'unit_of_measurement'],
+            switch: ['name', 'icon']
         };
         const attributeTypes = [
             'str',
@@ -67,6 +78,14 @@ RED.nodes.registerType('ha-entity', {
             'flow',
             'global'
         ];
+        const switchRows = [
+            'state',
+            'attributes',
+            'output-location',
+            'input-override',
+            'resend',
+            'debug'
+        ];
 
         haServer.init(node, '#node-input-server');
 
@@ -78,15 +97,6 @@ RED.nodes.registerType('ha-entity', {
             type: node.stateType
         });
 
-        $('#node-input-entityType')
-            .on('change', function() {
-                $('#node-input-state').typedInput(
-                    'types',
-                    stateTypes[$(this).val()]
-                );
-            })
-            .trigger('change');
-
         $('#attributes')
             .editableList({
                 removable: true,
@@ -145,6 +155,34 @@ RED.nodes.registerType('ha-entity', {
             })
             .editableList('addItems', node.config);
 
+        $('#node-input-entityType')
+            .on('change', function() {
+                const value = $(this).val();
+
+                $('#node-input-state').typedInput('types', stateTypes[value]);
+
+                switch (value) {
+                    case 'binary_sensor':
+                    case 'sensor':
+                        node.outputs = 1;
+                        // Show all form-rows
+                        $('.form-row').show();
+                        // Show all config items
+                        $('#config').editableList('filter', () => true);
+                        break;
+                    case 'switch':
+                        node.outputs = 2;
+                        // create a comma delimited list of ids
+                        $(`#${switchRows.join('-row,#')}-row`).hide();
+                        // filter config options
+                        $('#config').editableList('filter', data =>
+                            haConfigOptions[value].includes(data.property)
+                        );
+                        break;
+                }
+            })
+            .trigger('change');
+
         $('#node-input-outputLocation').typedInput({
             types: [
                 'msg',

diff --git a/package.json b/package.json
@@ -48,8 +48,8 @@
       "poll-state": "nodes/poll-state/poll-state.js",
       "ha-webhook": "nodes/webhook/webhook.js",
       "api-call-service": "nodes/call-service/call-service.js",
-      "ha-fire-event": "nodes/fire-event/fire-event.js",
       "ha-entity": "nodes/entity/entity.js",
+      "ha-fire-event": "nodes/fire-event/fire-event.js",
       "api-current-state": "nodes/current-state/current-state.js",
       "ha-get-entities": "nodes/get-entities/get-entities.js",
       "api-get-history": "nodes/get-history/get-history.js",