247 lines
39 KiB
HTML
247 lines
39 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/Hal.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_hal_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Hal.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_HAL_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_HAL_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <stddef.h></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "BuildOpt.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// list of persistent parameters</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_NONCE_ID (0)</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_ADDR_ID (1)</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_FCNT_UP_ID (2)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_MAGIC_ID (3)</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_APP_S_KEY_ID (4)</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_FNWK_SINT_KEY_ID (5)</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_SNWK_SINT_KEY_ID (6)</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_NWK_SENC_KEY_ID (7)</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">static</span> <span class="keyword">const</span> uint32_t RadioLibPersistentParamTable[] = {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  0x00, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_NONCE_ID</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  0x04, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_ADDR_ID</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  0x08, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_FCNT_UP_ID</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  0x0C, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_MAGIC_ID</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  0x10, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_APP_S_KEY_ID</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  0x20, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_FNWK_SINT_KEY_ID</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  0x30, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_SNWK_SINT_KEY_ID</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  0x40, <span class="comment">// RADIOLIB_PERSISTENT_PARAM_LORAWAN_NWK_SENC_KEY_ID</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  0x50, <span class="comment">// end</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// values for pin modes, levels and change directions</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// these tell RadioLib how are different logic states represented on a given platform</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769"> 44</a></span>  <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="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe"> 49</a></span>  <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="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4"> 54</a></span>  <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="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d"> 59</a></span>  <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="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851"> 64</a></span>  <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="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936"> 69</a></span>  <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="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <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="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <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="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b"> 90</a></span>  <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="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab"> 98</a></span>  <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="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2"> 106</a></span>  <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="l00107"></a><span class="lineno"> 107</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe"> 115</a></span>  <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="l00116"></a><span class="lineno"> 116</span>  </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56"> 122</a></span>  <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="l00123"></a><span class="lineno"> 123</span>  </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e"> 129</a></span>  <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="l00130"></a><span class="lineno"> 130</span>  </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac"> 136</a></span>  <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="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023"> 143</a></span>  <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="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3"> 150</a></span>  <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="l00151"></a><span class="lineno"> 151</span>  </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7"> 160</a></span>  <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="l00161"></a><span class="lineno"> 161</span>  </div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030"> 165</a></span>  <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="l00166"></a><span class="lineno"> 166</span>  </div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460"> 170</a></span>  <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="l00171"></a><span class="lineno"> 171</span>  </div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a"> 178</a></span>  <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="l00179"></a><span class="lineno"> 179</span>  </div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9"> 183</a></span>  <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="l00184"></a><span class="lineno"> 184</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64"> 188</a></span>  <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="l00189"></a><span class="lineno"> 189</span>  </div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="comment">// virtual methods - these may or may not exists on a given platform</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="comment">// they exist in this implementation, but do nothing</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <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="l00199"></a><span class="lineno"> 199</span>  </div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <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="l00206"></a><span class="lineno"> 206</span>  </div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <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="l00214"></a><span class="lineno"> 214</span>  </div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <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="l00220"></a><span class="lineno"> 220</span>  </div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <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="l00225"></a><span class="lineno"> 225</span>  </div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <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="l00232"></a><span class="lineno"> 232</span>  </div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a467356d0f1b097733da5ba99884cf354">readPersistentStorage</a>(uint32_t addr, uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  </div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a85cb796531c85215fa20f54754f6b4f3">writePersistentStorage</a>(uint32_t addr, uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#ac9d93c46d699b8ece64ec9afe4d3ad71">wipePersistentStorage</a>();</div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  </div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  uint32_t <a class="code" href="class_radio_lib_hal.html#ae8bda4b34a69c2738eb0b43a59b86f0d">getPersistentAddr</a>(uint32_t <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  </div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keywordtype">void</span> <a class="code" href="class_radio_lib_hal.html#a33d918e9e01c069e7d7bb64dbfcad478">setPersistentParameter</a>(uint32_t <span class="keywordtype">id</span>, T val);</div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  T <a class="code" href="class_radio_lib_hal.html#a216a59fbd4c022a3410a4b1e42059dbe">getPersistentParameter</a>(uint32_t <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> };</div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  </div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <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="ttdoc">Hardware abstraction library base interface.</div><div class="ttdef"><b>Definition:</b> Hal.h:35</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 "falling" GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:69</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_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 "output" GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:49</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_a216a59fbd4c022a3410a4b1e42059dbe"><div class="ttname"><a href="class_radio_lib_hal.html#a216a59fbd4c022a3410a4b1e42059dbe">RadioLibHal::getPersistentParameter</a></div><div class="ttdeci">T getPersistentParameter(uint32_t id)</div><div class="ttdoc">Method to get arbitrary parameter from persistent storage. This method DOES NOT perform any endiannes...</div><div class="ttdef"><b>Definition:</b> Hal.cpp:73</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 "input" GPIO direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:44</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_a33d918e9e01c069e7d7bb64dbfcad478"><div class="ttname"><a href="class_radio_lib_hal.html#a33d918e9e01c069e7d7bb64dbfcad478">RadioLibHal::setPersistentParameter</a></div><div class="ttdeci">void setPersistentParameter(uint32_t id, T val)</div><div class="ttdoc">Method to set arbitrary parameter to persistent storage. This method DOES NOT perform any endianness ...</div><div class="ttdef"><b>Definition:</b> Hal.cpp:63</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 "low" GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:54</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 "high" GPIO level.</div><div class="ttdef"><b>Definition:</b> Hal.h:59</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_a467356d0f1b097733da5ba99884cf354"><div class="ttname"><a href="class_radio_lib_hal.html#a467356d0f1b097733da5ba99884cf354">RadioLibHal::readPersistentStorage</a></div><div class="ttdeci">virtual void readPersistentStorage(uint32_t addr, uint8_t *buff, size_t len)</div><div class="ttdoc">Method to read from persistent storage (e.g. EEPROM).</div><div class="ttdef"><b>Definition:</b> Hal.cpp:37</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 "rising" GPIO level change direction.</div><div class="ttdef"><b>Definition:</b> Hal.h:64</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_a85cb796531c85215fa20f54754f6b4f3"><div class="ttname"><a href="class_radio_lib_hal.html#a85cb796531c85215fa20f54754f6b4f3">RadioLibHal::writePersistentStorage</a></div><div class="ttdeci">virtual void writePersistentStorage(uint32_t addr, uint8_t *buff, size_t len)</div><div class="ttdoc">Method to write to persistent storage (e.g. EEPROM).</div><div class="ttdef"><b>Definition:</b> Hal.cpp:44</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 destructor is called....</div><div class="ttdef"><b>Definition:</b> Hal.cpp:15</div></div>
|
|
<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 ("tone") 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_ac9d93c46d699b8ece64ec9afe4d3ad71"><div class="ttname"><a href="class_radio_lib_hal.html#ac9d93c46d699b8ece64ec9afe4d3ad71">RadioLibHal::wipePersistentStorage</a></div><div class="ttdeci">void wipePersistentStorage()</div><div class="ttdoc">Method to wipe the persistent storage by writing to 0. Will write at most RADIOLIB_HAL_PERSISTENT_STO...</div><div class="ttdef"><b>Definition:</b> Hal.cpp:51</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_ae8bda4b34a69c2738eb0b43a59b86f0d"><div class="ttname"><a href="class_radio_lib_hal.html#ae8bda4b34a69c2738eb0b43a59b86f0d">RadioLibHal::getPersistentAddr</a></div><div class="ttdeci">uint32_t getPersistentAddr(uint32_t id)</div><div class="ttdoc">Method to convert from persistent parameter ID to its physical address.</div><div class="ttdef"><b>Definition:</b> Hal.cpp:58</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>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>Hal.h</b></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|