Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1bf4209 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
matthias-bs committed May 16, 2024
1 parent 223de2b commit 87e021b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
30 changes: 15 additions & 15 deletions _weather_sensor_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -466,27 +466,27 @@
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>&#160; </div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_weather_sensor_html"><div class="ttname"><a href="class_weather_sensor.html">WeatherSensor</a></div><div class="ttdoc">Receive, decode and store Bresser Weather Sensor Data Uses CC1101 or SX1276 radio module for receivin...</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:169</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a05fbfc16fb2e13543591cb0b3cd8baaf"><div class="ttname"><a href="class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf">WeatherSensor::getMessage</a></div><div class="ttdeci">DecodeStatus getMessage(void)</div><div class="ttdoc">Tries to receive radio message (non-blocking) and to decode it. Timeout occurs after a multitude of e...</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:312</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a0adf85658be20d05e43e34c6b728b989"><div class="ttname"><a href="class_weather_sensor.html#a0adf85658be20d05e43e34c6b728b989">WeatherSensor::findId</a></div><div class="ttdeci">int findId(uint32_t id)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:556</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a2cb2e1d7ffb2aa6b641563772c72be20"><div class="ttname"><a href="class_weather_sensor.html#a2cb2e1d7ffb2aa6b641563772c72be20">WeatherSensor::radioReset</a></div><div class="ttdeci">void radioReset(void)</div><div class="ttdoc">Reset radio transceiver.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:228</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a05fbfc16fb2e13543591cb0b3cd8baaf"><div class="ttname"><a href="class_weather_sensor.html#a05fbfc16fb2e13543591cb0b3cd8baaf">WeatherSensor::getMessage</a></div><div class="ttdeci">DecodeStatus getMessage(void)</div><div class="ttdoc">Tries to receive radio message (non-blocking) and to decode it. Timeout occurs after a multitude of e...</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:316</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a0adf85658be20d05e43e34c6b728b989"><div class="ttname"><a href="class_weather_sensor.html#a0adf85658be20d05e43e34c6b728b989">WeatherSensor::findId</a></div><div class="ttdeci">int findId(uint32_t id)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:426</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a2cb2e1d7ffb2aa6b641563772c72be20"><div class="ttname"><a href="class_weather_sensor.html#a2cb2e1d7ffb2aa6b641563772c72be20">WeatherSensor::radioReset</a></div><div class="ttdeci">void radioReset(void)</div><div class="ttdoc">Reset radio transceiver.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:232</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a3d8e81b016a72815676e93441642a8a8"><div class="ttname"><a href="class_weather_sensor.html#a3d8e81b016a72815676e93441642a8a8">WeatherSensor::rxFlags</a></div><div class="ttdeci">uint8_t rxFlags</div><div class="ttdoc">receive flags (see getData())</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:330</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a50b72bc1883935f2ede454f57c12625e"><div class="ttname"><a href="class_weather_sensor.html#a50b72bc1883935f2ede454f57c12625e">WeatherSensor::rssi</a></div><div class="ttdeci">float rssi</div><div class="ttdoc">received signal strength indicator in dBm</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:329</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a522c70d5d83fe975ad85ff5994ae7a72"><div class="ttname"><a href="class_weather_sensor.html#a522c70d5d83fe975ad85ff5994ae7a72">WeatherSensor::getSensorsCfg</a></div><div class="ttdeci">void getSensorsCfg(uint8_t &amp;max_sensors, uint8_t &amp;rx_flags, uint8_t &amp;en_decoders)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:709</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a558191760f9d9b9bf12f79f6f3e5370a"><div class="ttname"><a href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">WeatherSensor::getData</a></div><div class="ttdeci">bool getData(uint32_t timeout, uint8_t flags=0, uint8_t type=0, void(*func)()=NULL)</div><div class="ttdoc">Wait for reception of data or occurrance of timeout. With BRESSER_6_IN_1, data is distributed across ...</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:238</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a62203c24af7924cc8e86bdff40fb9281"><div class="ttname"><a href="class_weather_sensor.html#a62203c24af7924cc8e86bdff40fb9281">WeatherSensor::setSensorsCfg</a></div><div class="ttdeci">void setSensorsCfg(uint8_t max_sensors, uint8_t rx_flags, uint8_t en_decoders=0xFF)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:693</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a522c70d5d83fe975ad85ff5994ae7a72"><div class="ttname"><a href="class_weather_sensor.html#a522c70d5d83fe975ad85ff5994ae7a72">WeatherSensor::getSensorsCfg</a></div><div class="ttdeci">void getSensorsCfg(uint8_t &amp;max_sensors, uint8_t &amp;rx_flags, uint8_t &amp;en_decoders)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:179</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a558191760f9d9b9bf12f79f6f3e5370a"><div class="ttname"><a href="class_weather_sensor.html#a558191760f9d9b9bf12f79f6f3e5370a">WeatherSensor::getData</a></div><div class="ttdeci">bool getData(uint32_t timeout, uint8_t flags=0, uint8_t type=0, void(*func)()=NULL)</div><div class="ttdoc">Wait for reception of data or occurrance of timeout. With BRESSER_6_IN_1, data is distributed across ...</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:242</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a62203c24af7924cc8e86bdff40fb9281"><div class="ttname"><a href="class_weather_sensor.html#a62203c24af7924cc8e86bdff40fb9281">WeatherSensor::setSensorsCfg</a></div><div class="ttdeci">void setSensorsCfg(uint8_t max_sensors, uint8_t rx_flags, uint8_t en_decoders=0xFF)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:163</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a652b68eb82bf73157e591094bb8f4f42"><div class="ttname"><a href="class_weather_sensor.html#a652b68eb82bf73157e591094bb8f4f42">WeatherSensor::enDecoders</a></div><div class="ttdeci">uint8_t enDecoders</div><div class="ttdoc">enabled Decoders</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:331</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a7f48011241803c5d42d45f2c3e5d3794"><div class="ttname"><a href="class_weather_sensor.html#a7f48011241803c5d42d45f2c3e5d3794">WeatherSensor::sleep</a></div><div class="ttdeci">void sleep(void)</div><div class="ttdoc">Set transceiver into sleep mode.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:233</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a9b84d8518edf33a2f796288bb482eb8b"><div class="ttname"><a href="class_weather_sensor.html#a9b84d8518edf33a2f796288bb482eb8b">WeatherSensor::begin</a></div><div class="ttdeci">int16_t begin(void)</div><div class="ttdoc">Presence check and initialization of radio module.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:131</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:569</div></div>
<div class="ttc" id="aclass_weather_sensor_html_ac6f489c26a476d658c2ce5161ea48441"><div class="ttname"><a href="class_weather_sensor.html#ac6f489c26a476d658c2ce5161ea48441">WeatherSensor::getSensorsInc</a></div><div class="ttdeci">uint8_t getSensorsInc(uint8_t *payload)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:646</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:418</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a7f48011241803c5d42d45f2c3e5d3794"><div class="ttname"><a href="class_weather_sensor.html#a7f48011241803c5d42d45f2c3e5d3794">WeatherSensor::sleep</a></div><div class="ttdeci">void sleep(void)</div><div class="ttdoc">Set transceiver into sleep mode.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:237</div></div>
<div class="ttc" id="aclass_weather_sensor_html_a9b84d8518edf33a2f796288bb482eb8b"><div class="ttname"><a href="class_weather_sensor.html#a9b84d8518edf33a2f796288bb482eb8b">WeatherSensor::begin</a></div><div class="ttdeci">int16_t begin(void)</div><div class="ttdoc">Presence check and initialization of radio module.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:135</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:439</div></div>
<div class="ttc" id="aclass_weather_sensor_html_ac6f489c26a476d658c2ce5161ea48441"><div class="ttname"><a href="class_weather_sensor.html#ac6f489c26a476d658c2ce5161ea48441">WeatherSensor::getSensorsInc</a></div><div class="ttdeci">uint8_t getSensorsInc(uint8_t *payload)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:116</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:368</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:327</div></div>
<div class="ttc" id="aclass_weather_sensor_html_ae732ec52236b0a6232e95df8f73934ee"><div class="ttname"><a href="class_weather_sensor.html#ae732ec52236b0a6232e95df8f73934ee">WeatherSensor::sensor</a></div><div class="ttdeci">std::vector&lt; sensor_t &gt; sensor</div><div class="ttdoc">sensor data array</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:328</div></div>
<div class="ttc" id="aclass_weather_sensor_html_aecf60e2ae2e51eff69fdd20b00f3f487"><div class="ttname"><a href="class_weather_sensor.html#aecf60e2ae2e51eff69fdd20b00f3f487">WeatherSensor::setSensorsInc</a></div><div class="ttdeci">void setSensorsInc(uint8_t *bytes, uint8_t size)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:623</div></div>
<div class="ttc" id="aclass_weather_sensor_html_af6ffcbf06bb5aea95203fbb3a53aaf3d"><div class="ttname"><a href="class_weather_sensor.html#af6ffcbf06bb5aea95203fbb3a53aaf3d">WeatherSensor::getSensorsExc</a></div><div class="ttdeci">uint8_t getSensorsExc(uint8_t *payload)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:681</div></div>
<div class="ttc" id="aclass_weather_sensor_html_aecf60e2ae2e51eff69fdd20b00f3f487"><div class="ttname"><a href="class_weather_sensor.html#aecf60e2ae2e51eff69fdd20b00f3f487">WeatherSensor::setSensorsInc</a></div><div class="ttdeci">void setSensorsInc(uint8_t *bytes, uint8_t size)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:93</div></div>
<div class="ttc" id="aclass_weather_sensor_html_af6ffcbf06bb5aea95203fbb3a53aaf3d"><div class="ttname"><a href="class_weather_sensor.html#af6ffcbf06bb5aea95203fbb3a53aaf3d">WeatherSensor::getSensorsExc</a></div><div class="ttdeci">uint8_t getSensorsExc(uint8_t *payload)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:151</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:349</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:359</div></div>
<div class="ttc" id="aclass_weather_sensor_html_affeca257b06518b29519756a9e85a006"><div class="ttname"><a href="class_weather_sensor.html#affeca257b06518b29519756a9e85a006">WeatherSensor::setSensorsExc</a></div><div class="ttdeci">void setSensorsExc(uint8_t *bytes, uint8_t size)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.cpp:658</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> WeatherSensorDecoders.cpp:139</div></div>
<div class="ttc" id="aclass_weather_sensor_html_affeca257b06518b29519756a9e85a006"><div class="ttname"><a href="class_weather_sensor.html#affeca257b06518b29519756a9e85a006">WeatherSensor::setSensorsExc</a></div><div class="ttdeci">void setSensorsExc(uint8_t *bytes, uint8_t size)</div><div class="ttdef"><b>Definition:</b> WeatherSensorConfig.cpp:128</div></div>
<div class="ttc" id="astruct_sensor_map_html"><div class="ttname"><a href="struct_sensor_map.html">SensorMap</a></div><div class="ttdoc">Mapping of sensor IDs to names.</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:156</div></div>
<div class="ttc" id="astruct_sensor_map_html_a67056237cfe5029dfebc682216edc524"><div class="ttname"><a href="struct_sensor_map.html#a67056237cfe5029dfebc682216edc524">SensorMap::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">Name of sensor (e.g. for MQTT topic)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:158</div></div>
<div class="ttc" id="astruct_sensor_map_html_aed559727b1c275362724332e45b08993"><div class="ttname"><a href="struct_sensor_map.html#aed559727b1c275362724332e45b08993">SensorMap::id</a></div><div class="ttdeci">uint32_t id</div><div class="ttdoc">ID if sensor (as transmitted in radio message)</div><div class="ttdef"><b>Definition:</b> WeatherSensor.h:157</div></div>
Expand Down
2 changes: 2 additions & 0 deletions class_weather_sensor.html
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aecf60e2ae2e51eff69fdd20b
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="_weather_sensor_8h_source.html">WeatherSensor.h</a></li>
<li>src/WeatherSensor.cpp</li>
<li>src/WeatherSensorConfig.cpp</li>
<li>src/WeatherSensorDecoders.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
Expand Down

0 comments on commit 87e021b

Please sign in to comment.