forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ 98c80a9cb9 🚀

Browse source
This commit is contained in:
jgromes 2024-05-19 17:05:36 +00:00
parent 796e3d9117
commit bc18ba1026
6 changed files with 16 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
_s_t_m32_w_lx_8h_source.html
View file

@ -167,23 +167,23 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">Module::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdoc">End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...</div><div class="ttdef"><b>Definition:</b> Module.h:102</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx___module_html"><div class="ttname"><a href="class_s_t_m32_w_lx___module.html">STM32WLx_Module</a></div><div class="ttdef"><b>Definition:</b> STM32WLx_Module.h:26</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html"><div class="ttname"><a href="class_s_t_m32_w_lx.html">STM32WLx</a></div><div class="ttdoc">Derived class for STM32WL modules.</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:33</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a119ad225f9eba91e7c38f82cf0f1c89d"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a119ad225f9eba91e7c38f82cf0f1c89d">STM32WLx::setChannelScanAction</a></div><div class="ttdeci">void setChannelScanAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:147</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a366a83d5f5ed02859717a83c21768378"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a366a83d5f5ed02859717a83c21768378">STM32WLx::clearChannelScanAction</a></div><div class="ttdeci">void clearChannelScanAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:151</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a119ad225f9eba91e7c38f82cf0f1c89d"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a119ad225f9eba91e7c38f82cf0f1c89d">STM32WLx::setChannelScanAction</a></div><div class="ttdeci">void setChannelScanAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:146</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a366a83d5f5ed02859717a83c21768378"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a366a83d5f5ed02859717a83c21768378">STM32WLx::clearChannelScanAction</a></div><div class="ttdeci">void clearChannelScanAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:150</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a4f2a9b5a72b5238d2014199d91094f84"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a4f2a9b5a72b5238d2014199d91094f84">STM32WLx::begin</a></div><div class="ttdeci">int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:13</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a54130403f6afbb0924da17c28afb17fc"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a54130403f6afbb0924da17c28afb17fc">STM32WLx::clearDio1Action</a></div><div class="ttdeci">void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1/2/3 activates.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:127</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a63d61bc5057e9da3d0ea12feae67122e"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a63d61bc5057e9da3d0ea12feae67122e">STM32WLx::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when DIO1/2/3 activates.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:117</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a7c0e3aef03f0b6834d0465d8f8568c32"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a7c0e3aef03f0b6834d0465d8f8568c32">STM32WLx::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:139</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a54130403f6afbb0924da17c28afb17fc"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a54130403f6afbb0924da17c28afb17fc">STM32WLx::clearDio1Action</a></div><div class="ttdeci">void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1/2/3 activates.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:126</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a63d61bc5057e9da3d0ea12feae67122e"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a63d61bc5057e9da3d0ea12feae67122e">STM32WLx::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when DIO1/2/3 activates.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:116</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a7c0e3aef03f0b6834d0465d8f8568c32"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a7c0e3aef03f0b6834d0465d8f8568c32">STM32WLx::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:138</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_a9afbde1c466907598974cc3923784c5b"><div class="ttname"><a href="class_s_t_m32_w_lx.html#a9afbde1c466907598974cc3923784c5b">STM32WLx::setOutputPower</a></div><div class="ttdeci">virtual int16_t setOutputPower(int8_t power) override</div><div class="ttdoc">Sets output power. Allowed values are in range from -17 to 22 dBm.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:41</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_aad377b018cf65ceb6b23cac523ba96b4"><div class="ttname"><a href="class_s_t_m32_w_lx.html#aad377b018cf65ceb6b23cac523ba96b4">STM32WLx::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:135</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_aad377b018cf65ceb6b23cac523ba96b4"><div class="ttname"><a href="class_s_t_m32_w_lx.html#aad377b018cf65ceb6b23cac523ba96b4">STM32WLx::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:134</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac0e8787dbb8e8aaa172b089ace6eaa09"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac0e8787dbb8e8aaa172b089ace6eaa09">STM32WLx::STM32WLx</a></div><div class="ttdeci">STM32WLx(STM32WLx_Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:11</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac11d53d29bf5a845e3797ba6bb875930"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac11d53d29bf5a845e3797ba6bb875930">STM32WLx::clearPacketSentAction</a></div><div class="ttdeci">void clearPacketSentAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:143</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac11d53d29bf5a845e3797ba6bb875930"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac11d53d29bf5a845e3797ba6bb875930">STM32WLx::clearPacketSentAction</a></div><div class="ttdeci">void clearPacketSentAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:142</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787">STM32WLx::OpMode_t</a></div><div class="ttdeci">OpMode_t</div><div class="ttdoc">Custom operation modes for STMWLx.</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:51</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787a0cffe238c4822ab7f8beddf4ec72052b"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787a0cffe238c4822ab7f8beddf4ec72052b">STM32WLx::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:53</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787a20a2eda9aaf3c7cdb4a55955d6ff3544"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787a20a2eda9aaf3c7cdb4a55955d6ff3544">STM32WLx::MODE_TX_LP</a></div><div class="ttdeci">@ MODE_TX_LP</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:59</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787a50df4b8580f1bded3cb61e79f954789e"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787a50df4b8580f1bded3cb61e79f954789e">STM32WLx::MODE_TX_HP</a></div><div class="ttdeci">@ MODE_TX_HP</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:61</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787a85ffabc9f35e2683aefdd785bf912172"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787a85ffabc9f35e2683aefdd785bf912172">STM32WLx::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:57</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ac8d380c3d3201015ad35594826975787a8cf0ccad0eec5fde12798e0b0347d6bf"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ac8d380c3d3201015ad35594826975787a8cf0ccad0eec5fde12798e0b0347d6bf">STM32WLx::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdef"><b>Definition:</b> STM32WLx.h:55</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ad23dafdeb21b97165be74ef8f093866c"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ad23dafdeb21b97165be74ef8f093866c">STM32WLx::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:131</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_ad23dafdeb21b97165be74ef8f093866c"><div class="ttname"><a href="class_s_t_m32_w_lx.html#ad23dafdeb21b97165be74ef8f093866c">STM32WLx::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:130</div></div>
<div class="ttc" id="aclass_s_t_m32_w_lx_html_af12e8eba13c5dd8bcf8656ed5c1f6cef"><div class="ttname"><a href="class_s_t_m32_w_lx.html#af12e8eba13c5dd8bcf8656ed5c1f6cef">STM32WLx::beginFSK</a></div><div class="ttdeci">int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)</div><div class="ttdoc">Initialization method for FSK modem.</div><div class="ttdef"><b>Definition:</b> STM32WLx.cpp:27</div></div>
<div class="ttc" id="aclass_s_x1262_html"><div class="ttname"><a href="class_s_x1262.html">SX1262</a></div><div class="ttdoc">Derived class for SX1262 modules.</div><div class="ttdef"><b>Definition:</b> SX1262.h:22</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2cb5ed645ebcc6f3f17d77e32c2ccdd7"><div class="ttname"><a href="class_s_x126x.html#a2cb5ed645ebcc6f3f17d77e32c2ccdd7">SX126x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1492</div></div>

1
class_s_t_m32_w_lx.html
View file

@ -855,7 +855,6 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
<p>Reimplemented from <a class="el" href="class_s_x1262.html#aa455a7f0e69abdcca55cf35388d9dc52">SX1262</a>.</p>

2
class_s_x1268.html
View file

@ -790,7 +790,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a></dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>integers only (all modules - frequency, data rate, bandwidth etc.) </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>integers only (all modules - frequency, data rate, bandwidth etc.) </dd></dl>
</div>
</div>

2
class_s_x1282.html
View file

@ -430,7 +430,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>implement advanced ranging </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>implement advanced ranging </dd></dl>
</div>
</div>

4
class_s_x128x.html
View file

@ -981,7 +981,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Expected time-on-air in microseconds. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd></dl>
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer</a>.</p>
@ -2081,7 +2081,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>add support for multiple sync words </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>add support for multiple sync words </dd></dl>
</div>
</div>

10
todo.html
View file

@ -97,16 +97,14 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
<dd><a class="anchor" id="_todo000003"></a>use header as address field? </dd>
<dt>Member <a class="el" href="class_si443x.html#a5a86a2032c4b876c1c8e4a7cf4730c99">Si443x::transmitDirect</a> (uint32_t frf=0) override</dt>
<dd><a class="anchor" id="_todo000002"></a>integers only </dd>
<dt>Member <a class="el" href="class_s_t_m32_w_lx.html#a9afbde1c466907598974cc3923784c5b">STM32WLx::setOutputPower</a> (int8_t power) override</dt>
<dd><a class="anchor" id="_todo000006"></a>power ramp time configuration </dd>
<dt>Member <a class="el" href="class_s_x1268.html#a59b538f4971525849b7aaa3456de9929">SX1268::setFrequency</a> (float freq, bool calibrate)</dt>
<dd><a class="anchor" id="_todo000007"></a>integers only (all modules - frequency, data rate, bandwidth etc.) </dd>
<dd><a class="anchor" id="_todo000006"></a>integers only (all modules - frequency, data rate, bandwidth etc.) </dd>
<dt>Member <a class="el" href="class_s_x1282.html#ae90b7dcd7167c4cbe20e33ced04e4232">SX1282::SX1282</a> (<a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> *mod)</dt>
<dd><a class="anchor" id="_todo000008"></a>implement advanced ranging </dd>
<dd><a class="anchor" id="_todo000007"></a>implement advanced ranging </dd>
<dt>Member <a class="el" href="class_s_x128x.html#ae7d3676df8f28c79b9bee23df884fa55">SX128x::getTimeOnAir</a> (size_t len) override</dt>
<dd><a class="anchor" id="_todo000010"></a>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd>
<dd><a class="anchor" id="_todo000009"></a>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd>
<dt>Member <a class="el" href="class_s_x128x.html#ad9584464d2e4cc09686cf4e83e65d3e0">SX128x::setSyncWord</a> (const uint8_t *syncWord, uint8_t len)</dt>
<dd><a class="anchor" id="_todo000009"></a>add support for multiple sync words </dd>
<dd><a class="anchor" id="_todo000008"></a>add support for multiple sync words </dd>
</dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->