135 lines
8.7 KiB
HTML
135 lines
8.7 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: RadioLib Documentation</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(document).ready(function(){initNavTree('index.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">RadioLib Documentation </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Universal wireless communication library for Arduino.</p>
|
|
<dl class="section user"><dt>Currently Supported Wireless Modules and Protocols</dt><dd><ul>
|
|
<li><a class="el" href="class_c_c1101.html" title="Control class for CC1101 module. ">CC1101</a> FSK module</li>
|
|
<li><a class="el" href="class_h_c05.html" title="Control class for HC05 module. Most methods supported by this module are implemented in ISerial inter...">HC05</a> Bluetooth module</li>
|
|
<li><a class="el" href="class_j_d_y08.html" title="Control class for JDY08 module. Most methods supported by this module are implemented in ISerial inte...">JDY08</a> BLE module</li>
|
|
<li><a class="el" href="class_r_f69.html" title="Control class for RF69 module. Also serves as base class for SX1231. ">RF69</a> FSK module</li>
|
|
<li><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> FSK module</li>
|
|
<li><a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a> LoRa/FSK module</li>
|
|
<li><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> LoRa/FSK module</li>
|
|
<li><a class="el" href="class_s_x128x.html" title="Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...">SX128x</a> LoRa/GFSK/BLE/FLRC module</li>
|
|
<li><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> FSK module</li>
|
|
<li><a class="el" href="class_x_bee.html" title="Control class for XBee modules. ">XBee</a> module (S2B)</li>
|
|
<li><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> protocols<ul>
|
|
<li>RTTY (<a class="el" href="class_r_t_t_y_client.html" title="Client for RTTY communication. The public interface is the same as Arduino Serial. ">RTTYClient</a>)</li>
|
|
<li>Morse Code (<a class="el" href="class_morse_client.html" title="Client for Morse Code communication. The public interface is the same as Arduino Serial. ">MorseClient</a>)</li>
|
|
<li>AX.25 (<a class="el" href="class_a_x25_client.html" title="Client for AX25 communication. ">AX25Client</a>)</li>
|
|
<li>SSTV (<a class="el" href="class_s_s_t_v_client.html" title="Client for SSTV transmissions. ">SSTVClient</a>)</li>
|
|
<li>Hellschreiber (<a class="el" href="class_hell_client.html" title="Client for Hellschreiber transmissions. ">HellClient</a>)</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> protocols<ul>
|
|
<li>HTTP (<a class="el" href="class_h_t_t_p_client.html" title="Client for simple HTTP communication. ">HTTPClient</a>)</li>
|
|
<li>MQTT (<a class="el" href="class_m_q_t_t_client.html" title="Client for simple MQTT communication. ">MQTTClient</a>)</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Quick Links</dt><dd>Documentation for most common methods can be found in its reference page (see the list above).<br />
|
|
Some methods (mainly configuration) are also overridden in derived classes, such as <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>, <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a>, <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> etc. 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>.<br />
|
|
<a class="el" href="group__status__codes.html">Status Codes</a> have their own page.<br />
|
|
Some modules implement methods of one or more compatibility layers, loosely based on the ISO/OSI model:<ul>
|
|
<li><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> - FSK and LoRa radio modules</li>
|
|
<li><a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> - Modules with Internet connectivity</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://github.com/jgromes/RadioLib">https://github.com/jgromes/RadioLib</a></dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2019 Jan Gromes </dd></dl>
|
|
</div></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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|