node-red-contrib-ruuvi-gateway 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dirk-Jan Faber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# Ruuvi gateway node
+
+![Example flow](./documentation/images/flow.png)
+
+The node uses the [poll mode](https://docs.ruuvi.com/gw-examples/polling-mode) to retrieve
+the values from the [Ruuvi Gateway](https://ruuvi.com/gateway/) and gets triggered when receiving input.
+
+### Inputs
+
+- `payload (string|number|json)` : the trigger to poll the Ruuvi gateway
+
+The `msg.topic` is filled with the MAC address of the queried gateway.
+
+### Outputs
+
+- `payload (json)` : the answer from the Ruuvi gateway
+
+A typical answer contains a few top level fields:
+
+- `timestamp` : the timestamp of the retrieval
+- `tags` : an object, containing all of the tags that are within reach of the gateway
+- `gw_mac` : the MAC address of the queried gateway 
+
+The `tags` contain an object for each found Ruuvi sensor, identified by its id. Typical fields that reside within this object are:
+- `rssi` : the signal strenght
+- `timestamp` : timestamp of the last received sensor reading
+- `data` : raw field containing the data of the sensor
+- `dataFormat` : identifier for the data format
+- `temperature` : the temperature in degrees Celsius
+- `humidity` : the humidity in percentage
+- `pressure` : if available, the pressure. Seems to return `null` 
+- `axelX` ,`axelY` and `axelZ` - movement information
+- `movementCounter` - how often the sensor was moved
+- `voltage` - the battery voltage
+- `txPower` - the transmit txPower
+- `measurementSequenceNumber` - a sequence number
+- `id` - the identification id for the sensor
+
+### Configuration
+
+- `name (string)` : the name for the node
+- `gateway (ruuvi config)` : the configured Ruuvi gateway
+- `store in global context (boolean)` : whether or not to store the answer in the global context
+- `verbose (boolean)` : show the used curl command in the debug tab
+
+Configure the gateway to enable [poll mode](https://docs.ruuvi.com/gw-examples/polling-mode).
+Then copy and paste the token into the configuration of a new Ruuvi gateway.
+
+Also fill out the hostname or ip address for the Ruuvi gateway. The easiest way is to
+enter `ruuvigatewayXXXX.local`, where the `XXXX` match the code, which is printed on the
+backside of the Ruuvi gateway.

package/examples/fetch-ruuvi-gateway-data.json

@@ -0,0 +1,69 @@
+[
+    {
+        "id": "276894333a56665b",
+        "type": "Ruuvi gateway",
+        "z": "985f6c11457dd04d",
+        "name": "",
+        "gateway": "bd209778320ddac5",
+        "x": 560,
+        "y": 360,
+        "wires": [
+            [
+                "91b67e458fe5c91f"
+            ]
+        ]
+    },
+    {
+        "id": "1b9c74cd503b2870",
+        "type": "inject",
+        "z": "985f6c11457dd04d",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 370,
+        "y": 360,
+        "wires": [
+            [
+                "276894333a56665b"
+            ]
+        ]
+    },
+    {
+        "id": "91b67e458fe5c91f",
+        "type": "debug",
+        "z": "985f6c11457dd04d",
+        "name": "Ruuvi debug",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 780,
+        "y": 360,
+        "wires": []
+    },
+    {
+        "id": "bd209778320ddac5",
+        "type": "config-ruuvi-gateway",
+        "name": "",
+        "host": "ruuvigatewayXXXX.local",
+        "token": ""
+    }
+]

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "node-red-contrib-ruuvi-gateway",
+  "version": "0.0.1",
+  "description": "Poll a Ruuvi gateway",
+  "main": "ruuvi-gateway.js",
+  "scripts": {
+    "test": "standard --fix"
+  },
+  "keywords": [
+    "node-red",
+    "ruuvi",
+    "gateway",
+    "victron"
+  ],
+  "author": "Dirk-Jan Faber <dfaber@victronenergy.com>",
+  "license": "MIT",
+  "node-red": {
+    "nodes": {
+      "config-ruuvi-gateway": "./src/nodes/config-ruuvi-gateway.js",
+      "ruuvi-gateway": "./src/nodes/ruuvi-gateway.js"
+    },
+    "version": ">=3.0.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dirkjanfaber/node-red-contrib-ruuvi-gateway"
+  },
+  "dependencies": {
+    "axios": "^1.4.0",
+    "axios-curlirize": "^1.3.7"
+  },
+  "devDependencies": {
+    "standard": "^17.1.0"
+  },
+  "engines": {
+    "node": ">=14.17.4"
+  }
+}

package/src/nodes/config-ruuvi-gateway.html

@@ -0,0 +1,33 @@
+<script type="text/javascript">
+    RED.nodes.registerType('config-ruuvi-gateway',{
+        category: 'config',
+        defaults: {
+            name: { value: "" },
+            host: { value: "", required: true },
+            token: { value: ""},
+        },
+        label: function() {
+            return ( this.name || 'Ruuvi gateway config')
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="config-ruuvi-gateway">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-host"><i class="fa fa-laptop"></i> Host / IP</label>
+        <input type="text" id="node-config-input-host" placeholder="Host / IP">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-token"><i class="fa fa-user-secret"></i> Token</label>
+        <input type="password" id="node-config-input-token" placeholder="password">
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="config-ruuvi-gateway">
+
+todo
+</script>

package/src/nodes/config-ruuvi-gateway.js

@@ -0,0 +1,10 @@
+module.exports = function (RED) {
+  'use strict'
+  function ConfigRuuviGateway (n) {
+    RED.nodes.createNode(this, n)
+    this.name = n.name
+    this.host = n.host
+    this.token = n.token
+  }
+  RED.nodes.registerType('config-ruuvi-gateway', ConfigRuuviGateway)
+}

package/src/nodes/icons/ruuvi-gateway.svg

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Generator: Adobe Illustrator 25.2.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+
+<svg
+   version="1.1"
+   id="Layer_1"
+   x="0px"
+   y="0px"
+   viewBox="0 0 721 475.1"
+   style="enable-background:new 0 0 721 475.1;"
+   xml:space="preserve"
+   sodipodi:docname="ruuvi-gateway.svg"
+   inkscape:version="1.3.2 (091e20e, 2023-11-25)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><defs
+   id="defs9" /><sodipodi:namedview
+   id="namedview9"
+   pagecolor="#ffffff"
+   bordercolor="#000000"
+   borderopacity="0.25"
+   inkscape:showpageshadow="2"
+   inkscape:pageopacity="0.0"
+   inkscape:pagecheckerboard="0"
+   inkscape:deskcolor="#d1d1d1"
+   inkscape:zoom="0.70249294"
+   inkscape:cx="360.85772"
+   inkscape:cy="237.01306"
+   inkscape:window-width="1512"
+   inkscape:window-height="916"
+   inkscape:window-x="0"
+   inkscape:window-y="38"
+   inkscape:window-maximized="0"
+   inkscape:current-layer="Layer_1" />
+<style
+   type="text/css"
+   id="style1">
+	.st0{opacity:0.5;}
+	.st1{fill:#7FD8CE;}
+	.st2{opacity:0.5;fill:#7FD8CE;enable-background:new    ;}
+</style>
+
+
+<rect
+   x="719.8"
+   y="53.3"
+   class="st2"
+   width="1.2"
+   height="27"
+   id="rect9" />
+<path
+   style="fill:#000000;stroke-width:1.42666"
+   d="m 112.36346,359.17815 c -4.55269,-3.72046 -5.19769,-7.77136 -3.84635,-24.15719 2.51586,-30.5065 19.6705,-49.25399 48.43783,-52.93537 16.95484,-2.16974 108.71717,-5.82619 146.21378,-5.82619 h 33.48678 v -10.90606 -10.90605 h 4.89891 c 3.96578,0 4.89891,-0.55396 4.89891,-2.90828 0,-2.87683 -0.93313,-2.90829 -86.26164,-2.90829 h -86.26162 l 0.95985,-8.81402 c 3.13282,-28.76771 16.44931,-58.55789 37.89317,-84.77038 12.00382,-14.67322 37.27248,-34.21977 56.01953,-43.33387 4.98629,-2.42413 9.06597,-4.99037 9.06597,-5.70275 0,-0.71238 -1.97101,-4.62315 -4.38002,-8.690615 -3.10932,-5.249866 -3.9458,-7.846489 -2.88331,-8.950318 1.06249,-1.103829 2.63776,0.440738 5.42978,5.323989 7.09808,12.414484 5.84238,11.761154 15.95094,8.299064 43.22952,-14.805695 93.41911,-14.652248 134.07564,0.40993 3.36856,1.24797 6.55055,2.26903 7.07111,2.26903 0.52054,0 3.0963,-3.85162 5.72392,-8.559152 2.91839,-5.228448 5.48275,-8.277986 6.58985,-7.836621 1.32961,0.530063 0.69016,2.760202 -2.40069,8.37262 -2.31718,4.207543 -4.21305,8.298563 -4.21305,9.091133 0,0.79258 4.05884,3.51694 9.01962,6.05413 26.23476,13.41778 54.19871,38.36677 69.43587,61.94957 12.51326,19.36698 21.16432,43.48475 24.38488,67.9811 l 0.90811,6.90716 h -86.16662 c -85.23345,0 -86.16659,0.0315 -86.16659,2.90829 0,2.35432 0.93314,2.90828 4.89891,2.90828 h 4.89891 v 10.68098 10.681 l 54.23792,0.90216 c 55.43415,0.92205 100.62301,2.88212 122.49579,5.31326 28.42386,3.15927 45.94443,20.24713 50.25535,49.01417 2.16474,14.4455 0.96855,23.54178 -3.63705,27.65747 l -3.75704,3.35738 H 357.76153 c -238.84237,0 -241.92346,-0.0361 -245.39807,-2.87556 z m 234.08986,-124.0387 v -9.12885 l -30.86695,-54.48982 c -16.97682,-29.9694 -31.78575,-55.95056 -32.90872,-57.73592 l -2.0418,-3.2461 -8.03215,3.68822 c -26.88686,12.34598 -53.88504,36.3254 -71.63571,63.6259 -9.92685,15.26745 -19.30561,40.93675 -21.74248,59.50825 l -0.90632,6.90717 h 84.06706 84.06707 z m 190.61812,4.03935 c -2.00754,-19.93407 -12.35205,-47.06233 -25.45367,-66.75182 -8.8775,-13.34134 -29.58393,-34.29385 -42.75083,-43.2589 -13.17158,-8.96822 -32.93337,-19.18934 -34.21826,-17.69825 -0.56811,0.65929 -15.29066,26.49495 -32.7168,57.41259 l -31.68386,56.21389 v 9.59743 9.59744 l 83.63138,-0.37497 83.63138,-0.37498 z M 351.73872,213.02798 c 0.43539,-0.38534 -58.09012,-104.08801 -59.7431,-105.86013 -1.50204,-1.61033 -5.72891,0.34105 -5.72891,2.64481 0,1.48187 46.59981,85.13342 56.91775,102.17332 1.51912,2.50881 2.79211,3.09933 5.09635,2.36409 1.68928,-0.539 3.24534,-1.13395 3.45791,-1.32209 z m 49.14912,-50.05725 c 16.25073,-28.7181 29.54678,-52.85323 29.54678,-53.63361 0,-2.16149 -5.32143,-3.13721 -6.78691,-1.24441 -1.72866,2.23274 -57.63418,101.13427 -58.51391,103.51597 -0.58602,1.58657 0.98365,2.59388 5.31081,3.40812 0.49307,0.0928 14.19252,-23.32796 30.44323,-52.04607 z m -11.49413,-2.90868 c 16.41386,-29.02301 29.84341,-53.37529 29.84341,-54.11619 0,-2.01747 -5.28126,-3.73616 -21.2605,-6.918876 -20.48562,-4.080282 -41.03931,-5.183921 -59.22159,-3.179926 -19.24704,2.121358 -39.84192,6.998502 -40.82818,9.668682 -0.878,2.377 58.42576,108.25199 60.3238,107.69609 0.71482,-0.20936 14.7292,-24.12675 31.14306,-53.14978 z"
+   id="path1" /></svg>

package/src/nodes/ruuvi-gateway.html

@@ -0,0 +1,86 @@
+<script type="text/javascript">
+
+    RED.nodes.registerType('Ruuvi gateway',{
+        category: 'network',
+        color: '#d4efeb',
+        defaults: {
+            name: {value:""},
+            gateway: {value:"", type: "config-ruuvi-gateway"},
+            store_in_global_context: {value: false},
+            verbose: {value: false}
+        },
+        icon: "ruuvi-gateway.svg",
+        inputs:1,
+        outputs:1,
+        label: function() {
+            return (this.name||"Ruuvi gateway")
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="Ruuvi gateway">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-gateway"><i class="fa fa-dot-circle-o"></i> Gateway</label>
+        <input type="text" id="node-input-gateway" placeholder="Gateway">
+    </div>
+    <div class="form-row" style="margin-bottom:0px;">
+        <input type="checkbox" id="node-input-store_in_global_context" style="display:inline-block; margin-left:8px; width:auto; vertical-align:top;">
+        <label style="min-width:390px" for="node-input-store_in_global_context"> Store the response in the global context?</label>
+    </div>
+    <div class="form-row" style="margin-bottom:0px;">
+        <input type="checkbox" id="node-input-verbose" style="display:inline-block; margin-left:8px; width:auto; vertical-align:top;">
+        <label style="min-width:390px" for="node-input-verbose"> Verbose: show the used <em>url</em> in the debug tab?</label>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="Ruuvi gateway">
+
+Interface with the [Ruuvi gateway](https://ruuvi.com/gateway/).
+
+### Inputs
+
+: payload (string|number|json) : the trigger to poll the Ruuvi gateway
+
+### Outputs
+
+: payload (json) : the answer from the Ruuvi gateway
+
+A typical answer contains a few top level fields:
+
+- `timestamp` : the timestamp of the retrieval
+- `tags` : an object, containing all of the tags that are within reach of the gateway
+- `gw_mac` : the MAC address of the queried gateway 
+
+The `tags` contain an object for each found Ruuvi sensor, identified by its id. Typical fields that reside within this object are:
+- `rssi` : the signal strenght
+- `timestamp` : timestamp of the last received sensor reading
+- `data` : raw field containing the data of the sensor
+- `dataFormat` : identifier for the data format
+- `temperature` : the temperature in degrees Celsius
+- `humidity` : the humidity in percentage
+- `pressure` : if available, the pressure. Seems to return `null` 
+- `axelX` ,`axelY` and `axelZ` - movement information
+- `movementCounter` - how often the sensor was moved
+- `voltage` - the battery voltage
+- `txPower` - the transmit txPower
+- `measurementSequenceNumber` - a sequence number
+- `id` - the identification id for the sensor
+
+### Configuration
+
+: name (string) : the name for the node
+: gateway (ruuvi config) : the configured Ruuvi gateway
+: store in global context (boolean) : whether or not to store the answer in the global context
+: verbose (boolean) : show the used curl command in the debug tab
+
+Configure the gateway to enable [poll mode](https://docs.ruuvi.com/gw-examples/polling-mode).
+Then copy and paste the token into the configuration of a new Ruuvi gateway.
+
+Also fill out the hostname or ip address for the Ruuvi gateway. The easiest way is to
+enter `ruuvigatewayXXXX.local`, where the `XXXX` match the code, which is printed on the
+backside of the Ruuvi gateway.
+</script>

package/src/nodes/ruuvi-gateway.js

@@ -0,0 +1,48 @@
+const axios = require('axios')
+const curlirize = require('axios-curlirize')
+const path = require('path')
+const packageJson = require(path.join(__dirname, '../../', 'package.json'))
+
+module.exports = function (RED) {
+  function RuuviGatewayNode (config) {
+    RED.nodes.createNode(this, config)
+    this.gateway = RED.nodes.getNode(config.gateway)
+    const node = this
+
+    node.on('input', function (msg) {
+      const url = msg.url || `http://${node.gateway.host}/history`
+      const headers = {
+        'User-Agent': 'node-red-contrib-ruuvi-gateway/' + packageJson.version,
+        Authorization: `Bearer ${node.gateway.token}`
+      }
+
+      axios.get(url, { headers }).then(function (response) {
+        msg.payload = response.data.data
+        if (config.store_in_global_context === true) {
+          const globalContext = node.context().global
+          globalContext.set('ruuvi.' + response.data.data.gw_mac, response.data.data)
+        }
+        msg.topic = response.data.data.gw_mac
+        node.status({ fill: 'green', shape: 'ring', text: 'Ok' })
+        node.send(msg)
+      }).catch(function (error) {
+        if (error.response && error.message) {
+          node.status({ fill: 'red', shape: 'dot', text: error.message })
+        } else {
+          node.status({ fill: 'red', shape: 'dot', text: 'Error fetching Ruuvi data' })
+        }
+      })
+
+      if (config.verbose === true) {
+        curlirize(axios, (result, err) => {
+          node.warn(result.command)
+        })
+      }
+    })
+
+    node.on('close', function (done) {
+      done()
+    })
+  }
+  RED.nodes.registerType('Ruuvi gateway', RuuviGatewayNode)
+}