205 lines
15 KiB
HTML
205 lines
15 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: Hal Class Reference</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('class_hal.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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_hal-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Hal Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Hardware abstraction library base interface.
|
|
<a href="class_hal.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_hal_8h_source.html">Hal.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a67fbd3c77fefe9a7777742ca0b383d1e"><td class="memItemLeft" align="right" valign="top"><a id="a67fbd3c77fefe9a7777742ca0b383d1e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Hal</b> (const uint32_t input, const uint32_t output, const uint32_t low, const uint32_t high, const uint32_t rising, const uint32_t falling)</td></tr>
|
|
<tr class="separator:a67fbd3c77fefe9a7777742ca0b383d1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a743f5222813676013a930ec9e8134c83"><td class="memItemLeft" align="right" valign="top"><a id="a743f5222813676013a930ec9e8134c83"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>init</b> ()</td></tr>
|
|
<tr class="separator:a743f5222813676013a930ec9e8134c83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c0c1310fd492bfff3749008f690a275"><td class="memItemLeft" align="right" valign="top"><a id="a9c0c1310fd492bfff3749008f690a275"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>term</b> ()</td></tr>
|
|
<tr class="separator:a9c0c1310fd492bfff3749008f690a275"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab19d275fa631056adb5d1ea0cb391d56"><td class="memItemLeft" align="right" valign="top"><a id="ab19d275fa631056adb5d1ea0cb391d56"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>pinMode</b> (uint32_t pin, uint32_t mode)=0</td></tr>
|
|
<tr class="separator:ab19d275fa631056adb5d1ea0cb391d56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a869281cbba88a04585b41badf57ac072"><td class="memItemLeft" align="right" valign="top"><a id="a869281cbba88a04585b41badf57ac072"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>digitalWrite</b> (uint32_t pin, uint32_t value)=0</td></tr>
|
|
<tr class="separator:a869281cbba88a04585b41badf57ac072"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aede141f2fc20436cdd0d67792f08dfd5"><td class="memItemLeft" align="right" valign="top"><a id="aede141f2fc20436cdd0d67792f08dfd5"></a>
|
|
virtual uint32_t </td><td class="memItemRight" valign="bottom"><b>digitalRead</b> (uint32_t pin)=0</td></tr>
|
|
<tr class="separator:aede141f2fc20436cdd0d67792f08dfd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bd1dd0c708893fd4e884cedcf86ba63"><td class="memItemLeft" align="right" valign="top"><a id="a6bd1dd0c708893fd4e884cedcf86ba63"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>attachInterrupt</b> (uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode)=0</td></tr>
|
|
<tr class="separator:a6bd1dd0c708893fd4e884cedcf86ba63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace747aae72abaea88161c18b8cad3045"><td class="memItemLeft" align="right" valign="top"><a id="ace747aae72abaea88161c18b8cad3045"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>detachInterrupt</b> (uint32_t interruptNum)=0</td></tr>
|
|
<tr class="separator:ace747aae72abaea88161c18b8cad3045"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcb5f5e011782e663f0cf20ca3627d4e"><td class="memItemLeft" align="right" valign="top"><a id="afcb5f5e011782e663f0cf20ca3627d4e"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>delay</b> (unsigned long ms)=0</td></tr>
|
|
<tr class="separator:afcb5f5e011782e663f0cf20ca3627d4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f6b462201b6e1f234549ead1d3531d9"><td class="memItemLeft" align="right" valign="top"><a id="a2f6b462201b6e1f234549ead1d3531d9"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>delayMicroseconds</b> (unsigned long us)=0</td></tr>
|
|
<tr class="separator:a2f6b462201b6e1f234549ead1d3531d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e2f3f43d70b75f897a607032a1d5319"><td class="memItemLeft" align="right" valign="top"><a id="a6e2f3f43d70b75f897a607032a1d5319"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>millis</b> ()=0</td></tr>
|
|
<tr class="separator:a6e2f3f43d70b75f897a607032a1d5319"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a1a9d42164debed8dfef8e3f70686ce"><td class="memItemLeft" align="right" valign="top"><a id="a3a1a9d42164debed8dfef8e3f70686ce"></a>
|
|
virtual unsigned long </td><td class="memItemRight" valign="bottom"><b>micros</b> ()=0</td></tr>
|
|
<tr class="separator:a3a1a9d42164debed8dfef8e3f70686ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9c293873ff98f372f99aadfee9a7cf3"><td class="memItemLeft" align="right" valign="top"><a id="ae9c293873ff98f372f99aadfee9a7cf3"></a>
|
|
virtual long </td><td class="memItemRight" valign="bottom"><b>pulseIn</b> (uint32_t pin, uint32_t state, unsigned long timeout)=0</td></tr>
|
|
<tr class="separator:ae9c293873ff98f372f99aadfee9a7cf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb88575c958f0352c45b2a230207aa7a"><td class="memItemLeft" align="right" valign="top"><a id="aeb88575c958f0352c45b2a230207aa7a"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>spiBegin</b> ()=0</td></tr>
|
|
<tr class="separator:aeb88575c958f0352c45b2a230207aa7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9ebdacb76dff0da030708fad1840375"><td class="memItemLeft" align="right" valign="top"><a id="ac9ebdacb76dff0da030708fad1840375"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>spiBeginTransaction</b> ()=0</td></tr>
|
|
<tr class="separator:ac9ebdacb76dff0da030708fad1840375"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d81fc5b2ea1c3d451323627b1cfad16"><td class="memItemLeft" align="right" valign="top"><a id="a7d81fc5b2ea1c3d451323627b1cfad16"></a>
|
|
virtual uint8_t </td><td class="memItemRight" valign="bottom"><b>spiTransfer</b> (uint8_t b)=0</td></tr>
|
|
<tr class="separator:a7d81fc5b2ea1c3d451323627b1cfad16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa8575028f97c5fc861733440857879d"><td class="memItemLeft" align="right" valign="top"><a id="afa8575028f97c5fc861733440857879d"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>spiEndTransaction</b> ()=0</td></tr>
|
|
<tr class="separator:afa8575028f97c5fc861733440857879d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8854f153ea9a6449d08c345a48e2c07"><td class="memItemLeft" align="right" valign="top"><a id="af8854f153ea9a6449d08c345a48e2c07"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>spiEnd</b> ()=0</td></tr>
|
|
<tr class="separator:af8854f153ea9a6449d08c345a48e2c07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a657daf98aafd516bbd001006e3bd731b"><td class="memItemLeft" align="right" valign="top"><a id="a657daf98aafd516bbd001006e3bd731b"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>tone</b> (uint32_t pin, unsigned int frequency, unsigned long duration=0)</td></tr>
|
|
<tr class="separator:a657daf98aafd516bbd001006e3bd731b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeecf4d41b5114bcd4cf0f39e9a95b418"><td class="memItemLeft" align="right" valign="top"><a id="aeecf4d41b5114bcd4cf0f39e9a95b418"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>noTone</b> (uint32_t pin)</td></tr>
|
|
<tr class="separator:aeecf4d41b5114bcd4cf0f39e9a95b418"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9eba3651d94a90e7640c180193677d7c"><td class="memItemLeft" align="right" valign="top"><a id="a9eba3651d94a90e7640c180193677d7c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>yield</b> ()</td></tr>
|
|
<tr class="separator:a9eba3651d94a90e7640c180193677d7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74667e5d37b66fb23089baf6a8ab46f5"><td class="memItemLeft" align="right" valign="top"><a id="a74667e5d37b66fb23089baf6a8ab46f5"></a>
|
|
virtual uint32_t </td><td class="memItemRight" valign="bottom"><b>pinToInterrupt</b> (uint32_t pin)</td></tr>
|
|
<tr class="separator:a74667e5d37b66fb23089baf6a8ab46f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0d7eac02f2da47da2b684acb2f77d2d4"><td class="memItemLeft" align="right" valign="top"><a id="a0d7eac02f2da47da2b684acb2f77d2d4"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioModeInput</b></td></tr>
|
|
<tr class="separator:a0d7eac02f2da47da2b684acb2f77d2d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20b9e2316f1cd433582db53f0671902a"><td class="memItemLeft" align="right" valign="top"><a id="a20b9e2316f1cd433582db53f0671902a"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioModeOutput</b></td></tr>
|
|
<tr class="separator:a20b9e2316f1cd433582db53f0671902a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa35ff3fe6a9336fa6e8e270759b46934"><td class="memItemLeft" align="right" valign="top"><a id="aa35ff3fe6a9336fa6e8e270759b46934"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioLevelLow</b></td></tr>
|
|
<tr class="separator:aa35ff3fe6a9336fa6e8e270759b46934"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab533754267d0e450d9a8ec1732041216"><td class="memItemLeft" align="right" valign="top"><a id="ab533754267d0e450d9a8ec1732041216"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioLevelHigh</b></td></tr>
|
|
<tr class="separator:ab533754267d0e450d9a8ec1732041216"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15bb9e9db67c8a364b887dbf5fd92374"><td class="memItemLeft" align="right" valign="top"><a id="a15bb9e9db67c8a364b887dbf5fd92374"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioInterruptRising</b></td></tr>
|
|
<tr class="separator:a15bb9e9db67c8a364b887dbf5fd92374"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20ffb038c341a8ea60fbae77078532f6"><td class="memItemLeft" align="right" valign="top"><a id="a20ffb038c341a8ea60fbae77078532f6"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioInterruptFalling</b></td></tr>
|
|
<tr class="separator:a20ffb038c341a8ea60fbae77078532f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Hardware abstraction library base interface. </p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="_hal_8h_source.html">Hal.h</a></li>
|
|
<li>src/Hal.cpp</li>
|
|
</ul>
|
|
</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="class_hal.html">Hal</a></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>
|