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

Deploying to gh-pages from @ a01b02fae2 🚀

Browse source
This commit is contained in:
jgromes 2023-06-26 17:37:30 +00:00
parent 961ea8b478
commit ebf3b59157
12 changed files with 74 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
_arduino_hal_8h_source.html
View file

@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('_arduino_hal_8h_source.html',''); init
<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="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">spiTransfer</a>(uint8_t* out, <span class="keywordtype">size_t</span> len, uint8_t* in) <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>
@ -155,7 +155,6 @@ $(document).ready(function(){initNavTree('_arduino_hal_8h_source.html',''); init
<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>
<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_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>
@ -172,6 +171,7 @@ $(document).ready(function(){initNavTree('_arduino_hal_8h_source.html',''); init
<div class="ttc" id="aclass_radio_lib_hal_html_ab4cc3bef7109f00b77b95e84511b0bb9"><div class="ttname"><a href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">RadioLibHal::tone</a></div><div class="ttdeci">virtual void tone(uint32_t pin, unsigned int frequency, unsigned long duration=0)</div><div class="ttdoc">Method to produce a square-wave with 50% duty cycle (&quot;tone&quot;) of a given frequency at some pin.</div><div class="ttdef"><b>Definition:</b> Hal.cpp:19</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_abe787d5e556190eef2c63e1581235460"><div class="ttname"><a href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">RadioLibHal::spiBeginTransaction</a></div><div class="ttdeci">virtual void spiBeginTransaction()=0</div><div class="ttdoc">Method to start SPI transaction.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_ad49128a75a3d7abdc68baa302955f3ac"><div class="ttname"><a href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">RadioLibHal::delayMicroseconds</a></div><div class="ttdeci">virtual void delayMicroseconds(unsigned long us)=0</div><div class="ttdoc">Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aebcaaf0cefdaaf5b572d4261e472ac8a"><div class="ttname"><a href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">RadioLibHal::spiTransfer</a></div><div class="ttdeci">virtual void spiTransfer(uint8_t *out, size_t len, uint8_t *in)=0</div><div class="ttdoc">Method to transfer buffer over SPI.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aedf55424bc4aa28379b6f4f6b04151d3"><div class="ttname"><a href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">RadioLibHal::micros</a></div><div class="ttdeci">virtual unsigned long micros()=0</div><div class="ttdoc">Get number of microseconds since start. Must be implemented by the platform-specific hardware abstrac...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_af01b4e5e01352b99ce4329c9f9f8433b"><div class="ttname"><a href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">RadioLibHal::pinMode</a></div><div class="ttdeci">virtual void pinMode(uint32_t pin, uint32_t mode)=0</div><div class="ttdoc">GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific h...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_af142f747becacd1e3e13503f79fd5ebe"><div class="ttname"><a href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">RadioLibHal::attachInterrupt</a></div><div class="ttdeci">virtual void attachInterrupt(uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode)=0</div><div class="ttdoc">Method to attach function to an external interrupt. Must be implemented by the platform-specific hard...</div></div>

48
_hal_8h_source.html
View file

@ -138,33 +138,32 @@ $(document).ready(function(){initNavTree('_hal_8h_source.html',''); initResizabl
<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="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="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="l00209"></a><span class="lineno"> 209</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a"> 154</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">spiTransfer</a>(uint8_t* out, <span class="keywordtype">size_t</span> len, uint8_t* in) = 0;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9"> 159</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="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64"> 164</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="l00165"></a><span class="lineno"> 165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="comment">// virtual methods - these may or may not exists on a given platform</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="comment">// they exist in this implementation, but do nothing</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</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="l00175"></a><span class="lineno"> 175</span>&#160; </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</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="l00182"></a><span class="lineno"> 182</span>&#160; </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</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="l00190"></a><span class="lineno"> 190</span>&#160; </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</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="l00196"></a><span class="lineno"> 196</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#a1bd9d614f66b374ec820ce31b167fdb2">yield</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> uint32_t <a class="code" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin);</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;};</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; </div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</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: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>
@ -187,6 +186,7 @@ $(document).ready(function(){initNavTree('_hal_8h_source.html',''); initResizabl
<div class="ttc" id="aclass_radio_lib_hal_html_abe787d5e556190eef2c63e1581235460"><div class="ttname"><a href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">RadioLibHal::spiBeginTransaction</a></div><div class="ttdeci">virtual void spiBeginTransaction()=0</div><div class="ttdoc">Method to start SPI transaction.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_ad49128a75a3d7abdc68baa302955f3ac"><div class="ttname"><a href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">RadioLibHal::delayMicroseconds</a></div><div class="ttdeci">virtual void delayMicroseconds(unsigned long us)=0</div><div class="ttdoc">Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_ae75a54271cb8bea37d32dd146b9c6513"><div class="ttname"><a href="class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513">RadioLibHal::RadioLibHal</a></div><div class="ttdeci">RadioLibHal(const uint32_t input, const uint32_t output, const uint32_t low, const uint32_t high, const uint32_t rising, const uint32_t falling)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Hal.cpp:3</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aebcaaf0cefdaaf5b572d4261e472ac8a"><div class="ttname"><a href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">RadioLibHal::spiTransfer</a></div><div class="ttdeci">virtual void spiTransfer(uint8_t *out, size_t len, uint8_t *in)=0</div><div class="ttdoc">Method to transfer buffer over SPI.</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_aedf55424bc4aa28379b6f4f6b04151d3"><div class="ttname"><a href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">RadioLibHal::micros</a></div><div class="ttdeci">virtual unsigned long micros()=0</div><div class="ttdoc">Get number of microseconds since start. Must be implemented by the platform-specific hardware abstrac...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_af01b4e5e01352b99ce4329c9f9f8433b"><div class="ttname"><a href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">RadioLibHal::pinMode</a></div><div class="ttdeci">virtual void pinMode(uint32_t pin, uint32_t mode)=0</div><div class="ttdoc">GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific h...</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_af142f747becacd1e3e13503f79fd5ebe"><div class="ttname"><a href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">RadioLibHal::attachInterrupt</a></div><div class="ttdeci">virtual void attachInterrupt(uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode)=0</div><div class="ttdoc">Method to attach function to an external interrupt. Must be implemented by the platform-specific hard...</div></div>

24
_module_8h_source.html
View file

@ -256,21 +256,21 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
<div class="ttc" id="aclass_module_html_a4483f0a39a523dd1b37b467d81418f7d"><div class="ttname"><a href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">Module::hal</a></div><div class="ttdeci">RadioLibHal * hal</div><div class="ttdoc">Hardware abstraction layer to be used.</div><div class="ttdef"><b>Definition:</b> Module.h:122</div></div>
<div class="ttc" id="aclass_module_html_a45bd514a1f2859d9a867c8f9b13eb332"><div class="ttname"><a href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">Module::term</a></div><div class="ttdeci">void term()</div><div class="ttdoc">Terminate low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:49</div></div>
<div class="ttc" id="aclass_module_html_a466112286d19675ca2dbe481358e4365"><div class="ttname"><a href="class_module.html#a466112286d19675ca2dbe481358e4365">Module::SPInopCommand</a></div><div class="ttdeci">uint8_t SPInopCommand</div><div class="ttdoc">Basic SPI no-operation command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:137</div></div>
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_t len)</div><div class="ttdoc">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...</div><div class="ttdef"><b>Definition:</b> Module.cpp:365</div></div>
<div class="ttc" id="aclass_module_html_a4add1a875bb88e91da232118201a78a8"><div class="ttname"><a href="class_module.html#a4add1a875bb88e91da232118201a78a8">Module::reflect</a></div><div class="ttdeci">static uint32_t reflect(uint32_t in, uint8_t bits)</div><div class="ttdoc">Function to reflect bits within a byte.</div><div class="ttdef"><b>Definition:</b> Module.cpp:383</div></div>
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_t len)</div><div class="ttdoc">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...</div><div class="ttdef"><b>Definition:</b> Module.cpp:376</div></div>
<div class="ttc" id="aclass_module_html_a4add1a875bb88e91da232118201a78a8"><div class="ttname"><a href="class_module.html#a4add1a875bb88e91da232118201a78a8">Module::reflect</a></div><div class="ttdeci">static uint32_t reflect(uint32_t in, uint8_t bits)</div><div class="ttdoc">Function to reflect bits within a byte.</div><div class="ttdef"><b>Definition:</b> Module.cpp:394</div></div>
<div class="ttc" id="aclass_module_html_a4ea888758b4a7784082d513a1e7849a4"><div class="ttname"><a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">Module::operator=</a></div><div class="ttdeci">Module &amp; operator=(const Module &amp;mod)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition:</b> Module.cpp:33</div></div>
<div class="ttc" id="aclass_module_html_a4ec27f0ba5e0009ea9661a5110526b52"><div class="ttname"><a href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">Module::getGpio</a></div><div class="ttdeci">uint32_t getGpio() const</div><div class="ttdoc">Access method to get the pin number of second interrupt/GPIO.</div><div class="ttdef"><b>Definition:</b> Module.h:355</div></div>
<div class="ttc" id="aclass_module_html_a5699a937b62ba41387567b4d679b9377"><div class="ttname"><a href="class_module.html#a5699a937b62ba41387567b4d679b9377">Module::findRfSwitchMode</a></div><div class="ttdeci">const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const</div><div class="ttdoc">Find a mode in the RfSwitchTable.</div><div class="ttdef"><b>Definition:</b> Module.cpp:498</div></div>
<div class="ttc" id="aclass_module_html_a5699a937b62ba41387567b4d679b9377"><div class="ttname"><a href="class_module.html#a5699a937b62ba41387567b4d679b9377">Module::findRfSwitchMode</a></div><div class="ttdeci">const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const</div><div class="ttdoc">Find a mode in the RfSwitchTable.</div><div class="ttdef"><b>Definition:</b> Module.cpp:509</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bf"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">Module::OpMode_t</a></div><div class="ttdeci">OpMode_t</div><div class="ttdef"><b>Definition:</b> Module.h:61</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdef"><b>Definition:</b> Module.h:71</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdef"><b>Definition:</b> Module.h:67</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdef"><b>Definition:</b> Module.h:69</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">Module::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdef"><b>Definition:</b> Module.h:65</div></div>
<div class="ttc" id="aclass_module_html_a5efa7ae78cab1d7f43005e965923f769"><div class="ttname"><a href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">Module::SPIcheckStream</a></div><div class="ttdeci">int16_t SPIcheckStream()</div><div class="ttdoc">Method to check the result of last SPI stream transfer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:224</div></div>
<div class="ttc" id="aclass_module_html_a5efa7ae78cab1d7f43005e965923f769"><div class="ttname"><a href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">Module::SPIcheckStream</a></div><div class="ttdeci">int16_t SPIcheckStream()</div><div class="ttdoc">Method to check the result of last SPI stream transfer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:236</div></div>
<div class="ttc" id="aclass_module_html_a66b06e69d57b97116bed1c6f185381f1"><div class="ttname"><a href="class_module.html#a66b06e69d57b97116bed1c6f185381f1">Module::SPIstreamError</a></div><div class="ttdeci">int16_t SPIstreamError</div><div class="ttdoc">The last recorded SPI stream error.</div><div class="ttdef"><b>Definition:</b> Module.h:158</div></div>
<div class="ttc" id="aclass_module_html_a74ce586afa403130007a474d3295d762"><div class="ttname"><a href="class_module.html#a74ce586afa403130007a474d3295d762">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a write transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:207</div></div>
<div class="ttc" id="aclass_module_html_a74ce586afa403130007a474d3295d762"><div class="ttname"><a href="class_module.html#a74ce586afa403130007a474d3295d762">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a write transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:219</div></div>
<div class="ttc" id="aclass_module_html_a78dd39aa71d97e2220a880df8162fdde"><div class="ttname"><a href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)</div><div class="ttdoc">SPI single transfer method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:141</div></div>
<div class="ttc" id="aclass_module_html_a7d3adea64acab11c47c804afc74bd4f3"><div class="ttname"><a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:475</div></div>
<div class="ttc" id="aclass_module_html_a7d3adea64acab11c47c804afc74bd4f3"><div class="ttname"><a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:486</div></div>
<div class="ttc" id="aclass_module_html_a817178405f125e068e88bad62aeb6f3b"><div class="ttname"><a href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module::Module</a></div><div class="ttdeci">Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio=RADIOLIB_NC)</div><div class="ttdoc">Module constructor.</div><div class="ttdef"><b>Definition:</b> Module.cpp:25</div></div>
<div class="ttc" id="aclass_module_html_a849ad85fc1bc3a7130e660c13973ab26"><div class="ttname"><a href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">Module::SPIreadCommand</a></div><div class="ttdeci">uint8_t SPIreadCommand</div><div class="ttdoc">Basic SPI read command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:127</div></div>
<div class="ttc" id="aclass_module_html_a874e030f1931e606e380930d37dd83ee"><div class="ttname"><a href="class_module.html#a874e030f1931e606e380930d37dd83ee">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:103</div></div>
@ -278,18 +278,18 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
<div class="ttc" id="aclass_module_html_a9a545e4a001da0d9f6358279ac40d4f0"><div class="ttname"><a href="class_module.html#a9a545e4a001da0d9f6358279ac40d4f0">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint16_t reg)</div><div class="ttdoc">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...</div><div class="ttdef"><b>Definition:</b> Module.cpp:112</div></div>
<div class="ttc" id="aclass_module_html_aa6cac04c7cb6d5278a318db0966ad1a7"><div class="ttname"><a href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">Module::getCs</a></div><div class="ttdeci">uint32_t getCs() const</div><div class="ttdoc">Access method to get the pin number of SPI chip select.</div><div class="ttdef"><b>Definition:</b> Module.h:337</div></div>
<div class="ttc" id="aclass_module_html_ab61bc5066c356e2d0d79f08a2bd0fbc9"><div class="ttname"><a href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">Module::getIrq</a></div><div class="ttdeci">uint32_t getIrq() const</div><div class="ttdoc">Access method to get the pin number of interrupt/GPIO.</div><div class="ttdef"><b>Definition:</b> Module.h:343</div></div>
<div class="ttc" id="aclass_module_html_ab9fc874adc8dbe7c3f1fd3c267c27708"><div class="ttname"><a href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a read transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:190</div></div>
<div class="ttc" id="aclass_module_html_abb13a50ed53b009c04dc2ed6caf78423"><div class="ttname"><a href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">Module::regdump</a></div><div class="ttdeci">void regdump(uint16_t start, size_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:436</div></div>
<div class="ttc" id="aclass_module_html_ab9fc874adc8dbe7c3f1fd3c267c27708"><div class="ttname"><a href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a read transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:202</div></div>
<div class="ttc" id="aclass_module_html_abb13a50ed53b009c04dc2ed6caf78423"><div class="ttname"><a href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">Module::regdump</a></div><div class="ttdeci">void regdump(uint16_t start, size_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:447</div></div>
<div class="ttc" id="aclass_module_html_ac19a495026aae62f5c2f089aa1b2b57a"><div class="ttname"><a href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a">Module::SPIaddrWidth</a></div><div class="ttdeci">uint8_t SPIaddrWidth</div><div class="ttdoc">SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.</div><div class="ttdef"><b>Definition:</b> Module.h:147</div></div>
<div class="ttc" id="aclass_module_html_ac308fa817a5c36c5dc724a0d15cefd4d"><div class="ttname"><a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:491</div></div>
<div class="ttc" id="aclass_module_html_ac3586c8d4013cbdd22cf34032632c181"><div class="ttname"><a href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)</div><div class="ttdoc">SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....</div><div class="ttdef"><b>Definition:</b> Module.cpp:243</div></div>
<div class="ttc" id="aclass_module_html_ad0532274dafe433ba68529945bfe6a1b"><div class="ttname"><a href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:391</div></div>
<div class="ttc" id="aclass_module_html_ac308fa817a5c36c5dc724a0d15cefd4d"><div class="ttname"><a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:502</div></div>
<div class="ttc" id="aclass_module_html_ac3586c8d4013cbdd22cf34032632c181"><div class="ttname"><a href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)</div><div class="ttdoc">SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....</div><div class="ttdef"><b>Definition:</b> Module.cpp:255</div></div>
<div class="ttc" id="aclass_module_html_ad0532274dafe433ba68529945bfe6a1b"><div class="ttname"><a href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:402</div></div>
<div class="ttc" id="aclass_module_html_ad1956ac81429ec1f61f83dbc081cf18c"><div class="ttname"><a href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">Module::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Initialize low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:43</div></div>
<div class="ttc" id="aclass_module_html_ad6cddbf3aebec9717a1a381dd81ad398"><div class="ttname"><a href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">Module::getRst</a></div><div class="ttdeci">uint32_t getRst() const</div><div class="ttdoc">Access method to get the pin number of hardware reset pin.</div><div class="ttdef"><b>Definition:</b> Module.h:349</div></div>
<div class="ttc" id="aclass_module_html_ae89764d15e8df5694a6aec0e18f72d3f"><div class="ttname"><a href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">Module::SPIwriteCommand</a></div><div class="ttdeci">uint8_t SPIwriteCommand</div><div class="ttdoc">Basic SPI write command. Defaults to 0x80.</div><div class="ttdef"><b>Definition:</b> Module.h:132</div></div>
<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:123</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:169</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:508</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:519</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:49</div></div>

2
class_radio_lib_hal-members.html
View file

@ -113,7 +113,7 @@ $(document).ready(function(){initNavTree('class_radio_lib_hal.html',''); initRes
<tr><td class="entry"><a class="el" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>()=0</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>()=0</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>()=0</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a>(uint8_t b)=0</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">spiTransfer</a>(uint8_t *out, size_t len, uint8_t *in)=0</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>()</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a>(uint32_t pin, unsigned int frequency, unsigned long duration=0)</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>()</td><td class="entry"><a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>

39
class_radio_lib_hal.html
View file

@ -134,9 +134,9 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hr
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a> ()=0</td></tr>
<tr class="memdesc:abe787d5e556190eef2c63e1581235460"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to start SPI transaction. <br /></td></tr>
<tr class="separator:abe787d5e556190eef2c63e1581235460"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12facb08577402e50c91c75ca7dd560f"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">spiTransfer</a> (uint8_t b)=0</td></tr>
<tr class="memdesc:a12facb08577402e50c91c75ca7dd560f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to transfer one byte over SPI. <a href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">More...</a><br /></td></tr>
<tr class="separator:a12facb08577402e50c91c75ca7dd560f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebcaaf0cefdaaf5b572d4261e472ac8a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">spiTransfer</a> (uint8_t *out, size_t len, uint8_t *in)=0</td></tr>
<tr class="memdesc:aebcaaf0cefdaaf5b572d4261e472ac8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to transfer buffer over SPI. <a href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">More...</a><br /></td></tr>
<tr class="separator:aebcaaf0cefdaaf5b572d4261e472ac8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68d9271c76f8c96afb734a4634bf92e9"><td class="memItemLeft" align="right" valign="top"><a id="a68d9271c76f8c96afb734a4634bf92e9"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a> ()=0</td></tr>
<tr class="memdesc:a68d9271c76f8c96afb734a4634bf92e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to end SPI transaction. <br /></td></tr>
@ -718,8 +718,8 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</div>
</div>
<a id="a12facb08577402e50c91c75ca7dd560f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12facb08577402e50c91c75ca7dd560f">&#9670;&nbsp;</a></span>spiTransfer()</h2>
<a id="aebcaaf0cefdaaf5b572d4261e472ac8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebcaaf0cefdaaf5b572d4261e472ac8a">&#9670;&nbsp;</a></span>spiTransfer()</h2>
<div class="memitem">
<div class="memproto">
@ -728,11 +728,27 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t RadioLibHal::spiTransfer </td>
<td class="memname">virtual void RadioLibHal::spiTransfer </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
@ -742,14 +758,15 @@ const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el"
</table>
</div><div class="memdoc">
<p>Method to transfer one byte over SPI. </p>
<p>Method to transfer buffer 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">out</td><td>Buffer to send. </td></tr>
<tr><td class="paramname">len</td><td>Number of data to send or receive. </td></tr>
<tr><td class="paramname">in</td><td>Buffer to save received data into. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Received byte. </dd></dl>
</div>
</div>

2
class_radio_lib_hal.js
View file

@ -18,7 +18,7 @@ var class_radio_lib_hal =
[ "spiBeginTransaction", "class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460", null ],
[ "spiEnd", "class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64", null ],
[ "spiEndTransaction", "class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9", null ],
[ "spiTransfer", "class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f", null ],
[ "spiTransfer", "class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a", null ],
[ "term", "class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e", null ],
[ "tone", "class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9", null ],
[ "yield", "class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2", null ],

2
functions_func_s.html
View file

@ -542,7 +542,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
: <a class="el" href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">Module</a>
</li>
<li>spiTransfer()
: <a class="el" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">RadioLibHal</a>
: <a class="el" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">RadioLibHal</a>
</li>
<li>SPItransferStream()
: <a class="el" href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">Module</a>

2
functions_s.html
View file

@ -575,7 +575,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
: <a class="el" href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">Module</a>
</li>
<li>spiTransfer()
: <a class="el" href="class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f">RadioLibHal</a>
: <a class="el" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">RadioLibHal</a>
</li>
<li>SPItransferStream()
: <a class="el" href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">Module</a>

2
navtreeindex1.js
View file

@ -198,7 +198,6 @@ var NAVTREEINDEX1 =
"class_radio_lib_hal.html":[3,0,24],
"class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936":[3,0,24,22],
"class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2":[3,0,24,5],
"class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f":[3,0,24,18],
"class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe":[3,0,24,27],
"class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2":[3,0,24,21],
"class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023":[3,0,24,9],
@ -221,6 +220,7 @@ var NAVTREEINDEX1 =
"class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460":[3,0,24,15],
"class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac":[3,0,24,3],
"class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513":[3,0,24,0],
"class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a":[3,0,24,18],
"class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3":[3,0,24,8],
"class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b":[3,0,24,11],
"class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe":[3,0,24,1],

2
navtreeindex4.js
View file

@ -128,8 +128,8 @@ var NAVTREEINDEX4 =
"group__status__codes.html#gafbc04b924d23cba05307e94972d7d607":[2,4,5],
"group__status__codes.html#gafeff72bd7b618959d86b804a11f09063":[2,4,1],
"hierarchy.html":[3,2],
"index.html":[0],
"index.html":[],
"index.html":[0],
"modules.html":[2],
"n_r_f24_8h_source.html":[4,0,0,0,2,0],
"pages.html":[],

2
search/all_f.js
View file

@ -108,7 +108,7 @@ var searchData=
['spistatuscommand_367',['SPIstatusCommand',['../class_module.html#a06d8d4257c584b57a529fcc405d87c79',1,'Module']]],
['spistreamerror_368',['SPIstreamError',['../class_module.html#a66b06e69d57b97116bed1c6f185381f1',1,'Module']]],
['spistreamtype_369',['SPIstreamType',['../class_module.html#a34927454be3a34df8a5a586c46c428af',1,'Module']]],
['spitransfer_370',['spiTransfer',['../class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f',1,'RadioLibHal']]],
['spitransfer_370',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]],
['spitransfer_371',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]],
['spitransferstream_372',['SPItransferStream',['../class_module.html#ac3586c8d4013cbdd22cf34032632c181',1,'Module']]],
['spiwritecommand_373',['SPIwriteCommand',['../class_module.html#ae89764d15e8df5694a6aec0e18f72d3f',1,'Module']]],

2
search/functions_f.js
View file

@ -97,7 +97,7 @@ var searchData=
['spireadregisterburst_715',['SPIreadRegisterBurst',['../class_module.html#a874e030f1931e606e380930d37dd83ee',1,'Module']]],
['spireadstream_716',['SPIreadStream',['../class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708',1,'Module::SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)'],['../class_module.html#a085415b49ff72238f118b937ad896cbd',1,'Module::SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)']]],
['spisetregvalue_717',['SPIsetRegValue',['../class_module.html#a081191402ad5c49e6c21982fc4587b77',1,'Module']]],
['spitransfer_718',['spiTransfer',['../class_radio_lib_hal.html#a12facb08577402e50c91c75ca7dd560f',1,'RadioLibHal']]],
['spitransfer_718',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]],
['spitransfer_719',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]],
['spitransferstream_720',['SPItransferStream',['../class_module.html#ac3586c8d4013cbdd22cf34032632c181',1,'Module']]],
['spiwriteregister_721',['SPIwriteRegister',['../class_module.html#a4437af6552e258e95ed8ed452afa6dd4',1,'Module']]],