kopia lustrzana https://github.com/jgromes/RadioLib
543 wiersze
74 KiB
HTML
543 wiersze
74 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: Si4430 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.9.1 -->
|
|
<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','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih: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_si4430.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_si4430-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Si4430 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Derived class for Si4430 modules.
|
|
<a href="class_si4430.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_si4430_8h_source.html">Si4430.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Si4430:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_si4430.png" usemap="#Si4430_map" alt=""/>
|
|
<map id="Si4430_map" name="Si4430_map">
|
|
<area href="class_si4432.html" title="Derived class for Si4432 modules." alt="Si4432" shape="rect" coords="0,112,93,136"/>
|
|
<area href="class_si443x.html" title="Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi..." alt="Si443x" shape="rect" coords="0,56,93,80"/>
|
|
<area href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...." alt="PhysicalLayer" shape="rect" coords="0,0,93,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:ac5ac1122e863a92b374a71e8880e16d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9">Si4430</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:ac5ac1122e863a92b374a71e8880e16d9"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9">More...</a><br /></td></tr>
|
|
<tr class="separator:ac5ac1122e863a92b374a71e8880e16d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaed612b8936609442042d8156e085d2c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4430.html#aaed612b8936609442042d8156e085d2c">begin</a> (float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)</td></tr>
|
|
<tr class="memdesc:aaed612b8936609442042d8156e085d2c"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. Must be called at least once from Arduino sketch to initialize the module. <a href="class_si4430.html#aaed612b8936609442042d8156e085d2c">More...</a><br /></td></tr>
|
|
<tr class="separator:aaed612b8936609442042d8156e085d2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a025a31861d1511090168e416140d0343"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4430.html#a025a31861d1511090168e416140d0343">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:a025a31861d1511090168e416140d0343"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz. <a href="class_si4430.html#a025a31861d1511090168e416140d0343">More...</a><br /></td></tr>
|
|
<tr class="separator:a025a31861d1511090168e416140d0343"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8d615431bf66e06b45487f3fff73d16"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4430.html#af8d615431bf66e06b45487f3fff73d16">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:af8d615431bf66e06b45487f3fff73d16"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps. <a href="class_si4430.html#af8d615431bf66e06b45487f3fff73d16">More...</a><br /></td></tr>
|
|
<tr class="separator:af8d615431bf66e06b45487f3fff73d16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_si4432"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_si4432')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_si4432.html">Si4432</a></td></tr>
|
|
<tr class="memitem:afb1f1ae46d04788aa42f6276efd231ac inherit pub_methods_class_si4432"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac">Si4432</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:afb1f1ae46d04788aa42f6276efd231ac inherit pub_methods_class_si4432"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1f1ae46d04788aa42f6276efd231ac inherit pub_methods_class_si4432"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5efc3a08f91a411da011201dc128fb34 inherit pub_methods_class_si4432"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4432.html#a5efc3a08f91a411da011201dc128fb34">begin</a> (float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)</td></tr>
|
|
<tr class="memdesc:a5efc3a08f91a411da011201dc128fb34 inherit pub_methods_class_si4432"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. Must be called at least once from Arduino sketch to initialize the module. <a href="class_si4432.html#a5efc3a08f91a411da011201dc128fb34">More...</a><br /></td></tr>
|
|
<tr class="separator:a5efc3a08f91a411da011201dc128fb34 inherit pub_methods_class_si4432"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0cdb6cb53bb0176803d5115356a8e84 inherit pub_methods_class_si4432"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4432.html#aa0cdb6cb53bb0176803d5115356a8e84">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:aa0cdb6cb53bb0176803d5115356a8e84 inherit pub_methods_class_si4432"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values range from 240.0 MHz to 930.0 MHz. <a href="class_si4432.html#aa0cdb6cb53bb0176803d5115356a8e84">More...</a><br /></td></tr>
|
|
<tr class="separator:aa0cdb6cb53bb0176803d5115356a8e84 inherit pub_methods_class_si4432"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b26e2c86a9e5e8f6405f0a57b65caca inherit pub_methods_class_si4432"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si4432.html#a8b26e2c86a9e5e8f6405f0a57b65caca">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:a8b26e2c86a9e5e8f6405f0a57b65caca inherit pub_methods_class_si4432"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values range from -1 to 20 dBm in 3 dBm steps. <a href="class_si4432.html#a8b26e2c86a9e5e8f6405f0a57b65caca">More...</a><br /></td></tr>
|
|
<tr class="separator:a8b26e2c86a9e5e8f6405f0a57b65caca inherit pub_methods_class_si4432"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_si443x"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_si443x')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_si443x.html">Si443x</a></td></tr>
|
|
<tr class="memitem:ae7cfff2efebfa01c8a50a5cbbe8775b9 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ae7cfff2efebfa01c8a50a5cbbe8775b9">Si443x</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:ae7cfff2efebfa01c8a50a5cbbe8775b9 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_si443x.html#ae7cfff2efebfa01c8a50a5cbbe8775b9">More...</a><br /></td></tr>
|
|
<tr class="separator:ae7cfff2efebfa01c8a50a5cbbe8775b9 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a453eda5436dc4dfe0dad676dc3977752 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a453eda5436dc4dfe0dad676dc3977752">begin</a> (float br, float freqDev, float rxBw, uint8_t preambleLen)</td></tr>
|
|
<tr class="memdesc:a453eda5436dc4dfe0dad676dc3977752 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="class_si443x.html#a453eda5436dc4dfe0dad676dc3977752">More...</a><br /></td></tr>
|
|
<tr class="separator:a453eda5436dc4dfe0dad676dc3977752 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae782ee06e2c463c24f22f5d4c3dd8d97 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top"><a id="ae782ee06e2c463c24f22f5d4c3dd8d97"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ae782ee06e2c463c24f22f5d4c3dd8d97">reset</a> ()</td></tr>
|
|
<tr class="memdesc:ae782ee06e2c463c24f22f5d4c3dd8d97 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Reset method. Will reset the chip to the default state using SDN pin. <br /></td></tr>
|
|
<tr class="separator:ae782ee06e2c463c24f22f5d4c3dd8d97 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a782748025e19ec6e597293afb6570bff inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a782748025e19ec6e597293afb6570bff">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a782748025e19ec6e597293afb6570bff inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to transmit Arduino String or C-string, see <a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534" title="C-string transmit method.">PhysicalLayer::transmit</a>. <a href="class_si443x.html#a782748025e19ec6e597293afb6570bff">More...</a><br /></td></tr>
|
|
<tr class="separator:a782748025e19ec6e597293afb6570bff inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabca3ba8eda212938febab1df2e764b4 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#aabca3ba8eda212938febab1df2e764b4">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:aabca3ba8eda212938febab1df2e764b4 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long. For overloads to receive Arduino String, see <a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8" title="Binary receive method. Must be implemented in module class.">PhysicalLayer::receive</a>. <a href="class_si443x.html#aabca3ba8eda212938febab1df2e764b4">More...</a><br /></td></tr>
|
|
<tr class="separator:aabca3ba8eda212938febab1df2e764b4 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada90718aeb67d7f0e9899da534de9695 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ada90718aeb67d7f0e9899da534de9695">sleep</a> ()</td></tr>
|
|
<tr class="memdesc:ada90718aeb67d7f0e9899da534de9695 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. <a href="class_si443x.html#ada90718aeb67d7f0e9899da534de9695">More...</a><br /></td></tr>
|
|
<tr class="separator:ada90718aeb67d7f0e9899da534de9695 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac45d2776df3ff338db154ead143fb7b8 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ac45d2776df3ff338db154ead143fb7b8">standby</a> () override</td></tr>
|
|
<tr class="memdesc:ac45d2776df3ff338db154ead143fb7b8 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby (with XTAL on). <a href="class_si443x.html#ac45d2776df3ff338db154ead143fb7b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ac45d2776df3ff338db154ead143fb7b8 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbc0f95f32ca961294666405596ff529 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#acbc0f95f32ca961294666405596ff529">standby</a> (uint8_t mode) override</td></tr>
|
|
<tr class="memdesc:acbc0f95f32ca961294666405596ff529 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby. <a href="class_si443x.html#acbc0f95f32ca961294666405596ff529">More...</a><br /></td></tr>
|
|
<tr class="separator:acbc0f95f32ca961294666405596ff529 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a86a2032c4b876c1c8e4a7cf4730c99 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a5a86a2032c4b876c1c8e4a7cf4730c99">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:a5a86a2032c4b876c1c8e4a7cf4730c99 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct transmission mode. While in direct mode, the module will not be able to transmit or receive packets. <a href="class_si443x.html#a5a86a2032c4b876c1c8e4a7cf4730c99">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a86a2032c4b876c1c8e4a7cf4730c99 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a178b471527813a608c04db7d3c9648d6 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a178b471527813a608c04db7d3c9648d6">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:a178b471527813a608c04db7d3c9648d6 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct reception mode. While in direct mode, the module will not be able to transmit or receive packets. <a href="class_si443x.html#a178b471527813a608c04db7d3c9648d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a178b471527813a608c04db7d3c9648d6 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a616eb24c4b11c5d39caaade160be8092 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a616eb24c4b11c5d39caaade160be8092">packetMode</a> ()</td></tr>
|
|
<tr class="memdesc:a616eb24c4b11c5d39caaade160be8092 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Disables direct mode and enables packet mode, allowing the module to receive packets. <a href="class_si443x.html#a616eb24c4b11c5d39caaade160be8092">More...</a><br /></td></tr>
|
|
<tr class="separator:a616eb24c4b11c5d39caaade160be8092 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a801b51059e61f93d4e01ae6ba8eb0726 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a801b51059e61f93d4e01ae6ba8eb0726">setIrqAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a801b51059e61f93d4e01ae6ba8eb0726 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when IRQ activates. <a href="class_si443x.html#a801b51059e61f93d4e01ae6ba8eb0726">More...</a><br /></td></tr>
|
|
<tr class="separator:a801b51059e61f93d4e01ae6ba8eb0726 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d019f58551346c3f3bd8b72d2486109 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top"><a id="a8d019f58551346c3f3bd8b72d2486109"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a8d019f58551346c3f3bd8b72d2486109">clearIrqAction</a> ()</td></tr>
|
|
<tr class="memdesc:a8d019f58551346c3f3bd8b72d2486109 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when IRQ activates. <br /></td></tr>
|
|
<tr class="separator:a8d019f58551346c3f3bd8b72d2486109 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2badfa5db1ae5b9ec26ad7a8b3cab167 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a2badfa5db1ae5b9ec26ad7a8b3cab167">setPacketReceivedAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a2badfa5db1ae5b9ec26ad7a8b3cab167 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <a href="class_si443x.html#a2badfa5db1ae5b9ec26ad7a8b3cab167">More...</a><br /></td></tr>
|
|
<tr class="separator:a2badfa5db1ae5b9ec26ad7a8b3cab167 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63a8bb675e7a0b54c493caa30adeb37e inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top"><a id="a63a8bb675e7a0b54c493caa30adeb37e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a63a8bb675e7a0b54c493caa30adeb37e">clearPacketReceivedAction</a> ()</td></tr>
|
|
<tr class="memdesc:a63a8bb675e7a0b54c493caa30adeb37e inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:a63a8bb675e7a0b54c493caa30adeb37e inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa55274bb345f178328ea2a674621fc84 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#aa55274bb345f178328ea2a674621fc84">setPacketSentAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:aa55274bb345f178328ea2a674621fc84 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <a href="class_si443x.html#aa55274bb345f178328ea2a674621fc84">More...</a><br /></td></tr>
|
|
<tr class="separator:aa55274bb345f178328ea2a674621fc84 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1835741ed147e575f9c03cf14c3b765e inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top"><a id="a1835741ed147e575f9c03cf14c3b765e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a1835741ed147e575f9c03cf14c3b765e">clearPacketSentAction</a> ()</td></tr>
|
|
<tr class="memdesc:a1835741ed147e575f9c03cf14c3b765e inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a1835741ed147e575f9c03cf14c3b765e inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a402b4f5f11ba79e9cd4fb6ac0bfd9314 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a402b4f5f11ba79e9cd4fb6ac0bfd9314">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a402b4f5f11ba79e9cd4fb6ac0bfd9314 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes long. <a href="class_si443x.html#a402b4f5f11ba79e9cd4fb6ac0bfd9314">More...</a><br /></td></tr>
|
|
<tr class="separator:a402b4f5f11ba79e9cd4fb6ac0bfd9314 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6792f13441a1bbb3340d2ba3d9abbec3 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a6792f13441a1bbb3340d2ba3d9abbec3">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:a6792f13441a1bbb3340d2ba3d9abbec3 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <a href="class_si443x.html#a6792f13441a1bbb3340d2ba3d9abbec3">More...</a><br /></td></tr>
|
|
<tr class="separator:a6792f13441a1bbb3340d2ba3d9abbec3 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10f886fc534a85bbf8c1aeb9b5ffe4f2 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a10f886fc534a85bbf8c1aeb9b5ffe4f2">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:a10f886fc534a85bbf8c1aeb9b5ffe4f2 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. IRQ will be activated when full valid packet is received. <a href="class_si443x.html#a10f886fc534a85bbf8c1aeb9b5ffe4f2">More...</a><br /></td></tr>
|
|
<tr class="separator:a10f886fc534a85bbf8c1aeb9b5ffe4f2 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1070a6cde04a01d4a35da670f65ce539 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a1070a6cde04a01d4a35da670f65ce539">startReceive</a> (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)</td></tr>
|
|
<tr class="memdesc:a1070a6cde04a01d4a35da670f65ce539 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method, implemented for compatibility with <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. <a href="class_si443x.html#a1070a6cde04a01d4a35da670f65ce539">More...</a><br /></td></tr>
|
|
<tr class="separator:a1070a6cde04a01d4a35da670f65ce539 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad00ff8b58c68118ad74fee82028aa71e inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ad00ff8b58c68118ad74fee82028aa71e">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:ad00ff8b58c68118ad74fee82028aa71e inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! <a href="class_si443x.html#ad00ff8b58c68118ad74fee82028aa71e">More...</a><br /></td></tr>
|
|
<tr class="separator:ad00ff8b58c68118ad74fee82028aa71e inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad43575e731dd7e66d5ad9e6dccd27170 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ad43575e731dd7e66d5ad9e6dccd27170">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:ad43575e731dd7e66d5ad9e6dccd27170 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. <a href="class_si443x.html#ad43575e731dd7e66d5ad9e6dccd27170">More...</a><br /></td></tr>
|
|
<tr class="separator:ad43575e731dd7e66d5ad9e6dccd27170 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c4e6caa95e5622f6f515ba0339a1c66 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a7c4e6caa95e5622f6f515ba0339a1c66">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:a7c4e6caa95e5622f6f515ba0339a1c66 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320.0 kHz. <a href="class_si443x.html#a7c4e6caa95e5622f6f515ba0339a1c66">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c4e6caa95e5622f6f515ba0339a1c66 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51e6b7c677e82042224798114f311175 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a51e6b7c677e82042224798114f311175">setRxBandwidth</a> (float rxBw)</td></tr>
|
|
<tr class="memdesc:a51e6b7c677e82042224798114f311175 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz. <a href="class_si443x.html#a51e6b7c677e82042224798114f311175">More...</a><br /></td></tr>
|
|
<tr class="separator:a51e6b7c677e82042224798114f311175 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ed0da298c2418db4a88a19ef8938e0a inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a4ed0da298c2418db4a88a19ef8938e0a">setSyncWord</a> (uint8_t *syncWord, size_t len)</td></tr>
|
|
<tr class="memdesc:a4ed0da298c2418db4a88a19ef8938e0a inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets sync word. Up to 4 bytes can be set as sync word. <a href="class_si443x.html#a4ed0da298c2418db4a88a19ef8938e0a">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ed0da298c2418db4a88a19ef8938e0a inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4821a6141caf16141074615c976ecd91 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a4821a6141caf16141074615c976ecd91">setPreambleLength</a> (uint8_t preambleLen)</td></tr>
|
|
<tr class="memdesc:a4821a6141caf16141074615c976ecd91 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets preamble length. <a href="class_si443x.html#a4821a6141caf16141074615c976ecd91">More...</a><br /></td></tr>
|
|
<tr class="separator:a4821a6141caf16141074615c976ecd91 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d944669dc69ccd47f9e6c360f2ffd10 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:a2d944669dc69ccd47f9e6c360f2ffd10 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <a href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">More...</a><br /></td></tr>
|
|
<tr class="separator:a2d944669dc69ccd47f9e6c360f2ffd10 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1382fc3b68f447e381613e6670747128 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a1382fc3b68f447e381613e6670747128">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:a1382fc3b68f447e381613e6670747128 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. <a href="class_si443x.html#a1382fc3b68f447e381613e6670747128">More...</a><br /></td></tr>
|
|
<tr class="separator:a1382fc3b68f447e381613e6670747128 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade08c79074c7e4414d34eefa25cee168 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:ade08c79074c7e4414d34eefa25cee168 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. <a href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">More...</a><br /></td></tr>
|
|
<tr class="separator:ade08c79074c7e4414d34eefa25cee168 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43e7ceeff9114b35ab89f1d69916b375 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a43e7ceeff9114b35ab89f1d69916b375">setRfSwitchPins</a> (uint32_t rxEn, uint32_t txEn)</td></tr>
|
|
<tr class="memdesc:a43e7ceeff9114b35ab89f1d69916b375 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. <a href="class_si443x.html#a43e7ceeff9114b35ab89f1d69916b375">More...</a><br /></td></tr>
|
|
<tr class="separator:a43e7ceeff9114b35ab89f1d69916b375 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8898f11cf9dabd9a5ad717376fdbffa6 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a8898f11cf9dabd9a5ad717376fdbffa6">setRfSwitchTable</a> (const uint32_t(&pins)[<a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a>], const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> table[])</td></tr>
|
|
<tr class="memdesc:a8898f11cf9dabd9a5ad717376fdbffa6 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. <a href="class_si443x.html#a8898f11cf9dabd9a5ad717376fdbffa6">More...</a><br /></td></tr>
|
|
<tr class="separator:a8898f11cf9dabd9a5ad717376fdbffa6 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74848176d435227e601c86ff37b0edbe inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a74848176d435227e601c86ff37b0edbe">randomByte</a> ()</td></tr>
|
|
<tr class="memdesc:a74848176d435227e601c86ff37b0edbe inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <a href="class_si443x.html#a74848176d435227e601c86ff37b0edbe">More...</a><br /></td></tr>
|
|
<tr class="separator:a74848176d435227e601c86ff37b0edbe inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55252bda74e8c67636a8c1fa0e9f58d3 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a55252bda74e8c67636a8c1fa0e9f58d3">getChipVersion</a> ()</td></tr>
|
|
<tr class="memdesc:a55252bda74e8c67636a8c1fa0e9f58d3 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if <a class="el" href="class_si443x.html" title="Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...">Si443x</a> is connected and working. <a href="class_si443x.html#a55252bda74e8c67636a8c1fa0e9f58d3">More...</a><br /></td></tr>
|
|
<tr class="separator:a55252bda74e8c67636a8c1fa0e9f58d3 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55fae20e81755c8b014d080741d61913 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a55fae20e81755c8b014d080741d61913">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a55fae20e81755c8b014d080741d61913 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. <a href="class_si443x.html#a55fae20e81755c8b014d080741d61913">More...</a><br /></td></tr>
|
|
<tr class="separator:a55fae20e81755c8b014d080741d61913 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af23d8eb0f1c436e6cc60361df13c08f7 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#af23d8eb0f1c436e6cc60361df13c08f7">readBit</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:af23d8eb0f1c436e6cc60361df13c08f7 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. <a href="class_si443x.html#af23d8eb0f1c436e6cc60361df13c08f7">More...</a><br /></td></tr>
|
|
<tr class="separator:af23d8eb0f1c436e6cc60361df13c08f7 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2b3a961a99d9e8f3a7ead6e8b69e858 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ad2b3a961a99d9e8f3a7ead6e8b69e858">fixedPacketLengthMode</a> (uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:ad2b3a961a99d9e8f3a7ead6e8b69e858 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. <a href="class_si443x.html#ad2b3a961a99d9e8f3a7ead6e8b69e858">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2b3a961a99d9e8f3a7ead6e8b69e858 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcca8ab4a1229efb5e7c6b09e564a48a inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#abcca8ab4a1229efb5e7c6b09e564a48a">variablePacketLengthMode</a> (uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:abcca8ab4a1229efb5e7c6b09e564a48a inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. <a href="class_si443x.html#abcca8ab4a1229efb5e7c6b09e564a48a">More...</a><br /></td></tr>
|
|
<tr class="separator:abcca8ab4a1229efb5e7c6b09e564a48a inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_si443x.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a3dd42f8d5569487ea74f004ca652a709">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <a href="class_si443x.html#a3dd42f8d5569487ea74f004ca652a709">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <a href="class_si443x.html#ab82617fa3fa9f21d4cd427314ecc4af8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_si443x.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#ad59e37ce0606dc8051e40be9d14cfec3">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <a href="class_si443x.html#ad59e37ce0606dc8051e40be9d14cfec3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_si443x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_si443x.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_si443x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_si443x.html#a3563453988a83d22dd07d4691543a300">More...</a><br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_si443x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_physical_layer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer</a> (float step, size_t maxLen)</td></tr>
|
|
<tr class="memdesc:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">More...</a><br /></td></tr>
|
|
<tr class="separator:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11b4c6d0bf3ae7b9ca04e9434180feab inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">invertIQ</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a11b4c6d0bf3ae7b9ca04e9434180feab inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set IQ inversion. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">More...</a><br /></td></tr>
|
|
<tr class="separator:a11b4c6d0bf3ae7b9ca04e9434180feab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85db1ff64e6c56e054f276c511194633 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">setPreambleLength</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a85db1ff64e6c56e054f276c511194633 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set preamble length. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">More...</a><br /></td></tr>
|
|
<tr class="separator:a85db1ff64e6c56e054f276c511194633 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ee1fed6bbb8d3571974153ac6f26751 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a6ee1fed6bbb8d3571974153ac6f26751 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set data. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ee1fed6bbb8d3571974153ac6f26751 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58d54eeb40fb586013ba48e15318abba inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a58d54eeb40fb586013ba48e15318abba inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">More...</a><br /></td></tr>
|
|
<tr class="separator:a58d54eeb40fb586013ba48e15318abba inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">getFreqStep</a> () const</td></tr>
|
|
<tr class="memdesc:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets the module frequency step size that was set in constructor. <a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">More...</a><br /></td></tr>
|
|
<tr class="separator:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabc94ab27a9ee6daaafa9b47dde5f75b inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:aabc94ab27a9ee6daaafa9b47dde5f75b inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">More...</a><br /></td></tr>
|
|
<tr class="separator:aabc94ab27a9ee6daaafa9b47dde5f75b inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <a href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">More...</a><br /></td></tr>
|
|
<tr class="separator:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">getTimeOnAir</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <a href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">More...</a><br /></td></tr>
|
|
<tr class="separator:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs)</td></tr>
|
|
<tr class="memdesc:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the timeout value for this specific module / series (in number of symbols or units of time) <a href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d1fe00d107bbc23b0315fd442bc3292 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a1d1fe00d107bbc23b0315fd442bc3292">irqRxDoneRxTimeout</a> (uint16_t &irqFlags, uint16_t &irqMask)</td></tr>
|
|
<tr class="memdesc:a1d1fe00d107bbc23b0315fd442bc3292 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Create the flags that make up RxDone and RxTimeout used for receiving downlinks. <a href="class_physical_layer.html#a1d1fe00d107bbc23b0315fd442bc3292">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d1fe00d107bbc23b0315fd442bc3292 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">isRxTimeout</a> ()</td></tr>
|
|
<tr class="memdesc:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the IRQ bit for RxTimeout is set. <a href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">More...</a><br /></td></tr>
|
|
<tr class="separator:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae30dfbb5445bb674898fc54f5f90b2f9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">startChannelScan</a> ()</td></tr>
|
|
<tr class="memdesc:ae30dfbb5445bb674898fc54f5f90b2f9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. interrupt will be activated when packet is detected. Must be implemented in module class. <a href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">More...</a><br /></td></tr>
|
|
<tr class="separator:ae30dfbb5445bb674898fc54f5f90b2f9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63979795a7b53557560bb95b65480906 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">getChannelScanResult</a> ()</td></tr>
|
|
<tr class="memdesc:a63979795a7b53557560bb95b65480906 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <a href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">More...</a><br /></td></tr>
|
|
<tr class="separator:a63979795a7b53557560bb95b65480906 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd9e39cc745acbf084cfa0d3f4d10718 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">scanChannel</a> ()</td></tr>
|
|
<tr class="memdesc:abd9e39cc745acbf084cfa0d3f4d10718 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. <a href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">More...</a><br /></td></tr>
|
|
<tr class="separator:abd9e39cc745acbf084cfa0d3f4d10718 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a> (int32_t max)</td></tr>
|
|
<tr class="memdesc:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">More...</a><br /></td></tr>
|
|
<tr class="separator:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">random</a> (int32_t min, int32_t max)</td></tr>
|
|
<tr class="memdesc:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <a href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a> ()</td></tr>
|
|
<tr class="memdesc:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. <a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">More...</a><br /></td></tr>
|
|
<tr class="separator:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a> (uint32_t syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word to be used to determine start of packet in direct reception mode. <a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a> ()</td></tr>
|
|
<tr class="memdesc:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of direct mode bytes currently available in buffer. <a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">More...</a><br /></td></tr>
|
|
<tr class="separator:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"><a id="a429796eb2e7ea86781a2e8ca42af43f3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a> ()</td></tr>
|
|
<tr class="memdesc:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Forcefully drop synchronization. <br /></td></tr>
|
|
<tr class="separator:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">read</a> (bool drop=true)</td></tr>
|
|
<tr class="memdesc:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get data from direct mode buffer. <a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">setDIOMapping</a> (uint32_t pin, uint32_t value)</td></tr>
|
|
<tr class="memdesc:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Configure DIO pin mapping to get a given signal on a DIO pin (if available). <a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">More...</a><br /></td></tr>
|
|
<tr class="separator:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">setChannelScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a channel scan is finished. <a href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">More...</a><br /></td></tr>
|
|
<tr class="separator:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"><a id="a169a4d04c5c50d3336e274d70930d9f6"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">clearChannelScanAction</a> ()</td></tr>
|
|
<tr class="memdesc:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Derived class for Si4430 modules. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ac5ac1122e863a92b374a71e8880e16d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5ac1122e863a92b374a71e8880e16d9">◆ </a></span>Si4430()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Si4430::Si4430 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><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>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>Instance of <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> that will be used to communicate with the radio chip. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aaed612b8936609442042d8156e085d2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaed612b8936609442042d8156e085d2c">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t Si4430::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em> = <code>434.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em> = <code>4.8</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em> = <code>5.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em> = <code>181.1</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em> = <code>10</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>preambleLen</em> = <code>16</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. Must be called at least once from Arduino sketch to initialize the module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 900.0 MHz to 960.0 MHz. </td></tr>
|
|
<tr><td class="paramname">br</td><td>Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps. </td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps. </td></tr>
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz. </td></tr>
|
|
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps. </td></tr>
|
|
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits. </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="a025a31861d1511090168e416140d0343"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a025a31861d1511090168e416140d0343">◆ </a></span>setFrequency()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t Si4430::setFrequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz. </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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8d615431bf66e06b45487f3fff73d16"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8d615431bf66e06b45487f3fff73d16">◆ </a></span>setOutputPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t Si4430::setOutputPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">power</td><td>Output power to be set in dBm. </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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/Si443x/<a class="el" href="_si4430_8h_source.html">Si4430.h</a></li>
|
|
<li>src/modules/Si443x/Si4430.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_si4430.html">Si4430</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|