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

Deploying to gh-pages from @ 7a99aa0ef4 🚀

Browse source
This commit is contained in:
jgromes 2023-04-22 16:54:06 +00:00
parent 94c3023793
commit 63efe4bfff
5 changed files with 142 additions and 142 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

102
_arduino_hal_8h_source.html
View file

@ -103,57 +103,57 @@ $(document).ready(function(){initNavTree('_arduino_hal_8h_source.html',''); init
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;SPI.h&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">class </span>ArduinoHal : <span class="keyword">public</span> <a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; ArduinoHal();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; ArduinoHal(SPIClass&amp; spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);</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">// implementations of pure virtual RadioLibHal methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a>(uint32_t pin, uint32_t mode) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a>(uint32_t pin, uint32_t value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint32_t <a class="code" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a>(uint32_t pin) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">attachInterrupt</a>(uint32_t interruptNum, <span class="keywordtype">void</span> (*interruptCb)(<span class="keywordtype">void</span>), uint32_t mode) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a>(uint32_t interruptNum) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">delay</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">delayMicroseconds</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">millis</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">micros</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">pulseIn</a>(uint32_t pin, uint32_t state, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint8_t <a class="code" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a>(uint8_t b) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>() <span class="keyword">override</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; <span class="comment">// implementations of virtual RadioLibHal methods</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a>(uint32_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> frequency, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a>(uint32_t pin) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint32_t <a class="code" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin) <span class="keyword">override</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; SPIClass* _spi = NULL;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; SPISettings _spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">bool</span> _initInterface = <span class="keyword">false</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"> #if defined(RADIOLIB_MBED_TONE_OVERRIDE)</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; mbed::PwmOut *pwmPin = NULL;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor"> #if defined(ESP32)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; int32_t _prev = -1;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</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="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:12</div></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">class </span>ArduinoHal : <span class="keyword">public</span> <a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; ArduinoHal();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; ArduinoHal(SPIClass&amp; spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// implementations of pure virtual RadioLibHal methods</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a>(uint32_t pin, uint32_t mode) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a>(uint32_t pin, uint32_t value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint32_t <a class="code" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a>(uint32_t pin) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">attachInterrupt</a>(uint32_t interruptNum, <span class="keywordtype">void</span> (*interruptCb)(<span class="keywordtype">void</span>), uint32_t mode) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a>(uint32_t interruptNum) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">delay</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">delayMicroseconds</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">millis</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">micros</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">pulseIn</a>(uint32_t pin, uint32_t state, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uint8_t <a class="code" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a>(uint8_t b) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// implementations of virtual RadioLibHal methods</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a>(uint32_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> frequency, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a>(uint32_t pin) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint32_t <a class="code" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; SPIClass* spi = NULL;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> initInterface = <span class="keyword">false</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;<span class="preprocessor"> #if defined(RADIOLIB_MBED_TONE_OVERRIDE)</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; mbed::PwmOut *pwmPin = NULL;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor"> #if defined(ESP32)</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; int32_t prev = -1;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;};</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;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:11</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a0c7c2dffd662cefca7bf11e14c56dab2"><div class="ttname"><a href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">RadioLibHal::digitalRead</a></div><div class="ttdeci">virtual uint32_t digitalRead(uint32_t pin)=0</div><div class="ttdoc">Digital read method. Must be implemented by the platform-specific hardware abstraction!</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a12facb08577402e50c91c75ca7dd560f"><div class="ttname"><a href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">RadioLibHal::spiTransfer</a></div><div class="ttdeci">virtual uint8_t spiTransfer(uint8_t b)=0</div><div class="ttdoc">Method to transfer one byte over SPI.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a1bd9d614f66b374ec820ce31b167fdb2"><div class="ttname"><a href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">RadioLibHal::yield</a></div><div class="ttdeci">virtual void yield()</div><div class="ttdoc">Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads...</div><div class="ttdef"><b>Definition:</b> Hal.cpp:29</div></div>

2
_external_radio_8h_source.html
View file

@ -113,7 +113,7 @@ $(document).ready(function(){initNavTree('_external_radio_8h_source.html',''); i
<div class="ttc" id="aclass_external_radio_html"><div class="ttname"><a href="class_external_radio.html">ExternalRadio</a></div><div class="ttdef"><b>Definition:</b> ExternalRadio.h:12</div></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_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:14</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:12</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:11</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

146
_hal_8h_source.html
View file

@ -92,94 +92,94 @@ $(document).ready(function(){initNavTree('_hal_8h_source.html',''); initResizabl
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html"> 12</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="comment">// values for pin modes, levels and change directions</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="comment">// these tell RadioLib how are different logic states represented on a given platform</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769"> 21</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">GpioModeInput</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe"> 26</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">GpioModeOutput</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4"> 31</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">GpioLevelLow</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d"> 36</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">GpioLevelHigh</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851"> 41</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">GpioInterruptRising</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936"> 46</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">GpioInterruptFalling</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513">RadioLibHal</a>(<span class="keyword">const</span> uint32_t input, <span class="keyword">const</span> uint32_t output, <span class="keyword">const</span> uint32_t low, <span class="keyword">const</span> uint32_t high, <span class="keyword">const</span> uint32_t rising, <span class="keyword">const</span> uint32_t falling);</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="comment">// pure virtual methods - these must be implemented by the hardware abstraction for RadioLib to function</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b"> 75</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a>(uint32_t pin, uint32_t mode) = 0;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab"> 85</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a>(uint32_t pin, uint32_t value) = 0;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2"> 95</a></span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a>(uint32_t pin) = 0;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe"> 107</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">attachInterrupt</a>(uint32_t interruptNum, <span class="keywordtype">void</span> (*interruptCb)(<span class="keywordtype">void</span>), uint32_t mode) = 0;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56"> 115</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a>(uint32_t interruptNum) = 0;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e"> 123</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">delay</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms) = 0;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac"> 131</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">delayMicroseconds</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) = 0;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023"> 139</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">millis</a>() = 0;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3"> 147</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">micros</a>() = 0;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7"> 161</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">pulseIn</a>(uint32_t pin, uint32_t state, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout) = 0;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030"> 166</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a>() = 0;</div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html"> 11</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="comment">// values for pin modes, levels and change directions</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="comment">// these tell RadioLib how are different logic states represented on a given platform</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769"> 20</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">GpioModeInput</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe"> 25</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">GpioModeOutput</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4"> 30</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">GpioLevelLow</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d"> 35</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">GpioLevelHigh</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851"> 40</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">GpioInterruptRising</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936"> 45</a></span>&#160; <span class="keyword">const</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">GpioInterruptFalling</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513">RadioLibHal</a>(<span class="keyword">const</span> uint32_t input, <span class="keyword">const</span> uint32_t output, <span class="keyword">const</span> uint32_t low, <span class="keyword">const</span> uint32_t high, <span class="keyword">const</span> uint32_t rising, <span class="keyword">const</span> uint32_t falling);</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="comment">// pure virtual methods - these must be implemented by the hardware abstraction for RadioLib to function</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b"> 66</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a>(uint32_t pin, uint32_t mode) = 0;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab"> 74</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a>(uint32_t pin, uint32_t value) = 0;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2"> 82</a></span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a>(uint32_t pin) = 0;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe"> 91</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">attachInterrupt</a>(uint32_t interruptNum, <span class="keywordtype">void</span> (*interruptCb)(<span class="keywordtype">void</span>), uint32_t mode) = 0;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56"> 98</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a>(uint32_t interruptNum) = 0;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e"> 105</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">delay</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms) = 0;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac"> 112</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">delayMicroseconds</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> us) = 0;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023"> 119</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">millis</a>() = 0;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3"> 126</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">micros</a>() = 0;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7"> 136</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">pulseIn</a>(uint32_t pin, uint32_t state, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout) = 0;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030"> 141</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a>() = 0;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460"> 146</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>() = 0;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f"> 153</a></span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a>(uint8_t b) = 0;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9"> 158</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>() = 0;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64"> 163</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>() = 0;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="comment">// virtual methods - these may or may not exists on a given platform</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="comment">// they exist in this implementation, but do nothing</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460"> 171</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>() = 0;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f"> 180</a></span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a>(uint8_t b) = 0;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a>();</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>();</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; </div>
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9"> 185</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>() = 0;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
<div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64"> 190</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>() = 0;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="comment">// virtual methods - these may or may not exists on a given platform</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="comment">// they exist in this implementation, but do nothing</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; </div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a>();</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>();</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a>(uint32_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> frequency, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; </div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a>(uint32_t pin);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>();</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;};</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; </div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a>(uint32_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> frequency, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0);</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a>(uint32_t pin);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; </div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>();</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin);</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;};</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; </div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:12</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a01f73b66a632fc9dba41a23f592e0936"><div class="ttname"><a href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">RadioLibHal::GpioInterruptFalling</a></div><div class="ttdeci">const uint32_t GpioInterruptFalling</div><div class="ttdoc">Value to be used as the &quot;falling&quot; GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:46</div></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:11</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a01f73b66a632fc9dba41a23f592e0936"><div class="ttname"><a href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">RadioLibHal::GpioInterruptFalling</a></div><div class="ttdeci">const uint32_t GpioInterruptFalling</div><div class="ttdoc">Value to be used as the &quot;falling&quot; GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:45</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a0c7c2dffd662cefca7bf11e14c56dab2"><div class="ttname"><a href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">RadioLibHal::digitalRead</a></div><div class="ttdeci">virtual uint32_t digitalRead(uint32_t pin)=0</div><div class="ttdoc">Digital read method. Must be implemented by the platform-specific hardware abstraction!</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a12facb08577402e50c91c75ca7dd560f"><div class="ttname"><a href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">RadioLibHal::spiTransfer</a></div><div class="ttdeci">virtual uint8_t spiTransfer(uint8_t b)=0</div><div class="ttdoc">Method to transfer one byte over SPI.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a18a711dd900a796ccfd7dddbdd2e6afe"><div class="ttname"><a href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">RadioLibHal::GpioModeOutput</a></div><div class="ttdeci">const uint32_t GpioModeOutput</div><div class="ttdoc">Value to be used as the &quot;output&quot; GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:26</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a18a711dd900a796ccfd7dddbdd2e6afe"><div class="ttname"><a href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">RadioLibHal::GpioModeOutput</a></div><div class="ttdeci">const uint32_t GpioModeOutput</div><div class="ttdoc">Value to be used as the &quot;output&quot; GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:25</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a1bd9d614f66b374ec820ce31b167fdb2"><div class="ttname"><a href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">RadioLibHal::yield</a></div><div class="ttdeci">virtual void yield()</div><div class="ttdoc">Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads...</div><div class="ttdef"><b>Definition:</b> Hal.cpp:29</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a2bc5dbf7c13e6031fb9892075755a023"><div class="ttname"><a href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">RadioLibHal::millis</a></div><div class="ttdeci">virtual unsigned long millis()=0</div><div class="ttdoc">Get number of milliseconds since start. Must be implemented by the platform-specific hardware abstrac...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a2d197fc1f62be4cd2d2c22be30744769"><div class="ttname"><a href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">RadioLibHal::GpioModeInput</a></div><div class="ttdeci">const uint32_t GpioModeInput</div><div class="ttdoc">Value to be used as the &quot;input&quot; GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:21</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a2d197fc1f62be4cd2d2c22be30744769"><div class="ttname"><a href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">RadioLibHal::GpioModeInput</a></div><div class="ttdeci">const uint32_t GpioModeInput</div><div class="ttdoc">Value to be used as the &quot;input&quot; GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:20</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a2ddf72a41b3cfbb63ea7ab5362003b56"><div class="ttname"><a href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">RadioLibHal::detachInterrupt</a></div><div class="ttdeci">virtual void detachInterrupt(uint32_t interruptNum)=0</div><div class="ttdoc">Method to detach function from an external interrupt. Must be implemented by the platform-specific ha...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a300a47d4d43dbe0c624f6e5dc1cf7a00"><div class="ttname"><a href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">RadioLibHal::pinToInterrupt</a></div><div class="ttdeci">virtual uint32_t pinToInterrupt(uint32_t pin)</div><div class="ttdoc">Function to convert from pin number to interrupt number.</div><div class="ttdef"><b>Definition:</b> Hal.cpp:33</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a35a6ef1b38553a3516c961872eb411d7"><div class="ttname"><a href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">RadioLibHal::pulseIn</a></div><div class="ttdeci">virtual long pulseIn(uint32_t pin, uint32_t state, unsigned long timeout)=0</div><div class="ttdoc">Measure the length of incoming digital pulse in microseconds. Must be implemented by the platform-spe...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a3cfca7ff9303fe84119ba2f4a4e1bbf4"><div class="ttname"><a href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">RadioLibHal::GpioLevelLow</a></div><div class="ttdeci">const uint32_t GpioLevelLow</div><div class="ttdoc">Value to be used as the &quot;low&quot; GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:31</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a409c719ef8a11e8765c90e98ba42316d"><div class="ttname"><a href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">RadioLibHal::GpioLevelHigh</a></div><div class="ttdeci">const uint32_t GpioLevelHigh</div><div class="ttdoc">Value to be used as the &quot;high&quot; GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:36</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a3cfca7ff9303fe84119ba2f4a4e1bbf4"><div class="ttname"><a href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">RadioLibHal::GpioLevelLow</a></div><div class="ttdeci">const uint32_t GpioLevelLow</div><div class="ttdoc">Value to be used as the &quot;low&quot; GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:30</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a409c719ef8a11e8765c90e98ba42316d"><div class="ttname"><a href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">RadioLibHal::GpioLevelHigh</a></div><div class="ttdeci">const uint32_t GpioLevelHigh</div><div class="ttdoc">Value to be used as the &quot;high&quot; GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:35</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a41c85e560155d644f5b4ce8444dd8b64"><div class="ttname"><a href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">RadioLibHal::spiEnd</a></div><div class="ttdeci">virtual void spiEnd()=0</div><div class="ttdoc">SPI termination method.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a450037acdfeb4e87413674ac90feb4d2"><div class="ttname"><a href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">RadioLibHal::init</a></div><div class="ttdeci">virtual void init()</div><div class="ttdoc">Module initialization method. This will be called by all radio modules at the beginning of startup....</div><div class="ttdef"><b>Definition:</b> Hal.cpp:11</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a4db0c60f2f6f64003f04cf0e03fea7ab"><div class="ttname"><a href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">RadioLibHal::digitalWrite</a></div><div class="ttdeci">virtual void digitalWrite(uint32_t pin, uint32_t value)=0</div><div class="ttdoc">Digital write method. Must be implemented by the platform-specific hardware abstraction!</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a68d9271c76f8c96afb734a4634bf92e9"><div class="ttname"><a href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">RadioLibHal::spiEndTransaction</a></div><div class="ttdeci">virtual void spiEndTransaction()=0</div><div class="ttdoc">Method to end SPI transaction.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a6b5341c59728a1932e33216feee04ea5"><div class="ttname"><a href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">RadioLibHal::noTone</a></div><div class="ttdeci">virtual void noTone(uint32_t pin)</div><div class="ttdoc">Method to stop producing a tone.</div><div class="ttdef"><b>Definition:</b> Hal.cpp:25</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a7ff9f3c608d68575dfc8962ba3669851"><div class="ttname"><a href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">RadioLibHal::GpioInterruptRising</a></div><div class="ttdeci">const uint32_t GpioInterruptRising</div><div class="ttdoc">Value to be used as the &quot;rising&quot; GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:41</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a7ff9f3c608d68575dfc8962ba3669851"><div class="ttname"><a href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">RadioLibHal::GpioInterruptRising</a></div><div class="ttdeci">const uint32_t GpioInterruptRising</div><div class="ttdoc">Value to be used as the &quot;rising&quot; GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:40</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a8427720749d8c87d17654071dfa5b94e"><div class="ttname"><a href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">RadioLibHal::delay</a></div><div class="ttdeci">virtual void delay(unsigned long ms)=0</div><div class="ttdoc">Blocking wait function. Must be implemented by the platform-specific hardware abstraction!</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aa1f8e5cd323e53ef9fa977734a05d030"><div class="ttname"><a href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">RadioLibHal::spiBegin</a></div><div class="ttdeci">virtual void spiBegin()=0</div><div class="ttdoc">SPI initialization method.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aa4f2bd49aea5a19aa9f85c720b4a883e"><div class="ttname"><a href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">RadioLibHal::term</a></div><div class="ttdeci">virtual void term()</div><div class="ttdoc">Module termination method. This will be called by all radio modules when the desctructor is called....</div><div class="ttdef"><b>Definition:</b> Hal.cpp:15</div></div>

2
_module_8h_source.html
View file

@ -290,7 +290,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
<div class="ttc" id="aclass_module_html_af474f82d00fffc1ee0fc8def2c7f220c"><div class="ttname"><a href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)</div><div class="ttdoc">SPI burst write method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:117</div></div>
<div class="ttc" id="aclass_module_html_af6e89e2bc4976e8c5dc42dedda9fa6a2"><div class="ttname"><a href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2">Module::SPIparseStatusCb</a></div><div class="ttdeci">SPIparseStatusCb_t SPIparseStatusCb</div><div class="ttdoc">Callback to function that will parse the module-specific status codes to RadioLib status codes....</div><div class="ttdef"><b>Definition:</b> Module.h:166</div></div>
<div class="ttc" id="aclass_module_html_afbed643f082286012bf44bba22381ae6"><div class="ttname"><a href="class_module.html#afbed643f082286012bf44bba22381ae6">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(uint8_t mode)</div><div class="ttdoc">Set RF switch state.</div><div class="ttdef"><b>Definition:</b> Module.cpp:501</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:12</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdef"><b>Definition:</b> Hal.h:11</div></div>
<div class="ttc" id="agroup__status__codes_html_gacc0baeb3e5fc99760a07d18ba55531b6"><div class="ttname"><a href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a></div><div class="ttdeci">#define RADIOLIB_ERR_UNKNOWN</div><div class="ttdoc">There was an unexpected, unknown error. If you see this, something went incredibly wrong....</div><div class="ttdef"><b>Definition:</b> TypeDef.h:110</div></div>
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:46</div></div>
</div><!-- fragment --></div><!-- contents -->

32
class_radio_lib_hal.html
View file

@ -248,11 +248,11 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Default constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Value to be used as the "input" GPIO direction.</td></tr>
<tr><td class="paramname">output</td><td>Value to be used as the "output" GPIO direction.</td></tr>
<tr><td class="paramname">low</td><td>Value to be used as the "low" GPIO level.</td></tr>
<tr><td class="paramname">high</td><td>Value to be used as the "high" GPIO level.</td></tr>
<tr><td class="paramname">rising</td><td>Value to be used as the "rising" GPIO level change direction.</td></tr>
<tr><td class="paramname">input</td><td>Value to be used as the "input" GPIO direction. </td></tr>
<tr><td class="paramname">output</td><td>Value to be used as the "output" GPIO direction. </td></tr>
<tr><td class="paramname">low</td><td>Value to be used as the "low" GPIO level. </td></tr>
<tr><td class="paramname">high</td><td>Value to be used as the "high" GPIO level. </td></tr>
<tr><td class="paramname">rising</td><td>Value to be used as the "rising" GPIO level change direction. </td></tr>
<tr><td class="paramname">falling</td><td>Value to be used as the "falling" GPIO level change direction. </td></tr>
</table>
</dd>
@ -304,8 +304,8 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Method to attach function to an external interrupt. Must be implemented by the platform-specific hardware abstraction! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">interruptNum</td><td>Interrupt number to attach to (platform-specific).</td></tr>
<tr><td class="paramname">interruptCb</td><td>Interrupt service routine to execute.</td></tr>
<tr><td class="paramname">interruptNum</td><td>Interrupt number to attach to (platform-specific). </td></tr>
<tr><td class="paramname">interruptCb</td><td>Interrupt service routine to execute. </td></tr>
<tr><td class="paramname">mode</td><td>Rising/falling mode (platform-specific). </td></tr>
</table>
</dd>
@ -442,7 +442,7 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Digital read method. Must be implemented by the platform-specific hardware abstraction! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific).</td></tr>
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
</table>
</dd>
</dl>
@ -487,7 +487,7 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Digital write method. Must be implemented by the platform-specific hardware abstraction! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific).</td></tr>
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
<tr><td class="paramname">value</td><td>Value to set (platform-specific). </td></tr>
</table>
</dd>
@ -622,7 +622,7 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific hardware abstraction! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific).</td></tr>
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
<tr><td class="paramname">mode</td><td>Mode to be set (platform-specific). </td></tr>
</table>
</dd>
@ -708,9 +708,9 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Measure the length of incoming digital pulse in microseconds. Must be implemented by the platform-specific hardware abstraction! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Pin to measure on (platform-specific).</td></tr>
<tr><td class="paramname">state</td><td>Pin level to monitor (platform-specific).</td></tr>
<tr><td class="paramname">timeout</td><td>Timeout in microseconds.</td></tr>
<tr><td class="paramname">pin</td><td>Pin to measure on (platform-specific). </td></tr>
<tr><td class="paramname">state</td><td>Pin level to monitor (platform-specific). </td></tr>
<tr><td class="paramname">timeout</td><td>Timeout in microseconds. </td></tr>
</table>
</dd>
</dl>
@ -745,7 +745,7 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Method to transfer one byte over SPI. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>Byte to send.</td></tr>
<tr><td class="paramname">b</td><td>Byte to send. </td></tr>
</table>
</dd>
</dl>
@ -796,8 +796,8 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<p>Method to produce a square-wave with 50% duty cycle ("tone") of a given frequency at some pin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Pin to be used as the output.</td></tr>
<tr><td class="paramname">frequency</td><td>Frequency of the square wave.</td></tr>
<tr><td class="paramname">pin</td><td>Pin to be used as the output. </td></tr>
<tr><td class="paramname">frequency</td><td>Frequency of the square wave. </td></tr>
<tr><td class="paramname">duration</td><td>Duration of the tone in ms. When set to 0, the tone will be infinite. </td></tr>
</table>
</dd>