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

Deploying to gh-pages from @ 674c37d00b 🚀

Browse source
This commit is contained in:
jgromes 2023-04-23 19:14:45 +00:00
parent 30c3b8a09c
commit 9c55dc654e
11 changed files with 680 additions and 683 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
_r_f_m22_8h_source.html
View file

@ -97,13 +97,13 @@ $(document).ready(function(){initNavTree('_r_f_m22_8h_source.html',''); initResi
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;../Si443x/Si443x.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;../Si443x/Si4432.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;RADIOLIB_TYPE_ALIAS(<a class="code" href="class_si4432.html">Si4432</a>, <a class="code" href="class_r_f_m22.html">RFM22</a>);</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;RADIOLIB_TYPE_ALIAS(<a class="code" href="class_si4432.html">Si4432</a>, <a class="code" href="class_r_f_m22.html">RFM22</a>);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_r_f_m22_html"><div class="ttname"><a href="class_r_f_m22.html">RFM22</a></div><div class="ttdoc">Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modul...</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:16</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:15</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

12
_r_f_m23_8h_source.html
View file

@ -97,13 +97,13 @@ $(document).ready(function(){initNavTree('_r_f_m23_8h_source.html',''); initResi
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;../Si443x/Si443x.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;../Si443x/Si4431.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;RADIOLIB_TYPE_ALIAS(<a class="code" href="class_si4431.html">Si4431</a>, <a class="code" href="class_r_f_m23.html">RFM23</a>);</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;RADIOLIB_TYPE_ALIAS(<a class="code" href="class_si4431.html">Si4431</a>, <a class="code" href="class_r_f_m23.html">RFM23</a>);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_r_f_m23_html"><div class="ttname"><a href="class_r_f_m23.html">RFM23</a></div><div class="ttdoc">Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modul...</div></div>
<div class="ttc" id="aclass_si4431_html"><div class="ttname"><a href="class_si4431.html">Si4431</a></div><div class="ttdoc">Derived class for Si4431 modules.</div><div class="ttdef"><b>Definition:</b> Si4431.h:16</div></div>
<div class="ttc" id="aclass_si4431_html"><div class="ttname"><a href="class_si4431.html">Si4431</a></div><div class="ttdoc">Derived class for Si4431 modules.</div><div class="ttdef"><b>Definition:</b> Si4431.h:15</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

2
_s_x126x_8h_source.html
View file

@ -743,7 +743,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>&#160; <span class="keywordtype">float</span> bandwidthKhz = 0;</div>
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>&#160; <span class="keywordtype">bool</span> ldroAuto = <span class="keyword">true</span>;</div>
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>&#160; </div>
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>&#160; uint32_t bitRate = 0, freqencyDev = 0;</div>
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>&#160; uint32_t bitRate = 0, frequencyDev = 0;</div>
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>&#160; uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;</div>
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>&#160; uint16_t preambleLengthFSK = 0;</div>
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>&#160; <span class="keywordtype">float</span> rxBandwidthKhz = 0;</div>

57
_si4430_8h_source.html
View file

@ -96,43 +96,42 @@ $(document).ready(function(){initNavTree('_si4430_8h_source.html',''); initResiz
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;Si4432.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_si4430.html"> 16</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4430.html">Si4430</a>: <span class="keyword">public</span> <a class="code" href="class_si4432.html">Si4432</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9">Si4430</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_si4430.html"> 15</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4430.html">Si4430</a>: <span class="keyword">public</span> <a class="code" href="class_si4432.html">Si4432</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9">Si4430</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4430.html#aaed612b8936609442042d8156e085d2c">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; int16_t <a class="code" href="class_si4430.html#aaed612b8936609442042d8156e085d2c">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4430.html#a025a31861d1511090168e416140d0343">setFrequency</a>(<span class="keywordtype">float</span> freq);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; int16_t <a class="code" href="class_si4430.html#a025a31861d1511090168e416140d0343">setFrequency</a>(<span class="keywordtype">float</span> freq);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; int16_t <a class="code" href="class_si4430.html#af8d615431bf66e06b45487f3fff73d16">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; int16_t <a class="code" href="class_si4430.html#af8d615431bf66e06b45487f3fff73d16">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:28</div></div>
<div class="ttc" id="aclass_si4430_html"><div class="ttname"><a href="class_si4430.html">Si4430</a></div><div class="ttdoc">Derived class for Si4430 modules.</div><div class="ttdef"><b>Definition:</b> Si4430.h:16</div></div>
<div class="ttc" id="aclass_si4430_html"><div class="ttname"><a href="class_si4430.html">Si4430</a></div><div class="ttdoc">Derived class for Si4430 modules.</div><div class="ttdef"><b>Definition:</b> Si4430.h:15</div></div>
<div class="ttc" id="aclass_si4430_html_a025a31861d1511090168e416140d0343"><div class="ttname"><a href="class_si4430.html#a025a31861d1511090168e416140d0343">Si4430::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz.</div><div class="ttdef"><b>Definition:</b> Si4430.cpp:24</div></div>
<div class="ttc" id="aclass_si4430_html_aaed612b8936609442042d8156e085d2c"><div class="ttname"><a href="class_si4430.html#aaed612b8936609442042d8156e085d2c">Si4430::begin</a></div><div class="ttdeci">int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)</div><div class="ttdoc">Initialization method. Must be called at least once from Arduino sketch to initialize the module.</div><div class="ttdef"><b>Definition:</b> Si4430.cpp:8</div></div>
<div class="ttc" id="aclass_si4430_html_ac5ac1122e863a92b374a71e8880e16d9"><div class="ttname"><a href="class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9">Si4430::Si4430</a></div><div class="ttdeci">Si4430(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Si4430.cpp:4</div></div>
<div class="ttc" id="aclass_si4430_html_af8d615431bf66e06b45487f3fff73d16"><div class="ttname"><a href="class_si4430.html#af8d615431bf66e06b45487f3fff73d16">Si4430::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps.</div><div class="ttdef"><b>Definition:</b> Si4430.cpp:31</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:16</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:15</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

53
_si4431_8h_source.html
View file

@ -96,40 +96,39 @@ $(document).ready(function(){initNavTree('_si4431_8h_source.html',''); initResiz
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;Si4432.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_si4431.html"> 16</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4431.html">Si4431</a>: <span class="keyword">public</span> <a class="code" href="class_si4432.html">Si4432</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="class_si4431.html#a332bfd2a32dea9ac0700bf172fe5b2d0">Si4431</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_si4431.html"> 15</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4431.html">Si4431</a>: <span class="keyword">public</span> <a class="code" href="class_si4432.html">Si4432</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="class_si4431.html#a332bfd2a32dea9ac0700bf172fe5b2d0">Si4431</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4431.html#a402223a49d5b1012b0bf58ce602e6ff3">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; int16_t <a class="code" href="class_si4431.html#a402223a49d5b1012b0bf58ce602e6ff3">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4431.html#a4da296b35056e076ff69a288bd801d19">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; int16_t <a class="code" href="class_si4431.html#a4da296b35056e076ff69a288bd801d19">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;};</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:28</div></div>
<div class="ttc" id="aclass_si4431_html"><div class="ttname"><a href="class_si4431.html">Si4431</a></div><div class="ttdoc">Derived class for Si4431 modules.</div><div class="ttdef"><b>Definition:</b> Si4431.h:16</div></div>
<div class="ttc" id="aclass_si4431_html"><div class="ttname"><a href="class_si4431.html">Si4431</a></div><div class="ttdoc">Derived class for Si4431 modules.</div><div class="ttdef"><b>Definition:</b> Si4431.h:15</div></div>
<div class="ttc" id="aclass_si4431_html_a332bfd2a32dea9ac0700bf172fe5b2d0"><div class="ttname"><a href="class_si4431.html#a332bfd2a32dea9ac0700bf172fe5b2d0">Si4431::Si4431</a></div><div class="ttdeci">Si4431(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Si4431.cpp:4</div></div>
<div class="ttc" id="aclass_si4431_html_a402223a49d5b1012b0bf58ce602e6ff3"><div class="ttname"><a href="class_si4431.html#a402223a49d5b1012b0bf58ce602e6ff3">Si4431::begin</a></div><div class="ttdeci">int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)</div><div class="ttdoc">Initialization method. Must be called at least once from Arduino sketch to initialize the module.</div><div class="ttdef"><b>Definition:</b> Si4431.cpp:8</div></div>
<div class="ttc" id="aclass_si4431_html_a4da296b35056e076ff69a288bd801d19"><div class="ttname"><a href="class_si4431.html#a4da296b35056e076ff69a288bd801d19">Si4431::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps.</div><div class="ttdef"><b>Definition:</b> Si4431.cpp:24</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:16</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:15</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

57
_si4432_8h_source.html
View file

@ -96,43 +96,42 @@ $(document).ready(function(){initNavTree('_si4432_8h_source.html',''); initResiz
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;Si443x.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_si4432.html"> 16</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4432.html">Si4432</a>: <span class="keyword">public</span> <a class="code" href="class_si443x.html">Si443x</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac">Si4432</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_si4432.html"> 15</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_si4432.html">Si4432</a>: <span class="keyword">public</span> <a class="code" href="class_si443x.html">Si443x</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// constructor</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac">Si4432</a>(<a class="code" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4432.html#a5efc3a08f91a411da011201dc128fb34">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; int16_t <a class="code" href="class_si4432.html#a5efc3a08f91a411da011201dc128fb34">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 181.1, int8_t power = 10, uint8_t preambleLen = 16);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int16_t <a class="code" href="class_si4432.html#aa0cdb6cb53bb0176803d5115356a8e84">setFrequency</a>(<span class="keywordtype">float</span> freq);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; int16_t <a class="code" href="class_si4432.html#aa0cdb6cb53bb0176803d5115356a8e84">setFrequency</a>(<span class="keywordtype">float</span> freq);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; int16_t <a class="code" href="class_si4432.html#a8b26e2c86a9e5e8f6405f0a57b65caca">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; int16_t <a class="code" href="class_si4432.html#a8b26e2c86a9e5e8f6405f0a57b65caca">setOutputPower</a>(int8_t power);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:28</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:16</div></div>
<div class="ttc" id="aclass_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules.</div><div class="ttdef"><b>Definition:</b> Si4432.h:15</div></div>
<div class="ttc" id="aclass_si4432_html_a5efc3a08f91a411da011201dc128fb34"><div class="ttname"><a href="class_si4432.html#a5efc3a08f91a411da011201dc128fb34">Si4432::begin</a></div><div class="ttdeci">int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)</div><div class="ttdoc">Initialization method. Must be called at least once from Arduino sketch to initialize the module.</div><div class="ttdef"><b>Definition:</b> Si4432.cpp:8</div></div>
<div class="ttc" id="aclass_si4432_html_a8b26e2c86a9e5e8f6405f0a57b65caca"><div class="ttname"><a href="class_si4432.html#a8b26e2c86a9e5e8f6405f0a57b65caca">Si4432::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Sets output power. Allowed values range from -1 to 20 dBm in 3 dBm steps.</div><div class="ttdef"><b>Definition:</b> Si4432.cpp:31</div></div>
<div class="ttc" id="aclass_si4432_html_aa0cdb6cb53bb0176803d5115356a8e84"><div class="ttname"><a href="class_si4432.html#aa0cdb6cb53bb0176803d5115356a8e84">Si4432::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Allowed values range from 240.0 MHz to 930.0 MHz.</div><div class="ttdef"><b>Definition:</b> Si4432.cpp:24</div></div>
<div class="ttc" id="aclass_si4432_html_afb1f1ae46d04788aa42f6276efd231ac"><div class="ttname"><a href="class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac">Si4432::Si4432</a></div><div class="ttdeci">Si4432(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Si4432.cpp:4</div></div>
<div class="ttc" id="aclass_si443x_html"><div class="ttname"><a href="class_si443x.html">Si443x</a></div><div class="ttdoc">Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...</div><div class="ttdef"><b>Definition:</b> Si443x.h:554</div></div>
<div class="ttc" id="aclass_si443x_html"><div class="ttname"><a href="class_si443x.html">Si443x</a></div><div class="ttdoc">Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...</div><div class="ttdef"><b>Definition:</b> Si443x.h:553</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

1064
_si443x_8h_source.html
View file

File diff suppressed because it is too large Load diff

16
class_si4430.html
View file

@ -394,12 +394,12 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Initialization method. Must be called at least once from Arduino sketch to initialize the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 900.0 MHz to 960.0 MHz.</td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps.</td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps.</td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz.</td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps.</td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits.</td></tr>
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 900.0 MHz to 960.0 MHz. </td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps. </td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps. </td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz. </td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps. </td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits. </td></tr>
</table>
</dd>
</dl>
@ -434,7 +434,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz.</td></tr>
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz. </td></tr>
</table>
</dd>
</dl>
@ -463,7 +463,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">power</td><td>Output power to be set in dBm.</td></tr>
<tr><td class="paramname">power</td><td>Output power to be set in dBm. </td></tr>
</table>
</dd>
</dl>

14
class_si4431.html
View file

@ -391,12 +391,12 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Initialization method. Must be called at least once from Arduino sketch to initialize the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 240.0 MHz to 930.0 MHz.</td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps.</td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps.</td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz.</td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps.</td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits.</td></tr>
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 240.0 MHz to 930.0 MHz. </td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps. </td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps. </td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz. </td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps. </td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits. </td></tr>
</table>
</dd>
</dl>
@ -423,7 +423,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">power</td><td>Output power to be set in dBm.</td></tr>
<tr><td class="paramname">power</td><td>Output power to be set in dBm. </td></tr>
</table>
</dd>
</dl>

16
class_si4432.html
View file

@ -382,12 +382,12 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Initialization method. Must be called at least once from Arduino sketch to initialize the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 240.0 MHz to 930.0 MHz.</td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps.</td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps.</td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz.</td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -1 to 20 dBm in 3 dBm steps.</td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits.</td></tr>
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 240.0 MHz to 930.0 MHz. </td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps. </td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps. </td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz. </td></tr>
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -1 to 20 dBm in 3 dBm steps. </td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits. </td></tr>
</table>
</dd>
</dl>
@ -422,7 +422,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets carrier frequency. Allowed values range from 240.0 MHz to 930.0 MHz. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz.</td></tr>
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz. </td></tr>
</table>
</dd>
</dl>
@ -451,7 +451,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets output power. Allowed values range from -1 to 20 dBm in 3 dBm steps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">power</td><td>Output power to be set in dBm.</td></tr>
<tr><td class="paramname">power</td><td>Output power to be set in dBm. </td></tr>
</table>
</dd>
</dl>

60
class_si443x.html
View file

@ -360,10 +360,10 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Initialization method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second).</td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz.</td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz.</td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits.</td></tr>
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). </td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. </td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. </td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. </td></tr>
</table>
</dd>
</dl>
@ -420,7 +420,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Set modem in fixed packet length mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">len</td><td>Packet length.</td></tr>
<tr><td class="paramname">len</td><td>Packet length. </td></tr>
</table>
</dd>
</dl>
@ -475,7 +475,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Query modem for the packet length of received payload. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">update</td><td>Update received packet length. Will return cached value when set to false.</td></tr>
<tr><td class="paramname">update</td><td>Update received packet length. Will return cached value when set to false. </td></tr>
</table>
</dd>
</dl>
@ -632,8 +632,8 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Reads data that was received after calling startReceive method. This method reads len characters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data.</td></tr>
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.</td></tr>
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
</table>
</dd>
</dl>
@ -704,8 +704,8 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long. For overloads to receive Arduino String, see <a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8" title="Binary receive method. Must be implemented in module class.">PhysicalLayer::receive</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data.</td></tr>
<tr><td class="paramname">len</td><td>Number of bytes that will be received. Must be known in advance for binary transmissions.</td></tr>
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes that will be received. Must be known in advance for binary transmissions. </td></tr>
</table>
</dd>
</dl>
@ -772,7 +772,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">br</td><td>Bit rate to be set (in kbps).</td></tr>
<tr><td class="paramname">br</td><td>Bit rate to be set (in kbps). </td></tr>
</table>
</dd>
</dl>
@ -809,7 +809,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sh</td><td>Gaussian shaping bandwidth-time product that will be used for data shaping</td></tr>
<tr><td class="paramname">sh</td><td>Gaussian shaping bandwidth-time product that will be used for data shaping </td></tr>
</table>
</dd>
</dl>
@ -882,7 +882,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoding</td><td>Encoding to be used.</td></tr>
<tr><td class="paramname">encoding</td><td>Encoding to be used. </td></tr>
</table>
</dd>
</dl>
@ -923,7 +923,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320.0 kHz. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">freqDev</td><td>Frequency deviation to be set (in kHz).</td></tr>
<tr><td class="paramname">freqDev</td><td>Frequency deviation to be set (in kHz). </td></tr>
</table>
</dd>
</dl>
@ -978,7 +978,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets preamble length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">preambleLen</td><td>Preamble length to be set (in bits).</td></tr>
<tr><td class="paramname">preambleLen</td><td>Preamble length to be set (in bits). </td></tr>
</table>
</dd>
</dl>
@ -1108,7 +1108,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth to be set in kHz.</td></tr>
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth to be set in kHz. </td></tr>
</table>
</dd>
</dl>
@ -1146,7 +1146,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets sync word. Up to 4 bytes can be set as sync word. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">syncWord</td><td>Pointer to the array of sync word bytes.</td></tr>
<tr><td class="paramname">syncWord</td><td>Pointer to the array of sync word bytes. </td></tr>
<tr><td class="paramname">len</td><td>Sync word length in bytes. </td></tr>
</table>
</dd>
@ -1241,7 +1241,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Sets the module to standby. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>Standby mode to be used.</td></tr>
<tr><td class="paramname">mode</td><td>Standby mode to be used. </td></tr>
</table>
</dd>
</dl>
@ -1320,10 +1320,10 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Interrupt-driven receive method, implemented for compatibility with <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>Ignored.</td></tr>
<tr><td class="paramname">irqFlags</td><td>Ignored.</td></tr>
<tr><td class="paramname">irqMask</td><td>Ignored.</td></tr>
<tr><td class="paramname">len</td><td>Ignored.</td></tr>
<tr><td class="paramname">timeout</td><td>Ignored. </td></tr>
<tr><td class="paramname">irqFlags</td><td>Ignored. </td></tr>
<tr><td class="paramname">irqMask</td><td>Ignored. </td></tr>
<tr><td class="paramname">len</td><td>Ignored. </td></tr>
</table>
</dd>
</dl>
@ -1425,9 +1425,9 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes long. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Binary data that will be transmitted.</td></tr>
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes).</td></tr>
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to.</td></tr>
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. </td></tr>
</table>
</dd>
</dl>
@ -1530,9 +1530,9 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to transmit Arduino String or C-string, see <a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534" title="C-string transmit method.">PhysicalLayer::transmit</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Binary data that will be transmitted.</td></tr>
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes).</td></tr>
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to.</td></tr>
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. </td></tr>
</table>
</dd>
</dl>
@ -1569,7 +1569,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Enables direct transmission mode. While in direct mode, the module will not be able to transmit or receive packets. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FRF</td><td>24-bit raw frequency value to start transmitting at. Required for quick frequency shifts in RTTY.</td></tr>
<tr><td class="paramname">frf</td><td>24-bit raw frequency value to start transmitting at. Required for quick frequency shifts in RTTY. </td></tr>
</table>
</dd>
</dl>
@ -1599,7 +1599,7 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
<p>Set modem in variable packet length mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">len</td><td>Maximum packet length.</td></tr>
<tr><td class="paramname">maxLen</td><td>Maximum packet length. </td></tr>
</table>
</dd>
</dl>