Support MQTT device retention data flag settings

shaonianzhentan · Oct 9, 2023 · f94f914 · f94f914
1 parent 5eedf36
commit f94f914
Show file tree

Hide file tree

Showing 31 changed files with 79 additions and 95 deletions.
diff --git a/HomeAssistant.js b/HomeAssistant.js
@@ -10,7 +10,8 @@ function object_id(name) {
 
 const DiscoveryDevice = {}
 module.exports = class HomeAssistant {
-  constructor(node, cfg, device_info) {
+  constructor(node, cfg, { device_info, retain }) {
+    this.retain = retain === true
     this.device_info = device_info
     node.config = cfg.config
     this.node = node
@@ -144,7 +145,8 @@ module.exports = class HomeAssistant {
         payload = String(payload)
         break;
     }
-    this.node.server.client.publish(topic, payload)
+
+    this.node.server.client.publish(topic, payload, { retain: this.retain })
     if (msg) {
       this.node.status({ fill: "green", shape: "ring", text: `${msg}：${payload}` });
     }

diff --git a/binary_sensor/binary_sensor.js b/binary_sensor/binary_sensor.js
@@ -8,7 +8,7 @@ module.exports = function (RED) {
             this.server.register(this)
 
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/button/button.js b/button/button.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const { json_attr_t, command_topic } = ha.config
             const node = this
             node.on('input', function (msg) {

diff --git a/camera/camera.js b/camera/camera.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/climate/climate.js b/climate/climate.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
 
             const {

diff --git a/cover/cover.js b/cover/cover.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const { command_topic, state_topic, set_position_topic, position_topic, tilt_command_topic, tilt_status_topic } = ha.config
             const node = this
             node.on('input', function (msg) {

diff --git a/device/device.html b/device/device.html
@@ -6,23 +6,33 @@
     <div class="form-row">
         <a href="https://developers.home-assistant.io/docs/device_registry_index/" target="_blank" style="color:blue;">
             <label for="node-input-config" data-i18n="node-red-contrib-ha-mqtt/common:label.config"></label>   
-        </a>         
+        </a>
         <input type="text" id="node-config-input-config" data-i18n="[placeholder]node-red-contrib-ha-mqtt/common:label.config">
+    </div>    
+    <div class="form-row">
+      <label for="node-config-input-retain">
+        retain
+      </label>
+      <label style="width: 70%;">
+        <input type="checkbox" id="node-config-input-retain" style="display:inline-block; width:22px; vertical-align:top;" autocomplete="off"/>
+        <span data-i18n="node-red-contrib-ha-mqtt/common:label.retainMessage" style="user-select: none;"></span>
+      </label>      
     </div>
 </script>
 
 <script type="text/javascript">
-    RED.nodes.registerType('ha-mqtt-device', {
-        category: 'config',
-        defaults: {
-            name: { value: "", required: true },
-            config: { value: "" }
-        },
-        label: function () {
-            return this.name.trim();
-        },
-        oneditprepare: function () {
-            $("#node-config-input-config").typedInput({ type: "json", types: ["json"] })
-        }
-    });
+  RED.nodes.registerType('ha-mqtt-device', {
+    category: 'config',
+    defaults: {
+      name: { value: "", required: true },
+      config: { value: "" },
+      retain: { value: false }
+    },
+    label: function () {
+      return this.name.trim();
+    },
+    oneditprepare: function () {
+      $("#node-config-input-config").typedInput({ type: "json", types: ["json"] })
+    }
+  });
 </script>
diff --git a/device/device.js b/device/device.js
@@ -1,21 +1,22 @@
 const HomeAssistant = require('../HomeAssistant')
 module.exports = function (RED) {
-    RED.nodes.registerType('ha-mqtt-device', function (cfg) {
-        RED.nodes.createNode(this, cfg);
-        let { name, config } = cfg
-        name = name.trim()
-        if (!name) {
-            name = 'Home Assistant'
-        }
-        config = config ? JSON.parse(config) : {}
-        this.device_info = {
-            configuration_url: 'https://github.com/shaonianzhentan/node-red-contrib-ha-mqtt',
-            identifiers: `ha-mqtt-${name}`,
-            manufacturer: "shaonianzhentan",
-            model: 'HA-MQTT',
-            sw_version: HomeAssistant.version,
-            ...config,
-            name
-        }
-    })
+  RED.nodes.registerType('ha-mqtt-device', function (cfg) {
+    RED.nodes.createNode(this, cfg);
+    let { name, config, retain } = cfg
+    name = name.trim()
+    if (!name) {
+      name = 'Home Assistant'
+    }
+    config = config ? JSON.parse(config) : {}
+    this.retain = retain
+    this.device_info = {
+      configuration_url: 'https://github.com/shaonianzhentan/node-red-contrib-ha-mqtt',
+      identifiers: `ha-mqtt-${name}`,
+      manufacturer: "shaonianzhentan",
+      model: 'HA-MQTT',
+      sw_version: HomeAssistant.version,
+      ...config,
+      name
+    }
+  })
 }
diff --git a/device_automation/device_automation.js b/device_automation/device_automation.js
@@ -9,7 +9,7 @@ module.exports = function (RED) {
             const subtype = cfg.name
             cfg.name = `${subtype}${cfg.action}`
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             const { name, state_topic } = ha.config
             node.on('input', function (msg) {

diff --git a/device_tracker/device_tracker.js b/device_tracker/device_tracker.js
@@ -8,7 +8,7 @@ module.exports = function (RED) {
     if (this.server) {
       this.server.register(this)
       const deviceNode = RED.nodes.getNode(cfg.device);
-      const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+      const ha = new HomeAssistant(this, cfg, deviceNode)
       const node = this
       node.on('input', function (msg) {
         const { payload, attributes } = msg

diff --git a/event/event.js b/event/event.js
@@ -8,7 +8,7 @@ module.exports = function (RED) {
       this.server.register(this)
 
       const deviceNode = RED.nodes.getNode(cfg.device);
-      const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+      const ha = new HomeAssistant(this, cfg, deviceNode)
       const node = this
       node.on('input', function (msg) {
         let { payload, attributes } = msg

diff --git a/fan/fan.js b/fan/fan.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes, preset_mode, percentage, oscillation } = msg

diff --git a/humidifier/humidifier.js b/humidifier/humidifier.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes, mode, target_humidity } = msg

diff --git a/image/image.js b/image/image.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
     if (this.server) {
       this.server.register(this)
       const deviceNode = RED.nodes.getNode(cfg.device);
-      const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+      const ha = new HomeAssistant(this, cfg, deviceNode)
       const node = this
       node.on('input', function (msg) {
         const { payload, attributes } = msg

diff --git a/lawn_mower/lawn_mower.js b/lawn_mower/lawn_mower.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
     if (this.server) {
       this.server.register(this)
       const deviceNode = RED.nodes.getNode(cfg.device);
-      const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+      const ha = new HomeAssistant(this, cfg, deviceNode)
 
       const { state_topic, pause_command_topic, dock_command_topic, start_mowing_command_topic } = ha.config
 

diff --git a/light/light.js b/light/light.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             const { command_topic, effect_state_topic, effect_command_topic, brightness_state_topic, brightness_command_topic } = ha.config
             node.on('input', function (msg) {

diff --git a/locales/en-US/common.json b/locales/en-US/common.json
@@ -4,7 +4,8 @@
         "mqttServer": "MQTT Server",
         "entityName": "Entity Name",
         "deviceName": "Device Name",
-        "config": "Configuration"
+        "config": "Configuration",
+        "retainMessage": "Retain data for immediate updates"
     },
     "ioLabels": {
         "state": "State",

diff --git a/locales/zh/common.json b/locales/zh/common.json
@@ -4,7 +4,8 @@
         "mqttServer": "MQTT",
         "entityName": "实体名称",
         "deviceName": "设备名称",
-        "config": "配置"
+        "config": "配置",
+        "retainMessage": "保留数据即时更新"
     },
     "ioLabels": {
         "state": "状态",

diff --git a/lock/lock.js b/lock/lock.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/number/number.js b/number/number.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-ha-mqtt",
-  "version": "1.2.12",
+  "version": "1.2.13",
   "description": "Generate MQTT entities in HomeAssistant",
   "keywords": [
     "node-red",

diff --git a/scene/scene.js b/scene/scene.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             const { command_topic } = ha.config
 

diff --git a/select/select.js b/select/select.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/sensor/sensor.js b/sensor/sensor.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/siren/siren.js b/siren/siren.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/switch/switch.js b/switch/switch.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/tag/tag.js b/tag/tag.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 try {

diff --git a/text/text.js b/text/text.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
         if (this.server) {
             this.server.register(this)
             const deviceNode = RED.nodes.getNode(cfg.device);
-            const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+            const ha = new HomeAssistant(this, cfg, deviceNode)
             const node = this
             node.on('input', function (msg) {
                 const { payload, attributes } = msg

diff --git a/update/update.js b/update/update.js
@@ -7,7 +7,7 @@ module.exports = function (RED) {
     if (this.server) {
       this.server.register(this)
       const deviceNode = RED.nodes.getNode(cfg.device);
-      const ha = new HomeAssistant(this, cfg, deviceNode.device_info)
+      const ha = new HomeAssistant(this, cfg, deviceNode)
       const node = this
       node.on('input', function (msg) {
         const { payload, attributes } = msg