diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html index 491de4bd..1dba650d 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -757,33 +757,33 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
Si443x::standby
int16_t standby() override
Sets the module to standby.
Definition: Si443x.cpp:136
Si443x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:321
Si443x::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:499
-
Si443x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:607
+
Si443x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:608
Si443x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets.
Definition: Si443x.cpp:198
Si443x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:375
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:589
+
Si443x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:590
Si443x::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:205
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:120
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:287
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:61
-
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:570
+
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:571
Si443x::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:209
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:213
Si443x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:515
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:547
-
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:566
+
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:567
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:104
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:528
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:598
+
Si443x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:599
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:482
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:603
+
Si443x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: Si443x.cpp:604
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:352
Si443x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: Si443x.cpp:254
-
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:594
+
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:595
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:98
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 277b95db..c74e2978 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -473,7 +473,7 @@ void 
Returns
Status Codes
-
Todo:
power ramp time configuration
+
Todo:
power ramp time configuration

Reimplemented from SX1262.

diff --git a/class_s_x1262.html b/class_s_x1262.html index 0afb567f..2a8cfe54 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -716,7 +716,7 @@ void 
Returns
Status Codes
-
Todo:
power ramp time configuration
+
Todo:
power ramp time configuration

Reimplemented in SX1261.

diff --git a/class_s_x1268.html b/class_s_x1268.html index f3d92021..d77896c0 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -679,7 +679,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.)
@@ -707,7 +707,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 b0e69977..c53787f1 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -1525,7 +1525,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)

Implements PhysicalLayer.

diff --git a/class_s_x1282.html b/class_s_x1282.html index 0c210ccd..774a47b5 100644 --- a/class_s_x1282.html +++ b/class_s_x1282.html @@ -394,7 +394,7 @@ void 
Todo:
implement advanced ranging
+
Todo:
implement advanced ranging
diff --git a/class_s_x128x.html b/class_s_x128x.html index a8fa8160..74dcb5f2 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -836,7 +836,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
@@ -1787,7 +1787,7 @@ void 
Returns
Status Codes
-
Todo:
add support for multiple sync words
+
Todo:
add support for multiple sync words
diff --git a/class_si4430.html b/class_si4430.html index a4556938..c40d3618 100644 --- a/class_si4430.html +++ b/class_si4430.html @@ -209,7 +209,7 @@ void  Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...
  int16_t setDataShaping (uint8_t sh) override - Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+ Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
  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 over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...
diff --git a/class_si4431.html b/class_si4431.html index 768cca51..c980e4b0 100644 --- a/class_si4431.html +++ b/class_si4431.html @@ -206,7 +206,7 @@ void  Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...
  int16_t setDataShaping (uint8_t sh) override - Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+ Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
  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 over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...
diff --git a/class_si4432.html b/class_si4432.html index 76c7e7c7..ae559d20 100644 --- a/class_si4432.html +++ b/class_si4432.html @@ -197,7 +197,7 @@ void  Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...
  int16_t setDataShaping (uint8_t sh) override - Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+ Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
  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 over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...
diff --git a/class_si443x.html b/class_si443x.html index 6f6f82c1..5d471058 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -184,7 +184,7 @@ void  Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...
  int16_t setDataShaping (uint8_t sh) override - Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+ Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
  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 over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...
@@ -862,7 +862,7 @@ void  -

Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.

+

Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.

Parameters
@@ -870,7 +870,6 @@ void 
shGaussian shaping bandwidth-time product that will be used for data shaping
Returns
Status Codes
-
Todo:
implement fiter configuration - docs claim this should be possible, but seems undocumented

Implements PhysicalLayer.

diff --git a/todo.html b/todo.html index 38082eb1..c760c7cf 100644 --- a/todo.html +++ b/todo.html @@ -87,8 +87,6 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
-
Member Si443x::setDataShaping (uint8_t sh) override
-
implement fiter configuration - docs claim this should be possible, but seems undocumented
Member Si443x::setEncoding (uint8_t encoding) override
- add inverted Manchester?
Member Si443x::setRxBandwidth (float rxBw)
@@ -98,21 +96,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)
-
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