node-red-contrib-thingsboard-gateway 0.1.0 → 0.2.0

package/README.md

@@ -1,16 +1,2 @@
 # node-red-contrib-thingsboard-gateway
 
-Send telemetry data from Node-RED to ThingsBoard Gateway using MQTT.
-
-## Input
-`msg.payload` should be a valid ThingsBoard gateway telemetry JSON.
-
-## Example
-
-```json
-{
-  "deviceName": "sensor-01",
-  "telemetry": {
-    "temperature": 27.5
-  }
-}

package/nodes/gateway_out.js

@@ -0,0 +1,9 @@
+ const fs = require("fs");
+ const path = require("path");
+
+ module.exports = function(RED) {
+     const subflowFile = path.join(__dirname,"gateway_out.json");
+     const subflowContents = fs.readFileSync(subflowFile);
+     const subflowJSON = JSON.parse(subflowContents);
+     RED.nodes.registerSubflow(subflowJSON);
+ }

package/nodes/gateway_out.json

@@ -0,0 +1,336 @@
+  {
+      "id": "8d3bffe93912093b",
+      "type": "subflow",
+      "name": "gateway out",
+      "info": "Node-RED Subflow to use the [Thingsboard MQTT Gateway API](https://thingsboard.io/docs/reference/gateway-mqtt-api) for direct integration with FlexIoT.\r\n\r\n### Details\r\n\r\n#### Node Status\r\n\r\nThe node status color indicates the connection status to the Thingsboard platform.\r\n\r\n`Con`: connected / disconnected / errors (total)\r\n`Tel`: success / errors (total)\r\n`Attr`: success / errors (total)\r\n\r\n#### Device Connection\r\n\r\nUsed to connect a device to the Thingsboard platform.\r\nIt handles the connection process, including authentication and device registration.\r\n\r\nMessage properties:\r\n\r\n: api_method (string) : Must be set to \"connection\" for device connection.\r\n: device_name (string) : Device name to be targeted in Device List on FlexIoT.\r\n: device_type (string) : Device type, required for first connection. See FlexIoT Device Profile.\r\n: value (object) : Connection status.\r\n\r\nExample:\r\n\r\n```json\r\n{\r\n  \"api_method\": \"connection\",\r\n  \"device_name\": \"xinergis_32A3D\",\r\n  \"device_type\": \"Xinergis Device\",\r\n  \"value\": {\r\n    \"active\": true\r\n  }\r\n}\r\n```\r\n\r\n#### Attributes\r\n\r\nUsed to set device attributes.\r\nIt allows you to send key-value pairs as attributes to the device.\r\n\r\nMessage properties:\r\n\r\n: api_method (string) : Must be set to \"attributes\" for setting attributes.\r\n: device_name (string) : Device name to be targeted in Device List on FlexIoT.\r\n: value (object) : Key-value pairs representing the attributes.\r\n\r\nExample:\r\n\r\n```json\r\n{\r\n  \"api_method\": \"attributes\",\r\n  \"device_name\": \"xinergis_32A3D\",\r\n  \"value\": {\r\n    \"attribute_key_1\": \"value_1\",\r\n    \"attribute_key_2\": \"value_2\"\r\n  }\r\n}\r\n```\r\n\r\n#### Telemetry\r\n\r\nUsed to send telemetry data to the device.\r\nIt allows you to send various types of telemetry data.\r\n\r\nMessage properties:\r\n\r\n: api_method (string) : Must be set to \"telemetry\" for sending telemetry data.\r\n: device_name (string) : Device name to be targeted in Device List on FlexIoT.\r\n: value (object | array) : Key-value pairs representing the telemetry data.\r\n\r\nSingle object example:\r\n\r\n```json\r\n{\r\n  \"api_method\": \"telemetry\",\r\n  \"device_name\": \"xinergis_32A3D\",\r\n  \"value\": {\r\n    \"telemetry_key_1\": \"value_1\",\r\n    \"telemetry_key_2\": \"value_2\"\r\n  }\r\n}\r\n```\r\n\r\nArray example:\r\n\r\n```json\r\n{\r\n  \"api_method\": \"telemetry\",\r\n  \"device_name\": \"xinergis_32A3D\",\r\n  \"value\": [\r\n    {\r\n      \"ts\": 1700000000000,\r\n      \"values\": {\r\n        \"telemetry_key_1\": \"value_1\",\r\n        \"telemetry_key_2\": \"value_2\"\r\n      }\r\n    },\r\n    {\r\n      \"ts\": 1700000001000,\r\n      \"values\": {\r\n        \"telemetry_key_1\": \"value_3\",\r\n        \"telemetry_key_2\": \"value_4\"\r\n      }\r\n    }\r\n  ]\r\n}\r\n```\r\n\r\n### References\r\n\r\n* [Thingsboard MQTT Gateway API](https://thingsboard.io/docs/reference/gateway-mqtt-api)\r\n",
+      "category": "",
+      "in": [
+          {
+              "x": 360,
+              "y": 560,
+              "wires": [
+                  {
+                      "id": "4b7e9a3f7a1c5324"
+                  }
+              ]
+          }
+      ],
+      "out": [],
+      "env": [
+          {
+              "name": "Server",
+              "type": "mqtt-broker",
+              "value": "",
+              "ui": {
+                  "icon": "font-awesome/fa-globe",
+                  "type": "conf-types"
+              }
+          }
+      ],
+      "meta": {
+          "module": "gateway-out",
+          "type": "network",
+          "version": "1.0.0",
+          "author": "farisrfp <farisrafp@gmail.com>",
+          "license": "MIT"
+      },
+      "color": "#8083fa",
+      "inputLabels": [
+          "paylod-in"
+      ],
+      "icon": "node-red/bridge-dash.svg",
+      "flow": [
+
+  {
+      "id": "aab53e74b7e5cb53",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Connection Process",
+      "func": "const device_name = msg.payload.device_name;\nconst device_type = msg.payload.device_type;\nconst payload = msg.payload.value;\n\nif (typeof payload?.active !== 'boolean') {\n    const connection_error = flow.get('connection_error') || 0;\n    flow.set('connection_error', connection_error + 1);\n\n    return null;\n}\n\nconst is_active = payload.active;\nmsg.topic = is_active ? 'v1/gateway/connect' : 'v1/gateway/disconnect';\nmsg.payload = is_active ? { device: device_name, type: device_type } : { device: device_name };\n\nconst connection_connected = flow.get('connection_connected') || 0;\nconst connection_disconnected = flow.get('connection_disconnected') || 0;\nconst connection_success = flow.get('connection_success') || 0;\nif (is_active) {\n    flow.set('connection_connected', connection_connected + 1);\n} else {\n    flow.set('connection_disconnected', connection_disconnected + 1);\n}\nflow.set('connection_success', connection_success + 1);\n\nreturn msg;",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 1320,
+      "y": 520,
+      "wires": [
+          [
+              "a9dd9c6e8b0c3ef8"
+          ]
+      ]
+  },
+  {
+      "id": "0c9017a47fbd43e3",
+      "type": "switch",
+      "z": "8d3bffe93912093b",
+      "name": "Switch API",
+      "property": "payload.api_method",
+      "propertyType": "msg",
+      "rules": [
+          {
+              "t": "eq",
+              "v": "connection",
+              "vt": "str"
+          },
+          {
+              "t": "eq",
+              "v": "attributes",
+              "vt": "str"
+          },
+          {
+              "t": "eq",
+              "v": "telemetry",
+              "vt": "str"
+          }
+      ],
+      "checkall": "true",
+      "repair": false,
+      "outputs": 3,
+      "x": 1050,
+      "y": 560,
+      "wires": [
+          [
+              "aab53e74b7e5cb53"
+          ],
+          [
+              "7e858adb86eafa1c"
+          ],
+          [
+              "bcfc701b1b986ff3"
+          ]
+      ]
+  },
+  {
+      "id": "aef5609072e8f7cf",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Summary Status",
+      "func": "const status = flow.get('status') || { fill: \"gray\", dot: \"fill\" }\n\nmsg = {};\nmsg.status = {\n    fill: status.fill,\n    shape: status.shape,\n    text: status.text\n};\n\nnode.status(msg.status)\n\nreturn msg;",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 2020,
+      "y": 660,
+      "wires": [
+          []
+      ]
+  },
+  {
+      "id": "dc4e55611ccff866",
+      "type": "delay",
+      "z": "8d3bffe93912093b",
+      "name": "limit message",
+      "pauseType": "rate",
+      "timeout": "5",
+      "timeoutUnits": "seconds",
+      "rate": "1",
+      "nbRateUnits": "0.5",
+      "rateUnits": "second",
+      "randomFirst": "1",
+      "randomLast": "5",
+      "randomUnits": "seconds",
+      "drop": false,
+      "allowrate": false,
+      "outputs": 1,
+      "x": 2040,
+      "y": 520,
+      "wires": [
+          [
+              "ea599d3aca06a643"
+          ]
+      ]
+  },
+  {
+      "id": "7e858adb86eafa1c",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Attributes Process",
+      "func": "const device_name = msg.payload.device_name;\nconst payload = msg.payload.value;\n\nif (!device_name || msg.payload == null) {\n    const attributes_error = flow.get('attributes_error') || 0;\n    flow.set('attributes_error', attributes_error + 1);\n\n    return null;\n}\n\nmsg.topic = 'v1/gateway/attributes';\nmsg.payload = { [device_name]: payload };\n\nconst attributes_success = flow.get('attributes_success') || 0;\nflow.set('attributes_success', attributes_success + 1);\n\nreturn msg;",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 1310,
+      "y": 560,
+      "wires": [
+          [
+              "a9dd9c6e8b0c3ef8"
+          ]
+      ]
+  },
+  {
+      "id": "cee336a87dd1a38f",
+      "type": "split",
+      "z": "8d3bffe93912093b",
+      "name": "Split Values",
+      "splt": "\\n",
+      "spltType": "str",
+      "arraySplt": "5",
+      "arraySpltType": "len",
+      "stream": false,
+      "addname": "",
+      "property": "payload.split",
+      "x": 1510,
+      "y": 600,
+      "wires": [
+          [
+              "b24e3d9340162324"
+          ]
+      ]
+  },
+  {
+      "id": "bcfc701b1b986ff3",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Telemetry Process",
+      "func": "let device_name = msg.payload.device_name\nconst payload = Array.isArray(msg.payload.value) ? msg.payload.value : [msg.payload.value];\n\nif (!device_name || typeof msg.payload == undefined) {\n    const telemetry_error = flow.get('telemetry_error') || 0;\n    flow.set('telemetry_error', telemetry_error + 1);\n    return null;\n}\n\n/* Temporary for splittring payload */\nmsg.device_name = device_name;\ndevice_name = \"split\";\n\nmsg.topic = 'v1/gateway/telemetry';\nmsg.payload = { [device_name]: payload };\n\nconst telemetry_success = flow.get('telemetry_success') || 0;\nflow.set('telemetry_success', telemetry_success + 1);\n\nreturn msg;",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 1310,
+      "y": 600,
+      "wires": [
+          [
+              "cee336a87dd1a38f"
+          ]
+      ]
+  },
+  {
+      "id": "b24e3d9340162324",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Return Device Name",
+      "func": "const device_name = msg.device_name;\nconst data_array = msg.payload.split;\n\nmsg.payload = {\n    [device_name]: data_array\n};\n\nreturn msg;\n",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 1740,
+      "y": 600,
+      "wires": [
+          [
+              "a9dd9c6e8b0c3ef8"
+          ]
+      ]
+  },
+  {
+      "id": "3380c50a90b10d49",
+      "type": "status",
+      "z": "8d3bffe93912093b",
+      "name": "",
+      "scope": [
+          "ea599d3aca06a643"
+      ],
+      "x": 1560,
+      "y": 660,
+      "wires": [
+          [
+              "af3fc41d0edfe224"
+          ]
+      ]
+  },
+  {
+      "id": "af3fc41d0edfe224",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "MQTT Publish Status",
+      "func": "flow.set(\"status\", msg.status)\n\nreturn msg;",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 1760,
+      "y": 660,
+      "wires": [
+          [
+              "aef5609072e8f7cf"
+          ]
+      ]
+  },
+  {
+      "id": "4b7e9a3f7a1c5324",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Format Device Name",
+      "func": "let oldKey = msg.payload.device_name;\nlet newKey = oldKey.replace(/_/g, \"-\").toUpperCase();\nmsg.payload.device_name = newKey;\nreturn msg;\n",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 580,
+      "y": 560,
+      "wires": [
+          [
+              "7689c6c186fb5477"
+          ]
+      ]
+  },
+  {
+      "id": "7689c6c186fb5477",
+      "type": "function",
+      "z": "8d3bffe93912093b",
+      "name": "Check Database",
+      "func": "const flexiot_devices = global.get(\"flexiot_devices\") || [];\nconst device_name = msg.payload.device_name;\n\nif (!flexiot_devices.includes(device_name)) {\n    msg.payload.api_method = \"connection\";\n    msg.payload.value.active = true;\n\n    if (device_name.includes(\"IR\")) {\n        msg.payload.device_type = \"PowerSense - IR Blaster Device\";\n    }\n\n    if (device_name.includes(\"METER\")) {\n        msg.payload.device_type = \"PowerSense - Meter Device\";\n    }\n\n    if (device_name.includes(\"SWITCH\")) {\n        msg.payload.device_type = \"PowerSense - Energy Device\";\n    }\n\n    if (device_name.includes(\"TEMP\")) {\n        msg.payload.device_type = \"PowerSense - Temperature Sensor\";\n    }\n\n    if (device_name.includes(\"DOOR\")) {\n        msg.payload.device_type = \"PowerSense - Door Sensor\";\n    }\n\n    if (device_name.includes(\"DR502\")) {\n        msg.payload.device_type = \"KC-LINK - Stand Alone\";\n    }\n\n    flexiot_devices.push(device_name);\n    global.set(\"flexiot_devices\", flexiot_devices);\n} \n\nreturn msg;\n\n// PZEM-004T — Single-phase energy monitor\n// JSY-MK-354 — 3-phase energy meter\n// NGSC-430 — Kobelindo compressor controller\n// TUF-2000 — Ultrasonic flow / power meter\n// XY-MD02",
+      "outputs": 1,
+      "timeout": 0,
+      "noerr": 0,
+      "initialize": "",
+      "finalize": "",
+      "libs": [],
+      "x": 830,
+      "y": 560,
+      "wires": [
+          [
+              "0c9017a47fbd43e3"
+          ]
+      ]
+  },
+  {
+      "id": "ea599d3aca06a643",
+      "type": "mqtt out",
+      "z": "8d3bffe93912093b",
+      "name": "Out",
+      "topic": "",
+      "qos": "",
+      "retain": "",
+      "respTopic": "",
+      "contentType": "",
+      "userProps": "",
+      "correl": "",
+      "expiry": "",
+      "broker": "${Server}",
+      "x": 2230,
+      "y": 520,
+      "wires": []
+  },
+  {
+      "id": "a9dd9c6e8b0c3ef8",
+      "type": "junction",
+      "z": "8d3bffe93912093b",
+      "x": 1900,
+      "y": 520,
+      "wires": [
+          [
+              "dc4e55611ccff866",
+              "aef5609072e8f7cf"
+          ]
+      ]
+  }
+]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-thingsboard-gateway",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Node-RED node for sending data to ThingsBoard via Gateway Device using MQTT protocol.",
   "keywords": [
     "node-red",
@@ -15,7 +15,7 @@
   },
   "node-red": {
     "nodes": {
-      "thingsboard-gateway": "nodes/thingsboard-gateway.js"
+      "gateway-out": "nodes/gateway_out.js"
     }
   }
 }

package/nodes/thingsboard-gateway.html

@@ -1,44 +0,0 @@
-<script type="text/javascript">
-RED.nodes.registerType("thingsboard-gateway", {
-    category: "network",
-    color: "#2C3E50",
-    defaults: {
-        name: { value: "" },
-        broker: { value: "mqtt://localhost:1883", required: true },
-        topic: { value: "v1/gateway/telemetry" },
-        username: { value: "" },
-        password: { value: "" }
-    },
-    inputs: 1,
-    outputs: 0,
-    icon: "bridge.svg",
-    label: function () {
-        return this.name || "ThingsBoard Gateway";
-    }
-});
-</script>
-
-<div class="form-row">
-    <label>Name</label>
-    <input type="text" id="node-input-name">
-</div>
-
-<div class="form-row">
-    <label>Broker</label>
-    <input type="text" id="node-input-broker">
-</div>
-
-<div class="form-row">
-    <label>Topic</label>
-    <input type="text" id="node-input-topic">
-</div>
-
-<div class="form-row">
-    <label>Username</label>
-    <input type="text" id="node-input-username">
-</div>
-
-<div class="form-row">
-    <label>Password</label>
-    <input type="password" id="node-input-password">
-</div>

package/nodes/thingsboard-gateway.js

@@ -1,37 +0,0 @@
-module.exports = function (RED) {
-    function ThingsBoardGatewayNode(config) {
-        RED.nodes.createNode(this, config);
-
-        const node = this;
-        const mqtt = require("mqtt");
-
-        const client = mqtt.connect(config.broker, {
-            username: config.username,
-            password: config.password
-        });
-
-        client.on("connect", () => {
-            node.status({ fill: "green", shape: "dot", text: "connected" });
-        });
-
-        client.on("error", (err) => {
-            node.status({ fill: "red", shape: "ring", text: "error" });
-            node.error(err);
-        });
-
-        node.on("input", (msg) => {
-            if (!msg.payload) return;
-
-            const topic = config.topic || "v1/gateway/telemetry";
-            const payload = JSON.stringify(msg.payload);
-
-            client.publish(topic, payload);
-        });
-
-        node.on("close", () => {
-            client.end();
-        });
-    }
-
-    RED.nodes.registerType("thingsboard-gateway", ThingsBoardGatewayNode);
-};