@mschaeffler/node-red-bthome 1.6.0 → 1.6.1

package/README.md

@@ -14,7 +14,7 @@ At the moment these sensors are implemented and tested:
 - Shelly BLU Motion
 - Shelly BLU Distance
 - Shelly BLU Remote
-- Ecowitt WS90
+- Ecowitt WS90 powered by Shelly
 
 ## Capture of Raw Frames
 
@@ -145,7 +145,9 @@ If content storage is active, statistical data is also stored in a variable with
 
 ## ws90 Node
 
-This node does some additional calculations to get more usefull data from the WS90 weather station.
+This node does additional calulations with the data from an "*Ecowitt WS90 powered by Shelly*" weather station.
+
+Normally this data is decoded by the `bthome` node.
 
 Similar calculations are done by the Ecowitt base stations.
 
@@ -154,6 +156,8 @@ Similar calculations are done by the Ecowitt base stations.
 |msg.    | type   | description                       |
 |:-------|:-------|:----------------------------------|
 |payload |object  |data from `bthome` node.           |
+|reset   |boolean |if set to `true`, the output filter is reset and unchanged values will been sent with the next raw data.|
+|newday  |boolean |if set to `true`, a new day is started (rain today, rain yesterday and wind max).|
 
 This is an example of such a message payload:
 ```
@@ -174,22 +178,28 @@ This is an example of such a message payload:
 ### 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.
+
+values are only sent out, if they are changed
+
+| topic | explanation |
+|:------|:------------|
+|temperature|no calculation, value directly from the input data|
+|dew point|no calculation, value directly from the input data|
+|humidity|no calculation, value directly from the input data|
+|raining|Is it raining at the moment?<br>It is set to `true`, if `moisture==true` or a delta in `precipitation` is received.<br>It is set to `false` after a timeout of 15min or 20min without any of the above events.<br>If `true` the class is set to `blueValue`.|
+|rain yesterday|rain from yesterday, at `newday==true` it is taken from `rain today`|
+|rain today|accumulated rain today, so since the last `newday==true` received|
+|uv|no calculation, value directly from the input data<br>between 0 and 2 the class is set to `greenValue`, up to 5 to `yellowValue` and above to `redValue`|
+|air pressure|can be either the measured air pressure (QFE) without any further calculation<br>or the air pressure at sea level (QFF) [for the calculation](https://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel)|
+|direction|no calculation, value directly from the input data|
+|wind|no calculation, value directly from the input data<br>between 0 and 25 the class is set to default, up to 50 to `yellowValue` and above to `redValue`|
+|wind max|maximal wind speed today, so since the last `newday==true` received|
+|illumination|no calculation, value directly from the input data|
 
 #### style classes
+
+Some values have style classes for the `dashboard 2` attached.
+
 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
@@ -202,7 +212,7 @@ This classes should be defined (for an example check the `ui-template` in the
 |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. |
+|reference height|number| height of the installation over the sea level, to caculate the relative air pressure (QFF).<br>If set to `0` no caclulation is done and the absolute air pressure (QFE) is outputed.|
 
 ## Example Flow
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mschaeffler/node-red-bthome",
-    "version": "1.6.0",
+    "version": "1.6.1",
     "description": "A Node Red node to decrypt and decode BT-Home frames",
     "author": {
         "name": "Mathias Schäffler",

package/ws90.html

@@ -48,19 +48,24 @@
         <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>
+        <label for="node-input-refheight"><i class="fa fa-level-up"></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>
+    <p>A Node Red node to perform additional calulations with the data from an &ldquo;<em>Ecowitt WS90 powered by Shelly</em>&rdquo; weather station.</p>
+    <p>Normally this data is decoded by the <code>bthome</code> node.
 
     <h3>Input</h3>
     <dl class="message-properties">
         <dt>payload <span class="property-type">object</span></dt>
-        <dd> data from <code>bthome</code> node.</dd>
+        <dd> raw data from <code>bthome</code> node.</dd>
+        <dt>reset <span class="property-type">boolean</span></dt>
+        <dd> if set to <code>true</code>, the output filter is reset and unchanged values will been sent with the next raw data.</dd>
+        <dt>newday <span class="property-type">boolean</span></dt>
+        <dd> if set to <code>true</code>, a new day is started (rain today, rain yesterday and wind max).</dd>
     </dl>
 
     <p>This is an example of such a message payload:</p>
@@ -78,24 +83,42 @@
 }</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>
+    <p>There are 12 output ports</p>
+    <p>values are only sent out, if they are changed</p>
+    <dl>
+      <dt>temperature</dt>
+      <dd>no calculation, value directly from the input data</dd>
+      <dt>dew point</dt>
+      <dd>no calculation, value directly from the input data</dd>
+      <dt>humidity</dt>
+      <dd>no calculation, value directly from the input data</dd>
+      <dt>raining</dt>
+      <dd>Is it raining at the moment?<br>
+          It is set to <code>true</code>, if <code>moisture==true</code> or a delta in <code>precipitation</code> is received.<br>
+          It is set to <code>false</code> after a timeout of 15min or 20min without any of the above events.<br>
+          If <code>true</code> the class is set to <code>blueValue</code>.</dd>
+      <dt>rain yesterday</dt>
+      <dd>rain from yesterday, at <code>newday==true</code> it is taken from <code>rain today</code></dd>
+      <dt>rain today</dt>
+      <dd>accumulated rain today, so since the last <code>newday==true</code> received</dd>
+      <dt>uv</dt>
+      <dd>no calculation, directly from the input data<br>
+          between 0 and 2 the class is set to <code>greenValue</code>, up to 5 to <code>yellowValue</code> and above to <code>redValue</code></dd>
+      <dt>air pressure</dt>
+      <dd>can be either the measured air pressure (QFE) without any further calculation<br>or the air pressure at sea level (QFF) (<a htref="https://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel">for the calculation</a>)</dd>
+      <dt>direction</dt>
+      <dd>no calculation, value directly from the input data</dd>
+      <dt>wind</dt>
+      <dd>no calculation, value directly from the input data<br>
+          between 0 and 25 the class is set to default, up to 50 to <code>yellowValue</code> and above to <code>redValue</code></dd>
+      <dt>wind max</dt>
+      <dd>maximal wind speed today, so since the last <code>newday==true</code> received</dd>
+      <dt>illumination</dt>
+      <dd>no calculation, directly from the input data</dd>
+    </dl>
 
     <h4>style classes</h4>
+    <p>Some values have style classes for the <code>dashboard 2</code> attached.<p>
     <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>
@@ -109,7 +132,8 @@
         <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>
+        <dd> height of the installation over the sea level, to caculate the relative air pressure (QFF). 
+             If set to <code>0</code> no caclulation is done and the absolute air pressure (QFE) is outputed.</dt>
     </dl>
     
 </script>

package/ws90.js

@@ -84,10 +84,14 @@ module.exports = function(RED) {
                 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 );
+                let luftdruck = msg.payload.pressure;
+                if( node.refheight != 0 )
+                {
+                    //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
+                    luftdruck *= 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;
@@ -130,7 +134,7 @@ module.exports = function(RED) {
                     setStorage( "WindMax", wind );
                 }
 
-                node.status( Math.round( normdruck ) );
+                node.status( Math.round( luftdruck ) );
                 send( [
                     genMessage( "outside temperature", msg.payload.temperature ),
                     genMessage( "dew point",           msg.payload.dewpoint ),
@@ -139,7 +143,7 @@ module.exports = function(RED) {
                     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( "air pressure",        luftdruck ),
                     genMessage( "wind direction",      msg.payload.direction ),
                     genMessage( "wind",                wind, ampel( wind, 25, 50 ) ),
                     genMessage( "wind_max",            node.storage.WindMax ),