Deploying to gh-pages from @ a72c7db 🚀

matthias-bs · Nov 23, 2023 · 69d4ecf · 69d4ecf
1 parent f674b44
commit 69d4ecf
Show file tree

Hide file tree

Showing 54 changed files with 186 additions and 143 deletions.
diff --git a/_weather_sensor_8h_source.html b/_weather_sensor_8h_source.html
@@ -305,10 +305,10 @@
 <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160; </div>
 <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;        <span class="keyword">typedef</span> <span class="keyword">struct </span>Sensor <a class="code" href="class_weather_sensor.html#ae38bcb7791c9c49d5f23c150d4517dc4">sensor_t</a>;    </div>
 <div class="line"><a name="l00274"></a><span class="lineno"><a class="line" href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">  274</a></span>&#160;        <a class="code" href="struct_weather_sensor_1_1_sensor.html">sensor_t</a> <a class="code" href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">sensor</a>[NUM_SENSORS];      </div>
-<div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">  275</a></span>&#160;        <span class="keywordtype">float</span>    <a class="code" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a> = 0                  </div>
+<div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">  275</a></span>&#160;        <span class="keywordtype">float</span>    <a class="code" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a> = 0.0;               </div>
 <div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160; </div>
 <div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160; </div>
-<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;        <span class="keywordtype">bool</span>    genMessage(<span class="keywordtype">int</span> i, uint32_t <span class="keywordtype">id</span> = 0xff, uint8_t s_type = 1, uint8_t channel = 0, uint8_t startup = 0);</div>
+<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;        <span class="keywordtype">bool</span>    <a class="code" href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">genMessage</a>(<span class="keywordtype">int</span> i, uint32_t <span class="keywordtype">id</span> = 0xff, uint8_t s_type = 1, uint8_t channel = 0, uint8_t startup = 0);</div>
 <div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160; </div>
 <div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160; </div>
 <div class="line"><a name="l00294"></a><span class="lineno"><a class="line" href="class_weather_sensor.html#af7d1085b72f2f41e8b349e63d2628b0c">  294</a></span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_weather_sensor.html#af7d1085b72f2f41e8b349e63d2628b0c">clearSlots</a>(uint8_t type = 0xFF)</div>
@@ -402,6 +402,7 @@
 <div class="ttc" id="aclass_weather_sensor_html_aa72d395844ee645e779a3b005fbd5dfd"><div class="ttname"><a href="class_weather_sensor.html#aa72d395844ee645e779a3b005fbd5dfd">WeatherSensor::WeatherSensor</a></div><div class="ttdeci">WeatherSensor()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:152</div></div>
 <div class="ttc" id="aclass_weather_sensor_html_ac0d3ac40d2ac605badcbb8e1631d64fa"><div class="ttname"><a href="class_weather_sensor.html#ac0d3ac40d2ac605badcbb8e1631d64fa">WeatherSensor::findType</a></div><div class="ttdeci">int findType(uint8_t type, uint8_t channel=0xFF)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:455</div></div>
 <div class="ttc" id="aclass_weather_sensor_html_ac3edc5eaae93e8289f0267d56fa0a44a"><div class="ttname"><a href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">WeatherSensor::sensor</a></div><div class="ttdeci">sensor_t sensor[NUM_SENSORS]</div><div class="ttdoc">sensor data array</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:274</div></div>
+<div class="ttc" id="aclass_weather_sensor_html_adffc6603766560fe6aa0cdd1200fc2a0"><div class="ttname"><a href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">WeatherSensor::genMessage</a></div><div class="ttdeci">bool genMessage(int i, uint32_t id=0xff, uint8_t s_type=1, uint8_t channel=0, uint8_t startup=0)</div><div class="ttdoc">Generates data otherwise received and decoded from a radio message.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:313</div></div>
 <div class="ttc" id="aclass_weather_sensor_html_ae38bcb7791c9c49d5f23c150d4517dc4"><div class="ttname"><a href="class_weather_sensor.html#ae38bcb7791c9c49d5f23c150d4517dc4">WeatherSensor::sensor_t</a></div><div class="ttdeci">struct Sensor sensor_t</div><div class="ttdoc">Shortcut for struct Sensor.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:273</div></div>
 <div class="ttc" id="aclass_weather_sensor_html_af7d1085b72f2f41e8b349e63d2628b0c"><div class="ttname"><a href="class_weather_sensor.html#af7d1085b72f2f41e8b349e63d2628b0c">WeatherSensor::clearSlots</a></div><div class="ttdeci">void clearSlots(uint8_t type=0xFF)</div><div class="ttdoc">Clear sensor data.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:294</div></div>
 <div class="ttc" id="aclass_weather_sensor_html_af964b214e398132f25d4e783dffe708a"><div class="ttname"><a href="class_weather_sensor.html#af964b214e398132f25d4e783dffe708a">WeatherSensor::decodeMessage</a></div><div class="ttdeci">DecodeStatus decodeMessage(const uint8_t *msg, uint8_t msgSize)</div><div class="ttdoc">Decode message Tries the available decoders until a decoding was successful.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:269</div></div>

diff --git a/class_weather_sensor-members.html b/class_weather_sensor-members.html
@@ -94,13 +94,14 @@
   <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#af964b214e398132f25d4e783dffe708a">decodeMessage</a>(const uint8_t *msg, uint8_t msgSize)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_weather_sensor.html#a0adf85658be20d05e43e34c6b728b989">findId</a>(uint32_t id)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#ac0d3ac40d2ac605badcbb8e1631d64fa">findType</a>(uint8_t type, uint8_t channel=0xFF)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">getData</a>(uint32_t timeout, uint8_t flags=0, uint8_t type=0, void(*func)()=NULL)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf">getMessage</a>(void)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#a3fe7bfad520c8834c5f85f7b0ed9eaad">is_decode3in1</a>(uint32_t id)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a></td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">sensor</a></td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#ae38bcb7791c9c49d5f23c150d4517dc4">sensor_t</a> typedef</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#aa72d395844ee645e779a3b005fbd5dfd">WeatherSensor</a>()</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">genMessage</a>(int i, uint32_t id=0xff, uint8_t s_type=1, uint8_t channel=0, uint8_t startup=0)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">getData</a>(uint32_t timeout, uint8_t flags=0, uint8_t type=0, void(*func)()=NULL)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf">getMessage</a>(void)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#a3fe7bfad520c8834c5f85f7b0ed9eaad">is_decode3in1</a>(uint32_t id)</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a></td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">sensor</a></td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_weather_sensor.html#ae38bcb7791c9c49d5f23c150d4517dc4">sensor_t</a> typedef</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_weather_sensor.html#aa72d395844ee645e779a3b005fbd5dfd">WeatherSensor</a>()</td><td class="entry"><a class="el" href="class_weather_sensor.html">WeatherSensor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/class_weather_sensor.html b/class_weather_sensor.html
@@ -139,6 +139,9 @@
 <tr class="memitem:af964b214e398132f25d4e783dffe708a"><td class="memItemLeft" align="right" valign="top">DecodeStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#af964b214e398132f25d4e783dffe708a">decodeMessage</a> (const uint8_t *msg, uint8_t msgSize)</td></tr>
 <tr class="memdesc:af964b214e398132f25d4e783dffe708a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode message Tries the available decoders until a decoding was successful.  <a href="class_weather_sensor.html#af964b214e398132f25d4e783dffe708a">More...</a><br /></td></tr>
 <tr class="separator:af964b214e398132f25d4e783dffe708a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adffc6603766560fe6aa0cdd1200fc2a0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">genMessage</a> (int i, uint32_t id=0xff, uint8_t s_type=1, uint8_t channel=0, uint8_t startup=0)</td></tr>
+<tr class="memdesc:adffc6603766560fe6aa0cdd1200fc2a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates data otherwise received and decoded from a radio message.  <a href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">More...</a><br /></td></tr>
+<tr class="separator:adffc6603766560fe6aa0cdd1200fc2a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af7d1085b72f2f41e8b349e63d2628b0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#af7d1085b72f2f41e8b349e63d2628b0c">clearSlots</a> (uint8_t type=0xFF)</td></tr>
 <tr class="memdesc:af7d1085b72f2f41e8b349e63d2628b0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear sensor data.  <a href="class_weather_sensor.html#af7d1085b72f2f41e8b349e63d2628b0c">More...</a><br /></td></tr>
 <tr class="separator:af7d1085b72f2f41e8b349e63d2628b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -155,8 +158,9 @@
 <a class="el" href="class_weather_sensor.html#ae38bcb7791c9c49d5f23c150d4517dc4">sensor_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#ac3edc5eaae93e8289f0267d56fa0a44a">sensor</a> [NUM_SENSORS]</td></tr>
 <tr class="memdesc:ac3edc5eaae93e8289f0267d56fa0a44a"><td class="mdescLeft">&#160;</td><td class="mdescRight">sensor data array <br /></td></tr>
 <tr class="separator:ac3edc5eaae93e8289f0267d56fa0a44a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a50b72bc1883935f2ede454f57c12625e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a></td></tr>
-<tr class="memdesc:a50b72bc1883935f2ede454f57c12625e"><td class="mdescLeft">&#160;</td><td class="mdescRight">received signal strength indicator in dBm  <a href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">More...</a><br /></td></tr>
+<tr class="memitem:a50b72bc1883935f2ede454f57c12625e"><td class="memItemLeft" align="right" valign="top"><a id="a50b72bc1883935f2ede454f57c12625e"></a>
+float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">rssi</a> = 0.0</td></tr>
+<tr class="memdesc:a50b72bc1883935f2ede454f57c12625e"><td class="mdescLeft">&#160;</td><td class="mdescRight">received signal strength indicator in dBm <br /></td></tr>
 <tr class="separator:a50b72bc1883935f2ede454f57c12625e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -310,6 +314,55 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac0d3ac40d2ac605badcbb8e1
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>slot (or -1 if not found) </dd></dl>
 
+</div>
+</div>
+<a id="adffc6603766560fe6aa0cdd1200fc2a0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adffc6603766560fe6aa0cdd1200fc2a0">&#9670;&nbsp;</a></span>genMessage()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool WeatherSensor::genMessage </td>
+          <td>(</td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>i</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint32_t&#160;</td>
+          <td class="paramname"><em>id</em> = <code>0xff</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint8_t&#160;</td>
+          <td class="paramname"><em>s_type</em> = <code>1</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint8_t&#160;</td>
+          <td class="paramname"><em>channel</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint8_t&#160;</td>
+          <td class="paramname"><em>startup</em> = <code>0</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Generates data otherwise received and decoded from a radio message. </p>
+<dl class="section return"><dt>Returns</dt><dd>Always true (for compatibility with <a class="el" href="class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf" title="Tries to receive radio message (non-blocking) and to decode it. Timeout occurs after a multitude of e...">getMessage()</a>) </dd></dl>
+
 </div>
 </div>
 <a id="a558191760f9d9b9bf12f79f6f3e5370a"></a>
@@ -409,28 +462,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3fe7bfad520c8834c5f85f7b
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>true if sensor is in sensor_ids_decode3in1[], false otherwise </dd></dl>
 
-</div>
-</div>
-<h2 class="groupheader">Member Data Documentation</h2>
-<a id="a50b72bc1883935f2ede454f57c12625e"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a50b72bc1883935f2ede454f57c12625e">&#9670;&nbsp;</a></span>rssi</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">float WeatherSensor::rssi</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<b>Initial value:</b><div class="fragment"><div class="line">= 0</div>
-<div class="line"> </div>
-<div class="line"> </div>
-<div class="line">        </div>
-<div class="line">        <span class="keywordtype">bool</span>    genMessage(<span class="keywordtype">int</span> i, uint32_t <span class="keywordtype">id</span> = 0xff, uint8_t s_type = 1, uint8_t channel = 0, uint8_t startup = 0)</div>
-</div><!-- fragment -->
-<p>received signal strength indicator in dBm </p>
-
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following files:<ul>

diff --git a/class_weather_sensor.js b/class_weather_sensor.js
@@ -13,6 +13,7 @@ var class_weather_sensor =
     [ "decodeMessage", "class_weather_sensor.html#af964b214e398132f25d4e783dffe708a", null ],
     [ "findId", "class_weather_sensor.html#a0adf85658be20d05e43e34c6b728b989", null ],
     [ "findType", "class_weather_sensor.html#ac0d3ac40d2ac605badcbb8e1631d64fa", null ],
+    [ "genMessage", "class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0", null ],
     [ "getData", "class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a", null ],
     [ "getMessage", "class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf", null ],
     [ "is_decode3in1", "class_weather_sensor.html#a3fe7bfad520c8834c5f85f7b0ed9eaad", null ],

diff --git a/functions.html b/functions.html
@@ -144,6 +144,9 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 
 
 <h3><a id="index_g"></a>- g -</h3><ul>
+<li>genMessage()
+: <a class="el" href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">WeatherSensor</a>
+</li>
 <li>getData()
 : <a class="el" href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">WeatherSensor</a>
 </li>

diff --git a/functions_func.html b/functions_func.html
@@ -107,6 +107,9 @@
 <li>findType()
 : <a class="el" href="class_weather_sensor.html#ac0d3ac40d2ac605badcbb8e1631d64fa">WeatherSensor</a>
 </li>
+<li>genMessage()
+: <a class="el" href="class_weather_sensor.html#adffc6603766560fe6aa0cdd1200fc2a0">WeatherSensor</a>
+</li>
 <li>getData()
 : <a class="el" href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">WeatherSensor</a>
 </li>