347 lines
46 KiB
HTML
347 lines
46 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: SerialModule 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_serial_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="class_serial_module-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SerialModule Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Extension of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...">Module</a> class for UART-based modules, only exists to distinguish the UART constructor.
|
|
<a href="class_serial_module.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_module_8h_source.html">Module.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SerialModule:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_serial_module.png" usemap="#SerialModule_map" alt=""/>
|
|
<map id="SerialModule_map" name="SerialModule_map">
|
|
<area href="class_module.html" title="Implements all common low-level SPI/UART methods to control the wireless module. Every module class c..." alt="Module" shape="rect" coords="0,0,87,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af40d6673000ae141af0004f8ba7b496f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serial_module.html#af40d6673000ae141af0004f8ba7b496f">SerialModule</a> (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)</td></tr>
|
|
<tr class="memdesc:af40d6673000ae141af0004f8ba7b496f"><td class="mdescLeft"> </td><td class="mdescRight">UART-based module constructor. <a href="class_serial_module.html#af40d6673000ae141af0004f8ba7b496f">More...</a><br /></td></tr>
|
|
<tr class="separator:af40d6673000ae141af0004f8ba7b496f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_module')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a06b2e1f1eb9e07a280e55f517f2fab38 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)</td></tr>
|
|
<tr class="memdesc:a06b2e1f1eb9e07a280e55f517f2fab38 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI-based module constructor. Will use the default SPI interface automatically initialize it. <a href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">More...</a><br /></td></tr>
|
|
<tr class="separator:a06b2e1f1eb9e07a280e55f517f2fab38 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8709b81f592a23ebd72ba3fd8066b0f inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae8709b81f592a23ebd72ba3fd8066b0f">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)</td></tr>
|
|
<tr class="memdesc:ae8709b81f592a23ebd72ba3fd8066b0f inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Extended SPI-based module constructor. Will use the default SPI interface automatically initialize it. <a href="class_module.html#ae8709b81f592a23ebd72ba3fd8066b0f">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8709b81f592a23ebd72ba3fd8066b0f inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac65f3d9e022b3284134ced1c20bcff09 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ac65f3d9e022b3284134ced1c20bcff09">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)</td></tr>
|
|
<tr class="memdesc:ac65f3d9e022b3284134ced1c20bcff09 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">SPI-based module constructor. <a href="class_module.html#ac65f3d9e022b3284134ced1c20bcff09">More...</a><br /></td></tr>
|
|
<tr class="separator:ac65f3d9e022b3284134ced1c20bcff09 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53d99944916b750dc1c69890f370680e inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a53d99944916b750dc1c69890f370680e">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0))</td></tr>
|
|
<tr class="memdesc:a53d99944916b750dc1c69890f370680e inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Extended SPI-based module constructor. <a href="class_module.html#a53d99944916b750dc1c69890f370680e">More...</a><br /></td></tr>
|
|
<tr class="separator:a53d99944916b750dc1c69890f370680e inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56456ade4eeffa2c566a6fc3fd098276 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a56456ade4eeffa2c566a6fc3fd098276">Module</a> (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)</td></tr>
|
|
<tr class="memdesc:a56456ade4eeffa2c566a6fc3fd098276 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Generic module constructor. <a href="class_module.html#a56456ade4eeffa2c566a6fc3fd098276">More...</a><br /></td></tr>
|
|
<tr class="separator:a56456ade4eeffa2c566a6fc3fd098276 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a919baf2e46c357ebfcdbc1025b6c551e inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">More...</a><br /></td></tr>
|
|
<tr class="separator:a919baf2e46c357ebfcdbc1025b6c551e inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ea888758b4a7784082d513a1e7849a4 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb22d89bc5f532f1d056d9a9f3a6589c inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">init</a> (uint8_t interface)</td></tr>
|
|
<tr class="memdesc:adb22d89bc5f532f1d056d9a9f3a6589c inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Initialize low-level module control. <a href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">More...</a><br /></td></tr>
|
|
<tr class="separator:adb22d89bc5f532f1d056d9a9f3a6589c inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0569f6930da7bee761eeca8158aed3a inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af0569f6930da7bee761eeca8158aed3a">term</a> (uint8_t interface)</td></tr>
|
|
<tr class="memdesc:af0569f6930da7bee761eeca8158aed3a inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Terminate low-level module control. <a href="class_module.html#af0569f6930da7bee761eeca8158aed3a">More...</a><br /></td></tr>
|
|
<tr class="separator:af0569f6930da7bee761eeca8158aed3a inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5767216ba9340ae6d86915b12e89bd6 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top"><a id="ad5767216ba9340ae6d86915b12e89bd6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">ATemptyBuffer</a> ()</td></tr>
|
|
<tr class="memdesc:ad5767216ba9340ae6d86915b12e89bd6 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Empty internal AT buffer. <br /></td></tr>
|
|
<tr class="separator:ad5767216ba9340ae6d86915b12e89bd6 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1aadc2b52eea2bf9d26591091eec3f1 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">ATgetResponse</a> ()</td></tr>
|
|
<tr class="memdesc:ad1aadc2b52eea2bf9d26591091eec3f1 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Get response after sending AT command. <a href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1aadc2b52eea2bf9d26591091eec3f1 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c09c878b55f56990dd0c2972a3440c4 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">ATsendCommand</a> (const char *cmd)</td></tr>
|
|
<tr class="memdesc:a5c09c878b55f56990dd0c2972a3440c4 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Send AT command. Will also call ATgetResponse. <a href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c09c878b55f56990dd0c2972a3440c4 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a623aee6405b330b7c935013ff3d01100 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a623aee6405b330b7c935013ff3d01100">ATsendData</a> (uint8_t *data, uint32_t len)</td></tr>
|
|
<tr class="memdesc:a623aee6405b330b7c935013ff3d01100 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Send raw AT data. Will also call ATgetResponse. <a href="class_module.html#a623aee6405b330b7c935013ff3d01100">More...</a><br /></td></tr>
|
|
<tr class="separator:a623aee6405b330b7c935013ff3d01100 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7ca9ae5a22cdacdf9437ca9cd37c9b4 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1286d7fd9673cbfab945c26b2585a129 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fa5239d73379e4140f5c4f513b1b8d2 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d1a279cc7e1ab92e30c29c4dcca26a3 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d77a08070cbd48fd4ece62a739333e9 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab814614ddd34b57f5a612a20f5fe4c57 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefd955f1cd6d588b2cc229db87cb2121 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae53e355a77f2b7ce6473c62ac5f37334 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c7f17a63b67117d953f1ba990b17f80 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae352c7a7b997fc1b17189c1312a8347f inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb4c7447372d56a7cae6db91994aacfc inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d66f76c11ac91a35a3a1d9647aa6f6d inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d">getRx</a> () const</td></tr>
|
|
<tr class="memdesc:a5d66f76c11ac91a35a3a1d9647aa6f6d inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of UART Rx. <a href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d66f76c11ac91a35a3a1d9647aa6f6d inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a680dd2e80255cab30cbe9773bf20b390 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">RADIOLIB_PIN_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a680dd2e80255cab30cbe9773bf20b390">getTx</a> () const</td></tr>
|
|
<tr class="memdesc:a680dd2e80255cab30cbe9773bf20b390 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the pin number of UART Rx. <a href="class_module.html#a680dd2e80255cab30cbe9773bf20b390">More...</a><br /></td></tr>
|
|
<tr class="separator:a680dd2e80255cab30cbe9773bf20b390 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae867ebfef795d63d1df234394510b96e inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">SPIClass * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#ae867ebfef795d63d1df234394510b96e">getSpi</a> () const</td></tr>
|
|
<tr class="memdesc:ae867ebfef795d63d1df234394510b96e inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the SPI interface. <a href="class_module.html#ae867ebfef795d63d1df234394510b96e">More...</a><br /></td></tr>
|
|
<tr class="separator:ae867ebfef795d63d1df234394510b96e inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b6da4ca8fe5178617a1cc28854929a0 inherit pub_methods_class_module"><td class="memItemLeft" align="right" valign="top">SPISettings </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a7b6da4ca8fe5178617a1cc28854929a0">getSpiSettings</a> () const</td></tr>
|
|
<tr class="memdesc:a7b6da4ca8fe5178617a1cc28854929a0 inherit pub_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Access method to get the SPI interface settings. <a href="class_module.html#a7b6da4ca8fe5178617a1cc28854929a0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7b6da4ca8fe5178617a1cc28854929a0 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ecbb4e1e98094c1296b1e823dc14703 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a87d59ad2bf6bb1bb9de1856a81b824 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><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 inherit pub_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_static_methods_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_module')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:af7e4872dad3d19b6f75f532c88683168 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ad10b113df7c7e0a932be19eff63cd inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7495c81640aac8f4686221dad34a274f inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32ba59613a2f1e77038956e18d9fedd7 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">tone</a> (RADIOLIB_PIN_TYPE pin, uint16_t value)</td></tr>
|
|
<tr class="memdesc:a32ba59613a2f1e77038956e18d9fedd7 inherit pub_static_methods_class_module"><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#a32ba59613a2f1e77038956e18d9fedd7">More...</a><br /></td></tr>
|
|
<tr class="separator:a32ba59613a2f1e77038956e18d9fedd7 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af998b86ce1243f616f6fcb6df5336207 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91aaa34aecdfeaf24948551b037033be inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a656738f2fe41fb236d27aed02efa8ad4 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a227d2d38e4747d0f49bb4df1c80b45d7 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a227d2d38e4747d0f49bb4df1c80b45d7"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a> ()</td></tr>
|
|
<tr class="memdesc:a227d2d38e4747d0f49bb4df1c80b45d7 inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core yield override. <br /></td></tr>
|
|
<tr class="separator:a227d2d38e4747d0f49bb4df1c80b45d7 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0f870b09b9dd9636f1587d708f07d38 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14d7cd8220bfa4440bda055ce5be748c inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top">static 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 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a216dd0c6ce140857f2b003ab8d89fbac inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a216dd0c6ce140857f2b003ab8d89fbac"></a>
|
|
static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a> ()</td></tr>
|
|
<tr class="memdesc:a216dd0c6ce140857f2b003ab8d89fbac inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core millis override. <br /></td></tr>
|
|
<tr class="separator:a216dd0c6ce140857f2b003ab8d89fbac inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3f51e517a825949891ad29e30fd3f59 inherit pub_static_methods_class_module"><td class="memItemLeft" align="right" valign="top"><a id="af3f51e517a825949891ad29e30fd3f59"></a>
|
|
static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a> ()</td></tr>
|
|
<tr class="memdesc:af3f51e517a825949891ad29e30fd3f59 inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Arduino core micros override. <br /></td></tr>
|
|
<tr class="separator:af3f51e517a825949891ad29e30fd3f59 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f5fd7409f21d33a16ea1de589962ae6 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Function to reflect bits within a byte. <br /></td></tr>
|
|
<tr class="separator:a7f5fd7409f21d33a16ea1de589962ae6 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a160006371be8e121a8a54cc4462b3a72 inherit pub_static_methods_class_module"><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 inherit pub_static_methods_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Function to reflect bits within an integer. <br /></td></tr>
|
|
<tr class="separator:a160006371be8e121a8a54cc4462b3a72 inherit pub_static_methods_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_module')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_module.html">Module</a></td></tr>
|
|
<tr class="memitem:a99556decb983f682b98220ae5434b004 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a99556decb983f682b98220ae5434b004"></a>
|
|
SoftwareSerial * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a99556decb983f682b98220ae5434b004">ModuleSerial</a></td></tr>
|
|
<tr class="memdesc:a99556decb983f682b98220ae5434b004 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Internal SoftwareSerial instance. <br /></td></tr>
|
|
<tr class="separator:a99556decb983f682b98220ae5434b004 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a128ead3f3198e3b06d39a128a5d6c777 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a128ead3f3198e3b06d39a128a5d6c777"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">baudrate</a> = 9600</td></tr>
|
|
<tr class="memdesc:a128ead3f3198e3b06d39a128a5d6c777 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud. <br /></td></tr>
|
|
<tr class="separator:a128ead3f3198e3b06d39a128a5d6c777 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d8ab2ff353bad5d0e7568d300a48ba0 inherit pub_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a9d8ab2ff353bad5d0e7568d300a48ba0"></a>
|
|
char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0">AtLineFeed</a> [3] = {'\r', '\n'}</td></tr>
|
|
<tr class="memdesc:a9d8ab2ff353bad5d0e7568d300a48ba0 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Line feed to be used when sending AT commands. Defaults to CR+LF. <br /></td></tr>
|
|
<tr class="separator:a9d8ab2ff353bad5d0e7568d300a48ba0 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a849ad85fc1bc3a7130e660c13973ab26 inherit pub_attribs_class_module"><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 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI read command. Defaults to 0x00. <br /></td></tr>
|
|
<tr class="separator:a849ad85fc1bc3a7130e660c13973ab26 inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae89764d15e8df5694a6aec0e18f72d3f inherit pub_attribs_class_module"><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 inherit pub_attribs_class_module"><td class="mdescLeft"> </td><td class="mdescRight">Basic SPI write command. Defaults to 0x80. <br /></td></tr>
|
|
<tr class="separator:ae89764d15e8df5694a6aec0e18f72d3f inherit pub_attribs_class_module"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Extension of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...">Module</a> class for UART-based modules, only exists to distinguish the UART constructor. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af40d6673000ae141af0004f8ba7b496f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af40d6673000ae141af0004f8ba7b496f">◆ </a></span>SerialModule()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SerialModule::SerialModule </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>rx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>tx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">HardwareSerial * </td>
|
|
<td class="paramname"><em>serial</em> = <code>nullptr</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>rst</em> = <code>RADIOLIB_NC</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>UART-based module constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rx</td><td>Arduino pin to be used as Rx pin for SoftwareSerial communication.</td></tr>
|
|
<tr><td class="paramname">tx</td><td>Arduino pin to be used as Tx pin for SoftwareSerial communication.</td></tr>
|
|
<tr><td class="paramname">serial</td><td>HardwareSerial to be used on platforms that do not support SoftwareSerial. Defaults to Serial1.</td></tr>
|
|
<tr><td class="paramname">rst</td><td>Arduino pin to be used as hardware reset for the module. Defaults to NC (unused). </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_serial_module.html">SerialModule</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>
|