forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/_hal_8h_source.html
jgromes 2338e94f76 Deploying to gh-pages from @ 56729041b3 🚀
2025-03-02 08:38:41 +00:00

221 lines
32 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_HAL_H)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_HAL_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;BuildOpt.h&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rlb_time_us();</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html"> 16</a></span><span class="keyword">class </span><a class="code hl_class" href="class_radio_lib_hal.html">RadioLibHal</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// values for pin modes, levels and change directions</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// these tell RadioLib how are different logic states represented on a given platform</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769"> 25</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">GpioModeInput</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe"> 30</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">GpioModeOutput</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4"> 35</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">GpioLevelLow</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d"> 40</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">GpioLevelHigh</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851"> 45</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">GpioInterruptRising</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936"> 50</a></span> <span class="keyword">const</span> uint32_t <a class="code hl_variable" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">GpioInterruptFalling</a>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_class" href="class_radio_lib_hal.html">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 id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</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 id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b"> 71</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a>(uint32_t pin, uint32_t mode) = 0;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab"> 79</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a>(uint32_t pin, uint32_t value) = 0;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2"> 87</a></span> <span class="keyword">virtual</span> uint32_t <a class="code hl_function" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a>(uint32_t pin) = 0;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe"> 96</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" 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 id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56"> 103</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a>(uint32_t interruptNum) = 0;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aa2de4fcafad28470f7d46073fa29da79"> 110</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#aa2de4fcafad28470f7d46073fa29da79">delay</a>(<a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> ms) = 0;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#ab93dc492291dfe6fc0dd763bee966161"> 117</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#ab93dc492291dfe6fc0dd763bee966161">delayMicroseconds</a>(<a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> us) = 0;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a4b8e36ccf8fe372c259b963666513d37"> 124</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code hl_function" href="class_radio_lib_hal.html#a4b8e36ccf8fe372c259b963666513d37">millis</a>() = 0;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a64d98b48668ced5ba1014f272606f370"> 131</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code hl_function" href="class_radio_lib_hal.html#a64d98b48668ced5ba1014f272606f370">micros</a>() = 0;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a3f38db9475dcd0967d6dfe240b8695c9"> 141</a></span> <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code hl_function" href="class_radio_lib_hal.html#a3f38db9475dcd0967d6dfe240b8695c9">pulseIn</a>(uint32_t pin, uint32_t state, <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeout) = 0;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030"> 146</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a>() = 0;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460"> 151</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">spiBeginTransaction</a>() = 0;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a"> 159</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" 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 id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9"> 164</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">spiEndTransaction</a>() = 0;</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"><a class="line" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64"> 169</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a>() = 0;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> <span class="comment">// virtual methods - these may or may not exists on a given platform</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// they exist in this implementation, but do nothing</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a>();</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a>();</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a62c9032e834ba420d81dc3e69df64e17">tone</a>(uint32_t pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> frequency, <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> duration = 0);</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a>(uint32_t pin);</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> </div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a>();</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">virtual</span> uint32_t <a class="code hl_function" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a>(uint32_t pin);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span>};</div>
</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</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:16</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:50</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 &quot;output&quot; GPIO direction.</div><div class="ttdef"><b>Definition</b> Hal.h:30</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:35</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a2d197fc1f62be4cd2d2c22be30744769"><div class="ttname"><a href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">RadioLibHal::GpioModeInput</a></div><div class="ttdeci">const uint32_t GpioModeInput</div><div class="ttdoc">Value to be used as the &quot;input&quot; GPIO direction.</div><div class="ttdef"><b>Definition</b> Hal.h:25</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:39</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a3cfca7ff9303fe84119ba2f4a4e1bbf4"><div class="ttname"><a href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">RadioLibHal::GpioLevelLow</a></div><div class="ttdeci">const uint32_t GpioLevelLow</div><div class="ttdoc">Value to be used as the &quot;low&quot; GPIO level.</div><div class="ttdef"><b>Definition</b> Hal.h:35</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a3f38db9475dcd0967d6dfe240b8695c9"><div class="ttname"><a href="class_radio_lib_hal.html#a3f38db9475dcd0967d6dfe240b8695c9">RadioLibHal::pulseIn</a></div><div class="ttdeci">virtual long pulseIn(uint32_t pin, uint32_t state, RadioLibTime_t 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_a409c719ef8a11e8765c90e98ba42316d"><div class="ttname"><a href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">RadioLibHal::GpioLevelHigh</a></div><div class="ttdeci">const uint32_t GpioLevelHigh</div><div class="ttdoc">Value to be used as the &quot;high&quot; GPIO level.</div><div class="ttdef"><b>Definition</b> Hal.h:40</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:17</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a4b8e36ccf8fe372c259b963666513d37"><div class="ttname"><a href="class_radio_lib_hal.html#a4b8e36ccf8fe372c259b963666513d37">RadioLibHal::millis</a></div><div class="ttdeci">virtual RadioLibTime_t 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_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_a62c9032e834ba420d81dc3e69df64e17"><div class="ttname"><a href="class_radio_lib_hal.html#a62c9032e834ba420d81dc3e69df64e17">RadioLibHal::tone</a></div><div class="ttdeci">virtual void tone(uint32_t pin, unsigned int frequency, RadioLibTime_t 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:25</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a64d98b48668ced5ba1014f272606f370"><div class="ttname"><a href="class_radio_lib_hal.html#a64d98b48668ced5ba1014f272606f370">RadioLibHal::micros</a></div><div class="ttdeci">virtual RadioLibTime_t 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_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:31</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_a7ff9f3c608d68575dfc8962ba3669851"><div class="ttname"><a href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">RadioLibHal::GpioInterruptRising</a></div><div class="ttdeci">const uint32_t GpioInterruptRising</div><div class="ttdoc">Value to be used as the &quot;rising&quot; GPIO level change direction.</div><div class="ttdef"><b>Definition</b> Hal.h:45</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_aa2de4fcafad28470f7d46073fa29da79"><div class="ttname"><a href="class_radio_lib_hal.html#aa2de4fcafad28470f7d46073fa29da79">RadioLibHal::delay</a></div><div class="ttdeci">virtual void delay(RadioLibTime_t 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_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:21</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html_ab93dc492291dfe6fc0dd763bee966161"><div class="ttname"><a href="class_radio_lib_hal.html#ab93dc492291dfe6fc0dd763bee966161">RadioLibHal::delayMicroseconds</a></div><div class="ttdeci">virtual void delayMicroseconds(RadioLibTime_t 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_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_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_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 class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition</b> TypeDef.h:642</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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink