1066 lines
54 KiB
HTML
1066 lines
54 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: RadioLibHal 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_radio_lib_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_radio_lib_hal-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RadioLibHal 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_radio_lib_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:ae75a54271cb8bea37d32dd146b9c6513"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513">RadioLibHal</a> (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="memdesc:ae75a54271cb8bea37d32dd146b9c6513"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_radio_lib_hal.html#ae75a54271cb8bea37d32dd146b9c6513">More...</a><br /></td></tr>
|
|
<tr class="separator:ae75a54271cb8bea37d32dd146b9c6513"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af01b4e5e01352b99ce4329c9f9f8433b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">pinMode</a> (uint32_t pin, uint32_t mode)=0</td></tr>
|
|
<tr class="memdesc:af01b4e5e01352b99ce4329c9f9f8433b"><td class="mdescLeft"> </td><td class="mdescRight">GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">More...</a><br /></td></tr>
|
|
<tr class="separator:af01b4e5e01352b99ce4329c9f9f8433b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4db0c60f2f6f64003f04cf0e03fea7ab"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">digitalWrite</a> (uint32_t pin, uint32_t value)=0</td></tr>
|
|
<tr class="memdesc:a4db0c60f2f6f64003f04cf0e03fea7ab"><td class="mdescLeft"> </td><td class="mdescRight">Digital write method. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">More...</a><br /></td></tr>
|
|
<tr class="separator:a4db0c60f2f6f64003f04cf0e03fea7ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c7c2dffd662cefca7bf11e14c56dab2"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">digitalRead</a> (uint32_t pin)=0</td></tr>
|
|
<tr class="memdesc:a0c7c2dffd662cefca7bf11e14c56dab2"><td class="mdescLeft"> </td><td class="mdescRight">Digital read method. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c7c2dffd662cefca7bf11e14c56dab2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af142f747becacd1e3e13503f79fd5ebe"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">attachInterrupt</a> (uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode)=0</td></tr>
|
|
<tr class="memdesc:af142f747becacd1e3e13503f79fd5ebe"><td class="mdescLeft"> </td><td class="mdescRight">Method to attach function to an external interrupt. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">More...</a><br /></td></tr>
|
|
<tr class="separator:af142f747becacd1e3e13503f79fd5ebe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ddf72a41b3cfbb63ea7ab5362003b56"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">detachInterrupt</a> (uint32_t interruptNum)=0</td></tr>
|
|
<tr class="memdesc:a2ddf72a41b3cfbb63ea7ab5362003b56"><td class="mdescLeft"> </td><td class="mdescRight">Method to detach function from an external interrupt. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">More...</a><br /></td></tr>
|
|
<tr class="separator:a2ddf72a41b3cfbb63ea7ab5362003b56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8427720749d8c87d17654071dfa5b94e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">delay</a> (unsigned long ms)=0</td></tr>
|
|
<tr class="memdesc:a8427720749d8c87d17654071dfa5b94e"><td class="mdescLeft"> </td><td class="mdescRight">Blocking wait function. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a8427720749d8c87d17654071dfa5b94e">More...</a><br /></td></tr>
|
|
<tr class="separator:a8427720749d8c87d17654071dfa5b94e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad49128a75a3d7abdc68baa302955f3ac"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">delayMicroseconds</a> (unsigned long us)=0</td></tr>
|
|
<tr class="memdesc:ad49128a75a3d7abdc68baa302955f3ac"><td class="mdescLeft"> </td><td class="mdescRight">Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#ad49128a75a3d7abdc68baa302955f3ac">More...</a><br /></td></tr>
|
|
<tr class="separator:ad49128a75a3d7abdc68baa302955f3ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bc5dbf7c13e6031fb9892075755a023"><td class="memItemLeft" align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">millis</a> ()=0</td></tr>
|
|
<tr class="memdesc:a2bc5dbf7c13e6031fb9892075755a023"><td class="mdescLeft"> </td><td class="mdescRight">Get number of milliseconds since start. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a2bc5dbf7c13e6031fb9892075755a023">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bc5dbf7c13e6031fb9892075755a023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedf55424bc4aa28379b6f4f6b04151d3"><td class="memItemLeft" align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">micros</a> ()=0</td></tr>
|
|
<tr class="memdesc:aedf55424bc4aa28379b6f4f6b04151d3"><td class="mdescLeft"> </td><td class="mdescRight">Get number of microseconds since start. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#aedf55424bc4aa28379b6f4f6b04151d3">More...</a><br /></td></tr>
|
|
<tr class="separator:aedf55424bc4aa28379b6f4f6b04151d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35a6ef1b38553a3516c961872eb411d7"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">pulseIn</a> (uint32_t pin, uint32_t state, unsigned long timeout)=0</td></tr>
|
|
<tr class="memdesc:a35a6ef1b38553a3516c961872eb411d7"><td class="mdescLeft"> </td><td class="mdescRight">Measure the length of incoming digital pulse in microseconds. Must be implemented by the platform-specific hardware abstraction! <a href="class_radio_lib_hal.html#a35a6ef1b38553a3516c961872eb411d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a35a6ef1b38553a3516c961872eb411d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1f8e5cd323e53ef9fa977734a05d030"><td class="memItemLeft" align="right" valign="top"><a id="aa1f8e5cd323e53ef9fa977734a05d030"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">spiBegin</a> ()=0</td></tr>
|
|
<tr class="memdesc:aa1f8e5cd323e53ef9fa977734a05d030"><td class="mdescLeft"> </td><td class="mdescRight">SPI initialization method. <br /></td></tr>
|
|
<tr class="separator:aa1f8e5cd323e53ef9fa977734a05d030"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe787d5e556190eef2c63e1581235460"><td class="memItemLeft" align="right" valign="top"><a id="abe787d5e556190eef2c63e1581235460"></a>
|
|
virtual void </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"> </td><td class="mdescRight">Method to start SPI transaction. <br /></td></tr>
|
|
<tr class="separator:abe787d5e556190eef2c63e1581235460"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebcaaf0cefdaaf5b572d4261e472ac8a"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </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"> </td></tr>
|
|
<tr class="memitem:a68d9271c76f8c96afb734a4634bf92e9"><td class="memItemLeft" align="right" valign="top"><a id="a68d9271c76f8c96afb734a4634bf92e9"></a>
|
|
virtual void </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"> </td><td class="mdescRight">Method to end SPI transaction. <br /></td></tr>
|
|
<tr class="separator:a68d9271c76f8c96afb734a4634bf92e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41c85e560155d644f5b4ce8444dd8b64"><td class="memItemLeft" align="right" valign="top"><a id="a41c85e560155d644f5b4ce8444dd8b64"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">spiEnd</a> ()=0</td></tr>
|
|
<tr class="memdesc:a41c85e560155d644f5b4ce8444dd8b64"><td class="mdescLeft"> </td><td class="mdescRight">SPI termination method. <br /></td></tr>
|
|
<tr class="separator:a41c85e560155d644f5b4ce8444dd8b64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a450037acdfeb4e87413674ac90feb4d2"><td class="memItemLeft" align="right" valign="top"><a id="a450037acdfeb4e87413674ac90feb4d2"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">init</a> ()</td></tr>
|
|
<tr class="memdesc:a450037acdfeb4e87413674ac90feb4d2"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> initialization method. This will be called by all radio modules at the beginning of startup. Can be used to e.g., initialize SPI interface. <br /></td></tr>
|
|
<tr class="separator:a450037acdfeb4e87413674ac90feb4d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4f2bd49aea5a19aa9f85c720b4a883e"><td class="memItemLeft" align="right" valign="top"><a id="aa4f2bd49aea5a19aa9f85c720b4a883e"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">term</a> ()</td></tr>
|
|
<tr class="memdesc:aa4f2bd49aea5a19aa9f85c720b4a883e"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> termination method. This will be called by all radio modules when the destructor is called. Can be used to e.g., stop SPI interface. <br /></td></tr>
|
|
<tr class="separator:aa4f2bd49aea5a19aa9f85c720b4a883e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4cc3bef7109f00b77b95e84511b0bb9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">tone</a> (uint32_t pin, unsigned int frequency, unsigned long duration=0)</td></tr>
|
|
<tr class="memdesc:ab4cc3bef7109f00b77b95e84511b0bb9"><td class="mdescLeft"> </td><td class="mdescRight">Method to produce a square-wave with 50% duty cycle ("tone") of a given frequency at some pin. <a href="class_radio_lib_hal.html#ab4cc3bef7109f00b77b95e84511b0bb9">More...</a><br /></td></tr>
|
|
<tr class="separator:ab4cc3bef7109f00b77b95e84511b0bb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b5341c59728a1932e33216feee04ea5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">noTone</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a6b5341c59728a1932e33216feee04ea5"><td class="mdescLeft"> </td><td class="mdescRight">Method to stop producing a tone. <a href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b5341c59728a1932e33216feee04ea5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bd9d614f66b374ec820ce31b167fdb2"><td class="memItemLeft" align="right" valign="top"><a id="a1bd9d614f66b374ec820ce31b167fdb2"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">yield</a> ()</td></tr>
|
|
<tr class="memdesc:a1bd9d614f66b374ec820ce31b167fdb2"><td class="mdescLeft"> </td><td class="mdescRight">Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads). <br /></td></tr>
|
|
<tr class="separator:a1bd9d614f66b374ec820ce31b167fdb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a300a47d4d43dbe0c624f6e5dc1cf7a00"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">pinToInterrupt</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a300a47d4d43dbe0c624f6e5dc1cf7a00"><td class="mdescLeft"> </td><td class="mdescRight">Function to convert from pin number to interrupt number. <a href="class_radio_lib_hal.html#a300a47d4d43dbe0c624f6e5dc1cf7a00">More...</a><br /></td></tr>
|
|
<tr class="separator:a300a47d4d43dbe0c624f6e5dc1cf7a00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a467356d0f1b097733da5ba99884cf354"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a467356d0f1b097733da5ba99884cf354">readPersistentStorage</a> (uint32_t addr, uint8_t *buff, size_t len)</td></tr>
|
|
<tr class="memdesc:a467356d0f1b097733da5ba99884cf354"><td class="mdescLeft"> </td><td class="mdescRight">Method to read from persistent storage (e.g. EEPROM). <a href="class_radio_lib_hal.html#a467356d0f1b097733da5ba99884cf354">More...</a><br /></td></tr>
|
|
<tr class="separator:a467356d0f1b097733da5ba99884cf354"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85cb796531c85215fa20f54754f6b4f3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a85cb796531c85215fa20f54754f6b4f3">writePersistentStorage</a> (uint32_t addr, uint8_t *buff, size_t len)</td></tr>
|
|
<tr class="memdesc:a85cb796531c85215fa20f54754f6b4f3"><td class="mdescLeft"> </td><td class="mdescRight">Method to write to persistent storage (e.g. EEPROM). <a href="class_radio_lib_hal.html#a85cb796531c85215fa20f54754f6b4f3">More...</a><br /></td></tr>
|
|
<tr class="separator:a85cb796531c85215fa20f54754f6b4f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9d93c46d699b8ece64ec9afe4d3ad71"><td class="memItemLeft" align="right" valign="top"><a id="ac9d93c46d699b8ece64ec9afe4d3ad71"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#ac9d93c46d699b8ece64ec9afe4d3ad71">wipePersistentStorage</a> ()</td></tr>
|
|
<tr class="memdesc:ac9d93c46d699b8ece64ec9afe4d3ad71"><td class="mdescLeft"> </td><td class="mdescRight">Method to wipe the persistent storage by writing to 0. Will write at most RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE bytes. <br /></td></tr>
|
|
<tr class="separator:ac9d93c46d699b8ece64ec9afe4d3ad71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8bda4b34a69c2738eb0b43a59b86f0d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#ae8bda4b34a69c2738eb0b43a59b86f0d">getPersistentAddr</a> (uint32_t id)</td></tr>
|
|
<tr class="memdesc:ae8bda4b34a69c2738eb0b43a59b86f0d"><td class="mdescLeft"> </td><td class="mdescRight">Method to convert from persistent parameter ID to its physical address. <a href="class_radio_lib_hal.html#ae8bda4b34a69c2738eb0b43a59b86f0d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8bda4b34a69c2738eb0b43a59b86f0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33d918e9e01c069e7d7bb64dbfcad478"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a33d918e9e01c069e7d7bb64dbfcad478"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a33d918e9e01c069e7d7bb64dbfcad478">setPersistentParameter</a> (uint32_t id, T val)</td></tr>
|
|
<tr class="memdesc:a33d918e9e01c069e7d7bb64dbfcad478"><td class="mdescLeft"> </td><td class="mdescRight">Method to set arbitrary parameter to persistent storage. This method DOES NOT perform any endianness conversion, so the value will be stored in the system endian! <a href="class_radio_lib_hal.html#a33d918e9e01c069e7d7bb64dbfcad478">More...</a><br /></td></tr>
|
|
<tr class="separator:a33d918e9e01c069e7d7bb64dbfcad478"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a216a59fbd4c022a3410a4b1e42059dbe"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a216a59fbd4c022a3410a4b1e42059dbe"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a216a59fbd4c022a3410a4b1e42059dbe">getPersistentParameter</a> (uint32_t id)</td></tr>
|
|
<tr class="memdesc:a216a59fbd4c022a3410a4b1e42059dbe"><td class="mdescLeft"> </td><td class="mdescRight">Method to get arbitrary parameter from persistent storage. This method DOES NOT perform any endianness conversion, so the value will be retrieved in the system endian! <a href="class_radio_lib_hal.html#a216a59fbd4c022a3410a4b1e42059dbe">More...</a><br /></td></tr>
|
|
<tr class="separator:a216a59fbd4c022a3410a4b1e42059dbe"><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:a2d197fc1f62be4cd2d2c22be30744769"><td class="memItemLeft" align="right" valign="top"><a id="a2d197fc1f62be4cd2d2c22be30744769"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a2d197fc1f62be4cd2d2c22be30744769">GpioModeInput</a></td></tr>
|
|
<tr class="memdesc:a2d197fc1f62be4cd2d2c22be30744769"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "input" GPIO direction. <br /></td></tr>
|
|
<tr class="separator:a2d197fc1f62be4cd2d2c22be30744769"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18a711dd900a796ccfd7dddbdd2e6afe"><td class="memItemLeft" align="right" valign="top"><a id="a18a711dd900a796ccfd7dddbdd2e6afe"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a18a711dd900a796ccfd7dddbdd2e6afe">GpioModeOutput</a></td></tr>
|
|
<tr class="memdesc:a18a711dd900a796ccfd7dddbdd2e6afe"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "output" GPIO direction. <br /></td></tr>
|
|
<tr class="separator:a18a711dd900a796ccfd7dddbdd2e6afe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cfca7ff9303fe84119ba2f4a4e1bbf4"><td class="memItemLeft" align="right" valign="top"><a id="a3cfca7ff9303fe84119ba2f4a4e1bbf4"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a3cfca7ff9303fe84119ba2f4a4e1bbf4">GpioLevelLow</a></td></tr>
|
|
<tr class="memdesc:a3cfca7ff9303fe84119ba2f4a4e1bbf4"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "low" GPIO level. <br /></td></tr>
|
|
<tr class="separator:a3cfca7ff9303fe84119ba2f4a4e1bbf4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a409c719ef8a11e8765c90e98ba42316d"><td class="memItemLeft" align="right" valign="top"><a id="a409c719ef8a11e8765c90e98ba42316d"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a409c719ef8a11e8765c90e98ba42316d">GpioLevelHigh</a></td></tr>
|
|
<tr class="memdesc:a409c719ef8a11e8765c90e98ba42316d"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "high" GPIO level. <br /></td></tr>
|
|
<tr class="separator:a409c719ef8a11e8765c90e98ba42316d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ff9f3c608d68575dfc8962ba3669851"><td class="memItemLeft" align="right" valign="top"><a id="a7ff9f3c608d68575dfc8962ba3669851"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a7ff9f3c608d68575dfc8962ba3669851">GpioInterruptRising</a></td></tr>
|
|
<tr class="memdesc:a7ff9f3c608d68575dfc8962ba3669851"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "rising" GPIO level change direction. <br /></td></tr>
|
|
<tr class="separator:a7ff9f3c608d68575dfc8962ba3669851"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01f73b66a632fc9dba41a23f592e0936"><td class="memItemLeft" align="right" valign="top"><a id="a01f73b66a632fc9dba41a23f592e0936"></a>
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a01f73b66a632fc9dba41a23f592e0936">GpioInterruptFalling</a></td></tr>
|
|
<tr class="memdesc:a01f73b66a632fc9dba41a23f592e0936"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "falling" GPIO level change direction. <br /></td></tr>
|
|
<tr class="separator:a01f73b66a632fc9dba41a23f592e0936"><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><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ae75a54271cb8bea37d32dd146b9c6513"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae75a54271cb8bea37d32dd146b9c6513">◆ </a></span>RadioLibHal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RadioLibHal::RadioLibHal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>input</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>output</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>low</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>high</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>rising</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>falling</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">input</td><td>Value to be used as the "input" GPIO direction. </td></tr>
|
|
<tr><td class="paramname">output</td><td>Value to be used as the "output" GPIO direction. </td></tr>
|
|
<tr><td class="paramname">low</td><td>Value to be used as the "low" GPIO level. </td></tr>
|
|
<tr><td class="paramname">high</td><td>Value to be used as the "high" GPIO level. </td></tr>
|
|
<tr><td class="paramname">rising</td><td>Value to be used as the "rising" GPIO level change direction. </td></tr>
|
|
<tr><td class="paramname">falling</td><td>Value to be used as the "falling" GPIO level change direction. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="af142f747becacd1e3e13503f79fd5ebe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af142f747becacd1e3e13503f79fd5ebe">◆ </a></span>attachInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::attachInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>interruptCb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to attach function to an external interrupt. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">interruptNum</td><td>Interrupt number to attach to (platform-specific). </td></tr>
|
|
<tr><td class="paramname">interruptCb</td><td>Interrupt service routine to execute. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>Rising/falling mode (platform-specific). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8427720749d8c87d17654071dfa5b94e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8427720749d8c87d17654071dfa5b94e">◆ </a></span>delay()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::delay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"><em>ms</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking wait function. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ms</td><td>Number of milliseconds to wait. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad49128a75a3d7abdc68baa302955f3ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad49128a75a3d7abdc68baa302955f3ac">◆ </a></span>delayMicroseconds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::delayMicroseconds </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"><em>us</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">us</td><td>Number of microseconds to wait. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ddf72a41b3cfbb63ea7ab5362003b56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ddf72a41b3cfbb63ea7ab5362003b56">◆ </a></span>detachInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::detachInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptNum</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to detach function from an external interrupt. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">interruptNum</td><td>Interrupt number to detach from (platform-specific). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c7c2dffd662cefca7bf11e14c56dab2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c7c2dffd662cefca7bf11e14c56dab2">◆ </a></span>digitalRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint32_t RadioLibHal::digitalRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Digital read method. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Value read on the pin (platform-specific). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4db0c60f2f6f64003f04cf0e03fea7ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4db0c60f2f6f64003f04cf0e03fea7ab">◆ </a></span>digitalWrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::digitalWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Digital write method. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
|
|
<tr><td class="paramname">value</td><td>Value to set (platform-specific). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae8bda4b34a69c2738eb0b43a59b86f0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8bda4b34a69c2738eb0b43a59b86f0d">◆ </a></span>getPersistentAddr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t RadioLibHal::getPersistentAddr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to convert from persistent parameter ID to its physical address. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Parameter ID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Parameter physical address. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a216a59fbd4c022a3410a4b1e42059dbe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a216a59fbd4c022a3410a4b1e42059dbe">◆ </a></span>getPersistentParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">template uint32_t RadioLibHal::getPersistentParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to get arbitrary parameter from persistent storage. This method DOES NOT perform any endianness conversion, so the value will be retrieved in the system endian! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Parameter ID to load from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The loaded value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aedf55424bc4aa28379b6f4f6b04151d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aedf55424bc4aa28379b6f4f6b04151d3">◆ </a></span>micros()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned long RadioLibHal::micros </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number of microseconds since start. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of microseconds since start. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bc5dbf7c13e6031fb9892075755a023"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bc5dbf7c13e6031fb9892075755a023">◆ </a></span>millis()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned long RadioLibHal::millis </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number of milliseconds since start. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of milliseconds since start. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b5341c59728a1932e33216feee04ea5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b5341c59728a1932e33216feee04ea5">◆ </a></span>noTone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibHal::noTone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to stop producing a tone. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin which is currently producing the tone. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af01b4e5e01352b99ce4329c9f9f8433b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af01b4e5e01352b99ce4329c9f9f8433b">◆ </a></span>pinMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::pinMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to be changed (platform-specific). </td></tr>
|
|
<tr><td class="paramname">mode</td><td>Mode to be set (platform-specific). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a300a47d4d43dbe0c624f6e5dc1cf7a00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a300a47d4d43dbe0c624f6e5dc1cf7a00">◆ </a></span>pinToInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t RadioLibHal::pinToInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to convert from pin number to interrupt number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to convert from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The interrupt number of a given pin. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35a6ef1b38553a3516c961872eb411d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35a6ef1b38553a3516c961872eb411d7">◆ </a></span>pulseIn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual long RadioLibHal::pulseIn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Measure the length of incoming digital pulse in microseconds. Must be implemented by the platform-specific hardware abstraction! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to measure on (platform-specific). </td></tr>
|
|
<tr><td class="paramname">state</td><td>Pin level to monitor (platform-specific). </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Timeout in microseconds. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pulse length in microseconds, or 0 if the pulse did not start before timeout. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a467356d0f1b097733da5ba99884cf354"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a467356d0f1b097733da5ba99884cf354">◆ </a></span>readPersistentStorage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibHal::readPersistentStorage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to read from persistent storage (e.g. EEPROM). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">addr</td><td>Address to start reading at. </td></tr>
|
|
<tr><td class="paramname">buff</td><td>Buffer to read into. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33d918e9e01c069e7d7bb64dbfcad478"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33d918e9e01c069e7d7bb64dbfcad478">◆ </a></span>setPersistentParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">template void RadioLibHal::setPersistentParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to set arbitrary parameter to persistent storage. This method DOES NOT perform any endianness conversion, so the value will be stored in the system endian! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Parameter ID to save at. </td></tr>
|
|
<tr><td class="paramname">val</td><td>Value to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebcaaf0cefdaaf5b572d4261e472ac8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebcaaf0cefdaaf5b572d4261e472ac8a">◆ </a></span>spiTransfer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void RadioLibHal::spiTransfer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>in</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to transfer buffer over SPI. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4cc3bef7109f00b77b95e84511b0bb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4cc3bef7109f00b77b95e84511b0bb9">◆ </a></span>tone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibHal::tone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>frequency</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long </td>
|
|
<td class="paramname"><em>duration</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to produce a square-wave with 50% duty cycle ("tone") of a given frequency at some pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to be used as the output. </td></tr>
|
|
<tr><td class="paramname">frequency</td><td>Frequency of the square wave. </td></tr>
|
|
<tr><td class="paramname">duration</td><td>Duration of the tone in ms. When set to 0, the tone will be infinite. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85cb796531c85215fa20f54754f6b4f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85cb796531c85215fa20f54754f6b4f3">◆ </a></span>writePersistentStorage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RadioLibHal::writePersistentStorage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to write to persistent storage (e.g. EEPROM). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">addr</td><td>Address to start writing to. </td></tr>
|
|
<tr><td class="paramname">buff</td><td>Buffer to write. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to write. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</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_radio_lib_hal.html">RadioLibHal</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>
|