diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html
index cc65d1aa..88e7052e 100644
--- a/_c_c1101_8h_source.html
+++ b/_c_c1101_8h_source.html
@@ -653,174 +653,176 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
- 708 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 779 int16_t
setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
+ 711 int16_t
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask,
size_t len);
+
+ 723 int16_t
readData(uint8_t* data,
size_t len)
override;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- 794 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
+ 794 int16_t
setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
-
-
- 814 int16_t
setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
-
-
-
- 830 int16_t
setOOK(
bool enableOOK);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 960 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
+ 809 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
+
+
+
+ 829 int16_t
setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
+
+
+
+ 845 int16_t
setOOK(
bool enableOOK);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- 973 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
-
-
- 987 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
-
- 993 int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
- 994 int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
- 995 void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
- 996 uint8_t SPIreadRegister(uint8_t reg);
- 997 void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data,
size_t len);
- 998 void SPIwriteRegister(uint8_t reg, uint8_t data);
-
- 1000 void SPIsendCommand(uint8_t cmd);
+
+
+ 975 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 988 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+ 1000 int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
- 1002 #if !defined(RADIOLIB_GODMODE)
+ 1002 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
- 1006 float _freq = RADIOLIB_CC1101_DEFAULT_FREQ;
- 1007 float _br = RADIOLIB_CC1101_DEFAULT_BR;
- 1008 uint8_t _rawRSSI = 0;
- 1009 uint8_t _rawLQI = 0;
- 1010 uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
-
- 1012 size_t _packetLength = 0;
- 1013 bool _packetLengthQueried =
false;
- 1014 uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
-
- 1016 bool _promiscuous =
false;
-
- 1018 bool _directMode =
true;
-
- 1020 int8_t _power = RADIOLIB_CC1101_DEFAULT_POWER;
-
-
-
-
-
- 1026 int16_t directMode(
bool sync);
- 1027 static void getExpMant(
float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
- 1028 int16_t setPacketMode(uint8_t mode, uint16_t len);
-
+
+
+
+ 1008 int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+ 1009 int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
+ 1010 void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
+ 1011 uint8_t SPIreadRegister(uint8_t reg);
+ 1012 void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data,
size_t len);
+ 1013 void SPIwriteRegister(uint8_t reg, uint8_t data);
+
+ 1015 void SPIsendCommand(uint8_t cmd);
+
+ 1017 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 1021 float _freq = RADIOLIB_CC1101_DEFAULT_FREQ;
+ 1022 float _br = RADIOLIB_CC1101_DEFAULT_BR;
+ 1023 uint8_t _rawRSSI = 0;
+ 1024 uint8_t _rawLQI = 0;
+ 1025 uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
+
+ 1027 size_t _packetLength = 0;
+ 1028 bool _packetLengthQueried =
false;
+ 1029 uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
-
+ 1031 bool _promiscuous =
false;
+
+ 1033 bool _directMode =
true;
+
+ 1035 int8_t _power = RADIOLIB_CC1101_DEFAULT_POWER;
+
+
+
+
+
+ 1041 int16_t directMode(
bool sync);
+ 1042 static void getExpMant(
float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
+ 1043 int16_t setPacketMode(uint8_t mode, uint16_t len);
+
+
+
Control class for CC1101 module.
Definition: CC1101.h:517
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:907
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition: CC1101.cpp:507
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: CC1101.cpp:775
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: CC1101.cpp:945
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:915
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition: CC1101.cpp:515
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: CC1101.cpp:783
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: CC1101.cpp:953
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: CC1101.cpp:174
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:824
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition: CC1101.cpp:931
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.
Definition: CC1101.cpp:486
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:832
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition: CC1101.cpp:939
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.
Definition: CC1101.cpp:494
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: CC1101.cpp:225
int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)
Sets 16-bit sync word as a two byte value.
Definition: CC1101.cpp:658
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:903
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: CC1101.cpp:748
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition: CC1101.cpp:810
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: CC1101.cpp:793
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:936
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition: CC1101.cpp:771
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:940
int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)
Sets 16-bit sync word as a two byte value.
Definition: CC1101.cpp:666
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:911
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: CC1101.cpp:756
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition: CC1101.cpp:818
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: CC1101.cpp:801
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:944
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition: CC1101.cpp:779
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:948
CC1101(Module *module)
Default constructor.
Definition: CC1101.cpp:4
int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
Sets node and broadcast addresses. Calling this method will also enable address filtering.
Definition: CC1101.cpp:698
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition: CC1101.cpp:797
int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
Sets node and broadcast addresses. Calling this method will also enable address filtering.
Definition: CC1101.cpp:706
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition: CC1101.cpp:805
int16_t standby() override
Sets the module to standby mode.
Definition: CC1101.cpp:160
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: CC1101.cpp:911
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464....
Definition: CC1101.cpp:440
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: CC1101.cpp:709
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: CC1101.cpp:919
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464....
Definition: CC1101.cpp:448
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: CC1101.cpp:717
int16_t receiveDirectAsync()
Starts asynchronous direct mode reception.
Definition: CC1101.cpp:208
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition: CC1101.cpp:466
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: CC1101.cpp:814
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition: CC1101.cpp:474
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: CC1101.cpp:822
int16_t receiveDirect() override
Starts direct mode reception.
Definition: CC1101.cpp:204
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition: CC1101.cpp:879
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition: CC1101.cpp:887
void clearGdo0Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:236
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition: CC1101.cpp:534
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition: CC1101.cpp:559
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition: CC1101.cpp:542
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition: CC1101.cpp:567
void setGdo2Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)
Sets interrupt service routine to call when GDO2 activates.
Definition: CC1101.cpp:240
void clearGdo2Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:248
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:663
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: CC1101.cpp:789
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADI...
Definition: CC1101.cpp:860
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:671
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: CC1101.cpp:797
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADI...
Definition: CC1101.cpp:868
void setGdo0Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Sets interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:232
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t begin(float freq=RADIOLIB_CC1101_DEFAULT_FREQ, float br=RADIOLIB_CC1101_DEFAULT_BR, float freqDev=RADIOLIB_CC1101_DEFAULT_FREQDEV, float rxBw=RADIOLIB_CC1101_DEFAULT_RXBW, int8_t power=RADIOLIB_CC1101_DEFAULT_POWER, uint8_t preambleLength=RADIOLIB_CC1101_DEFAULT_PREAMBLELEN)
Initialization method.
Definition: CC1101.cpp:12
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition: CC1101.cpp:856
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition: CC1101.cpp:864
int16_t transmitDirectAsync(uint32_t frf=0)
Starts asynchronous direct mode transmission.
Definition: CC1101.cpp:178
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: CC1101.cpp:329
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: CC1101.cpp:339
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:719
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:727
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
106 virtual int16_t
standby(uint8_t mode);
- 119 virtual int16_t
startReceive(uint32_t timeout = 0, uint16_t irqFlags = 0, uint16_t irqMask = 0);
-
- 130 virtual int16_t
receive(uint8_t* data,
size_t len);
-
-
-
-
-
- 167 virtual int16_t
startTransmit(uint8_t* data,
size_t len, uint8_t addr = 0);
-
-
-
- 186 int16_t
readData(String& str,
size_t len = 0);
-
- 198 virtual int16_t
readData(uint8_t* data,
size_t len);
-
-
-
-
-
-
+ 121 virtual int16_t
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask,
size_t len);
+
+ 132 virtual int16_t
receive(uint8_t* data,
size_t len);
+
+
+
+
+
+ 169 virtual int16_t
startTransmit(uint8_t* data,
size_t len, uint8_t addr = 0);
+
+
+
+ 188 int16_t
readData(String& str,
size_t len = 0);
+
+ 200 virtual int16_t
readData(uint8_t* data,
size_t len);
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 302 int32_t
random(int32_t max);
-
- 313 int32_t
random(int32_t min, int32_t max);
-
-
-
-
-
- 329 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
-
-
-
- 353 virtual void readBit(RADIOLIB_PIN_TYPE pin);
-
-
-
-
-
- 374 uint8_t
read(
bool drop =
true);
-
-
- 386 virtual int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
-
-
-
-
-
- 400 #if defined(RADIOLIB_INTERRUPT_TIMING)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 304 int32_t
random(int32_t max);
+
+ 315 int32_t
random(int32_t min, int32_t max);
+
+
+
+
+
+ 331 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+
+
+ 355 virtual void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+
+
+
+ 376 uint8_t
read(
bool drop =
true);
+
+
+ 388 virtual int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
+
+
+
+
- 408 void setInterruptSetup(
void (*func)(uint32_t));
-
-
-
-
+ 402 #if defined(RADIOLIB_INTERRUPT_TIMING)
+
+ 410 void setInterruptSetup(
void (*func)(uint32_t));
+
+
- 418 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
- 420 void updateDirectBuffer(uint8_t bit);
-
-
- 423 #if !defined(RADIOLIB_GODMODE)
-
-
-
- 427 size_t _maxPacketLength;
-
- 429 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
- 430 uint8_t _bufferBitPos;
- 431 uint8_t _bufferWritePos;
- 432 uint8_t _bufferReadPos;
- 433 uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
- 434 uint32_t _syncBuffer;
- 435 uint32_t _directSyncWord;
- 436 uint8_t _directSyncWordLen;
- 437 uint32_t _directSyncWordMask;
-
-
-
- 441 virtual Module* getMod() = 0;
+
+
+ 420 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+ 422 void updateDirectBuffer(uint8_t bit);
+
+
+ 425 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 429 size_t _maxPacketLength;
+
+ 431 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+ 432 uint8_t _bufferBitPos;
+ 433 uint8_t _bufferWritePos;
+ 434 uint8_t _bufferReadPos;
+ 435 uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
+ 436 uint32_t _syncBuffer;
+ 437 uint32_t _directSyncWord;
+ 438 uint8_t _directSyncWordLen;
+ 439 uint32_t _directSyncWordMask;
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+ 443 virtual Module* getMod() = 0;
+
+
+
+
+
+
+
+
+
+
+
+
+
Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...
Definition: AFSK.h:17
Client for AX25 communication.
Definition: AX25.h:279
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:16
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition: Morse.h:93
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
virtual uint8_t randomByte()
Get one truly random byte from RSSI noise. Must be implemented in module class.
Definition: PhysicalLayer.cpp:280
virtual int16_t finishTransmit()
Clean up after transmission is done.
Definition: PhysicalLayer.cpp:148
virtual int16_t setFrequencyDeviation(float freqDev)
Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...
Definition: PhysicalLayer.cpp:220
virtual size_t getPacketLength(bool update=true)
Query modem for the packet length of received payload. Must be implemented in module class.
Definition: PhysicalLayer.cpp:239
void dropSync()
Forcefully drop synchronization.
Definition: PhysicalLayer.cpp:303
virtual int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: PhysicalLayer.cpp:381
uint8_t read(bool drop=true)
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:310
virtual int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)
Interrupt-driven receive method. A DIO pin will be activated when full packet is received....
Definition: PhysicalLayer.cpp:126
virtual uint8_t randomByte()
Get one truly random byte from RSSI noise. Must be implemented in module class.
Definition: PhysicalLayer.cpp:281
virtual int16_t finishTransmit()
Clean up after transmission is done.
Definition: PhysicalLayer.cpp:149
virtual int16_t setFrequencyDeviation(float freqDev)
Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...
Definition: PhysicalLayer.cpp:221
virtual size_t getPacketLength(bool update=true)
Query modem for the packet length of received payload. Must be implemented in module class.
Definition: PhysicalLayer.cpp:240
void dropSync()
Forcefully drop synchronization.
Definition: PhysicalLayer.cpp:304
virtual int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: PhysicalLayer.cpp:382
uint8_t read(bool drop=true)
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:311
PhysicalLayer(float freqStep, size_t maxPacketLength)
Default constructor.
Definition: PhysicalLayer.cpp:3
virtual void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: PhysicalLayer.cpp:387
virtual int16_t startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: PhysicalLayer.cpp:126
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:284
virtual int16_t setFrequency(float freq)
Sets carrier frequency. Must be implemented in module class.
Definition: PhysicalLayer.cpp:210
int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)
Set sync word to be used to determine start of packet in direct reception mode.
Definition: PhysicalLayer.cpp:318
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:235
virtual int16_t transmitDirect(uint32_t frf=0)
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...
Definition: PhysicalLayer.cpp:201
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:244
virtual void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: PhysicalLayer.cpp:388
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:285
virtual int16_t setFrequency(float freq)
Sets carrier frequency. Must be implemented in module class.
Definition: PhysicalLayer.cpp:211
int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)
Set sync word to be used to determine start of packet in direct reception mode.
Definition: PhysicalLayer.cpp:319
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:236
virtual int16_t transmitDirect(uint32_t frf=0)
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...
Definition: PhysicalLayer.cpp:202
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:245
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:299
virtual void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode....
Definition: PhysicalLayer.cpp:371
virtual int16_t setEncoding(uint8_t encoding)
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:230
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:300
virtual void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode....
Definition: PhysicalLayer.cpp:372
virtual int16_t setEncoding(uint8_t encoding)
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:231
virtual int16_t standby()
Sets module to standby.
Definition: PhysicalLayer.cpp:117
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:252
virtual void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: PhysicalLayer.cpp:391
virtual int16_t receiveDirect()
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
Definition: PhysicalLayer.cpp:206
virtual void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:375
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
virtual int16_t setDataShaping(uint8_t sh)
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:225
virtual int16_t setBitRate(float br)
Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:215
virtual float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: PhysicalLayer.cpp:248
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:253
virtual void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: PhysicalLayer.cpp:392
virtual int16_t receiveDirect()
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
Definition: PhysicalLayer.cpp:207
virtual void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:376
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
virtual int16_t setDataShaping(uint8_t sh)
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:226
virtual int16_t setBitRate(float br)
Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.
Definition: PhysicalLayer.cpp:216
virtual float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: PhysicalLayer.cpp:249
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:113
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Client for RTTY communication. The public interface is the same as Arduino Serial.
Definition: RTTY.h:88
735 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 813 int16_t
setSyncWord(uint8_t* syncWord,
size_t len, uint8_t maxErrBits = 0);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 882 int16_t
setOOK(
bool enableOOK);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ 738 int16_t
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask,
size_t len);
+
+ 750 int16_t
readData(uint8_t* data,
size_t len)
override;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 828 int16_t
setSyncWord(uint8_t* syncWord,
size_t len, uint8_t maxErrBits = 0);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 897 int16_t
setOOK(
bool enableOOK);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- 1042 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
+
+
+
+
+
+
+
- 1055 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
- 1067 int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
-
- 1069 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 1074 #if !defined(RADIOLIB_GODMODE)
-
-
-
- 1078 float _freq = RADIOLIB_RF69_DEFAULT_FREQ;
- 1079 float _br = RADIOLIB_RF69_DEFAULT_BR;
- 1080 float _rxBw = RADIOLIB_RF69_DEFAULT_RXBW;
-
- 1082 int16_t _tempOffset = 0;
- 1083 int8_t _power = RADIOLIB_RF69_DEFAULT_POWER;
-
- 1085 size_t _packetLength = 0;
- 1086 bool _packetLengthQueried =
false;
- 1087 uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
+
+
+ 1057 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 1070 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+ 1082 int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
+
+ 1084 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
- 1089 bool _promiscuous =
false;
-
- 1091 uint8_t _syncWordLength = RADIOLIB_RF69_DEFAULT_SW_LEN;
+ 1089 #if !defined(RADIOLIB_GODMODE)
+
+
- 1093 bool _bitSync =
true;
-
-
- 1096 int16_t directMode();
- 1097 int16_t setPacketMode(uint8_t mode, uint8_t len);
-
- 1099 #if !defined(RADIOLIB_GODMODE)
-
-
- 1102 int16_t setMode(uint8_t mode);
- 1103 void clearIRQFlags();
- 1104 void clearFIFO(
size_t count);
-
-
-
-
-
+ 1093 float _freq = RADIOLIB_RF69_DEFAULT_FREQ;
+ 1094 float _br = RADIOLIB_RF69_DEFAULT_BR;
+ 1095 float _rxBw = RADIOLIB_RF69_DEFAULT_RXBW;
+
+ 1097 int16_t _tempOffset = 0;
+ 1098 int8_t _power = RADIOLIB_RF69_DEFAULT_POWER;
+
+ 1100 size_t _packetLength = 0;
+ 1101 bool _packetLengthQueried =
false;
+ 1102 uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
+
+ 1104 bool _promiscuous =
false;
+
+ 1106 uint8_t _syncWordLength = RADIOLIB_RF69_DEFAULT_SW_LEN;
+
+ 1108 bool _bitSync =
true;
+
+
+ 1111 int16_t directMode();
+ 1112 int16_t setPacketMode(uint8_t mode, uint8_t len);
+
+ 1114 #if !defined(RADIOLIB_GODMODE)
+
+
+ 1117 int16_t setMode(uint8_t mode);
+ 1118 void clearIRQFlags();
+ 1119 void clearFIFO(
size_t count);
+
+
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Control class for RF69 module. Also serves as base class for SX1231.
Definition: RF69.h:479
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:753
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:970
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:953
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition: RF69.cpp:309
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:783
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:761
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:978
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:961
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition: RF69.cpp:317
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:791
int16_t disableAES()
Disables AES encryption.
Definition: RF69.cpp:243
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition: RF69.cpp:313
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:727
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition: RF69.cpp:321
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:735
int16_t enableAES()
Enables AES encryption.
Definition: RF69.cpp:239
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:929
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:937
int16_t standby() override
Sets the module to standby mode.
Definition: RF69.cpp:168
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:494
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:502
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: RF69.cpp:181
int16_t getFrequency(float *freq)
Gets carrier frequency.
Definition: RF69.cpp:530
int16_t setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)
Sets sync word. Up to 8 bytes can be set as sync word.
Definition: RF69.cpp:680
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition: RF69.cpp:618
int16_t setOokFixedThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: RF69.cpp:501
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: RF69.cpp:430
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:796
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition: RF69.cpp:865
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:505
int16_t getFrequency(float *freq)
Gets carrier frequency.
Definition: RF69.cpp:538
int16_t setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)
Sets sync word. Up to 8 bytes can be set as sync word.
Definition: RF69.cpp:688
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition: RF69.cpp:626
int16_t setOokFixedThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: RF69.cpp:509
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: RF69.cpp:438
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:804
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition: RF69.cpp:873
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:513
int16_t sleep()
Sets the module to sleep mode.
Definition: RF69.cpp:160
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: RF69.cpp:958
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: RF69.cpp:925
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:736
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:791
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: RF69.cpp:966
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: RF69.cpp:933
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:744
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:799
int16_t begin(float freq=RADIOLIB_RF69_DEFAULT_FREQ, float br=RADIOLIB_RF69_DEFAULT_BR, float freqDev=RADIOLIB_RF69_DEFAULT_FREQDEV, float rxBw=RADIOLIB_RF69_DEFAULT_RXBW, int8_t power=RADIOLIB_RF69_DEFAULT_POWER, uint8_t preambleLen=RADIOLIB_RF69_DEFAULT_PREAMBLELEN)
Initialization method.
Definition: RF69.cpp:12
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: RF69.cpp:231
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:827
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12....
Definition: RF69.cpp:567
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition: RF69.cpp:298
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:706
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:801
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:949
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:770
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:279
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:810
int16_t setOutputPower(int8_t power, bool highPower=false)
Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to ...
Definition: RF69.cpp:642
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again,...
Definition: RF69.cpp:475
void setDio0Action(void(*func)(void))
Sets interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:275
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:903
bool fifoGet(volatile uint8_t *data, int totalLen, volatile int *rcvLen)
Set interrupt service routine function to call when FIFO is sufficently full to read.
Definition: RF69.cpp:350
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:283
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: RF69.cpp:921
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:885
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:835
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12....
Definition: RF69.cpp:575
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition: RF69.cpp:306
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:714
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:809
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:957
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:778
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:287
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:818
int16_t setOutputPower(int8_t power, bool highPower=false)
Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to ...
Definition: RF69.cpp:650
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again,...
Definition: RF69.cpp:483
void setDio0Action(void(*func)(void))
Sets interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:283
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:911
bool fifoGet(volatile uint8_t *data, int totalLen, volatile int *rcvLen)
Set interrupt service routine function to call when FIFO is sufficently full to read.
Definition: RF69.cpp:358
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:291
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: RF69.cpp:929
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:893
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....
Definition: RF69.cpp:509
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition: RF69.cpp:327
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:718
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....
Definition: RF69.cpp:517
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition: RF69.cpp:335
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:726
int16_t receiveDirect() override
Starts direct mode reception.
Definition: RF69.cpp:202
void setAESKey(uint8_t *key)
Sets AES key.
Definition: RF69.cpp:235
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:819
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:749
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:911
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.5 to 300.0 kbps.
Definition: RF69.cpp:545
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:595
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:291
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: RF69.cpp:322
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:787
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:827
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:757
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:919
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.5 to 300.0 kbps.
Definition: RF69.cpp:553
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:603
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:299
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: RF69.cpp:330
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:795
void reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: RF69.cpp:106
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: RF69.cpp:247
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
RF69(Module *module)
Default constructor.
Definition: RF69.cpp:4
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: RF69.cpp:915
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: RF69.cpp:923
@ MODE_IDLE
Definition: STM32WLx.h:57
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: STM32WLx.cpp:31
Derived class for SX1262 modules.
Definition: SX1262.h:23
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1361
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1362
556 int16_t
scanChannel(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
-
+
565 int16_t
sleep(
bool retainConfig =
true);
@@ -559,277 +559,277 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
- 630 int16_t
startReceive(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
- 646 int16_t
startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
- 663 int16_t
startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
-
-
- 682 int16_t
readData(uint8_t* data,
size_t len)
override;
-
- 695 int16_t
startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
-
-
-
-
+ 632 int16_t
startReceive(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE,
size_t len = 0);
+
+ 648 int16_t
startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
+ 665 int16_t
startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
+
+
+ 684 int16_t
readData(uint8_t* data,
size_t len)
override;
+
+ 697 int16_t
startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
+
+
-
-
-
-
-
-
- 742 int16_t
setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 827 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len);
-
- 838 int16_t
setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
-
-
-
-
-
-
- 878 int16_t
setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021,
bool inverted =
true);
-
- 889 int16_t
setWhitening(
bool enabled, uint16_t initial = 0x0100);
-
- 901 int16_t
setTCXO(
float voltage, uint32_t delay = 5000);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 1053 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
-
- 1066 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
- 1082 int16_t
uploadPatch(
const uint32_t* patch,
size_t len,
bool nonvolatile =
true);
-
- 1095 int16_t
spectralScanStart(uint16_t numScans, uint8_t window = RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
-
-
-
-
-
-
-
- 1118 #if !defined(RADIOLIB_GODMODE)
-
-
-
- 1122 int16_t setTx(uint32_t timeout = 0);
- 1123 int16_t setRx(uint32_t timeout);
- 1124 int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
- 1125 int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
- 1126 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 1127 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 1128 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
- 1129 int16_t readBuffer(uint8_t* data, uint8_t numBytes);
- 1130 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
- 1131 virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
- 1132 int16_t setRfFrequency(uint32_t frf);
- 1133 int16_t calibrateImage(uint8_t* data);
- 1134 uint8_t getPacketType();
- 1135 int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
- 1136 int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
- 1137 int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
- 1138 int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
- 1139 int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
- 1140 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
- 1141 int16_t setRegulatorMode(uint8_t mode);
- 1142 uint8_t getStatus();
- 1143 uint32_t getPacketStatus();
- 1144 uint16_t getDeviceErrors();
- 1145 int16_t clearDeviceErrors();
-
- 1147 int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
- 1148 int16_t setFrequencyRaw(
float freq);
- 1149 int16_t setPacketMode(uint8_t mode, uint8_t len);
- 1150 int16_t setHeaderType(uint8_t headerType,
size_t len = 0xFF);
- 1151 int16_t directMode();
- 1152 int16_t packetMode();
-
-
- 1155 int16_t fixSensitivity();
- 1156 int16_t fixPaClamping(
bool enable =
true);
- 1157 int16_t fixImplicitTimeout();
- 1158 int16_t fixInvertedIQ(uint8_t iqConfig);
-
- 1160 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
-
- 1166 static int16_t SPIparseStatus(uint8_t in);
-
- 1168 #if !defined(RADIOLIB_GODMODE)
-
-
-
- 1172 uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
- 1173 uint16_t _preambleLength = 0;
-
- 1175 bool _ldroAuto =
true;
-
- 1177 uint32_t _br = 0, _freqDev = 0;
- 1178 uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
- 1179 uint16_t _preambleLengthFSK = 0;
-
-
- 1182 float _dataRate = 0;
+
+
+
+
+
+
+
+
+ 744 int16_t
setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 829 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len);
+
+ 840 int16_t
setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
+
+
+
+
+
+
+ 880 int16_t
setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021,
bool inverted =
true);
+
+ 891 int16_t
setWhitening(
bool enabled, uint16_t initial = 0x0100);
+
+ 903 int16_t
setTCXO(
float voltage, uint32_t delay = 5000);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 1055 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 1068 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+ 1084 int16_t
uploadPatch(
const uint32_t* patch,
size_t len,
bool nonvolatile =
true);
+
+ 1097 int16_t
spectralScanStart(uint16_t numScans, uint8_t window = RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
+
+
+
+
+
+
+
+ 1120 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 1124 int16_t setTx(uint32_t timeout = 0);
+ 1125 int16_t setRx(uint32_t timeout);
+ 1126 int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+ 1127 int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
+ 1128 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 1129 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 1130 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+ 1131 int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+ 1132 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+ 1133 virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+ 1134 int16_t setRfFrequency(uint32_t frf);
+ 1135 int16_t calibrateImage(uint8_t* data);
+ 1136 uint8_t getPacketType();
+ 1137 int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+ 1138 int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+ 1139 int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
+ 1140 int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
+ 1141 int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+ 1142 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+ 1143 int16_t setRegulatorMode(uint8_t mode);
+ 1144 uint8_t getStatus();
+ 1145 uint32_t getPacketStatus();
+ 1146 uint16_t getDeviceErrors();
+ 1147 int16_t clearDeviceErrors();
+
+ 1149 int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+ 1150 int16_t setFrequencyRaw(
float freq);
+ 1151 int16_t setPacketMode(uint8_t mode, uint8_t len);
+ 1152 int16_t setHeaderType(uint8_t headerType,
size_t len = 0xFF);
+ 1153 int16_t directMode();
+ 1154 int16_t packetMode();
+
+
+ 1157 int16_t fixSensitivity();
+ 1158 int16_t fixPaClamping(
bool enable =
true);
+ 1159 int16_t fixImplicitTimeout();
+ 1160 int16_t fixInvertedIQ(uint8_t iqConfig);
+
+ 1162 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
+
+
+ 1168 static int16_t SPIparseStatus(uint8_t in);
+
+ 1170 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 1174 uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
+ 1175 uint16_t _preambleLength = 0;
+
+ 1177 bool _ldroAuto =
true;
+
+ 1179 uint32_t _br = 0, _freqDev = 0;
+ 1180 uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
+ 1181 uint16_t _preambleLengthFSK = 0;
+
- 1184 uint32_t _tcxoDelay = 0;
+ 1184 float _dataRate = 0;
- 1186 size_t _implicitLen = 0;
- 1187 const char* _chipType;
-
-
-
-
- 1192 int16_t config(uint8_t modem);
- 1193 bool findChip(
const char* verStr);
-
-
-
+ 1186 uint32_t _tcxoDelay = 0;
+
+ 1188 size_t _implicitLen = 0;
+ 1189 const char* _chipType;
+
+
+
+
+ 1194 int16_t config(uint8_t modem);
+ 1195 bool findChip(
const char* verStr);
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
@ MODE_TX
Definition: Module.h:64
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:113
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:432
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1247
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:579
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1248
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:580
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:462
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1224
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:687
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:999
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1345
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1357
int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)
Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...
Definition: SX126x.cpp:1417
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1353
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1225
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:539
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:688
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:1000
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1346
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1358
int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)
Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...
Definition: SX126x.cpp:1418
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1354
int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX126x.cpp:95
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:734
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:539
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1341
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1365
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1079
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1486
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1506
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:899
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1349
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:552
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1183
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:735
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1342
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1366
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1080
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1487
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1507
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:900
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1350
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:553
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1184
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:466
int16_t spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1466
int16_t spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1467
int16_t scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:420
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:450
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:857
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:881
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1295
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1386
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1482
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:858
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:882
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1296
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1387
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1483
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:346
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:531
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:822
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:962
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:823
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:963
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:330
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1291
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1292
int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:13
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1124
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1658
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1125
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1659
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:189
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:811
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:835
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:812
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:836
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:4
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:844
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:845
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1377
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX126x.cpp:1408
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1287
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1096
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:713
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1280
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1052
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1220
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1361
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1378
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX126x.cpp:1409
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1288
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1097
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:714
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1281
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1053
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1221
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1362
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:452
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1337
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1330
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1231
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1559
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1494
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:785
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1338
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1331
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1232
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1560
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1495
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:786
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1113
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:798
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1412
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1114
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:799
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1413
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:244
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:245
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:95
void reset() override
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX1272.cpp:70
int16_t setBandwidth(float bw)
Sets LoRa link bandwidth. Allowed values are 125, 250 and 500 kHz. Only available in LoRa mode.
Definition: SX1272.cpp:89
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:244
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:245
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
SX1278(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1278.cpp:4
int16_t setDataShapingOOK(uint8_t sh)
Sets filter cutoff frequency that will be used for data shaping. Allowed values are 1 for frequency e...
Definition: SX1278.cpp:352
832 int16_t
startReceive(uint8_t len = 0, uint8_t mode = RADIOLIB_SX127X_RXCONTINUOUS);
-
- 844 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 956 int16_t
setAFC(
bool isEnabled);
-
-
-
- 976 int16_t
setSyncWord(uint8_t* syncWord,
size_t len);
-
-
-
-
-
-
-
- 1010 int16_t
setOOK(
bool enableOOK);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 1117 int16_t
setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
-
-
-
-
-
-
-
-
+
+ 847 int16_t
startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask,
size_t len);
+
+ 859 int16_t
readData(uint8_t* data,
size_t len)
override;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 971 int16_t
setAFC(
bool isEnabled);
+
+
+
+ 991 int16_t
setSyncWord(uint8_t* syncWord,
size_t len);
+
+
+
+
+
+
+
+ 1025 int16_t
setOOK(
bool enableOOK);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 1132 int16_t
setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
+
+
+
+
-
-
-
-
-
-
-
-
-
-
- 1182 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
-
- 1195 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
-
-
-
-
-
-
-
-
- 1235 int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
-
-
-
-
-
- 1255 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 1260 #if !defined(RADIOLIB_GODMODE)
-
-
-
-
-
-
-
-
-
- 1270 bool _crcEnabled =
false;
-
- 1272 size_t _packetLength = 0;
-
- 1274 int16_t setFrequencyRaw(
float newFreq);
-
- 1276 int16_t configFSK();
- 1277 int16_t getActiveModem();
- 1278 int16_t directMode();
- 1279 int16_t setPacketMode(uint8_t mode, uint8_t len);
-
- 1281 #if !defined(RADIOLIB_GODMODE)
-
-
- 1284 float _dataRate = 0;
- 1285 bool _packetLengthQueried =
false;
- 1286 uint8_t _packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
-
- 1288 bool findChip(uint8_t ver);
- 1289 int16_t setMode(uint8_t mode);
- 1290 int16_t setActiveModem(uint8_t modem);
- 1291 void clearIRQFlags();
- 1292 void clearFIFO(
size_t count);
- 1300 static uint8_t calculateBWManExp(
float bandwidth);
-
- 1302 virtual void errataFix(
bool rx) = 0;
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 1197 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 1210 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+
+
+
+
+
+
+
+
+ 1250 int16_t
setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value);
+
+
+
+
+
+ 1270 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
+
+ 1275 #if !defined(RADIOLIB_GODMODE)
+
+
+
+
+
+
+
+
+
+ 1285 bool _crcEnabled =
false;
+
+ 1287 size_t _packetLength = 0;
+
+ 1289 int16_t setFrequencyRaw(
float newFreq);
+
+ 1291 int16_t configFSK();
+ 1292 int16_t getActiveModem();
+ 1293 int16_t directMode();
+ 1294 int16_t setPacketMode(uint8_t mode, uint8_t len);
+
+ 1296 #if !defined(RADIOLIB_GODMODE)
+
+
+ 1299 float _dataRate = 0;
+ 1300 bool _packetLengthQueried =
false;
+ 1301 uint8_t _packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
+
+ 1303 bool findChip(uint8_t ver);
+ 1304 int16_t setMode(uint8_t mode);
+ 1305 int16_t setActiveModem(uint8_t modem);
+ 1306 void clearIRQFlags();
+ 1307 void clearFIFO(
size_t count);
+ 1315 static uint8_t calculateBWManExp(
float bandwidth);
+
+ 1317 virtual void errataFix(
bool rx) = 0;
+
+
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...
Definition: SX127x.h:583
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1515
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1521
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets....
Definition: SX127x.cpp:363
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: SX127x.cpp:466
int16_t setOokFixedOrFloorThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: SX127x.cpp:1027
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:1051
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX127x.cpp:1131
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:650
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1490
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition: SX127x.cpp:457
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:1059
bool fifoGet(volatile uint8_t *data, int totalLen, volatile int *rcvLen)
Set interrupt service routine function to call when FIFO is sufficently full to read.
Definition: SX127x.cpp:494
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.
Definition: SX127x.cpp:897
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1254
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: SX127x.cpp:472
int16_t setOokFixedOrFloorThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: SX127x.cpp:1033
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:1057
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX127x.cpp:1137
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:656
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1496
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition: SX127x.cpp:463
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:1065
bool fifoGet(volatile uint8_t *data, int totalLen, volatile int *rcvLen)
Set interrupt service routine function to call when FIFO is sufficently full to read.
Definition: SX127x.cpp:500
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.
Definition: SX127x.cpp:903
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1260
virtual void reset()=0
Reset method. Will reset the chip to the default state using RST pin. Declared pure virtual since SX1...
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:471
int16_t setCurrentLimit(uint8_t currentLimit)
Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...
Definition: SX127x.cpp:688
void clearFHSSInt(void)
Clear the FHSS interrupt.
Definition: SX127x.cpp:1532
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:929
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:477
int16_t setCurrentLimit(uint8_t currentLimit)
Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...
Definition: SX127x.cpp:694
void clearFHSSInt(void)
Clear the FHSS interrupt.
Definition: SX127x.cpp:1538
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:935
int16_t sleep()
Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data ...
Definition: SX127x.cpp:276
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
Definition: SX127x.cpp:855
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:1099
int16_t setOokPeakThresholdStep(uint8_t value)
Size of each decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1043
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:794
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: SX127x.cpp:1191
uint8_t getFHSSChannel(void)
Gets the FHSS channel in use.
Definition: SX127x.cpp:1528
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
Definition: SX127x.cpp:861
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:1105
int16_t setOokPeakThresholdStep(uint8_t value)
Size of each decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1049
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:800
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: SX127x.cpp:1197
uint8_t getFHSSChannel(void)
Gets the FHSS channel in use.
Definition: SX127x.cpp:1534
int16_t begin(uint8_t chipVersion, uint8_t syncWord, uint16_t preambleLength)
Initialization method. Will be called with appropriate parameters when calling initialization method ...
Definition: SX127x.cpp:12
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.5 to 300 kbps. Only available in FSK mode.
Definition: SX127x.cpp:825
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition: SX127x.cpp:913
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1272
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX127x.cpp:1127
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:448
void setDio0Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Set interrupt service routine function to call when DIO0 activates.
Definition: SX127x.cpp:426
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: SX127x.cpp:430
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.5 to 300 kbps. Only available in FSK mode.
Definition: SX127x.cpp:831
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition: SX127x.cpp:919
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1278
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX127x.cpp:1133
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:454
void setDio0Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Set interrupt service routine function to call when DIO0 activates.
Definition: SX127x.cpp:432
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: SX127x.cpp:436
int16_t standby() override
Sets the LoRa module to standby.
Definition: SX127x.cpp:284
int16_t setDIOPreambleDetect(bool usePreambleDetect)
Configure DIO mapping to use RSSI or Preamble Detect for pins that support it.
Definition: SX127x.cpp:1551
int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)
Sets the hopping period and enables FHSS.
Definition: SX127x.cpp:1520
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX127x.cpp:588
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:1055
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:1019
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1301
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: SX127x.cpp:1181
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX127x.cpp:441
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX127x.cpp:1511
int16_t setDIOPreambleDetect(bool usePreambleDetect)
Configure DIO mapping to use RSSI or Preamble Detect for pins that support it.
Definition: SX127x.cpp:1557
int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)
Sets the hopping period and enables FHSS.
Definition: SX127x.cpp:1526
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX127x.cpp:594
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:1061
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:1025
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1307
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: SX127x.cpp:1187
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX127x.cpp:447
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX127x.cpp:1517
int16_t receiveDirect() override
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition: SX127x.cpp:326
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition: SX127x.cpp:453
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1035
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:939
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition: SX127x.cpp:459
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1041
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:945
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t setPreambleLength(uint16_t preambleLength)
Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in ...
Definition: SX127x.cpp:712
int16_t setNodeAddress(uint8_t nodeAddr)
Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode.
Definition: SX127x.cpp:973
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: SX127x.cpp:1220
float getSNR()
Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
Definition: SX127x.cpp:810
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...
Definition: SX127x.cpp:987
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:675
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1239
int16_t setPreambleLength(uint16_t preambleLength)
Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in ...
Definition: SX127x.cpp:718
int16_t setNodeAddress(uint8_t nodeAddr)
Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode.
Definition: SX127x.cpp:979
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: SX127x.cpp:1226
float getSNR()
Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
Definition: SX127x.cpp:816
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...
Definition: SX127x.cpp:993
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:681
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1245
SX127x(Module *mod)
Default constructor. Called internally when creating new LoRa instance.
Definition: SX127x.cpp:4
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX127x.cpp:1268
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1197
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX127x.cpp:1135
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition: SX127x.cpp:1524
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX127x.cpp:1274
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1203
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX127x.cpp:1141
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition: SX127x.cpp:1530
int16_t scanChannel()
Performs scan for valid LoRa preamble in the current channel.
Definition: SX127x.cpp:260
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: SX127x.cpp:1541
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:821
int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: SX127x.cpp:1547
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:827
int16_t beginFSK(uint8_t chipVersion, float br, float freqDev, float rxBw, uint16_t preambleLength, bool enableOOK)
Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK init...
Definition: SX127x.cpp:59
int16_t startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS)
Interrupt-driven receive method. DIO0 will be activated when full valid packet is received.
Definition: SX127x.cpp:372
void setDio1Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Set interrupt service routine function to call when DIO1 activates.
Definition: SX127x.cpp:434
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX127x.cpp:1264
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1297
void setDio1Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Set interrupt service routine function to call when DIO1 activates.
Definition: SX127x.cpp:440
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX127x.cpp:1270
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1303
int16_t transmitDirect(uint32_t frf=0) override
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition: SX127x.cpp:297
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:741
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:747
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:1001
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:1007
576 int16_t
startReceive(uint16_t timeout = RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX128X_IRQ_RX_DONE);
-
-
-
- 594 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
+ 578 int16_t
startReceive(uint16_t timeout = RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX128X_IRQ_RX_DONE,
size_t len = 0);
+
+
+
+ 596 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
-
-
-
-
- 634 int16_t
setCodingRate(uint8_t cr,
bool longInterleaving =
false);
-
-
-
-
-
-
-
-
-
-
-
- 691 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len);
-
- 702 int16_t
setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
- 715 int16_t
setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 830 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
-
- 843 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
- 846 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 851 #if !defined(RADIOLIB_GODMODE)
-
-
-
-
-
- 857 uint8_t _bw = 0, _sf = 0, _cr = 0;
- 858 uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;
-
-
-
- 862 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 863 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
- 864 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
- 865 int16_t readBuffer(uint8_t* data, uint8_t numBytes);
- 866 int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
- 867 int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
- 869 uint8_t getPacketType();
- 870 int16_t setRfFrequency(uint32_t frf);
- 871 int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
- 872 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
- 873 int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
- 874 int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
- 875 int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);
- 876 int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
- 877 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
- 878 int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
- 879 int16_t setRangingRole(uint8_t role);
- 880 int16_t setPacketType(uint8_t type);
-
- 882 int16_t setHeaderType(uint8_t headerType,
size_t len = 0xFF);
+
+
+
+
+
+
+
+
+ 636 int16_t
setCodingRate(uint8_t cr,
bool longInterleaving =
false);
+
+
+
+
+
+
+
+
+
+
+
+ 693 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len);
+
+ 704 int16_t
setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
+ 717 int16_t
setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 832 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 845 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+ 848 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
+
+ 853 #if !defined(RADIOLIB_GODMODE)
+
+
+
+
+
+ 859 uint8_t _bw = 0, _sf = 0, _cr = 0;
+ 860 uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;
+
+
+
+ 864 int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 865 int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+ 866 int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+ 867 int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+ 868 int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+ 869 int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
+ 871 uint8_t getPacketType();
+ 872 int16_t setRfFrequency(uint32_t frf);
+ 873 int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
+ 874 int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+ 875 int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
+ 876 int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
+ 877 int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);
+ 878 int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
+ 879 int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
+ 880 int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
+ 881 int16_t setRangingRole(uint8_t role);
+ 882 int16_t setPacketType(uint8_t type);
- 884 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 889 static int16_t SPIparseStatus(uint8_t in);
-
- 891 #if !defined(RADIOLIB_GODMODE)
-
-
-
-
-
-
- 898 float _modIndexReal = 0;
- 899 uint16_t _brKbps = 0;
- 900 uint8_t _br = 0, _modIndex = 0, _shaping = 0;
- 901 uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;
-
-
-
-
-
- 907 uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;
-
- 909 int16_t config(uint8_t modem);
-
-
-
+ 884 int16_t setHeaderType(uint8_t headerType,
size_t len = 0xFF);
+
+ 886 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
+
+ 891 static int16_t SPIparseStatus(uint8_t in);
+
+ 893 #if !defined(RADIOLIB_GODMODE)
+
+
+
+
+
+
+ 900 float _modIndexReal = 0;
+ 901 uint16_t _brKbps = 0;
+ 902 uint8_t _br = 0, _modIndex = 0, _shaping = 0;
+ 903 uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;
+
+
+
+
+
+ 909 uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;
+
+ 911 int16_t config(uint8_t modem);
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:113
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:351
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:469
int16_t setSyncWord(uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:897
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:729
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:623
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1188
int16_t setSyncWord(uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:899
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:731
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:625
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1190
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX128x.cpp:262
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:834
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1148
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:836
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1150
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:457
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1285
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1287
int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for BLE modem.
Definition: SX128x.cpp:142
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1068
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1181
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1070
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1183
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:541
int16_t setBitRate(float br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:777
int16_t setBitRate(float br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:779
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX128x.cpp:373
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1264
int16_t setHighSensitivityMode(bool hsm=false)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1051
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1260
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1266
int16_t setHighSensitivityMode(bool hsm=false)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1053
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:549
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1262
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:396
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1128
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:1020
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1130
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:1022
int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint16_t preambleLength=16)
Initialization method for GFSK modem.
Definition: SX128x.cpp:73
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1040
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1256
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1104
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1272
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:867
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1042
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1258
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1106
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1274
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:869
SX128x(Module *mod)
Default constructor.
Definition: SX128x.cpp:4
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:695
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:956
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:697
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:958
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:473
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1252
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1254
int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t power=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for FLRC modem.
Definition: SX128x.cpp:197
int16_t begin(float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=12)
Initialization method for LoRa modem.
Definition: SX128x.cpp:12
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:723
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:549
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1268
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1385
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:661
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:631
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:725
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1270
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1387
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:663
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:633
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1279
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1281
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:388
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:27
719 int16_t
readData(uint8_t* data,
size_t len)
override;
-
-
-
-
-
-
-
-
-
- 757 int16_t
setSyncWord(uint8_t* syncWord,
size_t len);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 817 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
+ 722 int16_t
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask,
size_t len);
+
+ 734 int16_t
readData(uint8_t* data,
size_t len)
override;
+
+
+
+
+
+
+
+
+
+ 772 int16_t
setSyncWord(uint8_t* syncWord,
size_t len);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- 830 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
-
-
-
-
- 851 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 856 #if !defined(RADIOLIB_GODMODE)
-
-
-
-
-
-
-
- 864 size_t _packetLength = 0;
- 865 bool _packetLengthQueried =
false;
- 866 uint8_t _packetLengthConfig = RADIOLIB_SI443X_FIXED_PACKET_LENGTH_ON;
-
- 868 int16_t setFrequencyRaw(
float newFreq);
- 869 int16_t setPacketMode(uint8_t mode, uint8_t len);
+
+
+ 832 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 845 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+
+
+
+
+ 866 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
871 #if !defined(RADIOLIB_GODMODE)
-
+
-
- 875 void clearIRQFlags();
- 876 void clearFIFO(
size_t count);
-
- 878 int16_t updateClockRecovery();
- 879 int16_t directMode();
-
-
-
-
-
+
+
+
+
+
+ 879 size_t _packetLength = 0;
+ 880 bool _packetLengthQueried =
false;
+ 881 uint8_t _packetLengthConfig = RADIOLIB_SI443X_FIXED_PACKET_LENGTH_ON;
+
+ 883 int16_t setFrequencyRaw(
float newFreq);
+ 884 int16_t setPacketMode(uint8_t mode, uint8_t len);
+
+ 886 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 890 void clearIRQFlags();
+ 891 void clearFIFO(
size_t count);
+
+ 893 int16_t updateClockRecovery();
+ 894 int16_t directMode();
+
+
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...
Definition: Si443x.h:554
int16_t startReceive()
Interrupt-driven receive method. IRQ will be activated when full valid packet is received.
Definition: Si443x.cpp:265
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:531
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:539
int16_t receiveDirect() override
Enables direct reception mode. While in direct mode, the module will not be able to transmit or recei...
Definition: Si443x.cpp:188
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:518
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:526
int16_t begin(float br, float freqDev, float rxBw, uint8_t preambleLen)
Initialization method.
Definition: Si443x.cpp:12
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:606
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:502
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:485
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:378
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Si443x.cpp:574
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:597
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:602
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:614
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:510
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:493
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:386
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Si443x.cpp:582
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:605
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:610
int16_t transmitDirect(uint32_t frf=0) override
Enables direct transmission mode. While in direct mode, the module will not be able to transmit or re...
Definition: Si443x.cpp:146
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets.
Definition: Si443x.cpp:201
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: Si443x.cpp:257
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:578
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....
Definition: Si443x.cpp:355
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:586
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....
Definition: Si443x.cpp:363
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:208
void clearIrqAction()
Clears interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:212
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:615
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: Si443x.cpp:623
int16_t standby() override
Sets the module to standby (with XTAL on).
Definition: Si443x.cpp:136
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: Si443x.cpp:611
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:324
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: Si443x.cpp:619
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:332
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
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:550
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Si443x.cpp:570
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:558
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Si443x.cpp:578
void reset()
Reset method. Will reset the chip to the default state using SDN pin.
Definition: Si443x.cpp:69
Si443x(Module *mod)
Default constructor.
Definition: Si443x.cpp:4
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:152
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:133
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
| standby(uint8_t mode) override | CC1101 | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | CC1101 | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | CC1101 | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | CC1101 | virtual |
| startTransmit(String &str, uint8_t addr=0) | CC1101 | |
| startTransmit(const char *str, uint8_t addr=0) | CC1101 | |
diff --git a/class_c_c1101.html b/class_c_c1101.html
index 555f15c1..267bc95c 100644
--- a/class_c_c1101.html
+++ b/class_c_c1101.html
@@ -166,6 +166,9 @@ void | int16_t | startReceive () |
| | Interrupt-driven receive method. GDO0 will be activated when full packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data received after calling startReceive method. More...
|
| |
@@ -314,9 +317,6 @@ void | virtual int16_t | sleep () |
| | Sets module to sleep. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -1881,7 +1881,7 @@ virtual void
-◆ startReceive()
+◆ startReceive() [1/2]
@@ -1898,6 +1898,68 @@ virtual void | Interrupt-driven receive method. GDO0 will be activated when full packet is received.
- Returns
- Status Codes
+
+
+
+◆ startReceive() [2/2]
+
+
+
+
+
+
+
+
+ | int16_t CC1101::startReceive |
+ ( |
+ uint32_t |
+ timeout, |
+
+
+ |
+ |
+ uint16_t |
+ irqFlags, |
+
+
+ |
+ |
+ uint16_t |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+virtual |
+
+
+
+
+ Interrupt-driven receive method, implemented for compatibility with PhysicalLayer.
+ - Parameters
-
+
+ | timeout | Ignored. |
+ | irqFlags | Ignored. |
+ | irqMask | Ignored. |
+ | len | Ignored. |
+
+
+
+ - Returns
- Status Codes
+
+ Reimplemented from PhysicalLayer.
+
| | standby() | PhysicalLayer | virtual |
| standby(uint8_t mode) | PhysicalLayer | virtual |
| startDirect() | PhysicalLayer | |
- | startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(String &str, uint8_t addr=0) | PhysicalLayer | |
| startTransmit(const char *str, uint8_t addr=0) | PhysicalLayer | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) | PhysicalLayer | virtual |
diff --git a/class_external_radio.html b/class_external_radio.html
index cae6be08..a27e61bd 100644
--- a/class_external_radio.html
+++ b/class_external_radio.html
@@ -132,9 +132,9 @@ Public Member Functions
| virtual int16_t | standby (uint8_t mode) |
| | Sets module to a specific standby mode. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| virtual int16_t | receive (uint8_t *data, size_t len) |
| | Binary receive method. Must be implemented in module class. More...
|
| |
diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html
index 5a6a6be5..f2cc8979 100644
--- a/class_l_l_c_c68-members.html
+++ b/class_l_l_c_c68-members.html
@@ -175,7 +175,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
- | startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+ | startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html
index d3174d4d..b6b0428b 100644
--- a/class_l_l_c_c68.html
+++ b/class_l_l_c_c68.html
@@ -195,9 +195,9 @@ void | int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
diff --git a/class_physical_layer-members.html b/class_physical_layer-members.html
index 3a8713ca..57095c37 100644
--- a/class_physical_layer-members.html
+++ b/class_physical_layer-members.html
@@ -129,7 +129,7 @@ $(document).ready(function(){initNavTree('class_physical_layer.html',''); initRe
| standby() | PhysicalLayer | virtual |
| standby(uint8_t mode) | PhysicalLayer | virtual |
| startDirect() | PhysicalLayer | |
- | startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(String &str, uint8_t addr=0) | PhysicalLayer | |
| startTransmit(const char *str, uint8_t addr=0) | PhysicalLayer | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) | PhysicalLayer | virtual |
diff --git a/class_physical_layer.html b/class_physical_layer.html
index 64ea638b..df585042 100644
--- a/class_physical_layer.html
+++ b/class_physical_layer.html
@@ -141,9 +141,9 @@ Public Member Functions
| virtual int16_t | standby (uint8_t mode) |
| | Sets module to a specific standby mode. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| virtual int16_t | receive (uint8_t *data, size_t len) |
| | Binary receive method. Must be implemented in module class. More...
|
| |
@@ -1289,8 +1289,8 @@ class PagerClient |
-
-◆ startReceive()
+
+◆ startReceive()
@@ -1302,19 +1302,25 @@ class
PagerClient |
int16_t PhysicalLayer::startReceive |
( |
uint32_t |
-
timeout = 0, |
+
timeout, |
|
|
uint16_t |
- irqFlags = 0, |
+ irqFlags, |
|
|
uint16_t |
- irqMask = 0 |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
|
@@ -1329,18 +1335,19 @@ class PagerClient |
-
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
+
Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class.
- Parameters
-
- | timeout | Raw timeout value. |
+ | timeout | Raw timeout value. Some modules use this argument to specify operation mode (single vs. continuous receive). |
| irqFlags | Sets the IRQ flags. |
- | irqMask | Sets the mask of IRQ flags that will trigger DIO1. |
+ | irqMask | Sets the mask of IRQ flags that will trigger the DIO pin. |
+ | len | Packet length, needed for some modules under special circumstances (e.g. LoRa implicit header mode). |
- Returns
- Status Codes
-
Reimplemented in SX126x.
+
Reimplemented in SX126x, Si443x, RF69, nRF24, CC1101, and SX127x.
| standby(uint8_t mode) override | RF69 | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | RF69 | |
-
| PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+
| startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | RF69 | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | RF69 | virtual |
| startTransmit(String &str, uint8_t addr=0) | RF69 | |
| startTransmit(const char *str, uint8_t addr=0) | RF69 | |
diff --git a/class_r_f69.html b/class_r_f69.html
index 3db8f7f5..8658643e 100644
--- a/class_r_f69.html
+++ b/class_r_f69.html
@@ -197,6 +197,9 @@ void
| int16_t | startReceive () |
| | Interrupt-driven receive method. GDO0 will be activated when full packet is received. More...
|
| |
+
| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+
| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+
| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data received after calling startReceive method. More...
|
| |
@@ -366,9 +369,6 @@ void
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-
| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -2288,7 +2288,7 @@ void
-◆ startReceive()
+◆ startReceive() [1/2]
@@ -2305,6 +2305,68 @@ void | ReturnsStatus Codes
+
+
+
+◆ startReceive() [2/2]
+
+
+
+
+
+
+
+
+ | int16_t RF69::startReceive |
+ ( |
+ uint32_t |
+ timeout, |
+
+
+ |
+ |
+ uint16_t |
+ irqFlags, |
+
+
+ |
+ |
+ uint16_t |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+virtual |
+
+
+
+
+ Interrupt-driven receive method, implemented for compatibility with PhysicalLayer.
+ - Parameters
-
+
+ | timeout | Ignored. |
+ | irqFlags | Ignored. |
+ | irqMask | Ignored. |
+ | len | Ignored. |
+
+
+
+ - Returns
- Status Codes
+
+ Reimplemented from PhysicalLayer.
+
| | startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
-
| PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+
| startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_r_f_m95.html b/class_r_f_m95.html
index da540eb2..a0d4e693 100644
--- a/class_r_f_m95.html
+++ b/class_r_f_m95.html
@@ -260,6 +260,9 @@ void
| int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+
| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+
| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+
| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -460,9 +463,6 @@ void
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-
| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_r_f_m96-members.html b/class_r_f_m96-members.html
index 561ebdbb..fd66c93f 100644
--- a/class_r_f_m96-members.html
+++ b/class_r_f_m96-members.html
@@ -195,7 +195,7 @@ $(document).ready(function(){initNavTree('class_r_f_m96.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
-
| PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+
| startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_r_f_m96.html b/class_r_f_m96.html
index 17d0ea81..5f4908fa 100644
--- a/class_r_f_m96.html
+++ b/class_r_f_m96.html
@@ -259,6 +259,9 @@ void
| int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+
| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+
| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+
| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -459,9 +462,6 @@ void
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-
| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_r_f_m97-members.html b/class_r_f_m97-members.html
index 8c15bd20..2b0881ae 100644
--- a/class_r_f_m97-members.html
+++ b/class_r_f_m97-members.html
@@ -196,7 +196,7 @@ $(document).ready(function(){initNavTree('class_r_f_m97.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
-
| PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+
| startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_r_f_m97.html b/class_r_f_m97.html
index 16ed4675..c6f33e8b 100644
--- a/class_r_f_m97.html
+++ b/class_r_f_m97.html
@@ -267,6 +267,9 @@ void
| int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+
| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+
| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+
| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -467,9 +470,6 @@ void
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-
| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html
index 4660a630..1c94d5a0 100644
--- a/class_s_t_m32_w_lx-members.html
+++ b/class_s_t_m32_w_lx-members.html
@@ -181,7 +181,7 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
-
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html
index 0ca142e6..6e245071 100644
--- a/class_s_t_m32_w_lx.html
+++ b/class_s_t_m32_w_lx.html
@@ -217,9 +217,9 @@ void
| int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
+
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+
| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
diff --git a/class_s_x1231-members.html b/class_s_x1231-members.html
index 477ca79a..2bdb1722 100644
--- a/class_s_x1231-members.html
+++ b/class_s_x1231-members.html
@@ -169,7 +169,7 @@ $(document).ready(function(){initNavTree('class_s_x1231.html',''); initResizable
| standby(uint8_t mode) override | RF69 | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | RF69 | |
-
| PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+
| startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | RF69 | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | RF69 | virtual |
| startTransmit(String &str, uint8_t addr=0) | RF69 | |
| startTransmit(const char *str, uint8_t addr=0) | RF69 | |
diff --git a/class_s_x1231.html b/class_s_x1231.html
index d5e480da..329622fe 100644
--- a/class_s_x1231.html
+++ b/class_s_x1231.html
@@ -204,6 +204,9 @@ void
| int16_t | startReceive () |
| | Interrupt-driven receive method. GDO0 will be activated when full packet is received. More...
|
| |
+
| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+
| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+
| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data received after calling startReceive method. More...
|
| |
@@ -373,9 +376,6 @@ void
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-
| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html
index d4837b65..1064063a 100644
--- a/class_s_x1261-members.html
+++ b/class_s_x1261-members.html
@@ -174,7 +174,7 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
-
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_s_x1261.html b/class_s_x1261.html
index 7b821ce6..83a4b0d3 100644
--- a/class_s_x1261.html
+++ b/class_s_x1261.html
@@ -186,9 +186,9 @@ void
| int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
+
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+
| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html
index f6397e95..32758b4a 100644
--- a/class_s_x1262-members.html
+++ b/class_s_x1262-members.html
@@ -174,7 +174,7 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
-
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_s_x1262.html b/class_s_x1262.html
index e773ff9e..1f0b3b55 100644
--- a/class_s_x1262.html
+++ b/class_s_x1262.html
@@ -184,9 +184,9 @@ void
| int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
+
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+
| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html
index f81b06ff..4b8f02f1 100644
--- a/class_s_x1268-members.html
+++ b/class_s_x1268-members.html
@@ -173,7 +173,7 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
-
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_s_x1268.html b/class_s_x1268.html
index 85cde4ef..4aff839d 100644
--- a/class_s_x1268.html
+++ b/class_s_x1268.html
@@ -178,9 +178,9 @@ void
| int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
+
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+
| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html
index f7ec81ce..98067d33 100644
--- a/class_s_x126x-members.html
+++ b/class_s_x126x-members.html
@@ -169,7 +169,7 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable
| standby(uint8_t mode) | SX126x | virtual |
| startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) | SX126x | |
| startDirect() | PhysicalLayer | |
-
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | virtual |
+
| startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) | SX126x | virtual |
| startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) | SX126x | |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX126x | virtual |
diff --git a/class_s_x126x.html b/class_s_x126x.html
index c5c0ab3a..67467615 100644
--- a/class_s_x126x.html
+++ b/class_s_x126x.html
@@ -164,9 +164,9 @@ void
| int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
-
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-
| |
+
| int16_t | startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0) |
+
| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+
| |
| int16_t | startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE) |
| | Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...
|
| |
@@ -2468,8 +2468,8 @@ bool
-◆ startReceive()
+
+◆ startReceive()
@@ -2493,7 +2493,13 @@ bool | |
|
uint16_t |
-
irqMask = RADIOLIB_SX126X_IRQ_RX_DONE |
+
irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, |
+
+
+ |
+ |
+ size_t |
+ len = 0 |
|
@@ -2514,12 +2520,13 @@ bool timeout | Raw timeout value, expressed as multiples of 15.625 us. Defaults to RADIOLIB_SX126X_RX_TIMEOUT_INF for infinite timeout (Rx continuous mode), set to RADIOLIB_SX126X_RX_TIMEOUT_NONE for no timeout (Rx single mode). If timeout other than infinite is set, signal will be generated on DIO1. |
| irqFlags | Sets the IRQ flags, defaults to RADIOLIB_SX126X_IRQ_RX_DEFAULT. |
| irqMask | Sets the mask of IRQ flags that will trigger DIO1, defaults to RADIOLIB_SX126X_IRQ_RX_DONE. |
+
| len | Only for PhysicalLayer compatibility, not used. |
- Returns
- Status Codes
-
Reimplemented from PhysicalLayer.
+
Reimplemented from PhysicalLayer.
diff --git a/class_s_x126x.js b/class_s_x126x.js
index c56fbd72..93d68df5 100644
--- a/class_s_x126x.js
+++ b/class_s_x126x.js
@@ -67,7 +67,7 @@ var class_s_x126x =
[ "standby", "class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71", null ],
[ "standby", "class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd", null ],
[ "startChannelScan", "class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2", null ],
- [ "startReceive", "class_s_x126x.html#a34057f054d1cd3cce520ddf87b0821d5", null ],
+ [ "startReceive", "class_s_x126x.html#a0ec1b926c93885739b546a7f39e8b09c", null ],
[ "startReceiveDutyCycle", "class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e", null ],
[ "startReceiveDutyCycleAuto", "class_s_x126x.html#a077f180905ce4818cbdacad0cd9fe841", null ],
[ "startTransmit", "class_s_x126x.html#a923654706eff5118ef6e84214e837f27", null ],
diff --git a/class_s_x1272-members.html b/class_s_x1272-members.html
index a7d36ada..3cd88a53 100644
--- a/class_s_x1272-members.html
+++ b/class_s_x1272-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1272.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1272.html b/class_s_x1272.html
index a1d4d99b..0d01f782 100644
--- a/class_s_x1272.html
+++ b/class_s_x1272.html
@@ -246,6 +246,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -446,9 +449,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1273-members.html b/class_s_x1273-members.html
index a46050e3..9d072026 100644
--- a/class_s_x1273-members.html
+++ b/class_s_x1273-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1273.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1273.html b/class_s_x1273.html
index 75d2dce2..a09e27c8 100644
--- a/class_s_x1273.html
+++ b/class_s_x1273.html
@@ -256,6 +256,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -456,9 +459,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1276-members.html b/class_s_x1276-members.html
index f27d8341..8a841df5 100644
--- a/class_s_x1276-members.html
+++ b/class_s_x1276-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1276.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1276.html b/class_s_x1276.html
index b28d6ee9..a4934dc3 100644
--- a/class_s_x1276.html
+++ b/class_s_x1276.html
@@ -259,6 +259,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -459,9 +462,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1277-members.html b/class_s_x1277-members.html
index b1b54db0..16777500 100644
--- a/class_s_x1277-members.html
+++ b/class_s_x1277-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1277.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1277.html b/class_s_x1277.html
index 0ce0b473..be65fa87 100644
--- a/class_s_x1277.html
+++ b/class_s_x1277.html
@@ -262,6 +262,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -462,9 +465,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1278-members.html b/class_s_x1278-members.html
index e337e038..dc3f35c1 100644
--- a/class_s_x1278-members.html
+++ b/class_s_x1278-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1278.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1278.html b/class_s_x1278.html
index 9f0c9254..2c2c0a82 100644
--- a/class_s_x1278.html
+++ b/class_s_x1278.html
@@ -251,6 +251,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -451,9 +454,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1279-members.html b/class_s_x1279-members.html
index 071868d7..a8e9014d 100644
--- a/class_s_x1279-members.html
+++ b/class_s_x1279-members.html
@@ -194,7 +194,7 @@ $(document).ready(function(){initNavTree('class_s_x1279.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x1279.html b/class_s_x1279.html
index 66dea78a..52921df2 100644
--- a/class_s_x1279.html
+++ b/class_s_x1279.html
@@ -256,6 +256,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -456,9 +459,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x127x-members.html b/class_s_x127x-members.html
index fa8677ab..233a0b85 100644
--- a/class_s_x127x-members.html
+++ b/class_s_x127x-members.html
@@ -180,7 +180,7 @@ $(document).ready(function(){initNavTree('class_s_x127x.html',''); initResizable
| startChannelScan() | SX127x | |
| startDirect() | PhysicalLayer | |
| startReceive(uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) | SX127x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) | SX127x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX127x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX127x | |
| startTransmit(const char *str, uint8_t addr=0) | SX127x | |
diff --git a/class_s_x127x.html b/class_s_x127x.html
index 65279a7c..982299d8 100644
--- a/class_s_x127x.html
+++ b/class_s_x127x.html
@@ -201,6 +201,9 @@ void | int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS) |
| | Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -401,9 +404,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -2539,10 +2539,72 @@ void ReturnsStatus Codes
+
+
+
+◆ startReceive() [1/2]
+
+
+
+
+
+
+
+
+ | int16_t SX127x::startReceive |
+ ( |
+ uint32_t |
+ mode, |
+
+
+ |
+ |
+ uint16_t |
+ irqFlags, |
+
+
+ |
+ |
+ uint16_t |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+virtual |
+
+
+
+
+ Interrupt-driven receive method, implemented for compatibility with PhysicalLayer.
+ - Parameters
-
+
+ | mode | Receive mode to be used. |
+ | irqFlags | Ignored. |
+ | irqMask | Ignored. |
+ | len | Expected length of packet to be received. Required for LoRa spreading factor 6. |
+
+
+
+ - Returns
- Status Codes
+
+ Reimplemented from PhysicalLayer.
+
◆ startReceive()
+◆ startReceive() [2/2]
diff --git a/class_s_x127x.js b/class_s_x127x.js
index 4e1fc574..5ed6dbc1 100644
--- a/class_s_x127x.js
+++ b/class_s_x127x.js
@@ -76,6 +76,7 @@ var class_s_x127x =
[ "standby", "class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41", null ],
[ "standby", "class_s_x127x.html#aa565bbff460e487672953dc05d335cb0", null ],
[ "startChannelScan", "class_s_x127x.html#a1d4631691c16d6ecf38815dc4e59a059", null ],
+ [ "startReceive", "class_s_x127x.html#a0ae533401c801f1d4034eb3db8b1f30c", null ],
[ "startReceive", "class_s_x127x.html#adffb96b7f80dc43909bb4cebde68fe9d", null ],
[ "startTransmit", "class_s_x127x.html#a923654706eff5118ef6e84214e837f27", null ],
[ "startTransmit", "class_s_x127x.html#af068e6e862c99e39d0261a7971dd56db", null ],
diff --git a/class_s_x1280-members.html b/class_s_x1280-members.html
index 7d140bee..03575186 100644
--- a/class_s_x1280-members.html
+++ b/class_s_x1280-members.html
@@ -155,8 +155,8 @@ $(document).ready(function(){initNavTree('class_s_x1280.html',''); initResizable
| standby(uint8_t mode) | SX128x | virtual |
| startDirect() | PhysicalLayer | |
| startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL) | SX1280 | |
- | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) | SX128x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) | SX128x | |
+ | PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX128x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX128x | |
| startTransmit(const char *str, uint8_t addr=0) | SX128x | |
diff --git a/class_s_x1280.html b/class_s_x1280.html
index 6745d344..719a6988 100644
--- a/class_s_x1280.html
+++ b/class_s_x1280.html
@@ -184,9 +184,9 @@ void | | int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) |
+| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+| |
| uint16_t | getIrqStatus () |
| | Reads the current IRQ status. More...
|
| |
@@ -332,9 +332,9 @@ void | virtual int16_t | sleep () |
| | Sets module to sleep. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1281-members.html b/class_s_x1281-members.html
index 7b368a8e..22e23006 100644
--- a/class_s_x1281-members.html
+++ b/class_s_x1281-members.html
@@ -152,8 +152,8 @@ $(document).ready(function(){initNavTree('class_s_x1281.html',''); initResizable
| standby() override | SX128x | virtual |
| standby(uint8_t mode) | SX128x | virtual |
| startDirect() | PhysicalLayer | |
- | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) | SX128x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) | SX128x | |
+ | PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX128x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX128x | |
| startTransmit(const char *str, uint8_t addr=0) | SX128x | |
diff --git a/class_s_x1281.html b/class_s_x1281.html
index 49c1e19c..3774add1 100644
--- a/class_s_x1281.html
+++ b/class_s_x1281.html
@@ -171,9 +171,9 @@ void | int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) |
+| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+| |
| uint16_t | getIrqStatus () |
| | Reads the current IRQ status. More...
|
| |
@@ -319,9 +319,9 @@ void | virtual int16_t | sleep () |
| | Sets module to sleep. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x1282-members.html b/class_s_x1282-members.html
index 21b5b2a9..e58804e4 100644
--- a/class_s_x1282-members.html
+++ b/class_s_x1282-members.html
@@ -155,8 +155,8 @@ $(document).ready(function(){initNavTree('class_s_x1282.html',''); initResizable
| standby(uint8_t mode) | SX128x | virtual |
| startDirect() | PhysicalLayer | |
| startRanging(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL) | SX1280 | |
- | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) | SX128x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) | SX128x | |
+ | PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX128x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX128x | |
| startTransmit(const char *str, uint8_t addr=0) | SX128x | |
diff --git a/class_s_x1282.html b/class_s_x1282.html
index 55af41ed..98c1d17b 100644
--- a/class_s_x1282.html
+++ b/class_s_x1282.html
@@ -188,9 +188,9 @@ void | int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) |
+| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+| |
| uint16_t | getIrqStatus () |
| | Reads the current IRQ status. More...
|
| |
@@ -336,9 +336,9 @@ void | virtual int16_t | sleep () |
| | Sets module to sleep. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_s_x128x-members.html b/class_s_x128x-members.html
index 4248f9fd..baff1559 100644
--- a/class_s_x128x-members.html
+++ b/class_s_x128x-members.html
@@ -152,8 +152,8 @@ $(document).ready(function(){initNavTree('class_s_x128x.html',''); initResizable
| standby() override | SX128x | virtual |
| standby(uint8_t mode) | SX128x | virtual |
| startDirect() | PhysicalLayer | |
- | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) | SX128x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) | SX128x | |
+ | PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | PhysicalLayer | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | SX128x | virtual |
| startTransmit(String &str, uint8_t addr=0) | SX128x | |
| startTransmit(const char *str, uint8_t addr=0) | SX128x | |
diff --git a/class_s_x128x.html b/class_s_x128x.html
index c372e9bf..18f68ed6 100644
--- a/class_s_x128x.html
+++ b/class_s_x128x.html
@@ -167,9 +167,9 @@ void | int16_t | finishTransmit () override |
| | Clean up after transmission is done. More...
|
| |
-| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| int16_t | startReceive (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0) |
+| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
+| |
| uint16_t | getIrqStatus () |
| | Reads the current IRQ status. More...
|
| |
@@ -315,9 +315,9 @@ void | virtual int16_t | sleep () |
| | Sets module to sleep. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
+| virtual int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. More...
|
+| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -2050,8 +2050,8 @@ void
-◆ startReceive()
+
+◆ startReceive()
@@ -2072,7 +2072,13 @@ void | |
|
uint16_t |
- irqMask = RADIOLIB_SX128X_IRQ_RX_DONE |
+ irqMask = RADIOLIB_SX128X_IRQ_RX_DONE, |
+
+
+ |
+ |
+ size_t |
+ len = 0 |
|
@@ -2088,6 +2094,7 @@ void timeout | Raw timeout value, expressed as multiples of 15.625 us. Defaults to RADIOLIB_SX128X_RX_TIMEOUT_INF for infinite timeout (Rx continuous mode), set to RADIOLIB_SX128X_RX_TIMEOUT_NONE for no timeout (Rx single mode). If timeout other than infinite is set, signal will be generated on DIO1. |
| irqFlags | Sets the IRQ flags, defaults to RADIOLIB_SX128X_IRQ_RX_DEFAULT. |
| irqMask | Sets the mask of IRQ flags that will trigger DIO1, defaults to RADIOLIB_SX128X_IRQ_RX_DONE. |
+ | len | Only for PhysicalLayer compatibility, not used. |
diff --git a/class_s_x128x.js b/class_s_x128x.js
index 0664786a..6f4e6b79 100644
--- a/class_s_x128x.js
+++ b/class_s_x128x.js
@@ -51,7 +51,7 @@ var class_s_x128x =
[ "sleep", "class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f", null ],
[ "standby", "class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45", null ],
[ "standby", "class_s_x128x.html#aa11ba80f0cebb3e6927c775ad5f96b4e", null ],
- [ "startReceive", "class_s_x128x.html#add774469f0bde099082a29068064712c", null ],
+ [ "startReceive", "class_s_x128x.html#a8530aaeacc4c12736ce5aa5b5460ee19", null ],
[ "startTransmit", "class_s_x128x.html#a923654706eff5118ef6e84214e837f27", null ],
[ "startTransmit", "class_s_x128x.html#af068e6e862c99e39d0261a7971dd56db", null ],
[ "startTransmit", "class_s_x128x.html#ad59e37ce0606dc8051e40be9d14cfec3", null ],
diff --git a/class_si4430-members.html b/class_si4430-members.html
index 61da6a72..9b69110c 100644
--- a/class_si4430-members.html
+++ b/class_si4430-members.html
@@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_si4430.html',''); initResizable(
| standby(uint8_t mode) override | Si443x | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | Si443x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | Si443x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | Si443x | virtual |
| startTransmit(String &str, uint8_t addr=0) | Si443x | |
| startTransmit(const char *str, uint8_t addr=0) | Si443x | |
diff --git a/class_si4430.html b/class_si4430.html
index 6c9881d9..c25b9579 100644
--- a/class_si4430.html
+++ b/class_si4430.html
@@ -187,6 +187,9 @@ void | int16_t | startReceive () |
| | Interrupt-driven receive method. IRQ will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -287,9 +290,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_si4431-members.html b/class_si4431-members.html
index 945355d6..f191159d 100644
--- a/class_si4431-members.html
+++ b/class_si4431-members.html
@@ -144,7 +144,7 @@ $(document).ready(function(){initNavTree('class_si4431.html',''); initResizable(
| standby(uint8_t mode) override | Si443x | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | Si443x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | Si443x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | Si443x | virtual |
| startTransmit(String &str, uint8_t addr=0) | Si443x | |
| startTransmit(const char *str, uint8_t addr=0) | Si443x | |
diff --git a/class_si4431.html b/class_si4431.html
index e2335c37..e407afd5 100644
--- a/class_si4431.html
+++ b/class_si4431.html
@@ -184,6 +184,9 @@ void | int16_t | startReceive () |
| | Interrupt-driven receive method. IRQ will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -284,9 +287,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_si4432-members.html b/class_si4432-members.html
index f51b116d..dff74cdc 100644
--- a/class_si4432-members.html
+++ b/class_si4432-members.html
@@ -143,7 +143,7 @@ $(document).ready(function(){initNavTree('class_si4432.html',''); initResizable(
| standby(uint8_t mode) override | Si443x | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | Si443x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | Si443x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | Si443x | virtual |
| startTransmit(String &str, uint8_t addr=0) | Si443x | |
| startTransmit(const char *str, uint8_t addr=0) | Si443x | |
diff --git a/class_si4432.html b/class_si4432.html
index 793e5881..c14b3258 100644
--- a/class_si4432.html
+++ b/class_si4432.html
@@ -175,6 +175,9 @@ void | int16_t | startReceive () |
| | Interrupt-driven receive method. IRQ will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -275,9 +278,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
diff --git a/class_si443x-members.html b/class_si443x-members.html
index 3912d240..599981b2 100644
--- a/class_si443x-members.html
+++ b/class_si443x-members.html
@@ -140,7 +140,7 @@ $(document).ready(function(){initNavTree('class_si443x.html',''); initResizable(
| standby(uint8_t mode) override | Si443x | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | Si443x | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | Si443x | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override | Si443x | virtual |
| startTransmit(String &str, uint8_t addr=0) | Si443x | |
| startTransmit(const char *str, uint8_t addr=0) | Si443x | |
diff --git a/class_si443x.html b/class_si443x.html
index c47571d5..8ae748f9 100644
--- a/class_si443x.html
+++ b/class_si443x.html
@@ -162,6 +162,9 @@ void | int16_t | startReceive () |
| | Interrupt-driven receive method. IRQ will be activated when full valid packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data that was received after calling startReceive method. This method reads len characters. More...
|
| |
@@ -262,9 +265,6 @@ void | int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -1330,7 +1330,7 @@ virtual void
-◆ startReceive()
+◆ startReceive() [1/2]
@@ -1347,6 +1347,68 @@ virtual void | Interrupt-driven receive method. IRQ will be activated when full valid packet is received.
- Returns
- Status Codes
+
+
+
+◆ startReceive() [2/2]
+
+
+
+
+
+
+
+
+ | int16_t Si443x::startReceive |
+ ( |
+ uint32_t |
+ timeout, |
+
+
+ |
+ |
+ uint16_t |
+ irqFlags, |
+
+
+ |
+ |
+ uint16_t |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+virtual |
+
+
+
+
+ Interrupt-driven receive method, implemented for compatibility with PhysicalLayer.
+ - Parameters
-
+
+ | timeout | Ignored. |
+ | irqFlags | Ignored. |
+ | irqMask | Ignored. |
+ | len | Ignored. |
+
+
+
+ - Returns
- Status Codes
+
+ Reimplemented from PhysicalLayer.
+
| | standby(uint8_t mode) override | nRF24 | virtual |
| startDirect() | PhysicalLayer | |
| startReceive() | nRF24 | |
- | PhysicalLayer::startReceive(uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) | PhysicalLayer | virtual |
+ | startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) | nRF24 | virtual |
| startTransmit(uint8_t *data, size_t len, uint8_t addr) override | nRF24 | virtual |
| startTransmit(String &str, uint8_t addr=0) | nRF24 | |
| startTransmit(const char *str, uint8_t addr=0) | nRF24 | |
diff --git a/classn_r_f24.html b/classn_r_f24.html
index d9270a39..76a7a460 100644
--- a/classn_r_f24.html
+++ b/classn_r_f24.html
@@ -148,6 +148,9 @@ Public Member Functions
| int16_t | startReceive () |
| | Interrupt-driven receive method. IRQ will be activated when full packet is received. More...
|
| |
+| int16_t | startReceive (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len) |
+| | Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
|
+| |
| int16_t | readData (uint8_t *data, size_t len) override |
| | Reads data received after calling startReceive method. More...
|
| |
@@ -260,9 +263,6 @@ Public Member Functions
| int16_t | receive (String &str, size_t len=0) |
| | Arduino String receive method. More...
|
| |
-| virtual int16_t | startReceive (uint32_t timeout=0, uint16_t irqFlags=0, uint16_t irqMask=0) |
-| | Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...
|
-| |
| int16_t | startTransmit (String &str, uint8_t addr=0) |
| | Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...
|
| |
@@ -1419,7 +1419,7 @@ virtual void
-◆ startReceive()
+◆ startReceive() [1/2]
@@ -1436,6 +1436,68 @@ virtual void | Interrupt-driven receive method. IRQ will be activated when full packet is received.
- Returns
- Status Codes
+
+
+
+◆ startReceive() [2/2]
+
+
+
+
+
+
+
+
+ | int16_t nRF24::startReceive |
+ ( |
+ uint32_t |
+ timeout, |
+
+
+ |
+ |
+ uint16_t |
+ irqFlags, |
+
+
+ |
+ |
+ uint16_t |
+ irqMask, |
+
+
+ |
+ |
+ size_t |
+ len |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+virtual |
+
+
+
+
+ Interrupt-driven receive method, implemented for compatibility with PhysicalLayer.
+ - Parameters
-
+
+ | timeout | Ignored. |
+ | irqFlags | Ignored. |
+ | irqMask | Ignored. |
+ | len | Ignored. |
+
+
+
+ - Returns
- Status Codes
+
+ Reimplemented from PhysicalLayer.
+
335 int16_t readData(uint8_t* data, size_t len) override;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 476 int16_t setAutoAck(uint8_t pipeNum, bool autoAckOn);
-
-
-
-
-
-
-
- 503 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
+ 339 int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
+
+ 350 int16_t readData(uint8_t* data, size_t len) override;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 491 int16_t setAutoAck(uint8_t pipeNum, bool autoAckOn);
+
+
+
+
- 516 void readBit(RADIOLIB_PIN_TYPE pin);
-
-
- 519 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
-
-
-
- 524 void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
- 525 void SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);
- 526 void SPItransfer(uint8_t cmd, bool write = false, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
-
- 528 #if !defined(RADIOLIB_GODMODE)
-
-
-
- 532 int16_t _freq = RADIOLIB_NRF24_DEFAULT_FREQ;
- 533 int16_t _dataRate = RADIOLIB_NRF24_DEFAULT_DR;
- 534 int8_t _power = RADIOLIB_NRF24_DEFAULT_POWER;
- 535 uint8_t _addrWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;
-
-
-
-
-
-
-
+
+
+ 518 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
+
+ 531 void readBit(RADIOLIB_PIN_TYPE pin);
+
+
+ 534 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
+
+
+
+ 539 void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
+ 540 void SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);
+ 541 void SPItransfer(uint8_t cmd, bool write = false, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
+
+ 543 #if !defined(RADIOLIB_GODMODE)
+
+
+
+ 547 int16_t _freq = RADIOLIB_NRF24_DEFAULT_FREQ;
+ 548 int16_t _dataRate = RADIOLIB_NRF24_DEFAULT_DR;
+ 549 int8_t _power = RADIOLIB_NRF24_DEFAULT_POWER;
+ 550 uint8_t _addrWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;
+
+
+
+
+
+
+
Implements all common low-level methods to control the wireless module. Every module class contains o... Definition: Module.h:24 Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN.... Definition: PhysicalLayer.h:14 int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0) Arduino Flash String transmit method. Definition: PhysicalLayer.cpp:12 int16_t readData(String &str, size_t len=0) Reads data that was received after calling startReceive method. Definition: PhysicalLayer.cpp:152 int16_t startTransmit(String &str, uint8_t addr=0) Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,... Definition: PhysicalLayer.cpp:133 int16_t readData(String &str, size_t len=0) Reads data that was received after calling startReceive method. Definition: PhysicalLayer.cpp:153 int16_t startTransmit(String &str, uint8_t addr=0) Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,... Definition: PhysicalLayer.cpp:134 int16_t receive(String &str, size_t len=0) Arduino String receive method. Definition: PhysicalLayer.cpp:60 Control class for nRF24 module. Definition: nRF24.h:186 int16_t sleep() Sets the module to sleep mode. Definition: nRF24.cpp:70 int16_t setEncoding(uint8_t encoding) override Dummy encoding configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:533 int16_t setBitRate(float br) Sets bit rate. Allowed values are 2000, 1000 or 250 kbps. Definition: nRF24.cpp:270 int16_t setEncoding(uint8_t encoding) override Dummy encoding configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:541 int16_t setBitRate(float br) Sets bit rate. Allowed values are 2000, 1000 or 250 kbps. Definition: nRF24.cpp:278 int16_t transmitDirect(uint32_t frf=0) override Starts direct mode transmission. Definition: nRF24.cpp:136 int16_t setDataShaping(uint8_t sh) override Dummy data shaping configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:526 size_t getPacketLength(bool update=true) override Query modem for the packet length of received payload. Definition: nRF24.cpp:479 void readBit(RADIOLIB_PIN_TYPE pin) Dummy method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:553 int16_t setReceivePipe(uint8_t pipeNum, uint8_t *addr) Sets address of receive pipes 0 or 1. The address width must be the same as the same as the configure... Definition: nRF24.cpp:381 void setDirectAction(void(*func)(void)) Dummy method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:547 int16_t setCrcFiltering(bool crcOn=true) Enable CRC filtering and generation. Definition: nRF24.cpp:486 int16_t getStatus(uint8_t mask=0xFF) Gets nRF24 status register. Definition: nRF24.cpp:464 int16_t setFrequency(float freq) Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz. Definition: nRF24.cpp:256 int16_t setDataShaping(uint8_t sh) override Dummy data shaping configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:534 size_t getPacketLength(bool update=true) override Query modem for the packet length of received payload. Definition: nRF24.cpp:487 void readBit(RADIOLIB_PIN_TYPE pin) Dummy method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:561 int16_t setReceivePipe(uint8_t pipeNum, uint8_t *addr) Sets address of receive pipes 0 or 1. The address width must be the same as the same as the configure... Definition: nRF24.cpp:389 void setDirectAction(void(*func)(void)) Dummy method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:555 int16_t setCrcFiltering(bool crcOn=true) Enable CRC filtering and generation. Definition: nRF24.cpp:494 int16_t getStatus(uint8_t mask=0xFF) Gets nRF24 status register. Definition: nRF24.cpp:472 int16_t setFrequency(float freq) Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz. Definition: nRF24.cpp:264 int16_t receiveDirect() override Dummy direct mode reception method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:151 int16_t disablePipe(uint8_t pipeNum) Disables specified receive pipe. Definition: nRF24.cpp:433 int16_t setFrequencyDeviation(float freqDev) override Dummy configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:472 int16_t disablePipe(uint8_t pipeNum) Disables specified receive pipe. Definition: nRF24.cpp:441 int16_t setFrequencyDeviation(float freqDev) override Dummy configuration method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:480 int16_t standby() override Sets the module to standby mode. Definition: nRF24.cpp:74 int16_t setAddressWidth(uint8_t addrWidth) Sets address width of transmit and receive pipes in bytes. Allowed values are 3, 4 or 5 bytes. Definition: nRF24.cpp:333 uint8_t randomByte() Dummy random method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:540 int16_t setOutputPower(int8_t power) Sets output power. Allowed values are -18, -12, -6 or 0 dBm. Definition: nRF24.cpp:298 int16_t setTransmitPipe(uint8_t *addr) Sets address of transmit pipe. The address width must be the same as the same as the configured in se... Definition: nRF24.cpp:366 int16_t setAddressWidth(uint8_t addrWidth) Sets address width of transmit and receive pipes in bytes. Allowed values are 3, 4 or 5 bytes. Definition: nRF24.cpp:341 uint8_t randomByte() Dummy random method, to ensure PhysicalLayer compatibility. Definition: nRF24.cpp:548 int16_t setOutputPower(int8_t power) Sets output power. Allowed values are -18, -12, -6 or 0 dBm. Definition: nRF24.cpp:306 int16_t setTransmitPipe(uint8_t *addr) Sets address of transmit pipe. The address width must be the same as the same as the configured in se... Definition: nRF24.cpp:374 int16_t begin(int16_t freq=RADIOLIB_NRF24_DEFAULT_FREQ, int16_t dataRate=RADIOLIB_NRF24_DEFAULT_DR, int8_t power=RADIOLIB_NRF24_DEFAULT_POWER, uint8_t addrWidth=RADIOLIB_NRF24_DEFAULT_ADDRWIDTH) Initialization method. Definition: nRF24.cpp:12 nRF24(Module *mod) Default constructor. Definition: nRF24.cpp:4 int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0) Arduino Flash String transmit method. Definition: PhysicalLayer.cpp:12 void setIrqAction(void(*func)(void)) Sets interrupt service routine to call when IRQ activates. Definition: nRF24.cpp:157 int16_t setAutoAck(bool autoAckOn=true) Enable or disable auto-acknowledge packets on all pipes. Definition: nRF24.cpp:497 bool isCarrierDetected() Checks if carrier was detected during last RX. Definition: nRF24.cpp:468 int16_t readData(String &str, size_t len=0) Reads data that was received after calling startReceive method. Definition: PhysicalLayer.cpp:152 int16_t startTransmit(String &str, uint8_t addr=0) Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,... Definition: PhysicalLayer.cpp:133 int16_t setAutoAck(bool autoAckOn=true) Enable or disable auto-acknowledge packets on all pipes. Definition: nRF24.cpp:505 bool isCarrierDetected() Checks if carrier was detected during last RX. Definition: nRF24.cpp:476 int16_t readData(String &str, size_t len=0) Reads data that was received after calling startReceive method. Definition: PhysicalLayer.cpp:153 int16_t startTransmit(String &str, uint8_t addr=0) Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,... Definition: PhysicalLayer.cpp:134 int16_t finishTransmit() override Clean up after transmission is done. Definition: nRF24.cpp:201 int16_t startReceive() Interrupt-driven receive method. IRQ will be activated when full packet is received. Definition: nRF24.cpp:209 int16_t receive(String &str, size_t len=0) Arduino String receive method. Definition: PhysicalLayer.cpp:60 |