npm - @mschaeffler/node-red-bthome - Versions diffs - 1.4.3 → 1.6.0 - Mend

@mschaeffler/node-red-bthome 1.4.3 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -12,6 +12,9 @@ At the moment these sensors are implemented and tested:
 - Shelly BLU RC Button 4
 - Shelly BLU Wall Switch 4
 - Shelly BLU Motion
+- Shelly BLU Distance
+- Shelly BLU Remote
+- Ecowitt WS90
 ## Capture of Raw Frames
@@ -29,14 +32,18 @@ This node can decrypt [encrypted messages](https://bthome.io/encryption/), if th
 $ npm install @mschaeffler/node-red-bthome
 ```
-## Input
+## bthome Node
+This node decodes the raw frames.
+### Input
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
 |payload | object | data from Shelly script|
 |resync  | boolean| if set to yes, allow all packed ids; to resync after some issue|
-### msg.payload
+#### msg.payload
 Only the first two values are needed, the others are optional.
@@ -59,27 +66,27 @@ This is an example of such a message payload:
 }
 ```
-## Outputs
+### Outputs
 There are two output ports:
 1. one for meassurement values (states)
 2. one for actions done with the devices (events)
-### State
+#### State
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
 |topic   | string | `State-Prefix` + name of the device|
 |payload | object | decoded state data|
-### Events
+#### Events
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
 |topic   | string | `Event-Prefix` + name of the device|
 |payload | object | data of the decoded event|
-## Parameters
+### Parameters
 |config       | type   | description                       |
 |:------------|:-------|:----------------------------------|
@@ -90,7 +97,7 @@ There are two output ports:
 |Context-Variable| string | name of the variable in flow context storage |
 |Contextstore | string | context store to be used |
-### Device-Configuration
+#### Device-Configuration
 With this JSON string the installed [BT-Home](https://bthome.io) devices are configured:
 ```
@@ -109,7 +116,7 @@ An example for such a config from the unit tests:
 }
 ```
-### Context storage
+#### Context storage
 All recorded data can be stored in a flow context variable for
 - initialisation
@@ -136,10 +143,73 @@ If content storage is active, statistical data is also stored in a variable with
 { ok:0, err:0, old:0, dup:0 }
 ```
+## ws90 Node
+This node does some additional calculations to get more usefull data from the WS90 weather station.
+Similar calculations are done by the Ecowitt base stations.
+### Input
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|payload |object  |data from `bthome` node.           |
+This is an example of such a message payload:
+```
+{
+    "lux":           3630,
+    "moisture":      false,
+    "wind":          [1.5,1.5],
+    "uv":            0,
+    "direction":     174,
+    "pressure":      948.2,
+    "dewpoint":      -0.43,
+    "humidity":      99,
+    "temperature":   -0.3,
+    "precipitation": 121.5
+}
+```
+### Outputs
+There are 12 output ports:
+- temperature
+- dew point
+- humidity
+- raining²
+- rain yesterday
+- rain today
+- uv²
+- air pressure
+- direction
+- wind²
+- wind max
+- illumination
+²: this values have style classes for the `dashboard 2` attached.
+#### style classes
+This classes should be defined (for an example check the `ui-template` in the
+[examples](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-bthome/examples/CSS.json)):
+- greenValue
+- yellowValue
+- redValue
+- blueValue
+### Parameters
+|config       | type   | description                       |
+|:------------|:-------|:----------------------------------|
+|Contextstore | string | context store to be used. |
+|reference height|number| height of the installation over the sea level, to caculate the absolute air pressure. |
 ## Example Flow
 [example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-bthome/examples/bthome.json)
+[CSS template](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-bthome/examples/CSS.json)
 ## Author
 [Mathias Schäffler](https://github.com/m-schaeffler)

package/bthome.js CHANGED Viewed

@@ -189,7 +189,7 @@ module.exports = function(RED) {
                             setData( "lux", rawdata.getUInt24() / 100 );
                             break;
                         case 0x08:
-                            setData( "dewpoint", rawdata.getInt16() /100 );
+                            setData( "dewpoint", rawdata.getInt16() / 100 );
                             break;
                         case 0x0C:
                             if( node.batteryState )
@@ -203,6 +203,9 @@ module.exports = function(RED) {
                                 delete item.data?.voltage;
                             }
                             break;
+                        case 0x1E:
+                            setData( "light", rawdata.getUInt8() );
+                            break;
                         case 0x20:
                             setData( "moisture", Boolean( rawdata.getUInt8() ) );
                             break;

package/examples/CSS.json ADDED Viewed

@@ -0,0 +1,54 @@
+[
+    {
+        "id": "fb58dd887406a7d3",
+        "type": "ui-template",
+        "z": "bf934c281a6f35c0",
+        "group": "",
+        "page": "",
+        "ui": "fd06eabec55c4e5d",
+        "name": "CSS classes 2.0",
+        "order": 0,
+        "width": 0,
+        "height": 0,
+        "head": "",
+        "format": ".red label.nrdb-ui-text-label, .red span, .redValue span.nrdb-ui-text-value, span.red {\n  color: red !important;\n}\n.green label.nrdb-ui-text-label, .green span, .greenValue span.nrdb-ui-text-value, span.green {\n  color: LimeGreen !important;\n}\n.darkgreen label.nrdb-ui-text-label, .darkgreen span, span.darkgreen {\n  color: green !important;\n}\n.blue label.nrdb-ui-text-label, .blue span, .blueValue span.nrdb-ui-text-value, span.blue {\n  color: aqua !important;\n}\n.yellow label.nrdb-ui-text-label, .yellow span, .yellowValue span.nrdb-ui-text-value, span.yellow {\n  color: yellow !important;\n}\n.gray label.nrdb-ui-text-label, .gray span, .grayValue span.nrdb-ui-text-value, span.gray {\n  color: gray !important;\n}\n.silver label.nrdb-ui-text-label, .silver span, .silverValue span.nrdb-ui-text-value, span.silver {\n  color: #b0b0b0 !important;\n}",
+        "storeOutMessages": true,
+        "passthru": false,
+        "resendOnRefresh": true,
+        "templateScope": "site:style",
+        "className": "",
+        "x": 440,
+        "y": 640,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "fd06eabec55c4e5d",
+        "type": "ui-base",
+        "name": "Dashboard 2.0",
+        "path": "/dashboard",
+        "appIcon": "",
+        "includeClientData": false,
+        "acceptsClientConfig": [
+            "ui-notification",
+            "ui-control"
+        ],
+        "showPathInSidebar": false,
+        "headerContent": "page",
+        "navigationStyle": "default",
+        "titleBarStyle": "fixed",
+        "showReconnectNotification": false,
+        "notificationDisplayTime": "5",
+        "showDisconnectNotification": false,
+        "allowInstall": true
+    },
+    {
+        "id": "7d327676499cd8a2",
+        "type": "global-config",
+        "env": [],
+        "modules": {
+            "@flowfuse/node-red-dashboard": "1.29.0"
+        }
+    }
+]

package/examples/bthome.json CHANGED Viewed

@@ -1,8 +1,8 @@
 [
     {
-        "id": "3a9fcdbd98993dbc",
+        "id": "da2333b077f13c53",
         "type": "mqtt in",
-        "z": "8e0e9a167c607864",
+        "z": "1607080a6a66359a",
         "name": "",
         "topic": "node-red/bleraw",
         "qos": "0",
@@ -12,39 +12,42 @@
         "rap": true,
         "rh": 0,
         "inputs": 0,
-        "x": 140,
-        "y": 1460,
+        "x": 260,
+        "y": 560,
         "wires": [
             [
-                "c4df490573c18fc4"
+                "da23792a27f30483"
             ]
         ]
     },
     {
-        "id": "c4df490573c18fc4",
+        "id": "da23792a27f30483",
         "type": "bthome",
-        "z": "8e0e9a167c607864",
+        "z": "1607080a6a66359a",
         "name": "",
         "devices": "{\"11:22:33:44:55:66\":{\"topic\":\"dev_unencrypted_1\"},\"00:01:02:03:04:05\":{\"topic\":\"dev_unencrypted_2\"},\"00:10:20:30:40:50\":{\"topic\":\"dev_encrypted_1\",\"key\":\"00112233445566778899AABBCCDDEEFF\"},\"00:00:00:00:00:00\":{\"topic\":\"dev_encrypted_2\",\"key\":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]}}",
+        "counterMode": "none",
         "statusPrefix": "Status",
         "eventPrefix": "Event",
         "contextVar": "bt-home",
         "contextStore": "memoryOnly",
-        "x": 340,
-        "y": 1440,
+        "batteryState": false,
+        "x": 460,
+        "y": 540,
         "wires": [
             [
-                "3c9fee837ed43fc0"
+                "45cc12931b5a0b52",
+                "02887e37eebfaae5"
             ],
             [
-                "26ebe1833f97c4d4"
+                "347a2db3d0351824"
             ]
         ]
     },
     {
-        "id": "3c9fee837ed43fc0",
+        "id": "45cc12931b5a0b52",
         "type": "debug",
-        "z": "8e0e9a167c607864",
+        "z": "1607080a6a66359a",
         "name": "debug 9",
         "active": true,
         "tosidebar": true,
@@ -53,14 +56,14 @@
         "complete": "false",
         "statusVal": "",
         "statusType": "auto",
-        "x": 520,
-        "y": 1420,
+        "x": 640,
+        "y": 520,
         "wires": []
     },
     {
-        "id": "26ebe1833f97c4d4",
+        "id": "347a2db3d0351824",
         "type": "debug",
-        "z": "8e0e9a167c607864",
+        "z": "1607080a6a66359a",
         "name": "debug 10",
         "active": true,
         "tosidebar": true,
@@ -69,14 +72,14 @@
         "complete": "false",
         "statusVal": "",
         "statusType": "auto",
-        "x": 520,
-        "y": 1460,
+        "x": 640,
+        "y": 560,
         "wires": []
     },
     {
-        "id": "e3ad83be53fa3fe3",
+        "id": "5ba4c641b627284d",
         "type": "inject",
-        "z": "8e0e9a167c607864",
+        "z": "1607080a6a66359a",
         "name": "",
         "props": [
             {
@@ -94,14 +97,63 @@
         "topic": "",
         "payload": "{\"addr\":\"11:22:33:44:55:66\",\"rssi\":-85,\"time\":1745395033113,\"gateway\":\"Shelly Gateway\",\"data\":[68,0,164,1,100,46,56,69,43,255]}",
         "payloadType": "json",
-        "x": 170,
-        "y": 1420,
+        "x": 290,
+        "y": 520,
         "wires": [
             [
-                "c4df490573c18fc4"
+                "da23792a27f30483"
             ]
         ]
     },
+    {
+        "id": "02887e37eebfaae5",
+        "type": "switch",
+        "z": "1607080a6a66359a",
+        "name": "is WS90",
+        "property": "payload",
+        "propertyType": "msg",
+        "rules": [
+            {
+                "t": "hask",
+                "v": "dewpoint",
+                "vt": "str"
+            }
+        ],
+        "checkall": "false",
+        "repair": false,
+        "outputs": 1,
+        "x": 480,
+        "y": 360,
+        "wires": [
+            [
+                "57b7cd4b7d2e6f25"
+            ]
+        ]
+    },
+    {
+        "id": "57b7cd4b7d2e6f25",
+        "type": "ws90",
+        "z": "1607080a6a66359a",
+        "name": "",
+        "contextStore": "memoryOnly",
+        "refheight": "500",
+        "x": 630,
+        "y": 360,
+        "wires": [
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            [],
+            []
+        ]
+    },
     {
         "id": "66b8b47e.0f87bc",
         "type": "mqtt-broker",
@@ -133,5 +185,13 @@
         "willMsg": {},
         "userProps": "",
         "sessionExpiry": ""
+    },
+    {
+        "id": "888386dbbbc56d84",
+        "type": "global-config",
+        "env": [],
+        "modules": {
+            "@mschaeffler/node-red-bthome": "1.6.0"
+        }
     }
 ]

package/examples/bthome.png CHANGED Viewed

Binary file

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@mschaeffler/node-red-bthome",
-    "version": "1.4.3",
+    "version": "1.6.0",
     "description": "A Node Red node to decrypt and decode BT-Home frames",
     "author": {
         "name": "Mathias Schäffler",
@@ -12,7 +12,8 @@
         "BT-Home",
         "bthome",
         "Shelly BLU",
-        "BLE"
+        "BLE",
+        "WS90"
     ],
     "bugs": {
         "url": "https://github.com/m-schaeffler/node-red-my-nodes/tree/main/node-red-bthome/issues"
@@ -25,7 +26,8 @@
     "node-red": {
         "version": ">=4.0.0",
         "nodes": {
-            "bthome": "bthome.js"
+            "bthome": "bthome.js",
+            "ws90": "ws90.js"
         }
     },
     "engines": {

package/ws90.html ADDED Viewed

@@ -0,0 +1,115 @@
+<script type="text/javascript">
+    RED.nodes.registerType('ws90',{
+        category: 'input',
+        color: '#DEB887',
+        defaults: {
+            name: {value:""},
+            contextStore:{value:"none",required:true},
+            refheight:{value:0,validate:RED.validators.number(),required:true}
+        },
+        inputs:1,
+        outputs:12,
+        icon: "font-awesome/fa-sun-o",
+        label: function() {
+            return this.name||"WS 90";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        },
+        paletteLabel: "ws 90",
+        inputLabels: 'decoded bthome frame from ws90',
+        outputLabels: ['temperature','dew point','humidity','raining','rain yesterday','rain today','uv','air pressure','direction','wind','wind max','illumination'],
+        oneditprepare: function() {
+            const node = this;
+            // populate store names
+            $("#node-input-contextStore").empty();
+            $("#node-input-contextStore").append(`<option value="none">None</option>`);
+            const defaultStore = RED.settings.hasOwnProperty('context') ? RED.settings.context.default : '';
+            RED.settings.context.stores.forEach(function(item){
+                if( item ) {
+                   const opt = $(`<option value="${item}">${item}${item===defaultStore?" (default)":""}</option>`);
+                   $("#node-input-contextStore").append(opt);
+                }
+            });
+            const currentStore = node.contextStore || '';
+            // select the current option
+            $("#node-input-contextStore").val(currentStore);
+        }
+    });
+</script>
+<script type="text/x-red" data-template-name="ws90">
+    <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-contextStore"><i class="fa fa-database"></i> Contextstore</label>
+        <select type="text" id="node-input-contextStore"></select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-refheight"><i class="fa fa-"></i> reference height</label>
+        <input type="text" id="node-input-refheight">
+    </div>
+</script>
+<script type="text/x-red" data-help-name="ws90">
+    <p>A Node Red node to work with data from the WS90 weather station.</p>
+    <h3>Input</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">object</span></dt>
+        <dd> data from <code>bthome</code> node.</dd>
+    </dl>
+    <p>This is an example of such a message payload:</p>
+    <code>{<br>
+    "lux":           3630,<br>
+    "moisture":      false,<br>
+    "wind":          [1.5,1.5],<br>
+    "uv":            0,<br>
+    "direction":     174,<br>
+    "pressure":      948.2,<br>
+    "dewpoint":      -0.43,<br>
+    "humidity":      99,<br>
+    "temperature":   -0.3,<br>
+    "precipitation": 121.5<br>
+}</code>
+    <h3>Outputs</h3>
+    <p>There are 12 output ports:</p>
+    <ol>
+      <li>temperature</li>
+      <li>dew point</li>
+      <li>humidity</li>
+      <li>raining²</li>
+      <li>rain yesterday</li>
+      <li>rain today</li>
+      <li>uv²</li>
+      <li>air pressure</li>
+      <li>direction</li>
+      <li>wind²</li>
+      <li>wind max</li>
+      <li>illumination</li>
+    </ol>
+    <p>²: this values have style classes for the <code>dashboard 2</code> attached.</p>
+    <h4>style classes</h4>
+    <p>This classes should be defined (for an example check the <code>ui-template</code> in the <a href="https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-bthome/examples/CSS.json">examples</a>):<p>
+    <ul>
+      <li>greenValue</li>
+      <li>yellowValue</li>
+      <li>redValue</li>
+      <li>blueValue</li>
+    </ul>
+    <h3>Parameters</h3>
+    <dl class="message-properties">
+        <dt>Contextstore <span class="property-type">string</span></dt>
+        <dd> context store to be used.</dd>
+        <dt>reference height <span class="property-type">number</span></dt>
+        <dd> height of the installation over the sea level, to caculate the absolute air pressure.</dt>
+    </dl>
+</script>

package/ws90.js ADDED Viewed

@@ -0,0 +1,154 @@
+module.exports = function(RED) {
+    function Ws90Node(config) {
+        RED.nodes.createNode(this,config);
+        var node    = this;
+        var context = this.context();
+        this.contextStore = config.contextStore ?? "none";
+        this.refheight    = Number( config.refheight ?? 0 );
+        this.timebase     = Number( config.timebase ?? 60 ) * 1000;
+        this.last         = {};
+        this.storage      = {Raining:false,RegenHeute:0,RegenGestern:0,WindMax:0};
+        node.status( "" );
+        if( node.contextStore !== "none" )
+        {
+            context.get( "storage", node.contextStore, function(err,value)
+            {
+                if( err )
+                {
+                    node.error( err );
+                }
+                else
+                {
+                    //console.log( "context read", value );
+                    if( value !== undefined )
+                    {
+                        node.storage = value;
+                    }
+                }
+            } );
+        }
+        function ampel(value,v1,v2,s1="")
+        {
+            return value <= v1 ? s1 : ( value <= v2 ? "yellowValue" : "redValue" );
+        }
+        function setStorage(topic,value)
+        {
+            node.storage[topic] = value;
+            if( node.contextStore !== "none" )
+            {
+                context.set( "storage", node.storage, node.contextStore );
+            }
+        }
+        function genMessage(name,value,style=null)
+        {
+            if( node.last[name]?.value !== value || node.last[name]?.style !== style )
+            {
+                node.last[name] = { value:value, style:style };
+                let result = { topic: name, payload: value };
+                if( style !== null )
+                {
+                    result.ui_update = { class: style };
+                }
+                return result;
+            }
+            else
+            {
+                return null;
+            }
+        }
+        node.on('input', function(msg,send,done) {
+            if( msg.invalid )
+            {
+            }
+            else if( msg.reset || msg.topic==="init" )
+            {
+                node.last = {};
+            }
+            else if( msg.newday || msg.topic==="newday" )
+            {
+                setStorage( "RegenGestern", node.storage.RegenHeute );
+                setStorage( "RegenHeute",   0                       );
+                setStorage( "WindMax",      0                       );
+            }
+            else if( typeof msg.payload !== "object" || msg.payload.temperature === undefined )
+            {
+                node.error( "invalid payload "+msg.payload );
+            }
+            else
+            {
+                const now = Date.now();
+                // Luftdruck https://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel
+                //const E = temperature >= 9.1 ? 18.219 * ( 1.0463 - Math.exp( -0.0666 * temperature ) ) : 5.6402 * ( Math.exp( 0.06 * temperature ) - 0.0916 );
+                const p_H2O = ( 6.112 * Math.exp((17.62 * msg.payload.temperature) / ( msg.payload.temperature + 243.12)) * msg.payload.humidity) / 100; // Partialdruck Wasserdampf https://www.schweizer-fn.de/lueftung/feuchte/feuchte.php
+                const h = node.refheight; // Ortshöhe
+                const normdruck = msg.payload.pressure * Math.exp( 9.80665 / ( 287.05 * ( 273.15 + msg.payload.temperature + 0.12 * p_H2O + 0.0065 * h / 2 ) ) * h );
+                // Regen
+                let raining = node.storage.Raining;
+                function setRaining(value,timeout)
+                {
+                    raining = value;
+                    setStorage( "rainingDate", value ? now + timeout*node.timebase : 8640000000000000 );
+                    if( node.storage.Raining !== value )
+                    {
+                        setStorage( "Raining", value );
+                    }
+                }
+                if( msg.payload.moisture && ! node.storage.moisture )
+                {
+                    setRaining( true, 15 );
+                }
+                else if( now >= node.storage.rainingDate )
+                {
+                    setRaining( false, 0 );
+                }
+                setStorage( "moisture", msg.payload.moisture );
+                // Regenmenge
+                if( msg.payload.precipitation > node.storage.Regen )
+                {
+                    setStorage( "RegenHeute", node.storage.RegenHeute + msg.payload.precipitation - node.storage.Regen );
+                    setRaining( true, 20 );
+                }
+                else if( msg.payload.precipitation < node.storage.Regen && msg.payload.precipitation <= 10 )
+                {
+                    setStorage( "RegenHeute", node.storage.RegenHeute + msg.payload.precipitation );
+                    setRaining( true, 20 );
+                }
+                setStorage( "Regen", msg.payload.precipitation );
+                // Wind
+                const wind = msg.payload.wind[1] * 3.6;
+                if( wind > node.storage.WindMax )
+                {
+                    setStorage( "WindMax", wind );
+                }
+                node.status( Math.round( normdruck ) );
+                send( [
+                    genMessage( "outside temperature", msg.payload.temperature ),
+                    genMessage( "dew point",           msg.payload.dewpoint ),
+                    genMessage( "humidity",            msg.payload.humidity ),
+                    genMessage( "raining",             raining ),
+                    genMessage( "rain yesterday",      node.storage.RegenGestern ),
+                    genMessage( "rain today",          node.storage.RegenHeute, msg.payload.moisture ? "blueValue" : "" ),
+                    genMessage( "uv index",            msg.payload.uv, ampel( msg.payload.uv, 2, 5, "greenValue" ) ),
+                    genMessage( "air pressure",        normdruck ),
+                    genMessage( "wind direction",      msg.payload.direction ),
+                    genMessage( "wind",                wind, ampel( wind, 25, 50 ) ),
+                    genMessage( "wind_max",            node.storage.WindMax ),
+                    genMessage( "illumination",        msg.payload.lux )
+                ] );
+            }
+            done();
+        });
+    }
+    RED.nodes.registerType( "ws90", Ws90Node );
+}