Skip to content

Commit

Permalink
Deploying to gh-pages from @ 59e45b6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
matthias-bs committed Oct 30, 2023
1 parent 4d482aa commit 8bd8e7a
Show file tree
Hide file tree
Showing 81 changed files with 1,874 additions and 716 deletions.
572 changes: 301 additions & 271 deletions _weather_sensor_8h_source.html

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,13 @@
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnv_lightning__t.html" target="_self">nvLightning_t</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_rain_gauge.html" target="_self">RainGauge</a></td><td class="desc">Calculation of hourly (past 60 minutes), daily, weekly and monthly rainfall </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_sensor_map.html" target="_self">SensorMap</a></td><td class="desc">Mapping of sensor IDs to names </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_weather_sensor.html" target="_self">WeatherSensor</a></td><td class="desc">Receive, decode and store Bresser Weather <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz </td></tr>
<tr id="row_5_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_sensor.html" target="_self">Sensor</a></td><td class="desc"><a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> data and status flags </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_weather_sensor.html" target="_self">WeatherSensor</a></td><td class="desc">Receive, decode and store Bresser <a class="el" href="struct_weather_sensor_1_1_weather.html">Weather</a> <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz </td></tr>
<tr id="row_5_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_air_p_m.html" target="_self">AirPM</a></td><td class="desc"></td></tr>
<tr id="row_5_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_leakage.html" target="_self">Leakage</a></td><td class="desc"></td></tr>
<tr id="row_5_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_lightning.html" target="_self">Lightning</a></td><td class="desc"></td></tr>
<tr id="row_5_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_sensor.html" target="_self">Sensor</a></td><td class="desc"><a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> data and status flags </td></tr>
<tr id="row_5_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_soil.html" target="_self">Soil</a></td><td class="desc"></td></tr>
<tr id="row_5_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_weather_sensor_1_1_weather.html" target="_self">Weather</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
3 changes: 1 addition & 2 deletions class_weather_sensor-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,13 @@
<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#a643dd64dab119203c14883e712d76aea">genMessage</a>(int i, uint32_t id=0xff, uint8_t type=1, uint8_t channel=0)</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#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 -->
Expand Down
43 changes: 28 additions & 15 deletions class_weather_sensor.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,26 @@
</div><!--header-->
<div class="contents">

<p>Receive, decode and store Bresser Weather <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz.
<p>Receive, decode and store Bresser <a class="el" href="struct_weather_sensor_1_1_weather.html">Weather</a> <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz.
<a href="class_weather_sensor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_weather_sensor_8h_source.html">WeatherSensor.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_air_p_m.html">AirPM</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_leakage.html">Leakage</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_lightning.html">Lightning</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_sensor.html">Sensor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">sensor data and status flags <a href="struct_weather_sensor_1_1_sensor.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_soil.html">Soil</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_weather_sensor_1_1_weather.html">Weather</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
Expand All @@ -113,12 +123,8 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa72d395844ee645e779a3b005fbd5dfd"><td class="memItemLeft" align="right" valign="top"><a id="aa72d395844ee645e779a3b005fbd5dfd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#aa72d395844ee645e779a3b005fbd5dfd">WeatherSensor</a> ()</td></tr>
<tr class="memdesc:aa72d395844ee645e779a3b005fbd5dfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aa72d395844ee645e779a3b005fbd5dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b84d8518edf33a2f796288bb482eb8b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#a9b84d8518edf33a2f796288bb482eb8b">begin</a> (void)</td></tr>
<tr class="memdesc:a9b84d8518edf33a2f796288bb482eb8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Presence check and initialization of radio module. <a href="class_weather_sensor.html#a9b84d8518edf33a2f796288bb482eb8b">More...</a><br /></td></tr>
<tr class="memdesc:a9b84d8518edf33a2f796288bb482eb8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="class_weather_sensor.html#a9b84d8518edf33a2f796288bb482eb8b">More...</a><br /></td></tr>
<tr class="separator:a9b84d8518edf33a2f796288bb482eb8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a558191760f9d9b9bf12f79f6f3e5370a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><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></tr>
<tr class="memdesc:a558191760f9d9b9bf12f79f6f3e5370a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for reception of data or occurrance of timeout. With BRESSER_6_IN_1, data is distributed across two different messages. Reception of entire data is tried if 'complete' is set. <a href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">More...</a><br /></td></tr>
Expand All @@ -129,9 +135,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:a643dd64dab119203c14883e712d76aea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_weather_sensor.html#a643dd64dab119203c14883e712d76aea">genMessage</a> (int i, uint32_t id=0xff, uint8_t type=1, uint8_t channel=0)</td></tr>
<tr class="memdesc:a643dd64dab119203c14883e712d76aea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates data otherwise received and decoded from a radio message. <a href="class_weather_sensor.html#a643dd64dab119203c14883e712d76aea">More...</a><br /></td></tr>
<tr class="separator:a643dd64dab119203c14883e712d76aea"><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>
Expand All @@ -154,7 +160,7 @@
<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>
<div class="textblock"><p>Receive, decode and store Bresser Weather <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz. </p>
<div class="textblock"><p>Receive, decode and store Bresser <a class="el" href="struct_weather_sensor_1_1_weather.html">Weather</a> <a class="el" href="struct_weather_sensor_1_1_sensor.html" title="sensor data and status flags">Sensor</a> Data Uses CC1101 or SX1276 radio module for receiving FSK modulated signal at 868 MHz. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9b84d8518edf33a2f796288bb482eb8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b84d8518edf33a2f796288bb482eb8b">&#9670;&nbsp;</a></span>begin()</h2>
Expand All @@ -172,7 +178,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9b84d8518edf33a2f796288b
</table>
</div><div class="memdoc">

<p>Presence check and initialization of radio module. </p>
<p>Constructor. </p>
<p>Presence check and initialization of radio module.</p>
<dl class="section return"><dt>Returns</dt><dd>RADIOLIB_ERR_NONE on success (otherwise does never return). </dd></dl>

</div>
Expand Down Expand Up @@ -306,8 +313,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac0d3ac40d2ac605badcbb8e1

</div>
</div>
<a id="a643dd64dab119203c14883e712d76aea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a643dd64dab119203c14883e712d76aea">&#9670;&nbsp;</a></span>genMessage()</h2>
<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">
Expand All @@ -328,13 +335,19 @@ <h2 class="memtitle"><span class="permalink"><a href="#a643dd64dab119203c14883e7
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em> = <code>1</code>, </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>channel</em> = <code>0</code>&#160;</td>
<td class="paramname"><em>startup</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
Expand Down
Loading

0 comments on commit 8bd8e7a

Please sign in to comment.