683 lines
41 KiB
HTML
683 lines
41 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: TockHal 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_tock_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="class_tock_hal-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">TockHal Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for TockHal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_tock_hal.png" usemap="#TockHal_map" alt=""/>
|
|
<map id="TockHal_map" name="TockHal_map">
|
|
<area href="class_radio_lib_hal.html" title="Hardware abstraction library base interface." alt="RadioLibHal" shape="rect" coords="0,0,80,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a9ee8dae5dc2a8cc09b73c35f39e49b7d"><td class="memItemLeft" align="right" valign="top"><a id="a9ee8dae5dc2a8cc09b73c35f39e49b7d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a9ee8dae5dc2a8cc09b73c35f39e49b7d">init</a> () override</td></tr>
|
|
<tr class="memdesc:a9ee8dae5dc2a8cc09b73c35f39e49b7d"><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:a9ee8dae5dc2a8cc09b73c35f39e49b7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42dcea862b480024119c2730270d8f1e"><td class="memItemLeft" align="right" valign="top"><a id="a42dcea862b480024119c2730270d8f1e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a42dcea862b480024119c2730270d8f1e">term</a> () override</td></tr>
|
|
<tr class="memdesc:a42dcea862b480024119c2730270d8f1e"><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:a42dcea862b480024119c2730270d8f1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade8ecf3f37cc3c6ce5eda9b523ffb912"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#ade8ecf3f37cc3c6ce5eda9b523ffb912">pinMode</a> (uint32_t pin, uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:ade8ecf3f37cc3c6ce5eda9b523ffb912"><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_tock_hal.html#ade8ecf3f37cc3c6ce5eda9b523ffb912">More...</a><br /></td></tr>
|
|
<tr class="separator:ade8ecf3f37cc3c6ce5eda9b523ffb912"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91df06b003b84729730f62480990dcb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a91df06b003b84729730f62480990dcb4">digitalWrite</a> (uint32_t pin, uint32_t value) override</td></tr>
|
|
<tr class="memdesc:a91df06b003b84729730f62480990dcb4"><td class="mdescLeft"> </td><td class="mdescRight">Digital write method. Must be implemented by the platform-specific hardware abstraction! <a href="class_tock_hal.html#a91df06b003b84729730f62480990dcb4">More...</a><br /></td></tr>
|
|
<tr class="separator:a91df06b003b84729730f62480990dcb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c67e4045f67a5c3a7b66630b6668f97"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a2c67e4045f67a5c3a7b66630b6668f97">digitalRead</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:a2c67e4045f67a5c3a7b66630b6668f97"><td class="mdescLeft"> </td><td class="mdescRight">Digital read method. Must be implemented by the platform-specific hardware abstraction! <a href="class_tock_hal.html#a2c67e4045f67a5c3a7b66630b6668f97">More...</a><br /></td></tr>
|
|
<tr class="separator:a2c67e4045f67a5c3a7b66630b6668f97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62f237ff6d0bc28db0e94e39fdbc533a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a62f237ff6d0bc28db0e94e39fdbc533a">attachInterrupt</a> (uint32_t interruptNum, gpioIrqFn interruptCb, uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:a62f237ff6d0bc28db0e94e39fdbc533a"><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_tock_hal.html#a62f237ff6d0bc28db0e94e39fdbc533a">More...</a><br /></td></tr>
|
|
<tr class="separator:a62f237ff6d0bc28db0e94e39fdbc533a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafef4eafff0ded10ad940777a67566f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#aafef4eafff0ded10ad940777a67566f3">detachInterrupt</a> (uint32_t interruptNum) override</td></tr>
|
|
<tr class="memdesc:aafef4eafff0ded10ad940777a67566f3"><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_tock_hal.html#aafef4eafff0ded10ad940777a67566f3">More...</a><br /></td></tr>
|
|
<tr class="separator:aafef4eafff0ded10ad940777a67566f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a895de6b3575c991b8b705fe4cdabc940"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a895de6b3575c991b8b705fe4cdabc940">delay</a> (unsigned long ms) override</td></tr>
|
|
<tr class="memdesc:a895de6b3575c991b8b705fe4cdabc940"><td class="mdescLeft"> </td><td class="mdescRight">Blocking wait function. Must be implemented by the platform-specific hardware abstraction! <a href="class_tock_hal.html#a895de6b3575c991b8b705fe4cdabc940">More...</a><br /></td></tr>
|
|
<tr class="separator:a895de6b3575c991b8b705fe4cdabc940"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac44afeda5a28e83721ba8c16b496c91e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#ac44afeda5a28e83721ba8c16b496c91e">delayMicroseconds</a> (unsigned long us) override</td></tr>
|
|
<tr class="memdesc:ac44afeda5a28e83721ba8c16b496c91e"><td class="mdescLeft"> </td><td class="mdescRight">Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction! <a href="class_tock_hal.html#ac44afeda5a28e83721ba8c16b496c91e">More...</a><br /></td></tr>
|
|
<tr class="separator:ac44afeda5a28e83721ba8c16b496c91e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f5aabd073320fbce5f93ad47caf78f2"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a1f5aabd073320fbce5f93ad47caf78f2">millis</a> () override</td></tr>
|
|
<tr class="memdesc:a1f5aabd073320fbce5f93ad47caf78f2"><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_tock_hal.html#a1f5aabd073320fbce5f93ad47caf78f2">More...</a><br /></td></tr>
|
|
<tr class="separator:a1f5aabd073320fbce5f93ad47caf78f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35d643277c35762e0ce0d66ac3fa28a0"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a35d643277c35762e0ce0d66ac3fa28a0">micros</a> () override</td></tr>
|
|
<tr class="memdesc:a35d643277c35762e0ce0d66ac3fa28a0"><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_tock_hal.html#a35d643277c35762e0ce0d66ac3fa28a0">More...</a><br /></td></tr>
|
|
<tr class="separator:a35d643277c35762e0ce0d66ac3fa28a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a416ee97a17f37cf0e686096050523a28"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a416ee97a17f37cf0e686096050523a28">pulseIn</a> (uint32_t pin, uint32_t state, unsigned long timeout) override</td></tr>
|
|
<tr class="memdesc:a416ee97a17f37cf0e686096050523a28"><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_tock_hal.html#a416ee97a17f37cf0e686096050523a28">More...</a><br /></td></tr>
|
|
<tr class="separator:a416ee97a17f37cf0e686096050523a28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04cc3c2c2c2554812557466ab5c0edc9"><td class="memItemLeft" align="right" valign="top"><a id="a04cc3c2c2c2554812557466ab5c0edc9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a04cc3c2c2c2554812557466ab5c0edc9">spiBegin</a> ()</td></tr>
|
|
<tr class="memdesc:a04cc3c2c2c2554812557466ab5c0edc9"><td class="mdescLeft"> </td><td class="mdescRight">SPI initialization method. <br /></td></tr>
|
|
<tr class="separator:a04cc3c2c2c2554812557466ab5c0edc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89091e5e7ed86cc7320f80e9a01713a6"><td class="memItemLeft" align="right" valign="top"><a id="a89091e5e7ed86cc7320f80e9a01713a6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a89091e5e7ed86cc7320f80e9a01713a6">spiBeginTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:a89091e5e7ed86cc7320f80e9a01713a6"><td class="mdescLeft"> </td><td class="mdescRight">Method to start SPI transaction. <br /></td></tr>
|
|
<tr class="separator:a89091e5e7ed86cc7320f80e9a01713a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55bab852d0b8c31a15050efdc28afe33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a55bab852d0b8c31a15050efdc28afe33">spiTransfer</a> (uint8_t *out, size_t len, uint8_t *in)</td></tr>
|
|
<tr class="memdesc:a55bab852d0b8c31a15050efdc28afe33"><td class="mdescLeft"> </td><td class="mdescRight">Method to transfer buffer over SPI. <a href="class_tock_hal.html#a55bab852d0b8c31a15050efdc28afe33">More...</a><br /></td></tr>
|
|
<tr class="separator:a55bab852d0b8c31a15050efdc28afe33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4cef7494b98e3d0fc0b1788d3f283c4"><td class="memItemLeft" align="right" valign="top"><a id="ae4cef7494b98e3d0fc0b1788d3f283c4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#ae4cef7494b98e3d0fc0b1788d3f283c4">spiEndTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:ae4cef7494b98e3d0fc0b1788d3f283c4"><td class="mdescLeft"> </td><td class="mdescRight">Method to end SPI transaction. <br /></td></tr>
|
|
<tr class="separator:ae4cef7494b98e3d0fc0b1788d3f283c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d4520f65f5c7a7e2e188d32d2c001e2"><td class="memItemLeft" align="right" valign="top"><a id="a1d4520f65f5c7a7e2e188d32d2c001e2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a1d4520f65f5c7a7e2e188d32d2c001e2">spiEnd</a> ()</td></tr>
|
|
<tr class="memdesc:a1d4520f65f5c7a7e2e188d32d2c001e2"><td class="mdescLeft"> </td><td class="mdescRight">SPI termination method. <br /></td></tr>
|
|
<tr class="separator:a1d4520f65f5c7a7e2e188d32d2c001e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a805835621f56279e4f6fa4b5370178d2"><td class="memItemLeft" align="right" valign="top"><a id="a805835621f56279e4f6fa4b5370178d2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tock_hal.html#a805835621f56279e4f6fa4b5370178d2">yield</a> ()</td></tr>
|
|
<tr class="memdesc:a805835621f56279e4f6fa4b5370178d2"><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:a805835621f56279e4f6fa4b5370178d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_radio_lib_hal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_radio_lib_hal')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td></tr>
|
|
<tr class="memitem:ae75a54271cb8bea37d32dd146b9c6513 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62c9032e834ba420d81dc3e69df64e17 inherit pub_methods_class_radio_lib_hal"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_hal.html#a62c9032e834ba420d81dc3e69df64e17">tone</a> (uint32_t pin, unsigned int frequency, <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> duration=0)</td></tr>
|
|
<tr class="memdesc:a62c9032e834ba420d81dc3e69df64e17 inherit pub_methods_class_radio_lib_hal"><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#a62c9032e834ba420d81dc3e69df64e17">More...</a><br /></td></tr>
|
|
<tr class="separator:a62c9032e834ba420d81dc3e69df64e17 inherit pub_methods_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b5341c59728a1932e33216feee04ea5 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a300a47d4d43dbe0c624f6e5dc1cf7a00 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><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 inherit pub_methods_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_attribs_class_radio_lib_hal"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_radio_lib_hal')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_radio_lib_hal.html">RadioLibHal</a></td></tr>
|
|
<tr class="memitem:a2d197fc1f62be4cd2d2c22be30744769 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "input" GPIO direction. <br /></td></tr>
|
|
<tr class="separator:a2d197fc1f62be4cd2d2c22be30744769 inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18a711dd900a796ccfd7dddbdd2e6afe inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "output" GPIO direction. <br /></td></tr>
|
|
<tr class="separator:a18a711dd900a796ccfd7dddbdd2e6afe inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cfca7ff9303fe84119ba2f4a4e1bbf4 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "low" GPIO level. <br /></td></tr>
|
|
<tr class="separator:a3cfca7ff9303fe84119ba2f4a4e1bbf4 inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a409c719ef8a11e8765c90e98ba42316d inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Value to be used as the "high" GPIO level. <br /></td></tr>
|
|
<tr class="separator:a409c719ef8a11e8765c90e98ba42316d inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ff9f3c608d68575dfc8962ba3669851 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01f73b66a632fc9dba41a23f592e0936 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><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 inherit pub_attribs_class_radio_lib_hal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a62f237ff6d0bc28db0e94e39fdbc533a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62f237ff6d0bc28db0e94e39fdbc533a">◆ </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">void TockHal::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">gpioIrqFn </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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#af142f747becacd1e3e13503f79fd5ebe">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a895de6b3575c991b8b705fe4cdabc940"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a895de6b3575c991b8b705fe4cdabc940">◆ </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">void TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#aa2de4fcafad28470f7d46073fa29da79">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac44afeda5a28e83721ba8c16b496c91e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac44afeda5a28e83721ba8c16b496c91e">◆ </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">void TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#ab93dc492291dfe6fc0dd763bee966161">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aafef4eafff0ded10ad940777a67566f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafef4eafff0ded10ad940777a67566f3">◆ </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">void TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a2ddf72a41b3cfbb63ea7ab5362003b56">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c67e4045f67a5c3a7b66630b6668f97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c67e4045f67a5c3a7b66630b6668f97">◆ </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">uint32_t TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a0c7c2dffd662cefca7bf11e14c56dab2">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a91df06b003b84729730f62480990dcb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91df06b003b84729730f62480990dcb4">◆ </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">void TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a4db0c60f2f6f64003f04cf0e03fea7ab">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35d643277c35762e0ce0d66ac3fa28a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35d643277c35762e0ce0d66ac3fa28a0">◆ </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">unsigned long TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a64d98b48668ced5ba1014f272606f370">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f5aabd073320fbce5f93ad47caf78f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f5aabd073320fbce5f93ad47caf78f2">◆ </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">unsigned long TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a4b8e36ccf8fe372c259b963666513d37">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade8ecf3f37cc3c6ce5eda9b523ffb912"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade8ecf3f37cc3c6ce5eda9b523ffb912">◆ </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">void TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#af01b4e5e01352b99ce4329c9f9f8433b">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a416ee97a17f37cf0e686096050523a28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a416ee97a17f37cf0e686096050523a28">◆ </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">long TockHal::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a3f38db9475dcd0967d6dfe240b8695c9">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55bab852d0b8c31a15050efdc28afe33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55bab852d0b8c31a15050efdc28afe33">◆ </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">void TockHal::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">inline</span><span class="mlabel">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>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/hal/Tock/<a class="el" href="libtock_hal_8h_source.html">libtockHal.h</a></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_tock_hal.html">TockHal</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>
|