1308 lines
71 KiB
HTML
1308 lines
71 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: Module Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_module.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_module-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Module Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class.
|
|
<a href="class_module.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_module_8h_source.html">Module.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1101d49f597f756141fc9de88a504f21"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)</td></tr>
|
|
<tr class="memdesc:a1101d49f597f756141fc9de88a504f21"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_module.html#a1101d49f597f756141fc9de88a504f21">More...</a><br /></td></tr>
|
|
<tr class="separator:a1101d49f597f756141fc9de88a504f21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a919baf2e46c357ebfcdbc1025b6c551e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">Module</a> (const <a class="el" href="class_module.html">Module</a> &mod)</td></tr>
|
|
<tr class="memdesc:a919baf2e46c357ebfcdbc1025b6c551e"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">More...</a><br /></td></tr>
|
|
<tr class="separator:a919baf2e46c357ebfcdbc1025b6c551e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ea888758b4a7784082d513a1e7849a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_module.html">Module</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">operator=</a> (const <a class="el" href="class_module.html">Module</a> &mod)</td></tr>
|
|
<tr class="memdesc:a4ea888758b4a7784082d513a1e7849a4"><td class="mdescLeft"> </td><td class="mdescRight">Overload for assignment operator. <a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ea888758b4a7784082d513a1e7849a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1956ac81429ec1f61f83dbc081cf18c"><td class="memItemLeft" align="right" valign="top"><a id="ad1956ac81429ec1f61f83dbc081cf18c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a> ()</td></tr>
|
|
<tr class="memdesc:ad1956ac81429ec1f61f83dbc081cf18c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize low-level module control. <br /></td></tr>
|
|
<tr class="separator:ad1956ac81429ec1f61f83dbc081cf18c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45bd514a1f2859d9a867c8f9b13eb332"><td class="memItemLeft" align="right" valign="top"><a id="a45bd514a1f2859d9a867c8f9b13eb332"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a> ()</td></tr>
|
|
<tr class="memdesc:a45bd514a1f2859d9a867c8f9b13eb332"><td class="mdescLeft"> </td><td class="mdescRight">Terminate low-level module control. <br /></td></tr>
|
|
<tr class="separator:a45bd514a1f2859d9a867c8f9b13eb332"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">SPIgetRegValue</a> (uint8_t reg, uint8_t msb=7, uint8_t lsb=0)</td></tr>
|
|
<tr class="memdesc:ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><td class="mdescLeft"> </td><td class="mdescRight">SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. <a href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1286d7fd9673cbfab945c26b2585a129"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a1286d7fd9673cbfab945c26b2585a129">SPIsetRegValue</a> (uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)</td></tr>
|
|
<tr class="memdesc:a1286d7fd9673cbfab945c26b2585a129"><td class="mdescLeft"> </td><td class="mdescRight">Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. <a href="class_module.html#a1286d7fd9673cbfab945c26b2585a129">More...</a><br /></td></tr>
|
|
<tr class="separator:a1286d7fd9673cbfab945c26b2585a129"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fa5239d73379e4140f5c4f513b1b8d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">SPIreadRegisterBurst</a> (uint8_t reg, uint8_t numBytes, uint8_t *inBytes)</td></tr>
|
|
<tr class="memdesc:a6fa5239d73379e4140f5c4f513b1b8d2"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst read method. <a href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">More...</a><br /></td></tr>
|
|
<tr class="separator:a6fa5239d73379e4140f5c4f513b1b8d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d1a279cc7e1ab92e30c29c4dcca26a3"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">SPIreadRegister</a> (uint8_t reg)</td></tr>
|
|
<tr class="memdesc:a1d1a279cc7e1ab92e30c29c4dcca26a3"><td class="mdescLeft"> </td><td class="mdescRight">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. <a href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d1a279cc7e1ab92e30c29c4dcca26a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d77a08070cbd48fd4ece62a739333e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">SPIwriteRegisterBurst</a> (uint8_t reg, uint8_t *data, uint8_t numBytes)</td></tr>
|
|
<tr class="memdesc:a9d77a08070cbd48fd4ece62a739333e9"><td class="mdescLeft"> </td><td class="mdescRight">SPI burst write method. <a href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d77a08070cbd48fd4ece62a739333e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab814614ddd34b57f5a612a20f5fe4c57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">SPIwriteRegister</a> (uint8_t reg, uint8_t data)</td></tr>
|
|
<tr class="memdesc:ab814614ddd34b57f5a612a20f5fe4c57"><td class="mdescLeft"> </td><td class="mdescRight">SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. <a href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">More...</a><br /></td></tr>
|
|
<tr class="separator:ab814614ddd34b57f5a612a20f5fe4c57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefd955f1cd6d588b2cc229db87cb2121"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">SPItransfer</a> (uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)</td></tr>
|
|
<tr class="memdesc:aefd955f1cd6d588b2cc229db87cb2121"><td class="mdescLeft"> </td><td class="mdescRight">SPI single transfer method. <a href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">More...</a><br /></td></tr>
|
|
<tr class="separator:aefd955f1cd6d588b2cc229db87cb2121"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae53e355a77f2b7ce6473c62ac5f37334"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334">getCs</a> () const</td></tr>
|
|
<tr class="memdesc:ae53e355a77f2b7ce6473c62ac5f37334"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of SPI chip select. <a href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334">More...</a><br /></td></tr>
|
|
<tr class="separator:ae53e355a77f2b7ce6473c62ac5f37334"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c7f17a63b67117d953f1ba990b17f80"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80">getIrq</a> () const</td></tr>
|
|
<tr class="memdesc:a8c7f17a63b67117d953f1ba990b17f80"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of interrupt/GPIO. <a href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80">More...</a><br /></td></tr>
|
|
<tr class="separator:a8c7f17a63b67117d953f1ba990b17f80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae352c7a7b997fc1b17189c1312a8347f"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f">getRst</a> () const</td></tr>
|
|
<tr class="memdesc:ae352c7a7b997fc1b17189c1312a8347f"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of hardware reset pin. <a href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f">More...</a><br /></td></tr>
|
|
<tr class="separator:ae352c7a7b997fc1b17189c1312a8347f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb4c7447372d56a7cae6db91994aacfc"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc">getGpio</a> () const</td></tr>
|
|
<tr class="memdesc:aeb4c7447372d56a7cae6db91994aacfc"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of second interrupt/GPIO. <a href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb4c7447372d56a7cae6db91994aacfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ecbb4e1e98094c1296b1e823dc14703"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">setRfSwitchPins</a> (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td></tr>
|
|
<tr class="memdesc:a0ecbb4e1e98094c1296b1e823dc14703"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! <a href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">More...</a><br /></td></tr>
|
|
<tr class="separator:a0ecbb4e1e98094c1296b1e823dc14703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a87d59ad2bf6bb1bb9de1856a81b824"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">setRfSwitchState</a> (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</td></tr>
|
|
<tr class="memdesc:a4a87d59ad2bf6bb1bb9de1856a81b824"><td class="mdescLeft"> </td><td class="mdescRight">Set RF switch state. <a href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a87d59ad2bf6bb1bb9de1856a81b824"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7e4872dad3d19b6f75f532c88683168"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af7e4872dad3d19b6f75f532c88683168">pinMode</a> (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)</td></tr>
|
|
<tr class="memdesc:af7e4872dad3d19b6f75f532c88683168"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin. <a href="class_module.html#af7e4872dad3d19b6f75f532c88683168">More...</a><br /></td></tr>
|
|
<tr class="separator:af7e4872dad3d19b6f75f532c88683168"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ad10b113df7c7e0a932be19eff63cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">digitalWrite</a> (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)</td></tr>
|
|
<tr class="memdesc:a46ad10b113df7c7e0a932be19eff63cd"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. <a href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">More...</a><br /></td></tr>
|
|
<tr class="separator:a46ad10b113df7c7e0a932be19eff63cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7495c81640aac8f4686221dad34a274f"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_STATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7495c81640aac8f4686221dad34a274f">digitalRead</a> (RADIOLIB_PIN_TYPE pin)</td></tr>
|
|
<tr class="memdesc:a7495c81640aac8f4686221dad34a274f"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. <a href="class_module.html#a7495c81640aac8f4686221dad34a274f">More...</a><br /></td></tr>
|
|
<tr class="separator:a7495c81640aac8f4686221dad34a274f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33e33df69d58660b8cd0e2dafe5e9189"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a33e33df69d58660b8cd0e2dafe5e9189">tone</a> (RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)</td></tr>
|
|
<tr class="memdesc:a33e33df69d58660b8cd0e2dafe5e9189"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. <a href="class_module.html#a33e33df69d58660b8cd0e2dafe5e9189">More...</a><br /></td></tr>
|
|
<tr class="separator:a33e33df69d58660b8cd0e2dafe5e9189"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af998b86ce1243f616f6fcb6df5336207"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af998b86ce1243f616f6fcb6df5336207">noTone</a> (RADIOLIB_PIN_TYPE pin)</td></tr>
|
|
<tr class="memdesc:af998b86ce1243f616f6fcb6df5336207"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. <a href="class_module.html#af998b86ce1243f616f6fcb6df5336207">More...</a><br /></td></tr>
|
|
<tr class="separator:af998b86ce1243f616f6fcb6df5336207"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91aaa34aecdfeaf24948551b037033be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a91aaa34aecdfeaf24948551b037033be">attachInterrupt</a> (RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</td></tr>
|
|
<tr class="memdesc:a91aaa34aecdfeaf24948551b037033be"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core attachInterrupt override. <a href="class_module.html#a91aaa34aecdfeaf24948551b037033be">More...</a><br /></td></tr>
|
|
<tr class="separator:a91aaa34aecdfeaf24948551b037033be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a656738f2fe41fb236d27aed02efa8ad4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">detachInterrupt</a> (RADIOLIB_PIN_TYPE interruptNum)</td></tr>
|
|
<tr class="memdesc:a656738f2fe41fb236d27aed02efa8ad4"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core detachInterrupt override. <a href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">More...</a><br /></td></tr>
|
|
<tr class="separator:a656738f2fe41fb236d27aed02efa8ad4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a227d2d38e4747d0f49bb4df1c80b45d7"><td class="memItemLeft" align="right" valign="top"><a id="a227d2d38e4747d0f49bb4df1c80b45d7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a> ()</td></tr>
|
|
<tr class="memdesc:a227d2d38e4747d0f49bb4df1c80b45d7"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core yield override. <br /></td></tr>
|
|
<tr class="separator:a227d2d38e4747d0f49bb4df1c80b45d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0f870b09b9dd9636f1587d708f07d38"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">delay</a> (uint32_t ms)</td></tr>
|
|
<tr class="memdesc:af0f870b09b9dd9636f1587d708f07d38"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core delay override. <a href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">More...</a><br /></td></tr>
|
|
<tr class="separator:af0f870b09b9dd9636f1587d708f07d38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14d7cd8220bfa4440bda055ce5be748c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">delayMicroseconds</a> (uint32_t us)</td></tr>
|
|
<tr class="memdesc:a14d7cd8220bfa4440bda055ce5be748c"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core delayMicroseconds override. <a href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">More...</a><br /></td></tr>
|
|
<tr class="separator:a14d7cd8220bfa4440bda055ce5be748c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a216dd0c6ce140857f2b003ab8d89fbac"><td class="memItemLeft" align="right" valign="top"><a id="a216dd0c6ce140857f2b003ab8d89fbac"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a> ()</td></tr>
|
|
<tr class="memdesc:a216dd0c6ce140857f2b003ab8d89fbac"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core millis override. <br /></td></tr>
|
|
<tr class="separator:a216dd0c6ce140857f2b003ab8d89fbac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3f51e517a825949891ad29e30fd3f59"><td class="memItemLeft" align="right" valign="top"><a id="af3f51e517a825949891ad29e30fd3f59"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a> ()</td></tr>
|
|
<tr class="memdesc:af3f51e517a825949891ad29e30fd3f59"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core micros override. <br /></td></tr>
|
|
<tr class="separator:af3f51e517a825949891ad29e30fd3f59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1310b9594f86fb1dc6646479922a1fdc"><td class="memItemLeft" align="right" valign="top"><a id="a1310b9594f86fb1dc6646479922a1fdc"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a1310b9594f86fb1dc6646479922a1fdc">pulseIn</a> (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)</td></tr>
|
|
<tr class="memdesc:a1310b9594f86fb1dc6646479922a1fdc"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core pulseIn override. <br /></td></tr>
|
|
<tr class="separator:a1310b9594f86fb1dc6646479922a1fdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6bfd022681d360082e3dd31a984e1f7"><td class="memItemLeft" align="right" valign="top"><a id="af6bfd022681d360082e3dd31a984e1f7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af6bfd022681d360082e3dd31a984e1f7">begin</a> ()</td></tr>
|
|
<tr class="memdesc:af6bfd022681d360082e3dd31a984e1f7"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core SPI begin override. <br /></td></tr>
|
|
<tr class="separator:af6bfd022681d360082e3dd31a984e1f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d0caa9f5e38cfa2c609570a89a4a703"><td class="memItemLeft" align="right" valign="top"><a id="a3d0caa9f5e38cfa2c609570a89a4a703"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a3d0caa9f5e38cfa2c609570a89a4a703">beginTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:a3d0caa9f5e38cfa2c609570a89a4a703"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core SPI beginTransaction override. <br /></td></tr>
|
|
<tr class="separator:a3d0caa9f5e38cfa2c609570a89a4a703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45e7823c44ac0aa8a10bd4f365890c98"><td class="memItemLeft" align="right" valign="top"><a id="a45e7823c44ac0aa8a10bd4f365890c98"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a45e7823c44ac0aa8a10bd4f365890c98">transfer</a> (uint8_t b)</td></tr>
|
|
<tr class="memdesc:a45e7823c44ac0aa8a10bd4f365890c98"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core SPI transfer override. <br /></td></tr>
|
|
<tr class="separator:a45e7823c44ac0aa8a10bd4f365890c98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a015226566efc5131c8a39a184b6c4e6b"><td class="memItemLeft" align="right" valign="top"><a id="a015226566efc5131c8a39a184b6c4e6b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a015226566efc5131c8a39a184b6c4e6b">endTransaction</a> ()</td></tr>
|
|
<tr class="memdesc:a015226566efc5131c8a39a184b6c4e6b"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core SPI endTransaction override. <br /></td></tr>
|
|
<tr class="separator:a015226566efc5131c8a39a184b6c4e6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7fc017ee35f40c90e5badc5bc568c3d"><td class="memItemLeft" align="right" valign="top"><a id="aa7fc017ee35f40c90e5badc5bc568c3d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#aa7fc017ee35f40c90e5badc5bc568c3d">end</a> ()</td></tr>
|
|
<tr class="memdesc:aa7fc017ee35f40c90e5badc5bc568c3d"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core SPI end override. <br /></td></tr>
|
|
<tr class="separator:aa7fc017ee35f40c90e5badc5bc568c3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7216d32fc55130d111409c6f2050d9c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7216d32fc55130d111409c6f2050d9c0">regdump</a> (uint8_t start, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a7216d32fc55130d111409c6f2050d9c0"><td class="mdescLeft"> </td><td class="mdescRight">Function to dump device registers as hex into the debug port. <a href="class_module.html#a7216d32fc55130d111409c6f2050d9c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7216d32fc55130d111409c6f2050d9c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9474048f40bb4ebe28e4ab4d122fb02"><td class="memItemLeft" align="right" valign="top"><a id="ac9474048f40bb4ebe28e4ab4d122fb02"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_PIN_MODE)</td></tr>
|
|
<tr class="separator:ac9474048f40bb4ebe28e4ab4d122fb02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82919ea8ad9ff1ddfcfe1875da1b5393"><td class="memItemLeft" align="right" valign="top"><a id="a82919ea8ad9ff1ddfcfe1875da1b5393"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_DIGITAL_WRITE)</td></tr>
|
|
<tr class="separator:a82919ea8ad9ff1ddfcfe1875da1b5393"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29032772488951dfcad1e9b685f8cbba"><td class="memItemLeft" align="right" valign="top"><a id="a29032772488951dfcad1e9b685f8cbba"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_DIGITAL_READ)</td></tr>
|
|
<tr class="separator:a29032772488951dfcad1e9b685f8cbba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a126721995b0b9ac702e96c35943b352e"><td class="memItemLeft" align="right" valign="top"><a id="a126721995b0b9ac702e96c35943b352e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_TONE)</td></tr>
|
|
<tr class="separator:a126721995b0b9ac702e96c35943b352e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bf1ef9c2da2f98fb67f5bf33593128a"><td class="memItemLeft" align="right" valign="top"><a id="a8bf1ef9c2da2f98fb67f5bf33593128a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_NO_TONE)</td></tr>
|
|
<tr class="separator:a8bf1ef9c2da2f98fb67f5bf33593128a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae76932d2c2895939f8074c58848b61e8"><td class="memItemLeft" align="right" valign="top"><a id="ae76932d2c2895939f8074c58848b61e8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_ATTACH_INTERRUPT)</td></tr>
|
|
<tr class="separator:ae76932d2c2895939f8074c58848b61e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc9a06beb7b390240fc537054c51b05a"><td class="memItemLeft" align="right" valign="top"><a id="acc9a06beb7b390240fc537054c51b05a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_DETACH_INTERRUPT)</td></tr>
|
|
<tr class="separator:acc9a06beb7b390240fc537054c51b05a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a132de8c267f9386ce17a5dcdb67cde3a"><td class="memItemLeft" align="right" valign="top"><a id="a132de8c267f9386ce17a5dcdb67cde3a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_YIELD)</td></tr>
|
|
<tr class="separator:a132de8c267f9386ce17a5dcdb67cde3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a5f23f2107b2afaf32df464fbc64318"><td class="memItemLeft" align="right" valign="top"><a id="a4a5f23f2107b2afaf32df464fbc64318"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_DELAY)</td></tr>
|
|
<tr class="separator:a4a5f23f2107b2afaf32df464fbc64318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98194d700bc3b5b26c788c464356dd23"><td class="memItemLeft" align="right" valign="top"><a id="a98194d700bc3b5b26c788c464356dd23"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_DELAY_MICROSECONDS)</td></tr>
|
|
<tr class="separator:a98194d700bc3b5b26c788c464356dd23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46a9dfbd5b3234927ba6c651db650d60"><td class="memItemLeft" align="right" valign="top"><a id="a46a9dfbd5b3234927ba6c651db650d60"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_MILLIS)</td></tr>
|
|
<tr class="separator:a46a9dfbd5b3234927ba6c651db650d60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe29925a8f9405e94ddddfe44fe235e4"><td class="memItemLeft" align="right" valign="top"><a id="abe29925a8f9405e94ddddfe44fe235e4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_MICROS)</td></tr>
|
|
<tr class="separator:abe29925a8f9405e94ddddfe44fe235e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7201089f1789070192ef1ea0c4f2498"><td class="memItemLeft" align="right" valign="top"><a id="ae7201089f1789070192ef1ea0c4f2498"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_PULSE_IN)</td></tr>
|
|
<tr class="separator:ae7201089f1789070192ef1ea0c4f2498"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97822a29abe87e2939297b787a22b3a5"><td class="memItemLeft" align="right" valign="top"><a id="a97822a29abe87e2939297b787a22b3a5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_SPI_BEGIN)</td></tr>
|
|
<tr class="separator:a97822a29abe87e2939297b787a22b3a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82be40be081e5211b4ef3aba96529cb6"><td class="memItemLeft" align="right" valign="top"><a id="a82be40be081e5211b4ef3aba96529cb6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION)</td></tr>
|
|
<tr class="separator:a82be40be081e5211b4ef3aba96529cb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad21d31efe1ca5b4da8487f5e234b916a"><td class="memItemLeft" align="right" valign="top"><a id="ad21d31efe1ca5b4da8487f5e234b916a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_SPI_TRANSFER)</td></tr>
|
|
<tr class="separator:ad21d31efe1ca5b4da8487f5e234b916a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace3db08404636376f9fc7efd431cda01"><td class="memItemLeft" align="right" valign="top"><a id="ace3db08404636376f9fc7efd431cda01"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_SPI_END_TRANSACTION)</td></tr>
|
|
<tr class="separator:ace3db08404636376f9fc7efd431cda01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb905cec1dcdac08201cf81dea652254"><td class="memItemLeft" align="right" valign="top"><a id="aeb905cec1dcdac08201cf81dea652254"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RADIOLIB_GENERATE_CALLBACK</b> (RADIOLIB_CB_ARGS_SPI_END)</td></tr>
|
|
<tr class="separator:aeb905cec1dcdac08201cf81dea652254"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7f5fd7409f21d33a16ea1de589962ae6"><td class="memItemLeft" align="right" valign="top"><a id="a7f5fd7409f21d33a16ea1de589962ae6"></a>
|
|
static uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7f5fd7409f21d33a16ea1de589962ae6">flipBits</a> (uint8_t b)</td></tr>
|
|
<tr class="memdesc:a7f5fd7409f21d33a16ea1de589962ae6"><td class="mdescLeft"> </td><td class="mdescRight">Function to reflect bits within a byte. <br /></td></tr>
|
|
<tr class="separator:a7f5fd7409f21d33a16ea1de589962ae6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a160006371be8e121a8a54cc4462b3a72"><td class="memItemLeft" align="right" valign="top"><a id="a160006371be8e121a8a54cc4462b3a72"></a>
|
|
static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a160006371be8e121a8a54cc4462b3a72">flipBits16</a> (uint16_t i)</td></tr>
|
|
<tr class="memdesc:a160006371be8e121a8a54cc4462b3a72"><td class="mdescLeft"> </td><td class="mdescRight">Function to reflect bits within an integer. <br /></td></tr>
|
|
<tr class="separator:a160006371be8e121a8a54cc4462b3a72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2dc188128f32f9360a178f31659291a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac2dc188128f32f9360a178f31659291a">hexdump</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ac2dc188128f32f9360a178f31659291a"><td class="mdescLeft"> </td><td class="mdescRight">Function to dump data as hex into the debug port. <a href="class_module.html#ac2dc188128f32f9360a178f31659291a">More...</a><br /></td></tr>
|
|
<tr class="separator:ac2dc188128f32f9360a178f31659291a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a849ad85fc1bc3a7130e660c13973ab26"><td class="memItemLeft" align="right" valign="top"><a id="a849ad85fc1bc3a7130e660c13973ab26"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000</td></tr>
|
|
<tr class="memdesc:a849ad85fc1bc3a7130e660c13973ab26"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI read command. Defaults to 0x00. <br /></td></tr>
|
|
<tr class="separator:a849ad85fc1bc3a7130e660c13973ab26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae89764d15e8df5694a6aec0e18f72d3f"><td class="memItemLeft" align="right" valign="top"><a id="ae89764d15e8df5694a6aec0e18f72d3f"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000</td></tr>
|
|
<tr class="memdesc:ae89764d15e8df5694a6aec0e18f72d3f"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI write command. Defaults to 0x80. <br /></td></tr>
|
|
<tr class="separator:ae89764d15e8df5694a6aec0e18f72d3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a1101d49f597f756141fc9de88a504f21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1101d49f597f756141fc9de88a504f21">◆ </a></span>Module() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Module::Module </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>cs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>irq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>rst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>gpio</em> = <code>RADIOLIB_NC</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cs</td><td>Pin to be used as chip select.</td></tr>
|
|
<tr><td class="paramname">irq</td><td>Pin to be used as interrupt/GPIO.</td></tr>
|
|
<tr><td class="paramname">rst</td><td>Pin to be used as hardware reset for the module.</td></tr>
|
|
<tr><td class="paramname">gpio</td><td>Pin to be used as additional interrupt/GPIO. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a919baf2e46c357ebfcdbc1025b6c551e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a919baf2e46c357ebfcdbc1025b6c551e">◆ </a></span>Module() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Module::Module </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_module.html">Module</a> & </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td><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> instance to copy. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a91aaa34aecdfeaf24948551b037033be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91aaa34aecdfeaf24948551b037033be">◆ </a></span>attachInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::attachInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </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>userFunc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_INTERRUPT_STATUS </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core attachInterrupt override. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">interruptNum</td><td>Interrupt number.</td></tr>
|
|
<tr><td class="paramname">userFunc</td><td>Interrupt service routine.</td></tr>
|
|
<tr><td class="paramname">mode</td><td>Pin hcange direction. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0f870b09b9dd9636f1587d708f07d38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0f870b09b9dd9636f1587d708f07d38">◆ </a></span>delay()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::delay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>ms</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core delay override. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ms</td><td>Delay length in milliseconds. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a14d7cd8220bfa4440bda055ce5be748c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14d7cd8220bfa4440bda055ce5be748c">◆ </a></span>delayMicroseconds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::delayMicroseconds </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>us</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core delayMicroseconds override. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">us</td><td>Delay length in microseconds. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a656738f2fe41fb236d27aed02efa8ad4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a656738f2fe41fb236d27aed02efa8ad4">◆ </a></span>detachInterrupt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::detachInterrupt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>interruptNum</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core detachInterrupt override. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">interruptNum</td><td>Interrupt number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7495c81640aac8f4686221dad34a274f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7495c81640aac8f4686221dad34a274f">◆ </a></span>digitalRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RADIOLIB_PIN_STATUS Module::digitalRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to read from.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pin value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46ad10b113df7c7e0a932be19eff63cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46ad10b113df7c7e0a932be19eff63cd">◆ </a></span>digitalWrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::digitalWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_STATUS </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to write to.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Whether to set the pin high or low. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae53e355a77f2b7ce6473c62ac5f37334"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae53e355a77f2b7ce6473c62ac5f37334">◆ </a></span>getCs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RADIOLIB_PIN_TYPE Module::getCs </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access method to get the pin number of SPI chip select. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pin number of SPI chip select configured in the constructor. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb4c7447372d56a7cae6db91994aacfc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb4c7447372d56a7cae6db91994aacfc">◆ </a></span>getGpio()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RADIOLIB_PIN_TYPE Module::getGpio </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access method to get the pin number of second interrupt/GPIO. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pin number of second interrupt/GPIO configured in the constructor. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c7f17a63b67117d953f1ba990b17f80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c7f17a63b67117d953f1ba990b17f80">◆ </a></span>getIrq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RADIOLIB_PIN_TYPE Module::getIrq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access method to get the pin number of interrupt/GPIO. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pin number of interrupt/GPIO configured in the constructor. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae352c7a7b997fc1b17189c1312a8347f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae352c7a7b997fc1b17189c1312a8347f">◆ </a></span>getRst()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RADIOLIB_PIN_TYPE Module::getRst </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access method to get the pin number of hardware reset pin. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pin number of hardware reset pin configured in the constructor. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2dc188128f32f9360a178f31659291a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2dc188128f32f9360a178f31659291a">◆ </a></span>hexdump()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::hexdump </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to dump data as hex into the debug port. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Data to dump.</td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to dump. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af998b86ce1243f616f6fcb6df5336207"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af998b86ce1243f616f6fcb6df5336207">◆ </a></span>noTone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::noTone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to write to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ea888758b4a7784082d513a1e7849a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ea888758b4a7784082d513a1e7849a4">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_module.html">Module</a> & Module::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_module.html">Module</a> & </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload for assignment operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame</td><td>rvalue <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>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7e4872dad3d19b6f75f532c88683168"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7e4872dad3d19b6f75f532c88683168">◆ </a></span>pinMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::pinMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_MODE </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to change the mode of.</td></tr>
|
|
<tr><td class="paramname">mode</td><td>Which mode to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7216d32fc55130d111409c6f2050d9c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7216d32fc55130d111409c6f2050d9c0">◆ </a></span>regdump()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::regdump </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to dump device registers as hex into the debug port. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">start</td><td>First address to dump.</td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to dump. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ecbb4e1e98094c1296b1e823dc14703"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ecbb4e1e98094c1296b1e823dc14703">◆ </a></span>setRfSwitchPins()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::setRfSwitchPins </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>rxEn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>txEn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxEn</td><td>RX enable pin.</td></tr>
|
|
<tr><td class="paramname">txEn</td><td>TX enable pin. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a87d59ad2bf6bb1bb9de1856a81b824"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a87d59ad2bf6bb1bb9de1856a81b824">◆ </a></span>setRfSwitchState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::setRfSwitchState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_STATUS </td>
|
|
<td class="paramname"><em>rxPinState</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_STATUS </td>
|
|
<td class="paramname"><em>txPinState</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set RF switch state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxPinState</td><td>Pin state to set on Tx enable pin (usually high to transmit).</td></tr>
|
|
<tr><td class="paramname">txPinState</td><td>Pin state to set on Rx enable pin (usually high to receive). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7ca9ae5a22cdacdf9437ca9cd37c9b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">◆ </a></span>SPIgetRegValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t Module::SPIgetRegValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>msb</em> = <code>7</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>lsb</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to read.</td></tr>
|
|
<tr><td class="paramname">msb</td><td>Most significant bit of the register variable. Bits above this one will be masked out.</td></tr>
|
|
<tr><td class="paramname">lsb</td><td>Least significant bit of the register variable. Bits below this one will be masked out.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Masked register value or status code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d1a279cc7e1ab92e30c29c4dcca26a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d1a279cc7e1ab92e30c29c4dcca26a3">◆ </a></span>SPIreadRegister()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Module::SPIreadRegister </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to read.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Value that was read from register. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fa5239d73379e4140f5c4f513b1b8d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fa5239d73379e4140f5c4f513b1b8d2">◆ </a></span>SPIreadRegisterBurst()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::SPIreadRegisterBurst </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>inBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI burst read method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to read.</td></tr>
|
|
<tr><td class="paramname">numBytes</td><td>Number of bytes that will be read.</td></tr>
|
|
<tr><td class="paramname">inBytes</td><td>Pointer to array that will hold the read data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1286d7fd9673cbfab945c26b2585a129"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1286d7fd9673cbfab945c26b2585a129">◆ </a></span>SPIsetRegValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t Module::SPIsetRegValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>msb</em> = <code>7</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>lsb</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>checkInterval</em> = <code>2</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>checkMask</em> = <code>0xFF</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to write.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Single byte value that will be written to the SPI register.</td></tr>
|
|
<tr><td class="paramname">msb</td><td>Most significant bit of the register variable. Bits above this one will not be affected by the write operation.</td></tr>
|
|
<tr><td class="paramname">lsb</td><td>Least significant bit of the register variable. Bits below this one will not be affected by the write operation.</td></tr>
|
|
<tr><td class="paramname">checkInterval</td><td>Number of milliseconds between register writing and verification reading. Some registers need up to 10ms to process the change.</td></tr>
|
|
<tr><td class="paramname">checkMask</td><td>Mask of bits to check, only bits set to 1 will be verified.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefd955f1cd6d588b2cc229db87cb2121"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefd955f1cd6d588b2cc229db87cb2121">◆ </a></span>SPItransfer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::SPItransfer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cmd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataOut</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI single transfer method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cmd</td><td>SPI access command (read/write/burst/...).</td></tr>
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to transfer to/from.</td></tr>
|
|
<tr><td class="paramname">dataOut</td><td>Data that will be transfered from master to slave.</td></tr>
|
|
<tr><td class="paramname">dataIn</td><td>Data that was transfered from slave to master.</td></tr>
|
|
<tr><td class="paramname">numBytes</td><td>Number of bytes to transfer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab814614ddd34b57f5a612a20f5fe4c57"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab814614ddd34b57f5a612a20f5fe4c57">◆ </a></span>SPIwriteRegister()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::SPIwriteRegister </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to write.</td></tr>
|
|
<tr><td class="paramname">data</td><td>Value that will be written to the register. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d77a08070cbd48fd4ece62a739333e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d77a08070cbd48fd4ece62a739333e9">◆ </a></span>SPIwriteRegisterBurst()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::SPIwriteRegisterBurst </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>reg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>SPI burst write method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reg</td><td>Address of SPI register to write.</td></tr>
|
|
<tr><td class="paramname">data</td><td>Pointer to array that holds the data that will be written.</td></tr>
|
|
<tr><td class="paramname">numBytes</td><td>Number of bytes that will be written. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33e33df69d58660b8cd0e2dafe5e9189"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33e33df69d58660b8cd0e2dafe5e9189">◆ </a></span>tone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Module::tone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>duration</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to write to.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Frequency to output. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="_module_8h_source.html">Module.h</a></li>
|
|
<li>src/Module.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_module.html">Module</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|