From 117a5188dda590f5291787e50fa855df312cc1b0 Mon Sep 17 00:00:00 2001 From: jgromes Date: Mon, 31 Jan 2022 22:16:05 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20b3922?= =?UTF-8?q?470c42ba45618190c9513393098291d92c8=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _si443x_8h_source.html | 18 +++++++++--------- class_s_x1261.html | 2 +- class_s_x1262.html | 2 +- class_s_x1268.html | 4 ++-- class_s_x127x.html | 2 +- class_s_x1282.html | 2 +- class_s_x128x.html | 4 ++-- class_si443x.html | 5 ++--- todo.html | 22 ++++++++++------------ 9 files changed, 29 insertions(+), 32 deletions(-) diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html index a09775a4..6b123cfc 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -752,32 +752,32 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
Si443x::standby
int16_t standby() override
Sets the module to standby.
Definition: Si443x.cpp:143
Si443x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:320
Si443x::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:498
-
Si443x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:601
+
Si443x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:604
Si443x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets.
Definition: Si443x.cpp:205
Si443x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:374
Si443x::begin
int16_t begin(float br, float freqDev, float rxBw, uint8_t preambleLen)
Initialization method.
Definition: Si443x.cpp:12
-
Si443x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:585
+
Si443x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:588
Si443x::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:212
Si443x::sleep
int16_t sleep()
Sets the module to sleep to save power. Module will not be able to transmit or receive any data while...
Definition: Si443x.cpp:127
Si443x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data that was received after calling startReceive method. This method reads len characters.
Definition: Si443x.cpp:286
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:566
+
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:569
Si443x::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:216
Si443x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes...
Definition: Si443x.cpp:220
Si443x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:514
-
Si443x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...
Definition: Si443x.cpp:543
-
Si443x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Si443x.cpp:562
+
Si443x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...
Definition: Si443x.cpp:546
+
Si443x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Si443x.cpp:565
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
Si443x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:524
+
Si443x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:527
Si443x::reset
void reset()
Reset method. Will reset the chip to the default state using SDN pin.
Definition: Si443x.cpp:69
-
Si443x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:593
+
Si443x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:596
Si443x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, size_t len)
Sets sync word. Up to 4 bytes can be set as sync word.
Definition: Si443x.cpp:481
Si443x
Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...
Definition: Si443x.h:554
-
Si443x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: Si443x.cpp:597
+
Si443x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: Si443x.cpp:600
Si443x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....
Definition: Si443x.cpp:351
-
Si443x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:589
+
Si443x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:592
Si443x::receive
int16_t receive(uint8_t *data, size_t len) override
Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long....
Definition: Si443x.cpp:105
Si443x::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to tra...
Definition: Si443x.cpp:77
Si443x::Si443x
Si443x(Module *mod)
Default constructor.
Definition: Si443x.cpp:4
diff --git a/class_s_x1261.html b/class_s_x1261.html index 6891e3be..7a59ac06 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -449,7 +449,7 @@ void 
Returns
Status Codes
-
Todo:
power ramp time configuration
+
Todo:
power ramp time configuration
diff --git a/class_s_x1262.html b/class_s_x1262.html index a08f14ac..ab5537e5 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -652,7 +652,7 @@ void 
Returns
Status Codes
-
Todo:
power ramp time configuration
+
Todo:
power ramp time configuration
diff --git a/class_s_x1268.html b/class_s_x1268.html index e8644f67..9ce274f3 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -623,7 +623,7 @@ void 
Returns
Status Codes
-
Todo:
integers only (all modules - frequency, data rate, bandwidth etc.)
+
Todo:
integers only (all modules - frequency, data rate, bandwidth etc.)
@@ -651,7 +651,7 @@ void 
Returns
Status Codes
-
Todo:
power ramp time configuration
+
Todo:
power ramp time configuration
diff --git a/class_s_x127x.html b/class_s_x127x.html index 0011db2d..bf9e6648 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -1325,7 +1325,7 @@ void 
Returns
Status Codes
-
Todo:
fractional part of bit rate setting (not in OOK)
+
Todo:
fractional part of bit rate setting (not in OOK)
diff --git a/class_s_x1282.html b/class_s_x1282.html index 4108ce5a..2c8c1308 100644 --- a/class_s_x1282.html +++ b/class_s_x1282.html @@ -372,7 +372,7 @@ void 
Todo:
implement advanced ranging
+
Todo:
implement advanced ranging
diff --git a/class_s_x128x.html b/class_s_x128x.html index f94027e4..7c1915f9 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -744,7 +744,7 @@ void 
Returns
Expected time-on-air in microseconds.
-
Todo:
implement this mess - SX1280 datasheet v3.0 section 7.4.4.2
+
Todo:
implement this mess - SX1280 datasheet v3.0 section 7.4.4.2
@@ -1621,7 +1621,7 @@ void 
Returns
Status Codes
-
Todo:
add support for multiple sync words
+
Todo:
add support for multiple sync words
diff --git a/class_si443x.html b/class_si443x.html index 699f8202..60687ddd 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -445,7 +445,6 @@ void 
Returns
Length of last received packet in bytes.
-
Todo:
variable length mode

Implements PhysicalLayer.

@@ -818,7 +817,7 @@ void 
Returns
Status Codes
-
Todo:
implement fiter configuration - docs claim this should be possible, but seems undocumented
+
Todo:
implement fiter configuration - docs claim this should be possible, but seems undocumented

Implements PhysicalLayer.

@@ -892,7 +891,7 @@ void 
Returns
Status Codes
-
Todo:
    +
    Todo:
    • add inverted Manchester?
    diff --git a/todo.html b/todo.html index 63ce9c16..e8527019 100644 --- a/todo.html +++ b/todo.html @@ -87,12 +87,10 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
    -
    Member Si443x::getPacketLength (bool update=true) override
    -
    variable length mode
    Member Si443x::setDataShaping (uint8_t sh) override
    -
    implement fiter configuration - docs claim this should be possible, but seems undocumented
    +
    implement fiter configuration - docs claim this should be possible, but seems undocumented
    Member Si443x::setEncoding (uint8_t encoding) override
    -
    - add inverted Manchester?
    +
    - add inverted Manchester?
    Member Si443x::setRxBandwidth (float rxBw)
    float tolerance equality as macro?
    Member Si443x::startTransmit (uint8_t *data, size_t len, uint8_t addr=0) override
    @@ -100,21 +98,21 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
    Member Si443x::transmitDirect (uint32_t frf=0) override
    integers only
    Member SX1261::setOutputPower (int8_t power)
    -
    power ramp time configuration
    +
    power ramp time configuration
    Member SX1262::setOutputPower (int8_t power)
    -
    power ramp time configuration
    +
    power ramp time configuration
    Member SX1268::setFrequency (float freq, bool calibrate=true)
    -
    integers only (all modules - frequency, data rate, bandwidth etc.)
    +
    integers only (all modules - frequency, data rate, bandwidth etc.)
    Member SX1268::setOutputPower (int8_t power)
    -
    power ramp time configuration
    +
    power ramp time configuration
    Member SX127x::setBitRate (float br)
    -
    fractional part of bit rate setting (not in OOK)
    +
    fractional part of bit rate setting (not in OOK)
    Member SX1282::SX1282 (Module *mod)
    -
    implement advanced ranging
    +
    implement advanced ranging
    Member SX128x::getTimeOnAir (size_t len)
    -
    implement this mess - SX1280 datasheet v3.0 section 7.4.4.2
    +
    implement this mess - SX1280 datasheet v3.0 section 7.4.4.2
    Member SX128x::setSyncWord (uint8_t *syncWord, uint8_t len)
    -
    add support for multiple sync words
    +
    add support for multiple sync words