From 16beaf243ddd5df41637ae668e04b6f642f56008 Mon Sep 17 00:00:00 2001 From: jgromes Date: Sat, 19 Oct 2024 07:20:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=200f2f5?= =?UTF-8?q?fdf4a12d5d48bcca56d74d80e9965a6ecc2=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _f_e_c_8h_source.html | 2 +- annotated.html | 2 +- class_radio_lib_conv_code.html | 6 +++--- hierarchy.html | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_f_e_c_8h_source.html b/_f_e_c_8h_source.html index 0a467360..bf021140 100644 --- a/_f_e_c_8h_source.html +++ b/_f_e_c_8h_source.html @@ -178,7 +178,7 @@ $(document).ready(function(){initNavTree('_f_e_c_8h_source.html',''); initResiza
RadioLibBCH::begin
void begin(uint8_t n, uint8_t k, uint32_t poly)
Initialization method.
Definition: FEC.cpp:21
RadioLibBCH::~RadioLibBCH
~RadioLibBCH()
Default destructor.
Definition: FEC.cpp:8
RadioLibBCH::encode
uint32_t encode(uint32_t dataword)
Encoding method - encodes one data word (without check bits) into a code word (with check bits).
Definition: FEC.cpp:200
-
RadioLibConvCode
Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently support...
Definition: FEC.h:123
+
RadioLibConvCode
Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently support...
Definition: FEC.h:123
RadioLibConvCode::RadioLibConvCode
RadioLibConvCode()
Default constructor.
Definition: FEC.cpp:311
RadioLibConvCode::encode
int16_t encode(const uint8_t *in, size_t in_bits, uint8_t *out, size_t *out_bits=NULL)
Encoding method.
Definition: FEC.cpp:320
RadioLibConvCode::begin
void begin(uint8_t rt)
Initialization method.
Definition: FEC.cpp:315
diff --git a/annotated.html b/annotated.html index c2d0f47a..34345e96 100644 --- a/annotated.html +++ b/annotated.html @@ -136,7 +136,7 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();  CPhysicalLayerProvides 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  CRadioLibAES128Class to perform AES encryption, decryption and CMAC  CRadioLibBCHClass 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) - CRadioLibConvCodeClass to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported + CRadioLibConvCodeClass to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported  CRadioLibCRCClass to calculate CRCs of varying formats  CRadioLibHalHardware abstraction library base interface  CRadioLibPrintPrinting class, based on Arduino Print class with additional encodings diff --git a/class_radio_lib_conv_code.html b/class_radio_lib_conv_code.html index 481e6664..b2926789 100644 --- a/class_radio_lib_conv_code.html +++ b/class_radio_lib_conv_code.html @@ -90,7 +90,7 @@ $(document).ready(function(){initNavTree('class_radio_lib_conv_code.html',''); i
-

Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported. +

Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported. More...

#include <FEC.h>

@@ -109,8 +109,8 @@ Public Member Functions  

Detailed Description

-

Class to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported.

-

Copnvolutional coder implementation in this class is adapted from Setmech's LR-FHSS demo: https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver

+

Class to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported.

+

Convolutional coder implementation in this class is adapted from Semtech's LR-FHSS demo: https://github.com/Lora-net/SWDM001/tree/master/lib/sx126x_driver

Its SX126x driver is distributed under the Clear BSD License, and to comply with its terms, it is reproduced below.

The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.

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.

diff --git a/hierarchy.html b/hierarchy.html index ba5e5ca9..aa046192 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -158,7 +158,7 @@ $(document).ready(function(){initNavTree('hierarchy.html',''); initResizable();  CnRF24Control class for nRF24 module  CRadioLibAES128Class to perform AES encryption, decryption and CMAC  CRadioLibBCHClass 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) - CRadioLibConvCodeClass to perform convolutional coding wtih variable rates. Only 1/2 and 1/3 rate is currently supported + CRadioLibConvCodeClass to perform convolutional coding with variable rates. Only 1/2 and 1/3 rate is currently supported  CRadioLibCRCClass to calculate CRCs of varying formats  CRadioLibHalHardware abstraction library base interface  ▼CRadioLibPrintPrinting class, based on Arduino Print class with additional encodings