147 lines
23 KiB
HTML
147 lines
23 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: Class List</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('annotated.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="headertitle">
|
|
<div class="title">Class List</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
|
|
<table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_f_s_k_client.html" target="_self">AFSKClient</a></td><td class="desc">Client for audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone.">tone()</a> function, and a module capable of direct mode transmission using DIO pins </td></tr>
|
|
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_p_r_s_client.html" target="_self">APRSClient</a></td><td class="desc">Client for APRS communication </td></tr>
|
|
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_x25_client.html" target="_self">AX25Client</a></td><td class="desc">Client for AX25 communication </td></tr>
|
|
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_x25_frame.html" target="_self">AX25Frame</a></td><td class="desc">Abstraction of AX.25 frame format </td></tr>
|
|
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_c1101.html" target="_self">CC1101</a></td><td class="desc">Control class for CC1101 module </td></tr>
|
|
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_f_s_k4_client.html" target="_self">FSK4Client</a></td><td class="desc">Client for FSK-4 communication. The public interface is the same as Arduino Serial </td></tr>
|
|
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_hell_client.html" target="_self">HellClient</a></td><td class="desc">Client for Hellschreiber transmissions </td></tr>
|
|
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_i_t_a2_string.html" target="_self">ITA2String</a></td><td class="desc">ITA2-encoded string </td></tr>
|
|
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_l_l_c_c68.html" target="_self">LLCC68</a></td><td class="desc">Derived class for LLCC68 modules </td></tr>
|
|
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_module.html" target="_self">Module</a></td><td class="desc">Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class </td></tr>
|
|
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_morse_client.html" target="_self">MorseClient</a></td><td class="desc">Client for Morse Code communication. The public interface is the same as Arduino Serial </td></tr>
|
|
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classn_r_f24.html" target="_self">nRF24</a></td><td class="desc">Control class for nRF24 module </td></tr>
|
|
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_pager_client.html" target="_self">PagerClient</a></td><td class="desc">Client for Pager communication </td></tr>
|
|
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_physical_layer.html" target="_self">PhysicalLayer</a></td><td class="desc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class </td></tr>
|
|
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f69.html" target="_self">RF69</a></td><td class="desc">Control class for RF69 module. Also serves as base class for <a class="el" href="class_s_x1231.html" title="Control class for SX1231 module. Overrides some methods from RF69 due to different register values.">SX1231</a> </td></tr>
|
|
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m22.html" target="_self">RFM22</a></td><td class="desc">Only exists as alias for <a class="el" href="class_si4432.html" title="Derived class for Si4432 modules.">Si4432</a>, since there seems to be no difference between RFM22 and Si4432 modules </td></tr>
|
|
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m23.html" target="_self">RFM23</a></td><td class="desc">Only exists as alias for <a class="el" href="class_si4431.html" title="Derived class for Si4431 modules.">Si4431</a>, since there seems to be no difference between RFM23 and Si4431 modules </td></tr>
|
|
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m95.html" target="_self">RFM95</a></td><td class="desc">Derived class for RFM95 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m96.html" target="_self">RFM96</a></td><td class="desc">Derived class for RFM96 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m97.html" target="_self">RFM97</a></td><td class="desc">Derived class for RFM97 modules. Overrides some methods from <a class="el" href="class_r_f_m95.html" title="Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM95</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m98.html" target="_self">RFM98</a></td><td class="desc">Only exists as alias for <a class="el" href="class_r_f_m96.html" title="Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM96</a>, since there seems to be no difference between RFM96 and RFM98 modules </td></tr>
|
|
<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_t_t_y_client.html" target="_self">RTTYClient</a></td><td class="desc">Client for RTTY communication. The public interface is the same as Arduino Serial </td></tr>
|
|
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4430.html" target="_self">Si4430</a></td><td class="desc">Derived class for Si4430 modules </td></tr>
|
|
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4431.html" target="_self">Si4431</a></td><td class="desc">Derived class for Si4431 modules </td></tr>
|
|
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4432.html" target="_self">Si4432</a></td><td class="desc">Derived class for Si4432 modules </td></tr>
|
|
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si443x.html" target="_self">Si443x</a></td><td class="desc">Base class for <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> series. All derived classes for <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> (e.g. <a class="el" href="class_si4431.html" title="Derived class for Si4431 modules.">Si4431</a> or <a class="el" href="class_si4432.html" title="Derived class for Si4432 modules.">Si4432</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
|
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_s_t_v_client.html" target="_self">SSTVClient</a></td><td class="desc">Client for SSTV transmissions </td></tr>
|
|
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_s_t_v_mode__t.html" target="_self">SSTVMode_t</a></td><td class="desc">Structure to save data about supported SSTV modes </td></tr>
|
|
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1231.html" target="_self">SX1231</a></td><td class="desc">Control class for SX1231 module. Overrides some methods from <a class="el" href="class_r_f69.html" title="Control class for RF69 module. Also serves as base class for SX1231.">RF69</a> due to different register values </td></tr>
|
|
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1261.html" target="_self">SX1261</a></td><td class="desc">Derived class for SX1261 modules </td></tr>
|
|
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1262.html" target="_self">SX1262</a></td><td class="desc">Derived class for SX1262 modules </td></tr>
|
|
<tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1268.html" target="_self">SX1268</a></td><td class="desc">Derived class for SX1268 modules </td></tr>
|
|
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x126x.html" target="_self">SX126x</a></td><td class="desc">Base class for SX126x series. All derived classes for SX126x (e.g. <a class="el" href="class_s_x1262.html" title="Derived class for SX1262 modules.">SX1262</a> or <a class="el" href="class_s_x1268.html" title="Derived class for SX1268 modules.">SX1268</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
|
<tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1272.html" target="_self">SX1272</a></td><td class="desc">Derived class for SX1272 modules. Also used as base class for <a class="el" href="class_s_x1273.html" title="Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter range...">SX1273</a>. Both modules use the same basic hardware and only differ in parameter ranges </td></tr>
|
|
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1273.html" target="_self">SX1273</a></td><td class="desc">Derived class for SX1273 modules. Overrides some methods from <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_35_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1276.html" target="_self">SX1276</a></td><td class="desc">Derived class for SX1276 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1277.html" target="_self">SX1277</a></td><td class="desc">Derived class for SX1277 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_37_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1278.html" target="_self">SX1278</a></td><td class="desc">Derived class for SX1278 modules. Also used as base class for <a class="el" href="class_s_x1276.html" title="Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter range...">SX1276</a>, <a class="el" href="class_s_x1277.html" title="Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter range...">SX1277</a>, <a class="el" href="class_s_x1279.html" title="Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...">SX1279</a>, <a class="el" href="class_r_f_m95.html" title="Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM95</a> and <a class="el" href="class_r_f_m96.html" title="Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM96</a>. All of these modules use the same basic hardware and only differ in parameter ranges (and names) </td></tr>
|
|
<tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1279.html" target="_self">SX1279</a></td><td class="desc">Derived class for SX1279 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> due to different parameter ranges </td></tr>
|
|
<tr id="row_39_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x127x.html" target="_self">SX127x</a></td><td class="desc">Base class for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a> series. All derived classes for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a> (e.g. <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...">SX1278</a> or <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
|
<tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1280.html" target="_self">SX1280</a></td><td class="desc">Derived class for SX1280 modules </td></tr>
|
|
<tr id="row_41_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1281.html" target="_self">SX1281</a></td><td class="desc">Derived class for SX1281 modules </td></tr>
|
|
<tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1282.html" target="_self">SX1282</a></td><td class="desc">Derived class for SX1282 modules </td></tr>
|
|
<tr id="row_43_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x128x.html" target="_self">SX128x</a></td><td class="desc">Base class for SX128x series. All derived classes for SX128x (e.g. <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> or <a class="el" href="class_s_x1281.html" title="Derived class for SX1281 modules.">SX1281</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
|
<tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtone__t.html" target="_self">tone_t</a></td><td class="desc">Structure to save data about tone </td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<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>
|