979 lines
51 KiB
HTML
979 lines
51 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: PicoHal 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_pico_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-methods">Public Member Functions</a> |
|
|
<a href="class_pico_hal-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PicoHal Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for PicoHal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_pico_hal.png" usemap="#PicoHal_map" alt=""/>
|
|
<map id="PicoHal_map" name="PicoHal_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-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aeee113b1e6f90931126fea24b61d1bb2" id="r_aeee113b1e6f90931126fea24b61d1bb2"><td class="memItemLeft" align="right" valign="top"><a id="aeee113b1e6f90931126fea24b61d1bb2" name="aeee113b1e6f90931126fea24b61d1bb2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>PicoHal</b> (spi_inst_t *spiChannel, uint32_t misoPin, uint32_t mosiPin, uint32_t sckPin, uint32_t spiSpeed=500 *1000)</td></tr>
|
|
<tr class="separator:aeee113b1e6f90931126fea24b61d1bb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9eea222b674b9f36c68dfb8db3bbf096" id="r_a9eea222b674b9f36c68dfb8db3bbf096"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a9eea222b674b9f36c68dfb8db3bbf096">init</a> () override</td></tr>
|
|
<tr class="memdesc:a9eea222b674b9f36c68dfb8db3bbf096"><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:a9eea222b674b9f36c68dfb8db3bbf096"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27803b7a0b53dca9fd1c74eadb15755a" id="r_a27803b7a0b53dca9fd1c74eadb15755a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a27803b7a0b53dca9fd1c74eadb15755a">term</a> () override</td></tr>
|
|
<tr class="memdesc:a27803b7a0b53dca9fd1c74eadb15755a"><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:a27803b7a0b53dca9fd1c74eadb15755a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac539134f4517ef79de49832bb86392f2" id="r_ac539134f4517ef79de49832bb86392f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#ac539134f4517ef79de49832bb86392f2">pinMode</a> (uint32_t pin, uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:ac539134f4517ef79de49832bb86392f2"><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:ac539134f4517ef79de49832bb86392f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f5e06e79f6f6b7952243fe3817200b4" id="r_a4f5e06e79f6f6b7952243fe3817200b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a4f5e06e79f6f6b7952243fe3817200b4">digitalWrite</a> (uint32_t pin, uint32_t value) override</td></tr>
|
|
<tr class="memdesc:a4f5e06e79f6f6b7952243fe3817200b4"><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:a4f5e06e79f6f6b7952243fe3817200b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25993f76cf572e1a891b7ecc777721c2" id="r_a25993f76cf572e1a891b7ecc777721c2"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a25993f76cf572e1a891b7ecc777721c2">digitalRead</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:a25993f76cf572e1a891b7ecc777721c2"><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:a25993f76cf572e1a891b7ecc777721c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a960f5c3890a0ee6fd339d93ca9769c62" id="r_a960f5c3890a0ee6fd339d93ca9769c62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a960f5c3890a0ee6fd339d93ca9769c62">attachInterrupt</a> (uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode) override</td></tr>
|
|
<tr class="memdesc:a960f5c3890a0ee6fd339d93ca9769c62"><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:a960f5c3890a0ee6fd339d93ca9769c62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a323d56fc8637f2b005070c7585bfe82e" id="r_a323d56fc8637f2b005070c7585bfe82e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a323d56fc8637f2b005070c7585bfe82e">detachInterrupt</a> (uint32_t interruptNum) override</td></tr>
|
|
<tr class="memdesc:a323d56fc8637f2b005070c7585bfe82e"><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:a323d56fc8637f2b005070c7585bfe82e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bab4dfe568d7107e569e848001e414a" id="r_a1bab4dfe568d7107e569e848001e414a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a1bab4dfe568d7107e569e848001e414a">delay</a> (unsigned long ms) override</td></tr>
|
|
<tr class="memdesc:a1bab4dfe568d7107e569e848001e414a"><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:a1bab4dfe568d7107e569e848001e414a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a69597cf1a071a0fa61d1d292008628" id="r_a4a69597cf1a071a0fa61d1d292008628"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a4a69597cf1a071a0fa61d1d292008628">delayMicroseconds</a> (unsigned long us) override</td></tr>
|
|
<tr class="memdesc:a4a69597cf1a071a0fa61d1d292008628"><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:a4a69597cf1a071a0fa61d1d292008628"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e82e02b4de6d1c192f52fb0ddd1c9c4" id="r_a4e82e02b4de6d1c192f52fb0ddd1c9c4"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a4e82e02b4de6d1c192f52fb0ddd1c9c4">millis</a> () override</td></tr>
|
|
<tr class="memdesc:a4e82e02b4de6d1c192f52fb0ddd1c9c4"><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:a4e82e02b4de6d1c192f52fb0ddd1c9c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eb9710f7b7702c9035833a4f8176038" id="r_a3eb9710f7b7702c9035833a4f8176038"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a3eb9710f7b7702c9035833a4f8176038">micros</a> () override</td></tr>
|
|
<tr class="memdesc:a3eb9710f7b7702c9035833a4f8176038"><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:a3eb9710f7b7702c9035833a4f8176038"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a504806e3adb1a5b9f6784478bae16c10" id="r_a504806e3adb1a5b9f6784478bae16c10"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a504806e3adb1a5b9f6784478bae16c10">pulseIn</a> (uint32_t pin, uint32_t state, unsigned long timeout) override</td></tr>
|
|
<tr class="memdesc:a504806e3adb1a5b9f6784478bae16c10"><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:a504806e3adb1a5b9f6784478bae16c10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abfa0319db88b4c015edf67a9c9b671be" id="r_abfa0319db88b4c015edf67a9c9b671be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#abfa0319db88b4c015edf67a9c9b671be">tone</a> (uint32_t pin, unsigned int frequency, unsigned long duration=0) override</td></tr>
|
|
<tr class="memdesc:abfa0319db88b4c015edf67a9c9b671be"><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:abfa0319db88b4c015edf67a9c9b671be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af80164483ca2bda3a7dd0cc795549524" id="r_af80164483ca2bda3a7dd0cc795549524"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#af80164483ca2bda3a7dd0cc795549524">noTone</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:af80164483ca2bda3a7dd0cc795549524"><td class="mdescLeft"> </td><td class="mdescRight">Method to stop producing a tone. <br /></td></tr>
|
|
<tr class="separator:af80164483ca2bda3a7dd0cc795549524"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a414de51bef859659b8cac66df32bdb5a" id="r_a414de51bef859659b8cac66df32bdb5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a414de51bef859659b8cac66df32bdb5a">spiBegin</a> ()</td></tr>
|
|
<tr class="memdesc:a414de51bef859659b8cac66df32bdb5a"><td class="mdescLeft"> </td><td class="mdescRight">SPI initialization method. <br /></td></tr>
|
|
<tr class="separator:a414de51bef859659b8cac66df32bdb5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b6136b2c90e83c1ab94bd92ef32805c" id="r_a2b6136b2c90e83c1ab94bd92ef32805c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#a2b6136b2c90e83c1ab94bd92ef32805c">spiBeginTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:a2b6136b2c90e83c1ab94bd92ef32805c"><td class="mdescLeft"> </td><td class="mdescRight">Method to start SPI transaction. <br /></td></tr>
|
|
<tr class="separator:a2b6136b2c90e83c1ab94bd92ef32805c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc961bf30af621d0dfec2b3f7e25cf5c" id="r_acc961bf30af621d0dfec2b3f7e25cf5c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#acc961bf30af621d0dfec2b3f7e25cf5c">spiTransfer</a> (uint8_t *out, size_t len, uint8_t *in)</td></tr>
|
|
<tr class="memdesc:acc961bf30af621d0dfec2b3f7e25cf5c"><td class="mdescLeft"> </td><td class="mdescRight">Method to transfer buffer over SPI. <br /></td></tr>
|
|
<tr class="separator:acc961bf30af621d0dfec2b3f7e25cf5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add7d8e380c51f7fa2312aea2982878c2" id="r_add7d8e380c51f7fa2312aea2982878c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#add7d8e380c51f7fa2312aea2982878c2">yield</a> () override</td></tr>
|
|
<tr class="memdesc:add7d8e380c51f7fa2312aea2982878c2"><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:add7d8e380c51f7fa2312aea2982878c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6773c6f0aac24774614a3179a4da475" id="r_ae6773c6f0aac24774614a3179a4da475"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#ae6773c6f0aac24774614a3179a4da475">spiEndTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:ae6773c6f0aac24774614a3179a4da475"><td class="mdescLeft"> </td><td class="mdescRight">Method to end SPI transaction. <br /></td></tr>
|
|
<tr class="separator:ae6773c6f0aac24774614a3179a4da475"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac932d26b6a31a0cd7f577d4f8812896c" id="r_ac932d26b6a31a0cd7f577d4f8812896c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pico_hal.html#ac932d26b6a31a0cd7f577d4f8812896c">spiEnd</a> ()</td></tr>
|
|
<tr class="memdesc:ac932d26b6a31a0cd7f577d4f8812896c"><td class="mdescLeft"> </td><td class="mdescRight">SPI termination method. <br /></td></tr>
|
|
<tr class="separator:ac932d26b6a31a0cd7f577d4f8812896c"><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="inherited" 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" 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="a960f5c3890a0ee6fd339d93ca9769c62" name="a960f5c3890a0ee6fd339d93ca9769c62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a960f5c3890a0ee6fd339d93ca9769c62">◆ </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 PicoHal::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="a1bab4dfe568d7107e569e848001e414a" name="a1bab4dfe568d7107e569e848001e414a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1bab4dfe568d7107e569e848001e414a">◆ </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 PicoHal::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="a4a69597cf1a071a0fa61d1d292008628" name="a4a69597cf1a071a0fa61d1d292008628"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a69597cf1a071a0fa61d1d292008628">◆ </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 PicoHal::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="a323d56fc8637f2b005070c7585bfe82e" name="a323d56fc8637f2b005070c7585bfe82e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a323d56fc8637f2b005070c7585bfe82e">◆ </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 PicoHal::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="a25993f76cf572e1a891b7ecc777721c2" name="a25993f76cf572e1a891b7ecc777721c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25993f76cf572e1a891b7ecc777721c2">◆ </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 PicoHal::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="a4f5e06e79f6f6b7952243fe3817200b4" name="a4f5e06e79f6f6b7952243fe3817200b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f5e06e79f6f6b7952243fe3817200b4">◆ </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 PicoHal::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="a9eea222b674b9f36c68dfb8db3bbf096" name="a9eea222b674b9f36c68dfb8db3bbf096"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9eea222b674b9f36c68dfb8db3bbf096">◆ </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 PicoHal::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="a3eb9710f7b7702c9035833a4f8176038" name="a3eb9710f7b7702c9035833a4f8176038"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3eb9710f7b7702c9035833a4f8176038">◆ </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 PicoHal::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="a4e82e02b4de6d1c192f52fb0ddd1c9c4" name="a4e82e02b4de6d1c192f52fb0ddd1c9c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e82e02b4de6d1c192f52fb0ddd1c9c4">◆ </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 PicoHal::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="af80164483ca2bda3a7dd0cc795549524" name="af80164483ca2bda3a7dd0cc795549524"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af80164483ca2bda3a7dd0cc795549524">◆ </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 PicoHal::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">override</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="ac539134f4517ef79de49832bb86392f2" name="ac539134f4517ef79de49832bb86392f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac539134f4517ef79de49832bb86392f2">◆ </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 PicoHal::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="a504806e3adb1a5b9f6784478bae16c10" name="a504806e3adb1a5b9f6784478bae16c10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a504806e3adb1a5b9f6784478bae16c10">◆ </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 PicoHal::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="a414de51bef859659b8cac66df32bdb5a" name="a414de51bef859659b8cac66df32bdb5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a414de51bef859659b8cac66df32bdb5a">◆ </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 PicoHal::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="a2b6136b2c90e83c1ab94bd92ef32805c" name="a2b6136b2c90e83c1ab94bd92ef32805c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b6136b2c90e83c1ab94bd92ef32805c">◆ </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 PicoHal::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="ac932d26b6a31a0cd7f577d4f8812896c" name="ac932d26b6a31a0cd7f577d4f8812896c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac932d26b6a31a0cd7f577d4f8812896c">◆ </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 PicoHal::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="ae6773c6f0aac24774614a3179a4da475" name="ae6773c6f0aac24774614a3179a4da475"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6773c6f0aac24774614a3179a4da475">◆ </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 PicoHal::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="acc961bf30af621d0dfec2b3f7e25cf5c" name="acc961bf30af621d0dfec2b3f7e25cf5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc961bf30af621d0dfec2b3f7e25cf5c">◆ </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 PicoHal::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="a27803b7a0b53dca9fd1c74eadb15755a" name="a27803b7a0b53dca9fd1c74eadb15755a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27803b7a0b53dca9fd1c74eadb15755a">◆ </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 PicoHal::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="abfa0319db88b4c015edf67a9c9b671be" name="abfa0319db88b4c015edf67a9c9b671be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abfa0319db88b4c015edf67a9c9b671be">◆ </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 PicoHal::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">override</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="add7d8e380c51f7fa2312aea2982878c2" name="add7d8e380c51f7fa2312aea2982878c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add7d8e380c51f7fa2312aea2982878c2">◆ </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 PicoHal::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/RPiPico/<a class="el" href="_pico_hal_8h_source.html">PicoHal.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_pico_hal.html">PicoHal</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>
|