forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ 0f2f5fdf4a 🚀

Browse source
This commit is contained in:
jgromes 2024-10-19 07:20:16 +00:00
parent 035e83facc
commit 16beaf243d
4 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
_f_e_c_8h_source.html
View file

@ -178,7 +178,7 @@ $(document).ready(function(){initNavTree('_f_e_c_8h_source.html',''); initResiza
<div class="ttc" id="aclass_radio_lib_b_c_h_html_aba6f10d4ac2d40eb2222d1081a34c88b"><div class="ttname"><a href="class_radio_lib_b_c_h.html#aba6f10d4ac2d40eb2222d1081a34c88b">RadioLibBCH::begin</a></div><div class="ttdeci">void begin(uint8_t n, uint8_t k, uint32_t poly)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> FEC.cpp:21</div></div>
<div class="ttc" id="aclass_radio_lib_b_c_h_html_ac4ceca6f132ff2047e2ca13d8d00a9e5"><div class="ttname"><a href="class_radio_lib_b_c_h.html#ac4ceca6f132ff2047e2ca13d8d00a9e5">RadioLibBCH::~RadioLibBCH</a></div><div class="ttdeci">~RadioLibBCH()</div><div class="ttdoc">Default destructor.</div><div class="ttdef"><b>Definition:</b> FEC.cpp:8</div></div>
<div class="ttc" id="aclass_radio_lib_b_c_h_html_afa0a2eb58245715536acb781cd351d8a"><div class="ttname"><a href="class_radio_lib_b_c_h.html#afa0a2eb58245715536acb781cd351d8a">RadioLibBCH::encode</a></div><div class="ttdeci">uint32_t encode(uint32_t dataword)</div><div class="ttdoc">Encoding method - encodes one data word (without check bits) into a code word (with check bits).</div><div class="ttdef"><b>Definition:</b> FEC.cpp:200</div></div>
<div class="ttc" id="aclass_radio_lib_conv_code_html"><div class="ttname"><a href="class_radio_lib_conv_code.html">RadioLibConvCode</a></div><div class="ttdoc">Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently support...</div><div class="ttdef"><b>Definition:</b> FEC.h:123</div></div>
<div class="ttc" id="aclass_radio_lib_conv_code_html"><div class="ttname"><a href="class_radio_lib_conv_code.html">RadioLibConvCode</a></div><div class="ttdoc">Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently support...</div><div class="ttdef"><b>Definition:</b> FEC.h:123</div></div>
<div class="ttc" id="aclass_radio_lib_conv_code_html_a4fbe7c4e90969f0be10b8484b405df78"><div class="ttname"><a href="class_radio_lib_conv_code.html#a4fbe7c4e90969f0be10b8484b405df78">RadioLibConvCode::RadioLibConvCode</a></div><div class="ttdeci">RadioLibConvCode()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> FEC.cpp:311</div></div>
<div class="ttc" id="aclass_radio_lib_conv_code_html_a64c324098fab2c5521b3f4e965503ca8"><div class="ttname"><a href="class_radio_lib_conv_code.html#a64c324098fab2c5521b3f4e965503ca8">RadioLibConvCode::encode</a></div><div class="ttdeci">int16_t encode(const uint8_t *in, size_t in_bits, uint8_t *out, size_t *out_bits=NULL)</div><div class="ttdoc">Encoding method.</div><div class="ttdef"><b>Definition:</b> FEC.cpp:320</div></div>
<div class="ttc" id="aclass_radio_lib_conv_code_html_af350f0a8b4d01e54e9d7eac9056c56c3"><div class="ttname"><a href="class_radio_lib_conv_code.html#af350f0a8b4d01e54e9d7eac9056c56c3">RadioLibConvCode::begin</a></div><div class="ttdeci">void begin(uint8_t rt)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> FEC.cpp:315</div></div>

2
annotated.html
View file

@ -136,7 +136,7 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
<tr id="row_43_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</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_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_a_e_s128.html" target="_self">RadioLibAES128</a></td><td class="desc">Class to perform AES encryption, decryption and CMAC </td></tr>
<tr id="row_45_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_b_c_h.html" target="_self">RadioLibBCH</a></td><td class="desc">Class to calculate Bose–Chaudhuri–Hocquenghem (BCH) class of forward error correction codes. In theory, this should be able to calculate an arbitrary BCH(N, K) code, but so far it was only tested for BCH(31, 21) </td></tr>
<tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_conv_code.html" target="_self">RadioLibConvCode</a></td><td class="desc">Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported </td></tr>
<tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_conv_code.html" target="_self">RadioLibConvCode</a></td><td class="desc">Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported </td></tr>
<tr id="row_47_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_c_r_c.html" target="_self">RadioLibCRC</a></td><td class="desc">Class to calculate CRCs of varying formats </td></tr>
<tr id="row_48_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_hal.html" target="_self">RadioLibHal</a></td><td class="desc">Hardware abstraction library base interface </td></tr>
<tr id="row_49_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_print.html" target="_self">RadioLibPrint</a></td><td class="desc">Printing class, based on Arduino Print class with additional encodings </td></tr>

6
class_radio_lib_conv_code.html
View file

@ -90,7 +90,7 @@ $(document).ready(function(){initNavTree('class_radio_lib_conv_code.html',''); i
</div><!--header-->
<div class="contents">
<p>Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported.
<p>Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported.
<a href="class_radio_lib_conv_code.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_f_e_c_8h_source.html">FEC.h</a>&gt;</code></p>
@ -109,8 +109,8 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a64c324098fab2c5521b3f4e965503ca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported. </p>
<p>Copnvolutional coder implementation in this class is adapted from Setmech's LR-FHSS demo: <a href="https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver">https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver</a></p>
<div class="textblock"><p>Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported. </p>
<p>Convolutional coder implementation in this class is adapted from Semtech's LR-FHSS demo: <a href="https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver">https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver</a></p>
<p>Its <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> driver is distributed under the Clear BSD License, and to comply with its terms, it is reproduced below.</p>
<p>The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</p>

2
hierarchy.html
View file

@ -158,7 +158,7 @@ $(document).ready(function(){initNavTree('hierarchy.html',''); initResizable();
<tr id="row_31_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</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_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_a_e_s128.html" target="_self">RadioLibAES128</a></td><td class="desc">Class to perform AES encryption, decryption and CMAC </td></tr>
<tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_b_c_h.html" target="_self">RadioLibBCH</a></td><td class="desc">Class to calculate Bose–Chaudhuri–Hocquenghem (BCH) class of forward error correction codes. In theory, this should be able to calculate an arbitrary BCH(N, K) code, but so far it was only tested for BCH(31, 21) </td></tr>
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_conv_code.html" target="_self">RadioLibConvCode</a></td><td class="desc">Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported </td></tr>
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_conv_code.html" target="_self">RadioLibConvCode</a></td><td class="desc">Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported </td></tr>
<tr id="row_35_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_c_r_c.html" target="_self">RadioLibCRC</a></td><td class="desc">Class to calculate CRCs of varying formats </td></tr>
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_hal.html" target="_self">RadioLibHal</a></td><td class="desc">Hardware abstraction library base interface </td></tr>
<tr id="row_37_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_37_" class="arrow" onclick="toggleFolder('37_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_radio_lib_print.html" target="_self">RadioLibPrint</a></td><td class="desc">Printing class, based on Arduino Print class with additional encodings </td></tr>