kopia lustrzana https://github.com/jgromes/RadioLib
167 wiersze
47 KiB
HTML
167 wiersze
47 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
|
||
|
|
<title>RadioLib: src/Module.h Source File</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>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</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>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
</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.11 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</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">
|
||
|
|
$(document).ready(function(){initNavTree('_module_8h_source.html','');});
|
||
|
|
</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="headertitle">
|
||
|
|
<div class="title">Module.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef _RADIOLIB_MODULE_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_MODULE_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <SPI.h></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <SoftwareSerial.h></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_module.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="class_module.html">Module</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial = <span class="keyword">nullptr</span>, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass& spi, SPISettings spiSettings);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq,
|
||
|
|
<div class="ttc" id="class_module_html_a5a2b7fd8c262a01d1abc1b5f4f9c3513"><div class="ttname"><a href="class_module.html#a5a2b7fd8c262a01d1abc1b5f4f9c3513">Module::getTx</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getTx() const </div><div class="ttdoc">Access method to get the pin number of UART Rx. </div><div class="ttdef"><b>Definition:</b> Module.h:342</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a9d8ab2ff353bad5d0e7568d300a48ba0"><div class="ttname"><a href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0">Module::AtLineFeed</a></div><div class="ttdeci">char AtLineFeed[3]</div><div class="ttdoc">Line feed to be used when sending AT commands. Defaults to CR+LF. </div><div class="ttdef"><b>Definition:</b> Module.h:151</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a4ea888758b4a7784082d513a1e7849a4"><div class="ttname"><a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">Module::operator=</a></div><div class="ttdeci">Module & operator=(const Module &mod)</div><div class="ttdoc">Overload for assignment operator. </div><div class="ttdef"><b>Definition:</b> Module.cpp:96</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a9d77a08070cbd48fd4ece62a739333e9"><div class="ttname"><a href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)</div><div class="ttdoc">SPI burst write method. </div><div class="ttdef"><b>Definition:</b> Module.cpp:264</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a7495c81640aac8f4686221dad34a274f"><div class="ttname"><a href="class_module.html#a7495c81640aac8f4686221dad34a274f">Module::digitalRead</a></div><div class="ttdeci">static RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. </div><div class="ttdef"><b>Definition:</b> Module.cpp:331</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a99556decb983f682b98220ae5434b004"><div class="ttname"><a href="class_module.html#a99556decb983f682b98220ae5434b004">Module::ModuleSerial</a></div><div class="ttdeci">SoftwareSerial * ModuleSerial</div><div class="ttdoc">Internal SoftwareSerial instance. </div><div class="ttdef"><b>Definition:</b> Module.h:140</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_aefd955f1cd6d588b2cc229db87cb2121"><div class="ttname"><a href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)</div><div class="ttdoc">SPI single transfer method. </div><div class="ttdef"><b>Definition:</b> Module.cpp:272</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_af0f870b09b9dd9636f1587d708f07d38"><div class="ttname"><a href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">Module::delay</a></div><div class="ttdeci">static void delay(uint32_t ms)</div><div class="ttdoc">Arduino core delay override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:368</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a227d2d38e4747d0f49bb4df1c80b45d7"><div class="ttname"><a href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">Module::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Arduino core yield override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:364</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a46ad10b113df7c7e0a932be19eff63cd"><div class="ttname"><a href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">Module::digitalWrite</a></div><div class="ttdeci">static void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)</div><div class="ttdoc">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. </div><div class="ttdef"><b>Definition:</b> Module.cpp:325</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_acbffe457d532fed652664debcb3c7748"><div class="ttname"><a href="class_module.html#acbffe457d532fed652664debcb3c7748">Module::getRx</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRx() const </div><div class="ttdoc">Access method to get the pin number of UART Rx. </div><div class="ttdef"><b>Definition:</b> Module.h:335</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a55ddb0fc8ce53db3a333b71fb798e0af"><div class="ttname"><a href="class_module.html#a55ddb0fc8ce53db3a333b71fb798e0af">Module::getIrq</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getIrq() const </div><div class="ttdoc">Access method to get the pin number of interrupt/GPIO. </div><div class="ttdef"><b>Definition:</b> Module.h:314</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a849ad85fc1bc3a7130e660c13973ab26"><div class="ttname"><a href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">Module::SPIreadCommand</a></div><div class="ttdeci">uint8_t SPIreadCommand</div><div class="ttdoc">Basic SPI read command. Defaults to 0x00. </div><div class="ttdef"><b>Definition:</b> Module.h:156</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a128ead3f3198e3b06d39a128a5d6c777"><div class="ttname"><a href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">Module::baudrate</a></div><div class="ttdeci">uint32_t baudrate</div><div class="ttdoc">Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud. </div><div class="ttdef"><b>Definition:</b> Module.h:146</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_af0569f6930da7bee761eeca8158aed3a"><div class="ttname"><a href="class_module.html#af0569f6930da7bee761eeca8158aed3a">Module::term</a></div><div class="ttdeci">void term(uint8_t interface)</div><div class="ttdoc">Terminate low-level module control. </div><div class="ttdef"><b>Definition:</b> Module.cpp:137</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a14d7cd8220bfa4440bda055ce5be748c"><div class="ttname"><a href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">Module::delayMicroseconds</a></div><div class="ttdeci">static void delayMicroseconds(uint32_t us)</div><div class="ttdoc">Arduino core delayMicroseconds override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:372</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a3b1d62f6df09d175179effd04c931881"><div class="ttname"><a href="class_module.html#a3b1d62f6df09d175179effd04c931881">Module::getGpio</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getGpio() const </div><div class="ttdoc">Access method to get the pin number of second interrupt/GPIO. </div><div class="ttdef"><b>Definition:</b> Module.h:328</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_adb22d89bc5f532f1d056d9a9f3a6589c"><div class="ttname"><a href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">Module::init</a></div><div class="ttdeci">void init(uint8_t interface)</div><div class="ttdoc">Initialize low-level module control. </div><div class="ttdef"><b>Definition:</b> Module.cpp:113</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ad5767216ba9340ae6d86915b12e89bd6"><div class="ttname"><a href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">Module::ATemptyBuffer</a></div><div class="ttdeci">void ATemptyBuffer()</div><div class="ttdoc">Empty internal AT buffer. </div><div class="ttdef"><b>Definition:</b> Module.cpp:152</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a32ba59613a2f1e77038956e18d9fedd7"><div class="ttname"><a href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">Module::tone</a></div><div class="ttdeci">static void tone(RADIOLIB_PIN_TYPE pin, uint16_t value)</div><div class="ttdoc">Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...</div><div class="ttdef"><b>Definition:</b> Module.cpp:338</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a4a87d59ad2bf6bb1bb9de1856a81b824"><div class="ttname"><a href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</div><div class="ttdoc">Set RF switch state. </div><div class="ttdef"><b>Definition:</b> Module.cpp:392</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ad1aadc2b52eea2bf9d26591091eec3f1"><div class="ttname"><a href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">Module::ATgetResponse</a></div><div class="ttdeci">bool ATgetResponse()</div><div class="ttdoc">Get response after sending AT command. </div><div class="ttdef"><b>Definition:</b> Module.cpp:175</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_aa4179db40b566a336d28ca33763c6b11"><div class="ttname"><a href="class_module.html#aa4179db40b566a336d28ca33763c6b11">Module::getRst</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRst() const </div><div class="ttdoc">Access method to get the pin number of hardware reset pin. </div><div class="ttdef"><b>Definition:</b> Module.h:321</div></div>
|
||
|
|
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a2ba602f873ba747733eed9f54ca94ed1"><div class="ttname"><a href="class_module.html#a2ba602f873ba747733eed9f54ca94ed1">Module::getSpiSettings</a></div><div class="ttdeci">SPISettings getSpiSettings() const </div><div class="ttdoc">Access method to get the SPI interface settings. </div><div class="ttdef"><b>Definition:</b> Module.h:356</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a623aee6405b330b7c935013ff3d01100"><div class="ttname"><a href="class_module.html#a623aee6405b330b7c935013ff3d01100">Module::ATsendData</a></div><div class="ttdeci">bool ATsendData(uint8_t *data, uint32_t len)</div><div class="ttdoc">Send raw AT data. Will also call ATgetResponse. </div><div class="ttdef"><b>Definition:</b> Module.cpp:165</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><div class="ttname"><a href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">Module::SPIgetRegValue</a></div><div class="ttdeci">int16_t SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)</div><div class="ttdoc">SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...</div><div class="ttdef"><b>Definition:</b> Module.cpp:199</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a216dd0c6ce140857f2b003ab8d89fbac"><div class="ttname"><a href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">Module::millis</a></div><div class="ttdeci">static uint32_t millis()</div><div class="ttdoc">Arduino core millis override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:376</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ad9e1458c0eb4f7c117d53e35450bbd76"><div class="ttname"><a href="class_module.html#ad9e1458c0eb4f7c117d53e35450bbd76">Module::getCs</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getCs() const </div><div class="ttdoc">Access method to get the pin number of SPI chip select. </div><div class="ttdef"><b>Definition:</b> Module.h:307</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ab814614ddd34b57f5a612a20f5fe4c57"><div class="ttname"><a href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint8_t reg, uint8_t data)</div><div class="ttdoc">SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...</div><div class="ttdef"><b>Definition:</b> Module.cpp:268</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a1d1a279cc7e1ab92e30c29c4dcca26a3"><div class="ttname"><a href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint8_t reg)</div><div class="ttdoc">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...</div><div class="ttdef"><b>Definition:</b> Module.cpp:258</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_af998b86ce1243f616f6fcb6df5336207"><div class="ttname"><a href="class_module.html#af998b86ce1243f616f6fcb6df5336207">Module::noTone</a></div><div class="ttdeci">static void noTone(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...</div><div class="ttdef"><b>Definition:</b> Module.cpp:347</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a5ea76bc25ef979ec1ff90c032e476004"><div class="ttname"><a href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module::Module</a></div><div class="ttdeci">Module(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)</div><div class="ttdoc">UART-based module constructor. </div><div class="ttdef"><b>Definition:</b> Module.cpp:29</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a656738f2fe41fb236d27aed02efa8ad4"><div class="ttname"><a href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">Module::detachInterrupt</a></div><div class="ttdeci">static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)</div><div class="ttdoc">Arduino core detachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:360</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a5c09c878b55f56990dd0c2972a3440c4"><div class="ttname"><a href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">Module::ATsendCommand</a></div><div class="ttdeci">bool ATsendCommand(const char *cmd)</div><div class="ttdoc">Send AT command. Will also call ATgetResponse. </div><div class="ttdef"><b>Definition:</b> Module.cpp:158</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a91aaa34aecdfeaf24948551b037033be"><div class="ttname"><a href="class_module.html#a91aaa34aecdfeaf24948551b037033be">Module::attachInterrupt</a></div><div class="ttdeci">static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</div><div class="ttdoc">Arduino core attachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:356</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_ae89764d15e8df5694a6aec0e18f72d3f"><div class="ttname"><a href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">Module::SPIwriteCommand</a></div><div class="ttdeci">uint8_t SPIwriteCommand</div><div class="ttdoc">Basic SPI write command. Defaults to 0x80. </div><div class="ttdef"><b>Definition:</b> Module.h:161</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a6fa5239d73379e4140f5c4f513b1b8d2"><div class="ttname"><a href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method. </div><div class="ttdef"><b>Definition:</b> Module.cpp:254</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a9909bad63883b996e856deceb2a2d48d"><div class="ttname"><a href="class_module.html#a9909bad63883b996e856deceb2a2d48d">Module::getSpi</a></div><div class="ttdeci">SPIClass * getSpi() const </div><div class="ttdoc">Access method to get the SPI interface. </div><div class="ttdef"><b>Definition:</b> Module.h:349</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a87ca265fa2d1fe7c251b4230ef6bd6ca"><div class="ttname"><a href="class_module.html#a87ca265fa2d1fe7c251b4230ef6bd6ca">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2)</div><div class="ttdoc">Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism...</div><div class="ttdef"><b>Definition:</b> Module.cpp:209</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_af3f51e517a825949891ad29e30fd3f59"><div class="ttname"><a href="class_module.html#af3f51e517a825949891ad29e30fd3f59">Module::micros</a></div><div class="ttdeci">static uint32_t micros()</div><div class="ttdoc">Arduino core micros override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:380</div></div>
|
||
|
|
<div class="ttc" id="class_module_html_a0ecbb4e1e98094c1296b1e823dc14703"><div class="ttname"><a href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> Module.cpp:384</div></div>
|
||
|
|
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>Module.h</b></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.11 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|