996 lines
52 KiB
HTML
996 lines
52 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: PiHal 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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_pi_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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_pi_hal-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PiHal Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for PiHal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_pi_hal.png" usemap="#PiHal_map" alt=""/>
|
|
<map id="PiHal_map" name="PiHal_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 id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a418882f00a562f9cb9c69f35e2d02815" id="r_a418882f00a562f9cb9c69f35e2d02815"><td class="memItemLeft" align="right" valign="top"><a id="a418882f00a562f9cb9c69f35e2d02815" name="a418882f00a562f9cb9c69f35e2d02815"></a>
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><b>RadioLibISR</b>) (void)</td></tr>
|
|
<tr class="separator:a418882f00a562f9cb9c69f35e2d02815"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad6a3d4e8b938a7ef12176407b163e5b7" id="r_ad6a3d4e8b938a7ef12176407b163e5b7"><td class="memItemLeft" align="right" valign="top"><a id="ad6a3d4e8b938a7ef12176407b163e5b7" name="ad6a3d4e8b938a7ef12176407b163e5b7"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>PiHal</b> (uint8_t spiChannel, uint32_t spiSpeed=2000000, uint8_t spiDevice=0, uint8_t gpioDevice=0)</td></tr>
|
|
<tr class="separator:ad6a3d4e8b938a7ef12176407b163e5b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78593321f098c53fbac81b8d0d423b7f" id="r_a78593321f098c53fbac81b8d0d423b7f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a78593321f098c53fbac81b8d0d423b7f">init</a> () override</td></tr>
|
|
<tr class="memdesc:a78593321f098c53fbac81b8d0d423b7f"><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:a78593321f098c53fbac81b8d0d423b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5821694030ae6364012be3a34ef584d" id="r_ae5821694030ae6364012be3a34ef584d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#ae5821694030ae6364012be3a34ef584d">term</a> () override</td></tr>
|
|
<tr class="memdesc:ae5821694030ae6364012be3a34ef584d"><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:ae5821694030ae6364012be3a34ef584d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2986ed862d4c429d6527bd54e472530" id="r_ad2986ed862d4c429d6527bd54e472530"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#ad2986ed862d4c429d6527bd54e472530">pinMode</a> (uint32_t pin, uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:ad2986ed862d4c429d6527bd54e472530"><td class="mdescLeft"> </td><td class="mdescRight">GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:ad2986ed862d4c429d6527bd54e472530"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a203ed127ad16bbeeba0a3cd536eebce6" id="r_a203ed127ad16bbeeba0a3cd536eebce6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a203ed127ad16bbeeba0a3cd536eebce6">digitalWrite</a> (uint32_t pin, uint32_t value) override</td></tr>
|
|
<tr class="memdesc:a203ed127ad16bbeeba0a3cd536eebce6"><td class="mdescLeft"> </td><td class="mdescRight">Digital write method. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:a203ed127ad16bbeeba0a3cd536eebce6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9a8fc4f0c7c5190db9d8770bc7d635e" id="r_ab9a8fc4f0c7c5190db9d8770bc7d635e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#ab9a8fc4f0c7c5190db9d8770bc7d635e">digitalRead</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:ab9a8fc4f0c7c5190db9d8770bc7d635e"><td class="mdescLeft"> </td><td class="mdescRight">Digital read method. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:ab9a8fc4f0c7c5190db9d8770bc7d635e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcd33b2d926e14d98ead593e3cded31f" id="r_abcd33b2d926e14d98ead593e3cded31f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#abcd33b2d926e14d98ead593e3cded31f">attachInterrupt</a> (uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:abcd33b2d926e14d98ead593e3cded31f"><td class="mdescLeft"> </td><td class="mdescRight">Method to attach function to an external interrupt. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:abcd33b2d926e14d98ead593e3cded31f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb13f79080b95925ea61576696abaa63" id="r_afb13f79080b95925ea61576696abaa63"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#afb13f79080b95925ea61576696abaa63">detachInterrupt</a> (uint32_t interruptNum) override</td></tr>
|
|
<tr class="memdesc:afb13f79080b95925ea61576696abaa63"><td class="mdescLeft"> </td><td class="mdescRight">Method to detach function from an external interrupt. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:afb13f79080b95925ea61576696abaa63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf1482ac38f67d58e4d41e3e74323e5a" id="r_adf1482ac38f67d58e4d41e3e74323e5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#adf1482ac38f67d58e4d41e3e74323e5a">delay</a> (unsigned long ms) override</td></tr>
|
|
<tr class="memdesc:adf1482ac38f67d58e4d41e3e74323e5a"><td class="mdescLeft"> </td><td class="mdescRight">Blocking wait function. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:adf1482ac38f67d58e4d41e3e74323e5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9ade61749459b508291d81e205ddacf" id="r_ab9ade61749459b508291d81e205ddacf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#ab9ade61749459b508291d81e205ddacf">delayMicroseconds</a> (unsigned long us) override</td></tr>
|
|
<tr class="memdesc:ab9ade61749459b508291d81e205ddacf"><td class="mdescLeft"> </td><td class="mdescRight">Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:ab9ade61749459b508291d81e205ddacf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0aca7bc69d8b31783656213e8a8873d" id="r_af0aca7bc69d8b31783656213e8a8873d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#af0aca7bc69d8b31783656213e8a8873d">yield</a> () override</td></tr>
|
|
<tr class="memdesc:af0aca7bc69d8b31783656213e8a8873d"><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:af0aca7bc69d8b31783656213e8a8873d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a162b953dbc7bb96be6d7ec037c4d465e" id="r_a162b953dbc7bb96be6d7ec037c4d465e"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a162b953dbc7bb96be6d7ec037c4d465e">millis</a> () override</td></tr>
|
|
<tr class="memdesc:a162b953dbc7bb96be6d7ec037c4d465e"><td class="mdescLeft"> </td><td class="mdescRight">Get number of milliseconds since start. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:a162b953dbc7bb96be6d7ec037c4d465e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99893a968bd5789511154b559f349e60" id="r_a99893a968bd5789511154b559f349e60"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a99893a968bd5789511154b559f349e60">micros</a> () override</td></tr>
|
|
<tr class="memdesc:a99893a968bd5789511154b559f349e60"><td class="mdescLeft"> </td><td class="mdescRight">Get number of microseconds since start. Must be implemented by the platform-specific hardware abstraction! <br /></td></tr>
|
|
<tr class="separator:a99893a968bd5789511154b559f349e60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3350f8cc20008dbe69e7180599fb80ee" id="r_a3350f8cc20008dbe69e7180599fb80ee"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a3350f8cc20008dbe69e7180599fb80ee">pulseIn</a> (uint32_t pin, uint32_t state, unsigned long timeout) override</td></tr>
|
|
<tr class="memdesc:a3350f8cc20008dbe69e7180599fb80ee"><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! <br /></td></tr>
|
|
<tr class="separator:a3350f8cc20008dbe69e7180599fb80ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40d237c2f5f4ead26c39f33481b4d7e3" id="r_a40d237c2f5f4ead26c39f33481b4d7e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a40d237c2f5f4ead26c39f33481b4d7e3">spiBegin</a> ()</td></tr>
|
|
<tr class="memdesc:a40d237c2f5f4ead26c39f33481b4d7e3"><td class="mdescLeft"> </td><td class="mdescRight">SPI initialization method. <br /></td></tr>
|
|
<tr class="separator:a40d237c2f5f4ead26c39f33481b4d7e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8c97e2b1c42368793d48d08b815fd69" id="r_ab8c97e2b1c42368793d48d08b815fd69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#ab8c97e2b1c42368793d48d08b815fd69">spiBeginTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:ab8c97e2b1c42368793d48d08b815fd69"><td class="mdescLeft"> </td><td class="mdescRight">Method to start SPI transaction. <br /></td></tr>
|
|
<tr class="separator:ab8c97e2b1c42368793d48d08b815fd69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96a0f36efd8e23893add3242bdef8be4" id="r_a96a0f36efd8e23893add3242bdef8be4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a96a0f36efd8e23893add3242bdef8be4">spiTransfer</a> (uint8_t *out, size_t len, uint8_t *in)</td></tr>
|
|
<tr class="memdesc:a96a0f36efd8e23893add3242bdef8be4"><td class="mdescLeft"> </td><td class="mdescRight">Method to transfer buffer over SPI. <br /></td></tr>
|
|
<tr class="separator:a96a0f36efd8e23893add3242bdef8be4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7debfa73095e727950831af2e8aab5f7" id="r_a7debfa73095e727950831af2e8aab5f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a7debfa73095e727950831af2e8aab5f7">spiEndTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:a7debfa73095e727950831af2e8aab5f7"><td class="mdescLeft"> </td><td class="mdescRight">Method to end SPI transaction. <br /></td></tr>
|
|
<tr class="separator:a7debfa73095e727950831af2e8aab5f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b0d64ed834b91f67b3344ce8c573d7b" id="r_a6b0d64ed834b91f67b3344ce8c573d7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a6b0d64ed834b91f67b3344ce8c573d7b">spiEnd</a> ()</td></tr>
|
|
<tr class="memdesc:a6b0d64ed834b91f67b3344ce8c573d7b"><td class="mdescLeft"> </td><td class="mdescRight">SPI termination method. <br /></td></tr>
|
|
<tr class="separator:a6b0d64ed834b91f67b3344ce8c573d7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95856f347434694b018d0ad18126e041" id="r_a95856f347434694b018d0ad18126e041"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a95856f347434694b018d0ad18126e041">tone</a> (uint32_t pin, unsigned int frequency, unsigned long duration=0)</td></tr>
|
|
<tr class="memdesc:a95856f347434694b018d0ad18126e041"><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. <br /></td></tr>
|
|
<tr class="separator:a95856f347434694b018d0ad18126e041"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06ee4519e6226013798e03f303fe3941" id="r_a06ee4519e6226013798e03f303fe3941"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pi_hal.html#a06ee4519e6226013798e03f303fe3941">noTone</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a06ee4519e6226013798e03f303fe3941"><td class="mdescLeft"> </td><td class="mdescRight">Method to stop producing a tone. <br /></td></tr>
|
|
<tr class="separator:a06ee4519e6226013798e03f303fe3941"><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" id="r_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 inherit pub_methods_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:ae75a54271cb8bea37d32dd146b9c6513 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" id="r_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 inherit pub_methods_class_radio_lib_hal"><td class="mdescLeft"> </td><td class="mdescRight">Function to convert from pin number to interrupt number. <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 id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ae741a33f83a857176c2be1e07081da34" id="r_ae741a33f83a857176c2be1e07081da34"><td class="memItemLeft" align="right" valign="top"><a id="ae741a33f83a857176c2be1e07081da34" name="ae741a33f83a857176c2be1e07081da34"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>interruptEnabled</b> [PI_MAX_USER_GPIO+1]</td></tr>
|
|
<tr class="separator:ae741a33f83a857176c2be1e07081da34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ed40fd4ef2890af172ad7ae1263b9db" id="r_a3ed40fd4ef2890af172ad7ae1263b9db"><td class="memItemLeft" align="right" valign="top"><a id="a3ed40fd4ef2890af172ad7ae1263b9db" name="a3ed40fd4ef2890af172ad7ae1263b9db"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>interruptModes</b> [PI_MAX_USER_GPIO+1]</td></tr>
|
|
<tr class="separator:a3ed40fd4ef2890af172ad7ae1263b9db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc9c9132975470401efc003ea62d5791" id="r_afc9c9132975470401efc003ea62d5791"><td class="memItemLeft" align="right" valign="top"><a id="afc9c9132975470401efc003ea62d5791" name="afc9c9132975470401efc003ea62d5791"></a>
|
|
RadioLibISR </td><td class="memItemRight" valign="bottom"><b>interruptCallbacks</b> [PI_MAX_USER_GPIO+1]</td></tr>
|
|
<tr class="separator:afc9c9132975470401efc003ea62d5791"><td class="memSeparator" colspan="2"> </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" id="r_a2d197fc1f62be4cd2d2c22be30744769"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioModeInput</b></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" id="r_a18a711dd900a796ccfd7dddbdd2e6afe"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioModeOutput</b></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" id="r_a3cfca7ff9303fe84119ba2f4a4e1bbf4"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioLevelLow</b></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" id="r_a409c719ef8a11e8765c90e98ba42316d"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioLevelHigh</b></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" id="r_a7ff9f3c608d68575dfc8962ba3669851"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioInterruptRising</b></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" id="r_a01f73b66a632fc9dba41a23f592e0936"><td class="memItemLeft" align="right" valign="top">
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>GpioInterruptFalling</b></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="abcd33b2d926e14d98ead593e3cded31f" name="abcd33b2d926e14d98ead593e3cded31f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abcd33b2d926e14d98ead593e3cded31f">◆ </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 PiHal::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">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="adf1482ac38f67d58e4d41e3e74323e5a" name="adf1482ac38f67d58e4d41e3e74323e5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf1482ac38f67d58e4d41e3e74323e5a">◆ </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 PiHal::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="ab9ade61749459b508291d81e205ddacf" name="ab9ade61749459b508291d81e205ddacf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9ade61749459b508291d81e205ddacf">◆ </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 PiHal::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="afb13f79080b95925ea61576696abaa63" name="afb13f79080b95925ea61576696abaa63"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb13f79080b95925ea61576696abaa63">◆ </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 PiHal::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="ab9a8fc4f0c7c5190db9d8770bc7d635e" name="ab9a8fc4f0c7c5190db9d8770bc7d635e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9a8fc4f0c7c5190db9d8770bc7d635e">◆ </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 PiHal::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="a203ed127ad16bbeeba0a3cd536eebce6" name="a203ed127ad16bbeeba0a3cd536eebce6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a203ed127ad16bbeeba0a3cd536eebce6">◆ </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 PiHal::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="a78593321f098c53fbac81b8d0d423b7f" name="a78593321f098c53fbac81b8d0d423b7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78593321f098c53fbac81b8d0d423b7f">◆ </a></span>init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::init </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><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. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_radio_lib_hal.html#a450037acdfeb4e87413674ac90feb4d2">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99893a968bd5789511154b559f349e60" name="a99893a968bd5789511154b559f349e60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99893a968bd5789511154b559f349e60">◆ </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 PiHal::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="a162b953dbc7bb96be6d7ec037c4d465e" name="a162b953dbc7bb96be6d7ec037c4d465e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a162b953dbc7bb96be6d7ec037c4d465e">◆ </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 PiHal::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="a06ee4519e6226013798e03f303fe3941" name="a06ee4519e6226013798e03f303fe3941"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06ee4519e6226013798e03f303fe3941">◆ </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 PiHal::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">inline</span><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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_radio_lib_hal.html#a6b5341c59728a1932e33216feee04ea5">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2986ed862d4c429d6527bd54e472530" name="ad2986ed862d4c429d6527bd54e472530"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2986ed862d4c429d6527bd54e472530">◆ </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 PiHal::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="a3350f8cc20008dbe69e7180599fb80ee" name="a3350f8cc20008dbe69e7180599fb80ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3350f8cc20008dbe69e7180599fb80ee">◆ </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 PiHal::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="a40d237c2f5f4ead26c39f33481b4d7e3" name="a40d237c2f5f4ead26c39f33481b4d7e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40d237c2f5f4ead26c39f33481b4d7e3">◆ </a></span>spiBegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::spiBegin </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI initialization method. </p>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#aa1f8e5cd323e53ef9fa977734a05d030">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8c97e2b1c42368793d48d08b815fd69" name="ab8c97e2b1c42368793d48d08b815fd69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8c97e2b1c42368793d48d08b815fd69">◆ </a></span>spiBeginTransaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::spiBeginTransaction </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to start SPI transaction. </p>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#abe787d5e556190eef2c63e1581235460">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b0d64ed834b91f67b3344ce8c573d7b" name="a6b0d64ed834b91f67b3344ce8c573d7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b0d64ed834b91f67b3344ce8c573d7b">◆ </a></span>spiEnd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::spiEnd </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI termination method. </p>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a41c85e560155d644f5b4ce8444dd8b64">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7debfa73095e727950831af2e8aab5f7" name="a7debfa73095e727950831af2e8aab5f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7debfa73095e727950831af2e8aab5f7">◆ </a></span>spiEndTransaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::spiEndTransaction </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to end SPI transaction. </p>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_hal.html#a68d9271c76f8c96afb734a4634bf92e9">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96a0f36efd8e23893add3242bdef8be4" name="a96a0f36efd8e23893add3242bdef8be4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96a0f36efd8e23893add3242bdef8be4">◆ </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 PiHal::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>
|
|
<a id="ae5821694030ae6364012be3a34ef584d" name="ae5821694030ae6364012be3a34ef584d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5821694030ae6364012be3a34ef584d">◆ </a></span>term()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::term </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><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. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_radio_lib_hal.html#aa4f2bd49aea5a19aa9f85c720b4a883e">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95856f347434694b018d0ad18126e041" name="a95856f347434694b018d0ad18126e041"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95856f347434694b018d0ad18126e041">◆ </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 PiHal::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">inline</span><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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_radio_lib_hal.html#a62c9032e834ba420d81dc3e69df64e17">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0aca7bc69d8b31783656213e8a8873d" name="af0aca7bc69d8b31783656213e8a8873d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0aca7bc69d8b31783656213e8a8873d">◆ </a></span>yield()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PiHal::yield </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>Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads). </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_radio_lib_hal.html#a1bd9d614f66b374ec820ce31b167fdb2">RadioLibHal</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/hal/RPi/<a class="el" href="_pi_hal_8h_source.html">PiHal.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_pi_hal.html">PiHal</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.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|