From 9438f15ce5af9d2175df5f16cb860719787bbe1b Mon Sep 17 00:00:00 2001 From: jgromes Date: Sun, 21 Nov 2021 20:18:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=201d429?= =?UTF-8?q?5feed7e6c9227d98ffdb34c9a87e4242cc3=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _c_c1101_8h_source.html | 258 ++++++++++----------- _physical_layer_8h_source.html | 130 +++++------ _r_f69_8h_source.html | 289 +++++++++++------------ _s_x126x_8h_source.html | 410 ++++++++++++++++----------------- _s_x127x_8h_source.html | 324 +++++++++++++------------- _s_x128x_8h_source.html | 304 ++++++++++++------------ _si443x_8h_source.html | 145 ++++++------ class_c_c1101.html | 6 +- class_physical_layer.html | 4 +- class_r_f69.html | 6 +- class_s_x126x.html | 6 +- class_s_x127x.html | 6 +- class_s_x128x.html | 6 +- class_si443x.html | 6 +- classn_r_f24.html | 4 +- n_r_f24_8h_source.html | 36 +-- 16 files changed, 971 insertions(+), 969 deletions(-) diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index 05acd25d..a1380ed3 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -629,156 +629,156 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
642 
648  int16_t startReceive();
649 
-
659  int16_t readData(uint8_t* data, size_t len) override;
-
660 
-
661  // configuration methods
-
662 
-
670  int16_t setFrequency(float freq);
-
671 
-
679  int16_t setBitRate(float br);
-
680 
-
688  int16_t setRxBandwidth(float rxBw);
-
689 
-
697  int16_t setFrequencyDeviation(float freqDev) override;
-
698 
-
706  int16_t setOutputPower(int8_t power);
-
707 
-
721  int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
722 
-
736  int16_t setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
737 
-
745  int16_t setPreambleLength(uint8_t preambleLength);
-
746 
-
756  int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
-
757 
-
763  int16_t disableAddressFiltering();
-
764 
-
772  int16_t setOOK(bool enableOOK);
-
773 
-
779  float getRSSI() const;
-
780 
-
786  uint8_t getLQI() const;
-
787 
-
795  size_t getPacketLength(bool update = true) override;
-
796 
-
804  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
-
805 
-
813  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
-
814 
-
824  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
825 
-
833  int16_t disableSyncWordFiltering(bool requireCarrierSense = false);
-
834 
-
842  int16_t setCrcFiltering(bool crcOn = true);
-
843 
-
851  int16_t setPromiscuousMode(bool promiscuous = true);
-
852 
-
858  bool getPromiscuousMode();
-
859 
-
868  int16_t setDataShaping(uint8_t sh) override;
-
869 
-
877  int16_t setEncoding(uint8_t encoding) override;
-
878 
-
887  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
888 
-
894  uint8_t randomByte();
-
895 
-
901  int16_t getChipVersion();
-
902 
-
908  void setDirectAction(void (*func)(void));
-
909 
-
915  void readBit(RADIOLIB_PIN_TYPE pin);
-
916 
-
917  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
918  protected:
-
919  #endif
-
920  Module* _mod;
-
921 
-
922  // SPI read overrides to set bit for burst write and status registers access
-
923  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
-
924  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
-
925  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
-
926  uint8_t SPIreadRegister(uint8_t reg);
-
927  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
-
928  void SPIwriteRegister(uint8_t reg, uint8_t data);
-
929 
-
930  void SPIsendCommand(uint8_t cmd);
-
931 
-
932  #if !defined(RADIOLIB_GODMODE)
-
933  protected:
-
934  #endif
-
935 
-
936  float _freq = 0;
-
937  float _br = 0;
-
938  uint8_t _rawRSSI = 0;
-
939  uint8_t _rawLQI = 0;
-
940  uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
-
941 
-
942  size_t _packetLength = 0;
-
943  bool _packetLengthQueried = false;
-
944  uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
-
945 
-
946  bool _promiscuous = false;
-
947  bool _crcOn = true;
-
948 
-
949  uint8_t _syncWordLength = 2;
-
950  int8_t _power = 0;
-
951 
-
952  int16_t config();
-
953  int16_t directMode();
-
954  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
-
955  int16_t setPacketMode(uint8_t mode, uint16_t len);
-
956 };
-
957 
-
958 #endif
+
660  int16_t readData(uint8_t* data, size_t len) override;
+
661 
+
662  // configuration methods
+
663 
+
671  int16_t setFrequency(float freq);
+
672 
+
680  int16_t setBitRate(float br);
+
681 
+
689  int16_t setRxBandwidth(float rxBw);
+
690 
+
698  int16_t setFrequencyDeviation(float freqDev) override;
+
699 
+
707  int16_t setOutputPower(int8_t power);
+
708 
+
722  int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
723 
+
737  int16_t setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
738 
+
746  int16_t setPreambleLength(uint8_t preambleLength);
+
747 
+
757  int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
+
758 
+
764  int16_t disableAddressFiltering();
+
765 
+
773  int16_t setOOK(bool enableOOK);
+
774 
+
780  float getRSSI() const;
+
781 
+
787  uint8_t getLQI() const;
+
788 
+
796  size_t getPacketLength(bool update = true) override;
+
797 
+
805  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
+
806 
+
814  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
+
815 
+
825  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
826 
+
834  int16_t disableSyncWordFiltering(bool requireCarrierSense = false);
+
835 
+
843  int16_t setCrcFiltering(bool crcOn = true);
+
844 
+
852  int16_t setPromiscuousMode(bool promiscuous = true);
+
853 
+
859  bool getPromiscuousMode();
+
860 
+
869  int16_t setDataShaping(uint8_t sh) override;
+
870 
+
878  int16_t setEncoding(uint8_t encoding) override;
+
879 
+
888  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
889 
+
895  uint8_t randomByte();
+
896 
+
902  int16_t getChipVersion();
+
903 
+
909  void setDirectAction(void (*func)(void));
+
910 
+
916  void readBit(RADIOLIB_PIN_TYPE pin);
+
917 
+
918  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
919  protected:
+
920  #endif
+
921  Module* _mod;
+
922 
+
923  // SPI read overrides to set bit for burst write and status registers access
+
924  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
925  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
+
926  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
+
927  uint8_t SPIreadRegister(uint8_t reg);
+
928  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
+
929  void SPIwriteRegister(uint8_t reg, uint8_t data);
+
930 
+
931  void SPIsendCommand(uint8_t cmd);
+
932 
+
933  #if !defined(RADIOLIB_GODMODE)
+
934  protected:
+
935  #endif
+
936 
+
937  float _freq = 0;
+
938  float _br = 0;
+
939  uint8_t _rawRSSI = 0;
+
940  uint8_t _rawLQI = 0;
+
941  uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
+
942 
+
943  size_t _packetLength = 0;
+
944  bool _packetLengthQueried = false;
+
945  uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
+
946 
+
947  bool _promiscuous = false;
+
948  bool _crcOn = true;
+
949 
+
950  uint8_t _syncWordLength = 2;
+
951  int8_t _power = 0;
+
952 
+
953  int16_t config();
+
954  int16_t directMode();
+
955  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
+
956  int16_t setPacketMode(uint8_t mode, uint16_t len);
+
957 };
+
958 
+
959 #endif
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
-
CC1101::disableSyncWordFiltering
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition: CC1101.cpp:748
+
CC1101::disableSyncWordFiltering
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition: CC1101.cpp:749
CC1101::startReceive
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: CC1101.cpp:315
-
CC1101::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: CC1101.cpp:713
-
CC1101::getLQI
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition: CC1101.cpp:709
+
CC1101::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: CC1101.cpp:714
+
CC1101::getLQI
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition: CC1101.cpp:710
CC1101::clearGdo0Action
void clearGdo0Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:222
CC1101::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: CC1101.cpp:241
-
CC1101::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:865
+
CC1101::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:866
CC1101::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: CC1101.cpp:102
-
CC1101::setOutputPower
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:506
-
CC1101::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.
Definition: CC1101.cpp:813
+
CC1101::setOutputPower
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:507
+
CC1101::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.
Definition: CC1101.cpp:814
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
CC1101::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: CC1101.cpp:336
CC1101::setGdo2Action
void setGdo2Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)
Sets interrupt service routine to call when GDO2 activates.
Definition: CC1101.cpp:226
-
CC1101::getPromiscuousMode
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition: CC1101.cpp:790
+
CC1101::getPromiscuousMode
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition: CC1101.cpp:791
CC1101::clearGdo2Action
void clearGdo2Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:234
-
CC1101::setSyncWord
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:607
-
CC1101::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition: CC1101.cpp:861
-
CC1101::getRSSI
float getRSSI() const
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: CC1101.cpp:699
-
CC1101::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:670
-
CC1101::setFrequency
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:417
-
CC1101::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: CC1101.cpp:660
-
CC1101::setNodeAddress
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:649
-
CC1101::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition: CC1101.cpp:483
-
CC1101::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: CC1101.cpp:727
+
CC1101::setSyncWord
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:608
+
CC1101::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition: CC1101.cpp:862
+
CC1101::getRSSI
float getRSSI() const
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: CC1101.cpp:700
+
CC1101::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:671
+
CC1101::setFrequency
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:418
+
CC1101::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: CC1101.cpp:661
+
CC1101::setNodeAddress
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:650
+
CC1101::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition: CC1101.cpp:484
+
CC1101::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: CC1101.cpp:728
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
CC1101::standby
int16_t standby() override
Sets the module to standby mode.
Definition: CC1101.cpp:167
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
CC1101::setDataShaping
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:794
-
CC1101::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.
Definition: CC1101.cpp:463
-
CC1101::setBitRate
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition: CC1101.cpp:443
-
CC1101::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: CC1101.cpp:841
+
CC1101::setDataShaping
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:795
+
CC1101::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.
Definition: CC1101.cpp:464
+
CC1101::setBitRate
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition: CC1101.cpp:444
+
CC1101::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: CC1101.cpp:842
CC1101::packetMode
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: CC1101.cpp:211
CC1101::begin
int16_t begin(float freq=434.0, float br=48.0, float freqDev=48.0, float rxBw=135.0, int8_t power=10, uint8_t preambleLength=16)
Initialization method.
Definition: CC1101.cpp:12
-
CC1101::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:612
+
CC1101::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:613
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
CC1101::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: CC1101.cpp:143
-
CC1101::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:869
+
CC1101::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:870
CC1101::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception.
Definition: CC1101.cpp:198
-
CC1101::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition: CC1101.cpp:735
+
CC1101::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition: CC1101.cpp:736
CC1101::setGdo0Action
void setGdo0Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=RISING)
Sets interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:218
CC1101
Control class for CC1101 module.
Definition: CC1101.h:507
-
CC1101::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: CC1101.cpp:731
-
CC1101::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: CC1101.cpp:837
-
CC1101::setPromiscuousMode
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:762
-
CC1101::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: CC1101.cpp:752
+
CC1101::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: CC1101.cpp:732
+
CC1101::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: CC1101.cpp:838
+
CC1101::setPromiscuousMode
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:763
+
CC1101::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: CC1101.cpp:753
CC1101::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: CC1101.cpp:176
CC1101::CC1101
CC1101(Module *module)
Default constructor.
Definition: CC1101.cpp:4
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index 49244a96..a133b0f0 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -121,67 +121,67 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
128 
140  virtual int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) = 0;
141 
-
151  int16_t readData(String& str, size_t len = 0);
-
152 
-
162  virtual int16_t readData(uint8_t* data, size_t len) = 0;
-
163 
-
172  virtual int16_t transmitDirect(uint32_t frf = 0) = 0;
-
173 
-
180  virtual int16_t receiveDirect() = 0;
-
181 
-
182  // configuration methods
+
152  int16_t readData(String& str, size_t len = 0);
+
153 
+
164  virtual int16_t readData(uint8_t* data, size_t len) = 0;
+
165 
+
174  virtual int16_t transmitDirect(uint32_t frf = 0) = 0;
+
175 
+
182  virtual int16_t receiveDirect() = 0;
183 
-
192  virtual int16_t setFrequencyDeviation(float freqDev) = 0;
-
193 
-
201  virtual int16_t setDataShaping(uint8_t sh) = 0;
-
202 
-
210  virtual int16_t setEncoding(uint8_t encoding) = 0;
-
211 
-
217  float getFreqStep() const;
-
218 
-
226  virtual size_t getPacketLength(bool update = true) = 0;
-
227 
-
235  int32_t random(int32_t max);
-
236 
-
246  int32_t random(int32_t min, int32_t max);
-
247 
-
253  virtual uint8_t randomByte() = 0;
-
254 
-
260  int16_t startDirect();
-
261 
-
271  int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
-
272 
-
278  virtual void setDirectAction(void (*func)(void)) = 0;
-
279 
-
285  virtual void readBit(RADIOLIB_PIN_TYPE pin) = 0;
-
286 
-
292  int16_t available();
-
293 
-
299  uint8_t read();
-
300 
-
301  virtual Module* getMod() = 0;
+
184  // configuration methods
+
185 
+
194  virtual int16_t setFrequencyDeviation(float freqDev) = 0;
+
195 
+
203  virtual int16_t setDataShaping(uint8_t sh) = 0;
+
204 
+
212  virtual int16_t setEncoding(uint8_t encoding) = 0;
+
213 
+
219  float getFreqStep() const;
+
220 
+
228  virtual size_t getPacketLength(bool update = true) = 0;
+
229 
+
237  int32_t random(int32_t max);
+
238 
+
248  int32_t random(int32_t min, int32_t max);
+
249 
+
255  virtual uint8_t randomByte() = 0;
+
256 
+
262  int16_t startDirect();
+
263 
+
273  int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
+
274 
+
280  virtual void setDirectAction(void (*func)(void)) = 0;
+
281 
+
287  virtual void readBit(RADIOLIB_PIN_TYPE pin) = 0;
+
288 
+
294  int16_t available();
+
295 
+
301  uint8_t read();
302 
-
303  protected:
-
304  void updateDirectBuffer(uint8_t bit);
-
305 
-
306 #if !defined(RADIOLIB_GODMODE)
-
307  private:
-
308 #endif
-
309  float _freqStep;
-
310  size_t _maxPacketLength;
-
311 
-
312  uint8_t _bufferBitPos;
-
313  uint8_t _bufferWritePos;
-
314  uint8_t _bufferReadPos;
-
315  uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
-
316  uint32_t _syncBuffer;
-
317  uint32_t _directSyncWord;
-
318  uint8_t _directSyncWordLen;
-
319  uint32_t _directSyncWordMask;
-
320  bool _gotSync;
-
321 };
-
322 
-
323 #endif
+
303  virtual Module* getMod() = 0;
+
304 
+
305  protected:
+
306  void updateDirectBuffer(uint8_t bit);
+
307 
+
308 #if !defined(RADIOLIB_GODMODE)
+
309  private:
+
310 #endif
+
311  float _freqStep;
+
312  size_t _maxPacketLength;
+
313 
+
314  uint8_t _bufferBitPos;
+
315  uint8_t _bufferWritePos;
+
316  uint8_t _bufferReadPos;
+
317  uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
+
318  uint32_t _syncBuffer;
+
319  uint32_t _directSyncWord;
+
320  uint8_t _directSyncWordLen;
+
321  uint32_t _directSyncWordMask;
+
322  bool _gotSync;
+
323 };
+
324 
+
325 #endif
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
@@ -189,22 +189,22 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
PhysicalLayer::setFrequencyDeviation
virtual int16_t setFrequencyDeviation(float freqDev)=0
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
PhysicalLayer::setEncoding
virtual int16_t setEncoding(uint8_t encoding)=0
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
PhysicalLayer::transmitDirect
virtual int16_t transmitDirect(uint32_t frf=0)=0
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...
-
PhysicalLayer::available
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:191
+
PhysicalLayer::available
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:186
PhysicalLayer::setDirectAction
virtual void setDirectAction(void(*func)(void))=0
Set interrupt service routine function to call when data bit is receveid in direct mode....
PhysicalLayer::readBit
virtual void readBit(RADIOLIB_PIN_TYPE pin)=0
Function to read and process data bit in direct reception mode. Must be implemented in module class.
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
PhysicalLayer::receiveDirect
virtual int16_t receiveDirect()=0
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
-
PhysicalLayer::read
uint8_t read()
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:195
+
PhysicalLayer::read
uint8_t read()
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:190
PhysicalLayer::PhysicalLayer
PhysicalLayer(float freqStep, size_t maxPacketLength)
Default constructor.
Definition: PhysicalLayer.cpp:3
-
PhysicalLayer::startDirect
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:177
+
PhysicalLayer::startDirect
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:172
PhysicalLayer::randomByte
virtual uint8_t randomByte()=0
Get one truly random byte from RSSI noise. Must be implemented in module class.
-
PhysicalLayer::random
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:149
+
PhysicalLayer::random
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:144
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
PhysicalLayer::getPacketLength
virtual size_t getPacketLength(bool update=true)=0
Query modem for the packet length of received payload. Must be implemented in module class.
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
PhysicalLayer::setDirectSyncWord
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:204
-
PhysicalLayer::getFreqStep
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:145
+
PhysicalLayer::setDirectSyncWord
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:199
+
PhysicalLayer::getFreqStep
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:140
PhysicalLayer::setDataShaping
virtual int16_t setDataShaping(uint8_t sh)=0
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index 9b122b43..a8f73fd1 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -574,178 +574,179 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
606 
612  int16_t startReceive();
613 
-
623  int16_t readData(uint8_t* data, size_t len) override;
-
624 
-
625  // configuration methods
-
626 
-
634  int16_t setFrequency(float freq);
-
635 
-
643  int16_t setBitRate(float br);
-
644 
-
652  int16_t setRxBandwidth(float rxBw);
-
653 
-
661  int16_t setFrequencyDeviation(float freqDev) override;
-
662 
-
672  int16_t setOutputPower(int8_t power, bool highPower = false);
-
673 
-
683  int16_t setSyncWord(uint8_t* syncWord, size_t len, uint8_t maxErrBits = 0);
-
684 
-
692  int16_t setPreambleLength(uint8_t preambleLen);
-
693 
-
701  int16_t setNodeAddress(uint8_t nodeAddr);
-
702 
-
710  int16_t setBroadcastAddress(uint8_t broadAddr);
-
711 
-
717  int16_t disableAddressFiltering();
-
718 
-
719  // measurement methods
-
720 
-
726  void setAmbientTemperature(int16_t tempAmbient);
-
727 
-
733  int16_t getTemperature();
-
734 
-
742  size_t getPacketLength(bool update = true) override;
-
743 
-
751  int16_t setOOK(bool enableOOK);
-
752 
-
760  int16_t setOokThresholdType(uint8_t type);
-
761 
-
769  int16_t setOokFixedThreshold(uint8_t value);
-
770 
-
778  int16_t setOokPeakThresholdDecrement(uint8_t value);
-
779 
-
787  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
788 
-
796  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
797 
-
805  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
-
806 
-
812  int16_t disableSyncWordFiltering();
-
813 
-
819  int16_t enableContinuousModeBitSync();
-
820 
-
826  int16_t disableContinuousModeBitSync();
-
827 
-
835  int16_t setCrcFiltering(bool crcOn = true);
-
836 
-
844  int16_t setPromiscuousMode(bool promiscuous = true);
-
845 
-
854  int16_t setDataShaping(uint8_t sh) override;
-
855 
-
864  int16_t setEncoding(uint8_t encoding) override;
-
865 
-
873  int16_t setLnaTestBoost(bool value);
-
874 
-
880  float getRSSI();
-
881 
-
890  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
891 
-
897  uint8_t randomByte();
-
898 
-
904  int16_t getChipVersion();
-
905 
-
911  void setDirectAction(void (*func)(void));
-
912 
-
918  void readBit(RADIOLIB_PIN_TYPE pin);
-
919 
-
920 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
921  protected:
-
922 #endif
-
923  Module* _mod;
-
924 
-
925 #if !defined(RADIOLIB_GODMODE)
-
926  protected:
-
927 #endif
-
928 
-
929  float _freq = 0;
-
930  float _br = 0;
-
931  float _rxBw = 0;
-
932  bool _ook = false;
-
933  int16_t _tempOffset = 0;
-
934  int8_t _power = 0;
-
935 
-
936  size_t _packetLength = 0;
-
937  bool _packetLengthQueried = false;
-
938  uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
-
939 
-
940  bool _promiscuous = false;
-
941 
-
942  uint8_t _syncWordLength = 2;
-
943 
-
944  int16_t config();
-
945  int16_t directMode();
-
946  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
947 
-
948 #if !defined(RADIOLIB_GODMODE)
-
949  private:
-
950 #endif
-
951  int16_t setMode(uint8_t mode);
-
952  void clearIRQFlags();
-
953 };
-
954 
-
955 #endif
+
624  int16_t readData(uint8_t* data, size_t len) override;
+
625 
+
626  // configuration methods
+
627 
+
635  int16_t setFrequency(float freq);
+
636 
+
644  int16_t setBitRate(float br);
+
645 
+
653  int16_t setRxBandwidth(float rxBw);
+
654 
+
662  int16_t setFrequencyDeviation(float freqDev) override;
+
663 
+
673  int16_t setOutputPower(int8_t power, bool highPower = false);
+
674 
+
684  int16_t setSyncWord(uint8_t* syncWord, size_t len, uint8_t maxErrBits = 0);
+
685 
+
693  int16_t setPreambleLength(uint8_t preambleLen);
+
694 
+
702  int16_t setNodeAddress(uint8_t nodeAddr);
+
703 
+
711  int16_t setBroadcastAddress(uint8_t broadAddr);
+
712 
+
718  int16_t disableAddressFiltering();
+
719 
+
720  // measurement methods
+
721 
+
727  void setAmbientTemperature(int16_t tempAmbient);
+
728 
+
734  int16_t getTemperature();
+
735 
+
743  size_t getPacketLength(bool update = true) override;
+
744 
+
752  int16_t setOOK(bool enableOOK);
+
753 
+
761  int16_t setOokThresholdType(uint8_t type);
+
762 
+
770  int16_t setOokFixedThreshold(uint8_t value);
+
771 
+
779  int16_t setOokPeakThresholdDecrement(uint8_t value);
+
780 
+
788  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
789 
+
797  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
798 
+
806  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
+
807 
+
813  int16_t disableSyncWordFiltering();
+
814 
+
820  int16_t enableContinuousModeBitSync();
+
821 
+
827  int16_t disableContinuousModeBitSync();
+
828 
+
836  int16_t setCrcFiltering(bool crcOn = true);
+
837 
+
845  int16_t setPromiscuousMode(bool promiscuous = true);
+
846 
+
855  int16_t setDataShaping(uint8_t sh) override;
+
856 
+
865  int16_t setEncoding(uint8_t encoding) override;
+
866 
+
874  int16_t setLnaTestBoost(bool value);
+
875 
+
881  float getRSSI();
+
882 
+
891  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
892 
+
898  uint8_t randomByte();
+
899 
+
905  int16_t getChipVersion();
+
906 
+
912  void setDirectAction(void (*func)(void));
+
913 
+
919  void readBit(RADIOLIB_PIN_TYPE pin);
+
920 
+
921 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
922  protected:
+
923 #endif
+
924  Module* _mod;
+
925 
+
926 #if !defined(RADIOLIB_GODMODE)
+
927  protected:
+
928 #endif
+
929 
+
930  float _freq = 0;
+
931  float _br = 0;
+
932  float _rxBw = 0;
+
933  bool _ook = false;
+
934  int16_t _tempOffset = 0;
+
935  int8_t _power = 0;
+
936 
+
937  size_t _packetLength = 0;
+
938  bool _packetLengthQueried = false;
+
939  uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
+
940 
+
941  bool _promiscuous = false;
+
942 
+
943  uint8_t _syncWordLength = 2;
+
944 
+
945  int16_t config();
+
946  int16_t directMode();
+
947  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
948 
+
949 #if !defined(RADIOLIB_GODMODE)
+
950  private:
+
951 #endif
+
952  int16_t setMode(uint8_t mode);
+
953  void clearIRQFlags();
+
954  void clearFIFO(size_t count);
+
955 };
956 
957 #endif
+
958 
+
959 #endif
-
RF69::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:735
+
RF69::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:743
RF69::setDio0Action
void setDio0Action(void(*func)(void))
Sets interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:273
RF69::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:289
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
-
RF69::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:646
+
RF69::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:654
RF69::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception.
Definition: RF69.cpp:204
-
RF69::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: RF69.cpp:819
-
RF69::setOokFixedThreshold
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:395
+
RF69::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: RF69.cpp:827
+
RF69::setOokFixedThreshold
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:403
RF69::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: RF69.cpp:344
-
RF69::setPromiscuousMode
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:743
+
RF69::setPromiscuousMode
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:751
RF69::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: RF69.cpp:143
RF69::clearDio0Action
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:277
-
RF69::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:689
+
RF69::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:697
RF69
Control class for RF69 module. Also serves as base class for SX1231.
Definition: RF69.h:440
RF69::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:281
RF69::startReceive
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: RF69.cpp:245
-
RF69::setFrequency
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:403
-
RF69::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:637
+
RF69::setFrequency
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:411
+
RF69::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:645
RF69::enableAES
int16_t enableAES()
Enables AES encryption.
Definition: RF69.cpp:237
-
RF69::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:626
-
RF69::disableContinuousModeBitSync
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:731
+
RF69::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:634
+
RF69::disableContinuousModeBitSync
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:739
RF69::reset
void reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: RF69.cpp:106
-
RF69::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:706
+
RF69::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:714
RF69::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: RF69.cpp:114
-
RF69::setRxBandwidth
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:446
+
RF69::setRxBandwidth
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:454
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
RF69::setBitRate
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.
Definition: RF69.cpp:425
+
RF69::setBitRate
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.
Definition: RF69.cpp:433
RF69::disableAES
int16_t disableAES()
Disables AES encryption.
Definition: RF69.cpp:241
RF69::RF69
RF69(Module *module)
Default constructor.
Definition: RF69.cpp:4
-
RF69::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:399
-
RF69::setDataShaping
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:769
-
RF69::enableContinuousModeBitSync
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:727
-
RF69::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:823
-
RF69::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: RF69.cpp:373
+
RF69::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:407
+
RF69::setDataShaping
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:777
+
RF69::enableContinuousModeBitSync
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:735
+
RF69::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:831
+
RF69::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: RF69.cpp:381
RF69::standby
int16_t standby() override
Sets the module to standby mode.
Definition: RF69.cpp:175
-
RF69::setLnaTestBoost
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:807
-
RF69::getTemperature
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:672
-
RF69::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:541
-
RF69::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:655
-
RF69::setSyncWord
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:603
-
RF69::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:846
-
RF69::disableSyncWordFiltering
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:715
-
RF69::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:815
-
RF69::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:702
+
RF69::setLnaTestBoost
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:815
+
RF69::getTemperature
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:680
+
RF69::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:549
+
RF69::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:663
+
RF69::setSyncWord
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:611
+
RF69::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:854
+
RF69::disableSyncWordFiltering
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:723
+
RF69::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:823
+
RF69::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:710
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
RF69::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:789
+
RF69::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:797
RF69::setAESKey
void setAESKey(uint8_t *key)
Sets AES key.
Definition: RF69.cpp:233
-
RF69::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:842
+
RF69::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:850
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
RF69::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: RF69.cpp:183
-
RF69::setOutputPower
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:565
+
RF69::setOutputPower
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:573
RF69::packetMode
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: RF69.cpp:229
-
RF69::setAmbientTemperature
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:668
-
RF69::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:388
+
RF69::setAmbientTemperature
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:676
+
RF69::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:396
RF69::sleep
int16_t sleep()
Sets the module to sleep mode.
Definition: RF69.cpp:167
-
RF69::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:850
-
RF69::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:710
+
RF69::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:858
+
RF69::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:718
RF69::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: RF69.cpp:296
RF69::begin
int16_t begin(float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16)
Initialization method.
Definition: RF69.cpp:12
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index cf9134e4..dbe26c18 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -471,238 +471,238 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
534 
546  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8);
547 
-
557  int16_t readData(uint8_t* data, size_t len) override;
-
558 
-
564  int16_t startChannelScan();
-
565 
-
571  int16_t getChannelScanResult();
-
572 
-
573  // configuration methods
-
574 
-
582  int16_t setBandwidth(float bw);
-
583 
-
591  int16_t setSpreadingFactor(uint8_t sf);
-
592 
-
600  int16_t setCodingRate(uint8_t cr);
-
601 
-
611  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
612 
-
620  int16_t setCurrentLimit(float currentLimit);
-
621 
-
627  float getCurrentLimit();
-
628 
-
636  int16_t setPreambleLength(uint16_t preambleLength);
-
637 
-
645  int16_t setFrequencyDeviation(float freqDev) override;
-
646 
-
654  int16_t setBitRate(float br);
-
655 
-
663  int16_t setRxBandwidth(float rxBw);
-
664 
-
674  int16_t setDataShaping(uint8_t sh) override;
-
675 
-
685  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
-
686 
-
696  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
697 
-
705  int16_t setNodeAddress(uint8_t nodeAddr);
-
706 
-
714  int16_t setBroadcastAddress(uint8_t broadAddr);
-
715 
-
721  int16_t disableAddressFiltering();
-
722 
-
736  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
737 
-
747  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
-
748 
-
759  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
760 
-
766  int16_t setDio2AsRfSwitch(bool enable = true);
-
767 
-
773  float getDataRate() const;
-
774 
-
780  float getRSSI();
-
781 
-
787  float getSNR();
-
788 
-
796  size_t getPacketLength(bool update = true) override;
-
797 
-
805  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
806 
-
814  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
815 
-
823  uint32_t getTimeOnAir(size_t len);
-
824 
-
830  float getRSSIInst();
-
831 
-
837  int16_t implicitHeader(size_t len);
-
838 
-
846  int16_t explicitHeader();
-
847 
-
853  int16_t setRegulatorLDO();
-
854 
-
860  int16_t setRegulatorDCDC();
-
861 
-
869  int16_t setEncoding(uint8_t encoding) override;
-
870 
-
879  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
880 
-
889  int16_t forceLDRO(bool enable);
-
890 
-
897  int16_t autoLDRO();
-
898 
-
904  uint8_t randomByte();
-
905 
-
911  void setDirectAction(void (*func)(void));
-
912 
-
918  void readBit(RADIOLIB_PIN_TYPE pin);
-
919 
-
920 #if !defined(RADIOLIB_GODMODE)
-
921  protected:
-
922 #endif
-
923  // SX126x SPI command implementations
-
924  int16_t setTx(uint32_t timeout = 0);
-
925  int16_t setRx(uint32_t timeout);
-
926  int16_t setCad();
-
927  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);
-
928  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
929  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
930  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
931  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
932  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
933  uint16_t getIrqStatus();
-
934  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
935  int16_t setRfFrequency(uint32_t frf);
-
936  int16_t calibrateImage(uint8_t* data);
-
937  uint8_t getPacketType();
-
938  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
-
939  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
940  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
-
941  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
-
942  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);
-
943  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
944  int16_t setRegulatorMode(uint8_t mode);
-
945  uint8_t getStatus();
-
946  uint32_t getPacketStatus();
-
947  uint16_t getDeviceErrors();
-
948  int16_t clearDeviceErrors();
-
949 
-
950  int16_t startReceiveCommon();
-
951  int16_t setFrequencyRaw(float freq);
-
952  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
953  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
-
954 
-
955  // fixes to errata
-
956  int16_t fixSensitivity();
-
957  int16_t fixPaClamping();
-
958  int16_t fixImplicitTimeout();
-
959  int16_t fixInvertedIQ(uint8_t iqConfig);
-
960 
-
961 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
962  protected:
-
963 #endif
-
964  Module* _mod;
-
965 
-
966  // common low-level SPI interface
-
967  int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
968  int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
969  int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
970  int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
-
971  int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);
-
972 
-
973 #if !defined(RADIOLIB_GODMODE)
-
974  protected:
-
975 #endif
-
976 
-
977  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
-
978  uint16_t _preambleLength = 0;
-
979  float _bwKhz = 0;
-
980  bool _ldroAuto = true;
-
981 
-
982  uint32_t _br = 0, _freqDev = 0;
-
983  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
-
984  uint16_t _preambleLengthFSK = 0;
-
985  float _rxBwKhz = 0;
-
986 
-
987  float _dataRate = 0;
-
988 
-
989  uint32_t _tcxoDelay = 0;
-
990 
-
991  size_t _implicitLen = 0;
-
992 
-
993  int16_t config(uint8_t modem);
-
994 };
-
995 
-
996 #endif
-
997 
-
998 #endif
+
558  int16_t readData(uint8_t* data, size_t len) override;
+
559 
+
565  int16_t startChannelScan();
+
566 
+
572  int16_t getChannelScanResult();
+
573 
+
574  // configuration methods
+
575 
+
583  int16_t setBandwidth(float bw);
+
584 
+
592  int16_t setSpreadingFactor(uint8_t sf);
+
593 
+
601  int16_t setCodingRate(uint8_t cr);
+
602 
+
612  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
613 
+
621  int16_t setCurrentLimit(float currentLimit);
+
622 
+
628  float getCurrentLimit();
+
629 
+
637  int16_t setPreambleLength(uint16_t preambleLength);
+
638 
+
646  int16_t setFrequencyDeviation(float freqDev) override;
+
647 
+
655  int16_t setBitRate(float br);
+
656 
+
664  int16_t setRxBandwidth(float rxBw);
+
665 
+
675  int16_t setDataShaping(uint8_t sh) override;
+
676 
+
686  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
+
687 
+
697  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
698 
+
706  int16_t setNodeAddress(uint8_t nodeAddr);
+
707 
+
715  int16_t setBroadcastAddress(uint8_t broadAddr);
+
716 
+
722  int16_t disableAddressFiltering();
+
723 
+
737  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
+
738 
+
748  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
+
749 
+
760  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
761 
+
767  int16_t setDio2AsRfSwitch(bool enable = true);
+
768 
+
774  float getDataRate() const;
+
775 
+
781  float getRSSI();
+
782 
+
788  float getSNR();
+
789 
+
797  size_t getPacketLength(bool update = true) override;
+
798 
+
806  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
807 
+
815  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
816 
+
824  uint32_t getTimeOnAir(size_t len);
+
825 
+
831  float getRSSIInst();
+
832 
+
838  int16_t implicitHeader(size_t len);
+
839 
+
847  int16_t explicitHeader();
+
848 
+
854  int16_t setRegulatorLDO();
+
855 
+
861  int16_t setRegulatorDCDC();
+
862 
+
870  int16_t setEncoding(uint8_t encoding) override;
+
871 
+
880  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
881 
+
890  int16_t forceLDRO(bool enable);
+
891 
+
898  int16_t autoLDRO();
+
899 
+
905  uint8_t randomByte();
+
906 
+
912  void setDirectAction(void (*func)(void));
+
913 
+
919  void readBit(RADIOLIB_PIN_TYPE pin);
+
920 
+
921 #if !defined(RADIOLIB_GODMODE)
+
922  protected:
+
923 #endif
+
924  // SX126x SPI command implementations
+
925  int16_t setTx(uint32_t timeout = 0);
+
926  int16_t setRx(uint32_t timeout);
+
927  int16_t setCad();
+
928  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);
+
929  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
930  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
931  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
932  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
933  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
934  uint16_t getIrqStatus();
+
935  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
936  int16_t setRfFrequency(uint32_t frf);
+
937  int16_t calibrateImage(uint8_t* data);
+
938  uint8_t getPacketType();
+
939  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+
940  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
941  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
+
942  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
+
943  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);
+
944  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
945  int16_t setRegulatorMode(uint8_t mode);
+
946  uint8_t getStatus();
+
947  uint32_t getPacketStatus();
+
948  uint16_t getDeviceErrors();
+
949  int16_t clearDeviceErrors();
+
950 
+
951  int16_t startReceiveCommon();
+
952  int16_t setFrequencyRaw(float freq);
+
953  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
954  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
+
955 
+
956  // fixes to errata
+
957  int16_t fixSensitivity();
+
958  int16_t fixPaClamping();
+
959  int16_t fixImplicitTimeout();
+
960  int16_t fixInvertedIQ(uint8_t iqConfig);
+
961 
+
962 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
963  protected:
+
964 #endif
+
965  Module* _mod;
+
966 
+
967  // common low-level SPI interface
+
968  int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
+
969  int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
+
970  int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
+
971  int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
+
972  int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);
+
973 
+
974 #if !defined(RADIOLIB_GODMODE)
+
975  protected:
+
976 #endif
+
977 
+
978  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
+
979  uint16_t _preambleLength = 0;
+
980  float _bwKhz = 0;
+
981  bool _ldroAuto = true;
+
982 
+
983  uint32_t _br = 0, _freqDev = 0;
+
984  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
+
985  uint16_t _preambleLengthFSK = 0;
+
986  float _rxBwKhz = 0;
+
987 
+
988  float _dataRate = 0;
+
989 
+
990  uint32_t _tcxoDelay = 0;
+
991 
+
992  size_t _implicitLen = 0;
+
993 
+
994  int16_t config(uint8_t modem);
+
995 };
+
996 
+
997 #endif
+
998 
+
999 #endif
-
SX126x::variablePacketLengthMode
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:1124
+
SX126x::variablePacketLengthMode
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:1125
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
SX126x::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: SX126x.cpp:197
-
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1128
-
SX126x::setBandwidth
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:631
+
SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1129
+
SX126x::setBandwidth
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:632
SX126x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX126x.cpp:351
SX126x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: SX126x.cpp:553
-
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:682
+
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:683
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:461
-
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1178
-
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1174
-
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:979
-
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:945
-
SX126x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX126x.cpp:1190
+
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1179
+
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1175
+
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:980
+
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:946
+
SX126x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX126x.cpp:1191
SX126x::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: SX126x.cpp:256
-
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:732
+
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:733
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:383
-
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:708
+
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:709
SX126x::startReceive
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:448
-
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1182
-
SX126x::setPreambleLength
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:741
-
SX126x::setSyncBits
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:918
-
SX126x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1090
+
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1183
+
SX126x::setPreambleLength
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:742
+
SX126x::setSyncBits
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:919
+
SX126x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1091
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:164
-
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1113
-
SX126x::getRSSIInst
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1163
-
SX126x::fixedPacketLengthMode
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:1120
+
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1114
+
SX126x::getRSSIInst
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1164
+
SX126x::fixedPacketLengthMode
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:1121
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
SX126x::beginFSK
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:83
SX126x::SX126x
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:4
-
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1049
-
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 0.25 mA steps.
Definition: SX126x.cpp:719
-
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1170
-
SX126x::setRxBandwidth
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:802
-
SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1194
+
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1050
+
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 0.25 mA steps.
Definition: SX126x.cpp:720
+
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1171
+
SX126x::setRxBandwidth
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:803
+
SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1195
SX126x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:337
-
SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1086
-
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1206
+
SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1087
+
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1207
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:379
-
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1248
+
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1249
SX126x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: SX126x.cpp:387
-
SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:990
-
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:610
-
SX126x::setDataShaping
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:865
-
SX126x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:584
-
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1215
+
SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:991
+
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:611
+
SX126x::setDataShaping
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:866
+
SX126x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:585
+
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1216
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:695
+
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:696
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:488
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:754
+
SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:755
SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:329
-
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1296
-
SX126x::setEncoding
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:1186
-
SX126x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1242
-
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1236
-
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1097
+
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1297
+
SX126x::setEncoding
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:1187
+
SX126x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1243
+
SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1237
+
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1098
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:367
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:313
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:342
SX126x::begin
int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:12
-
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:781
+
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:782
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
-
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:962
+
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:963
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
-
SX127x::setNodeAddress
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:876
-
SX127x::getTempRaw
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1124
+
SX127x::setNodeAddress
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:875
+
SX127x::getTempRaw
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1123
SX127x::startReceive
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:364
-
SX127x::invertIQ
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1313
-
SX127x::setAFCAGCTrigger
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:842
-
SX127x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: SX127x.cpp:1047
+
SX127x::invertIQ
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1312
+
SX127x::setAFCAGCTrigger
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:841
+
SX127x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: SX127x.cpp:1046
SX127x::setDio1Action
void setDio1Action(void(*func)(void))
Set interrupt service routine function to call when DIO1 activates.
Definition: SX127x.cpp:419
-
SX127x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1337
-
SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:946
-
SX127x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX127x.cpp:1333
+
SX127x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1336
+
SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:945
+
SX127x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX127x.cpp:1332
SX127x::sleep
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:273
SX127x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data that was received after calling startReceive method. This method reads len characters.
Definition: SX127x.cpp:497
-
SX127x::variablePacketLengthMode
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:1020
-
SX127x::disableBitSync
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:950
-
SX127x::setAFC
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:832
+
SX127x::variablePacketLengthMode
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:1019
+
SX127x::disableBitSync
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:949
+
SX127x::setAFC
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:831
SX127x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX127x.cpp:426
-
SX127x::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:579
+
SX127x::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:578
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
SX127x::beginFSK
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
SX127x::receiveDirect
int16_t receiveDirect() override
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition: SX127x.cpp:318
SX127x::setDio0Action
void setDio0Action(void(*func)(void))
Set interrupt service routine function to call when DIO0 activates.
Definition: SX127x.cpp:411
-
SX127x::setFrequencyDeviation
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:758
-
SX127x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:554
-
SX127x::getDataRate
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:725
+
SX127x::setFrequencyDeviation
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:757
+
SX127x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:553
+
SX127x::getDataRate
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:724
SX127x::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Binary transmit method. Will transmit arbitrary binary data up to 255 bytes long using LoRa or up to ...
Definition: SX127x.cpp:141
-
SX127x::setOokFixedOrFloorThreshold
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:930
-
SX127x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX127x.cpp:1091
-
SX127x::fixedPacketLengthMode
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:1016
-
SX127x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:904
+
SX127x::setOokFixedOrFloorThreshold
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:929
+
SX127x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX127x.cpp:1090
+
SX127x::fixedPacketLengthMode
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:1015
+
SX127x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:903
SX127x::transmitDirect
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:289
SX127x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 255 byte...
Definition: SX127x.cpp:433
-
SX127x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...
Definition: SX127x.cpp:890
-
SX127x::getAFCError
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:698
-
SX127x::getModemStatus
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1081
-
SX127x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1095
+
SX127x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...
Definition: SX127x.cpp:889
+
SX127x::getAFCError
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:697
+
SX127x::getModemStatus
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1080
+
SX127x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1094
SX127x::standby
int16_t standby() override
Sets the LoRa module to standby.
Definition: SX127x.cpp:281
SX127x
Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...
Definition: SX127x.h:547
-
SX127x::getSNR
float getSNR()
Gets signal-to-noise ratio of the latest received packet.
Definition: SX127x.cpp:714
+
SX127x::getSNR
float getSNR()
Gets signal-to-noise ratio of the latest received packet.
Definition: SX127x.cpp:713
SX127x::reset
virtual void reset()=0
Reset method. Will reset the chip to the default state using RST pin. Declared pure virtual since SX1...
SX127x::begin
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
-
SX127x::setPreambleLength
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:616
-
SX127x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 1.2 to 300 kbps. Only available in FSK mode.
Definition: SX127x.cpp:729
+
SX127x::setPreambleLength
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:615
+
SX127x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 1.2 to 300 kbps. Only available in FSK mode.
Definition: SX127x.cpp:728
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
SX127x::clearDio0Action
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: SX127x.cpp:415
-
SX127x::getIRQFlags
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1066
-
SX127x::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:938
-
SX127x::setRSSIConfig
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1024
-
SX127x::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:922
-
SX127x::setAFCBandwidth
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition: SX127x.cpp:816
-
SX127x::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:954
-
SX127x::setRxBandwidth
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:800
+
SX127x::getIRQFlags
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1065
+
SX127x::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:937
+
SX127x::setRSSIConfig
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1023
+
SX127x::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:921
+
SX127x::setAFCBandwidth
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition: SX127x.cpp:815
+
SX127x::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:953
+
SX127x::setRxBandwidth
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:799
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
SX127x::scanChannel
int16_t scanChannel()
Performs scan for valid LoRa preamble in the current channel.
Definition: SX127x.cpp:253
SX127x::receive
int16_t receive(uint8_t *data, size_t len) override
Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa ...
Definition: SX127x.cpp:208
-
SX127x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1120
-
SX127x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:988
+
SX127x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1119
+
SX127x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:987
SX127x::SX127x
SX127x(Module *mod)
Default constructor. Called internally when creating new LoRa instance.
Definition: SX127x.cpp:4
SX127x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets....
Definition: SX127x.cpp:355
-
SX127x::setCurrentLimit
int16_t setCurrentLimit(uint8_t currentLimit)
Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...
Definition: SX127x.cpp:592
-
SX127x::getFrequencyError
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:645
+
SX127x::setCurrentLimit
int16_t setCurrentLimit(uint8_t currentLimit)
Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...
Definition: SX127x.cpp:591
+
SX127x::getFrequencyError
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:644
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
SX128x::beginBLE
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:130
@@ -614,49 +614,49 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
SX128x::begin
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
SX128x
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350
-
SX128x::setSyncWord
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:868
-
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:666
-
SX128x::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1153
+
SX128x::setSyncWord
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:869
+
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:667
+
SX128x::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1154
SX128x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: SX128x.cpp:461
SX128x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:441
SX128x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:372
-
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1011
-
SX128x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1165
-
SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1159
-
SX128x::setDataShaping
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:838
+
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1012
+
SX128x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1166
+
SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1160
+
SX128x::setDataShaping
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:839
SX128x::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: SX128x.cpp:319
RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:25
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
SX128x::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:594
+
SX128x::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:595
SX128x::SX128x
SX128x(Module *mod)
Default constructor.
Definition: SX128x.cpp:4
-
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:927
-
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:991
+
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:928
+
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:992
SX128x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:380
-
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:805
+
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:806
SX128x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:457
-
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:602
+
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:603
SX128x::beginFLRC
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:179
-
SX128x::setBitRate
int16_t setBitRate(uint16_t br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:748
-
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1145
-
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:632
+
SX128x::setBitRate
int16_t setBitRate(uint16_t br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:749
+
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1146
+
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:633
SX128x::beginGFSK
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:67
-
SX128x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1022
-
SX128x::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:694
+
SX128x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1023
+
SX128x::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:695
SX128x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX128x.cpp:357
SX128x::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: SX128x.cpp:271
-
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1066
+
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1067
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
SX128x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1073
+
SX128x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1074
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
SX128x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:453
-
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:700
+
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:701
SX128x::startReceive
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:525
-
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1141
+
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1142
SX128x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX128x.cpp:425
-
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1137
-
SX128x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX128x.cpp:1149
-
SX128x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1046
+
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1138
+
SX128x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: SX128x.cpp:1150
+
SX128x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1047
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
SX128x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX128x.cpp:238
diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html index 73c8e5a1..a695a369 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -677,98 +677,99 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
685 
691  int16_t startReceive();
692 
-
702  int16_t readData(uint8_t* data, size_t len) override;
-
703 
-
704  // configuration methods
-
705 
-
713  int16_t setBitRate(float br);
-
714 
-
722  int16_t setFrequencyDeviation(float freqDev) override;
-
723 
-
731  int16_t setRxBandwidth(float rxBw);
-
732 
-
740  int16_t setSyncWord(uint8_t* syncWord, size_t len);
-
741 
-
749  int16_t setPreambleLength(uint8_t preambleLen);
-
750 
-
758  size_t getPacketLength(bool update = true) override;
-
759 
-
768  int16_t setEncoding(uint8_t encoding) override;
-
769 
-
778  int16_t setDataShaping(uint8_t sh) override;
-
779 
-
788  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
789 
-
795  uint8_t randomByte();
-
796 
-
802  int16_t getChipVersion();
-
803 
-
809  void setDirectAction(void (*func)(void));
-
810 
-
816  void readBit(RADIOLIB_PIN_TYPE pin);
-
817 
-
818 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
819  protected:
-
820 #endif
-
821  Module* _mod;
-
822 
-
823 #if !defined(RADIOLIB_GODMODE)
-
824  protected:
-
825 #endif
-
826 
-
827  float _br = 0;
-
828  float _freqDev = 0;
-
829  float _freq = 0;
-
830 
-
831  size_t _packetLength = 0;
-
832  bool _packetLengthQueried = false;
-
833 
-
834  int16_t setFrequencyRaw(float newFreq);
-
835 
-
836 #if !defined(RADIOLIB_GODMODE)
-
837  private:
-
838 #endif
-
839  bool findChip();
-
840  void clearIRQFlags();
-
841  int16_t config();
-
842  int16_t updateClockRecovery();
-
843  int16_t directMode();
-
844 };
-
845 
-
846 #endif
+
703  int16_t readData(uint8_t* data, size_t len) override;
+
704 
+
705  // configuration methods
+
706 
+
714  int16_t setBitRate(float br);
+
715 
+
723  int16_t setFrequencyDeviation(float freqDev) override;
+
724 
+
732  int16_t setRxBandwidth(float rxBw);
+
733 
+
741  int16_t setSyncWord(uint8_t* syncWord, size_t len);
+
742 
+
750  int16_t setPreambleLength(uint8_t preambleLen);
+
751 
+
759  size_t getPacketLength(bool update = true) override;
+
760 
+
769  int16_t setEncoding(uint8_t encoding) override;
+
770 
+
779  int16_t setDataShaping(uint8_t sh) override;
+
780 
+
789  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
790 
+
796  uint8_t randomByte();
+
797 
+
803  int16_t getChipVersion();
+
804 
+
810  void setDirectAction(void (*func)(void));
+
811 
+
817  void readBit(RADIOLIB_PIN_TYPE pin);
+
818 
+
819 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
820  protected:
+
821 #endif
+
822  Module* _mod;
+
823 
+
824 #if !defined(RADIOLIB_GODMODE)
+
825  protected:
+
826 #endif
+
827 
+
828  float _br = 0;
+
829  float _freqDev = 0;
+
830  float _freq = 0;
+
831 
+
832  size_t _packetLength = 0;
+
833  bool _packetLengthQueried = false;
+
834 
+
835  int16_t setFrequencyRaw(float newFreq);
+
836 
+
837 #if !defined(RADIOLIB_GODMODE)
+
838  private:
+
839 #endif
+
840  bool findChip();
+
841  void clearIRQFlags();
+
842  void clearFIFO(size_t count);
+
843  int16_t config();
+
844  int16_t updateClockRecovery();
+
845  int16_t directMode();
+
846 };
847 
848 #endif
+
849 
+
850 #endif
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
Si443x::receiveDirect
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:190
Si443x::standby
int16_t standby() override
Sets the module to standby.
Definition: Si443x.cpp:141
-
Si443x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:309
-
Si443x::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:487
+
Si443x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.
Definition: Si443x.cpp:317
+
Si443x::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: Si443x.cpp:495
Si443x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets.
Definition: Si443x.cpp:203
-
Si443x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:363
+
Si443x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.
Definition: Si443x.cpp:371
Si443x::begin
int16_t begin(float br, float freqDev, float rxBw, uint8_t preambleLen)
Initialization method.
Definition: Si443x.cpp:12
-
Si443x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:574
+
Si443x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...
Definition: Si443x.cpp:582
Si443x::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:210
Si443x::sleep
int16_t sleep()
Sets the module to sleep to save power. Module will not be able to transmit or receive any data while...
Definition: Si443x.cpp:125
Si443x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data that was received after calling startReceive method. This method reads len characters.
Definition: Si443x.cpp:283
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:555
+
Si443x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: Si443x.cpp:563
Si443x::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ activates.
Definition: Si443x.cpp:214
Si443x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes...
Definition: Si443x.cpp:218
-
Si443x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:503
-
Si443x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...
Definition: Si443x.cpp:532
-
Si443x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Si443x.cpp:551
+
Si443x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: Si443x.cpp:511
+
Si443x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...
Definition: Si443x.cpp:540
+
Si443x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Si443x.cpp:559
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
Si443x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:513
+
Si443x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:521
Si443x::reset
void reset()
Reset method. Will reset the chip to the default state using SDN pin.
Definition: Si443x.cpp:67
-
Si443x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:582
-
Si443x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, size_t len)
Sets sync word. Up to 4 bytes can be set as sync word.
Definition: Si443x.cpp:470
+
Si443x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:590
+
Si443x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, size_t len)
Sets sync word. Up to 4 bytes can be set as sync word.
Definition: Si443x.cpp:478
Si443x
Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...
Definition: Si443x.h:554
-
Si443x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....
Definition: Si443x.cpp:340
-
Si443x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:578
+
Si443x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....
Definition: Si443x.cpp:348
+
Si443x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: Si443x.cpp:586
Si443x::receive
int16_t receive(uint8_t *data, size_t len) override
Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long....
Definition: Si443x.cpp:103
Si443x::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to tra...
Definition: Si443x.cpp:75
Si443x::Si443x
Si443x(Module *mod)
Default constructor.
Definition: Si443x.cpp:4
diff --git a/class_c_c1101.html b/class_c_c1101.html index 2e0c1d4d..adba9ae9 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -728,7 +728,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -774,7 +774,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -800,7 +800,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_physical_layer.html b/class_physical_layer.html index 1d906504..fff21e0f 100644 --- a/class_physical_layer.html +++ b/class_physical_layer.html @@ -520,7 +520,7 @@ virtual Module * 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -566,7 +566,7 @@ virtual Module * 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_r_f69.html b/class_r_f69.html index e0d92e03..504d4ddb 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -805,7 +805,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -851,7 +851,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -877,7 +877,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_s_x126x.html b/class_s_x126x.html index 29008421..a14e7903 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -950,7 +950,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -996,7 +996,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -1022,7 +1022,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_s_x127x.html b/class_s_x127x.html index 2a67ef16..c7789352 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -936,7 +936,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -982,7 +982,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -1008,7 +1008,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_s_x128x.html b/class_s_x128x.html index 06144e68..e0acb4b5 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -851,7 +851,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -897,7 +897,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -923,7 +923,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/class_si443x.html b/class_si443x.html index 5be24c05..d0184c0d 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -520,7 +520,7 @@ void 
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -566,7 +566,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -592,7 +592,7 @@ void 
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/classn_r_f24.html b/classn_r_f24.html index f41b731f..1145cc59 100644 --- a/classn_r_f24.html +++ b/classn_r_f24.html @@ -560,7 +560,7 @@ Public Member Functions
Parameters
- +
strAddress of Arduino String to save the received data.
lenExpected number of characters in the message.
lenExpected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
@@ -632,7 +632,7 @@ Public Member Functions
Parameters
- +
dataPointer to array to save the received binary data.
lenNumber of bytes that will be received. Must be known in advance for binary transmissions.
lenNumber of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
diff --git a/n_r_f24_8h_source.html b/n_r_f24_8h_source.html index f5af878d..ce8a2328 100644 --- a/n_r_f24_8h_source.html +++ b/n_r_f24_8h_source.html @@ -363,39 +363,39 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
nRF24::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: nRF24.cpp:115
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
-
nRF24::setDataRate
int16_t setDataRate(int16_t dataRate)
Sets data rate. Allowed values are 2000, 1000 or 250 kbps.
Definition: nRF24.cpp:256
-
nRF24::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:512
-
nRF24::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Dummy data shaping configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:498
-
nRF24::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: nRF24.cpp:458
-
nRF24::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: nRF24.cpp:451
-
nRF24::setTransmitPipe
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:338
+
nRF24::setDataRate
int16_t setDataRate(int16_t dataRate)
Sets data rate. Allowed values are 2000, 1000 or 250 kbps.
Definition: nRF24.cpp:257
+
nRF24::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:513
+
nRF24::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Dummy data shaping configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:499
+
nRF24::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: nRF24.cpp:459
+
nRF24::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: nRF24.cpp:452
+
nRF24::setTransmitPipe
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:339
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
nRF24::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:524
+
nRF24::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:525
nRF24::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: nRF24.cpp:158
nRF24::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr) override
Interrupt-driven binary transmit method. IRQ will be activated when full packet is transmitted....
Definition: nRF24.cpp:162
-
nRF24::isCarrierDetected
bool isCarrierDetected()
Checks if carrier was detected during last RX.
Definition: nRF24.cpp:440
-
nRF24::setEncoding
int16_t setEncoding(uint8_t encoding) override
Dummy encoding configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:505
-
nRF24::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Dummy configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:444
+
nRF24::isCarrierDetected
bool isCarrierDetected()
Checks if carrier was detected during last RX.
Definition: nRF24.cpp:441
+
nRF24::setEncoding
int16_t setEncoding(uint8_t encoding) override
Dummy encoding configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:506
+
nRF24::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Dummy configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:445
nRF24::startReceive
int16_t startReceive()
Interrupt-driven receive method. IRQ will be activated when full packet is received.
Definition: nRF24.cpp:202
nRF24::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: nRF24.cpp:84
-
nRF24::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:518
+
nRF24::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:519
nRF24::receiveDirect
int16_t receiveDirect() override
Dummy direct mode reception method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:152
-
nRF24::disablePipe
int16_t disablePipe(uint8_t pipeNum)
Disables specified receive pipe.
Definition: nRF24.cpp:405
+
nRF24::disablePipe
int16_t disablePipe(uint8_t pipeNum)
Disables specified receive pipe.
Definition: nRF24.cpp:406
nRF24::nRF24
nRF24(Module *mod)
Default constructor.
Definition: nRF24.cpp:4
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
nRF24::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -18, -12, -6 or 0 dBm.
Definition: nRF24.cpp:278
-
nRF24::getStatus
int16_t getStatus(uint8_t mask=0xFF)
Gets nRF24 status register.
Definition: nRF24.cpp:436
+
nRF24::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -18, -12, -6 or 0 dBm.
Definition: nRF24.cpp:279
+
nRF24::getStatus
int16_t getStatus(uint8_t mask=0xFF)
Gets nRF24 status register.
Definition: nRF24.cpp:437
nRF24::sleep
int16_t sleep()
Sets the module to sleep mode.
Definition: nRF24.cpp:70
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
nRF24
Control class for nRF24 module.
Definition: nRF24.h:179
nRF24::begin
int16_t begin(int16_t freq=2400, int16_t dataRate=1000, int8_t power=-12, uint8_t addrWidth=5)
Initialization method.
Definition: nRF24.cpp:12
-
nRF24::setFrequency
int16_t setFrequency(int16_t freq)
Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.
Definition: nRF24.cpp:248
+
nRF24::setFrequency
int16_t setFrequency(int16_t freq)
Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.
Definition: nRF24.cpp:249
nRF24::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: nRF24.cpp:137
nRF24::standby
int16_t standby() override
Sets the module to standby mode.
Definition: nRF24.cpp:74
-
nRF24::setReceivePipe
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:353
-
nRF24::setAutoAck
int16_t setAutoAck(bool autoAckOn=true)
Enable or disable auto-acknowledge packets on all pipes.
Definition: nRF24.cpp:469
-
nRF24::setAddressWidth
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:307
+
nRF24::setReceivePipe
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:354
+
nRF24::setAutoAck
int16_t setAutoAck(bool autoAckOn=true)
Enable or disable auto-acknowledge packets on all pipes.
Definition: nRF24.cpp:470
+
nRF24::setAddressWidth
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:308
nRF24::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: nRF24.cpp:228
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51