diff --git a/_s_x127x_8h_source.html b/_s_x127x_8h_source.html index de37e720..0a5c600b 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -100,7 +100,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
12 // SX127x physical layer properties
13 #define RADIOLIB_SX127X_FREQUENCY_STEP_SIZE 61.03515625
14 #define RADIOLIB_SX127X_MAX_PACKET_LENGTH 255
-
15 #define RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK 64
+
15 #define RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK 63
16 #define RADIOLIB_SX127X_CRYSTAL_FREQ 32.0
17 #define RADIOLIB_SX127X_DIV_EXPONENT 19
18 
@@ -499,7 +499,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
411 // SX127X_REG_FIFO_THRESH
412 #define RADIOLIB_SX127X_TX_START_FIFO_LEVEL 0b00000000 // 7 7 start packet transmission when: number of bytes in FIFO exceeds FIFO_THRESHOLD
413 #define RADIOLIB_SX127X_TX_START_FIFO_NOT_EMPTY 0b10000000 // 7 7 at least one byte in FIFO (default)
-
414 #define RADIOLIB_SX127X_FIFO_THRESH 0x0F // 5 0 FIFO level threshold
+
414 #define RADIOLIB_SX127X_FIFO_THRESH 0x1F // 5 0 FIFO level threshold
415 
416 // SX127X_REG_SEQ_CONFIG_1
417 #define RADIOLIB_SX127X_SEQUENCER_START 0b10000000 // 7 7 manually start sequencer
@@ -674,221 +674,238 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
698 
702  void clearDio1Action();
703 
-
715  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
716 
-
726  int16_t startReceive(uint8_t len = 0, uint8_t mode = RADIOLIB_SX127X_RXCONTINUOUS);
+
709  void setFifoEmptyAction(void (*func)(void));
+
710 
+
714  void clearFifoEmptyAction();
+
715 
+
721  void setFifoFullAction(void (*func)(void));
+
722 
+
726  void clearFifoFullAction();
727 
-
738  int16_t readData(uint8_t* data, size_t len) override;
-
739 
-
746  int16_t startChannelScan();
-
747 
-
748  // configuration methods
-
749 
-
757  int16_t setSyncWord(uint8_t syncWord);
-
758 
-
766  int16_t setCurrentLimit(uint8_t currentLimit);
-
767 
-
775  int16_t setPreambleLength(uint16_t preambleLength);
-
776 
-
784  float getFrequencyError(bool autoCorrect = false);
-
785 
-
791  float getAFCError();
-
792 
-
798  float getSNR();
-
799 
-
805  float getDataRate() const;
-
806 
-
814  int16_t setBitRate(float br);
-
815 
-
823  int16_t setFrequencyDeviation(float freqDev) override;
-
824 
-
832  int16_t setRxBandwidth(float rxBw);
-
833 
-
841  int16_t setAFCBandwidth(float afcBw);
-
842 
-
850  int16_t setAFC(bool isEnabled);
-
851 
-
859  int16_t setAFCAGCTrigger(uint8_t trigger);
-
860 
-
870  int16_t setSyncWord(uint8_t* syncWord, size_t len);
-
871 
-
879  int16_t setNodeAddress(uint8_t nodeAddr);
-
880 
-
888  int16_t setBroadcastAddress(uint8_t broadAddr);
-
889 
-
895  int16_t disableAddressFiltering();
-
896 
-
904  int16_t setOOK(bool enableOOK);
-
905 
-
913  int16_t setOokThresholdType(uint8_t type);
-
914 
-
922  int16_t setOokPeakThresholdDecrement(uint8_t value);
-
923 
-
931  int16_t setOokFixedOrFloorThreshold(uint8_t value);
-
932 
-
940  int16_t setOokPeakThresholdStep(uint8_t value);
-
941 
-
947  int16_t enableBitSync();
-
948 
-
954  int16_t disableBitSync();
-
955 
-
963  size_t getPacketLength(bool update = true) override;
-
964 
-
972  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
-
973 
-
981  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
-
982 
-
990  uint32_t getTimeOnAir(size_t len);
-
991 
-
999  int16_t setCrcFiltering(bool crcOn = true);
-
1000 
-
1011  int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
-
1012 
-
1021  int16_t setEncoding(uint8_t encoding) override;
-
1022 
-
1030  uint16_t getIRQFlags();
-
1031 
-
1037  uint8_t getModemStatus();
-
1038 
-
1045  int8_t getTempRaw();
-
1046 
-
1055  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
1056 
-
1062  uint8_t randomByte();
-
1063 
-
1069  int16_t getChipVersion();
-
1070 
-
1078  int16_t invertIQ(bool invertIQ);
-
1079 
-
1085  void setDirectAction(void (*func)(void));
-
1086 
-
1092  void readBit(RADIOLIB_PIN_TYPE pin);
-
1093 
-
1101  int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod);
-
1102 
-
1108  uint8_t getFHSSHoppingPeriod(void);
-
1109 
-
1115  uint8_t getFHSSChannel(void);
-
1116 
-
1120  void clearFHSSInt(void);
+
735  bool fifoAdd(uint8_t* data, int totalLen, volatile int* remLen);
+
736 
+
737  bool fifoGet(volatile uint8_t* data, int totalLen, volatile int* rcvLen);
+
738 
+
750  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
751 
+
761  int16_t startReceive(uint8_t len = 0, uint8_t mode = RADIOLIB_SX127X_RXCONTINUOUS);
+
762 
+
773  int16_t readData(uint8_t* data, size_t len) override;
+
774 
+
781  int16_t startChannelScan();
+
782 
+
783  // configuration methods
+
784 
+
792  int16_t setSyncWord(uint8_t syncWord);
+
793 
+
801  int16_t setCurrentLimit(uint8_t currentLimit);
+
802 
+
810  int16_t setPreambleLength(uint16_t preambleLength);
+
811 
+
819  float getFrequencyError(bool autoCorrect = false);
+
820 
+
826  float getAFCError();
+
827 
+
833  float getSNR();
+
834 
+
840  float getDataRate() const;
+
841 
+
849  int16_t setBitRate(float br);
+
850 
+
858  int16_t setFrequencyDeviation(float freqDev) override;
+
859 
+
867  int16_t setRxBandwidth(float rxBw);
+
868 
+
876  int16_t setAFCBandwidth(float afcBw);
+
877 
+
885  int16_t setAFC(bool isEnabled);
+
886 
+
894  int16_t setAFCAGCTrigger(uint8_t trigger);
+
895 
+
905  int16_t setSyncWord(uint8_t* syncWord, size_t len);
+
906 
+
914  int16_t setNodeAddress(uint8_t nodeAddr);
+
915 
+
923  int16_t setBroadcastAddress(uint8_t broadAddr);
+
924 
+
930  int16_t disableAddressFiltering();
+
931 
+
939  int16_t setOOK(bool enableOOK);
+
940 
+
948  int16_t setOokThresholdType(uint8_t type);
+
949 
+
957  int16_t setOokPeakThresholdDecrement(uint8_t value);
+
958 
+
966  int16_t setOokFixedOrFloorThreshold(uint8_t value);
+
967 
+
975  int16_t setOokPeakThresholdStep(uint8_t value);
+
976 
+
982  int16_t enableBitSync();
+
983 
+
989  int16_t disableBitSync();
+
990 
+
998  size_t getPacketLength(bool update = true) override;
+
999 
+
1007  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
+
1008 
+
1016  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
+
1017 
+
1025  uint32_t getTimeOnAir(size_t len);
+
1026 
+
1034  int16_t setCrcFiltering(bool crcOn = true);
+
1035 
+
1046  int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
+
1047 
+
1056  int16_t setEncoding(uint8_t encoding) override;
+
1057 
+
1065  uint16_t getIRQFlags();
+
1066 
+
1072  uint8_t getModemStatus();
+
1073 
+
1080  int8_t getTempRaw();
+
1081 
+
1090  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
1091 
+
1097  uint8_t randomByte();
+
1098 
+
1104  int16_t getChipVersion();
+
1105 
+
1113  int16_t invertIQ(bool invertIQ);
+
1114 
+
1120  void setDirectAction(void (*func)(void));
1121 
-
1122 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1123  protected:
-
1124 #endif
-
1125  Module* _mod;
-
1126 
-
1127 #if !defined(RADIOLIB_GODMODE)
-
1128  protected:
-
1129 #endif
-
1130 
-
1131  float _freq = 0;
-
1132  float _bw = 0;
-
1133  uint8_t _sf = 0;
-
1134  uint8_t _cr = 0;
-
1135  float _br = 0;
-
1136  bool _ook = false;
-
1137  bool _crcEnabled = false;
-
1138  bool _crcOn = true; // default value used in FSK mode
-
1139  size_t _packetLength = 0;
-
1140 
-
1141  int16_t setFrequencyRaw(float newFreq);
-
1142  int16_t config();
-
1143  int16_t configFSK();
-
1144  int16_t getActiveModem();
-
1145  int16_t directMode();
-
1146  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1147 
-
1148 #if !defined(RADIOLIB_GODMODE)
-
1149  private:
-
1150 #endif
-
1151  float _dataRate = 0;
-
1152  bool _packetLengthQueried = false; // FSK packet length is the first byte in FIFO, length can only be queried once
-
1153  uint8_t _packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
-
1154 
-
1155  bool findChip(uint8_t ver);
-
1156  int16_t setMode(uint8_t mode);
-
1157  int16_t setActiveModem(uint8_t modem);
-
1158  void clearIRQFlags();
-
1159  void clearFIFO(size_t count); // used mostly to clear remaining bytes in FIFO after a packet read
-
1167  static uint8_t calculateBWManExp(float bandwidth);
-
1168 
-
1169  virtual void errataFix(bool rx) = 0;
-
1170 };
-
1171 
-
1172 #endif
-
1173 
-
1174 #endif
+
1127  void readBit(RADIOLIB_PIN_TYPE pin);
+
1128 
+
1136  int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod);
+
1137 
+
1143  uint8_t getFHSSHoppingPeriod(void);
+
1144 
+
1150  uint8_t getFHSSChannel(void);
+
1151 
+
1155  void clearFHSSInt(void);
+
1156 
+
1157 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1158  protected:
+
1159 #endif
+
1160  Module* _mod;
+
1161 
+
1162 #if !defined(RADIOLIB_GODMODE)
+
1163  protected:
+
1164 #endif
+
1165 
+
1166  float _freq = 0;
+
1167  float _bw = 0;
+
1168  uint8_t _sf = 0;
+
1169  uint8_t _cr = 0;
+
1170  float _br = 0;
+
1171  bool _ook = false;
+
1172  bool _crcEnabled = false;
+
1173  bool _crcOn = true; // default value used in FSK mode
+
1174  size_t _packetLength = 0;
+
1175 
+
1176  int16_t setFrequencyRaw(float newFreq);
+
1177  int16_t config();
+
1178  int16_t configFSK();
+
1179  int16_t getActiveModem();
+
1180  int16_t directMode();
+
1181  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1182 
+
1183 #if !defined(RADIOLIB_GODMODE)
+
1184  private:
+
1185 #endif
+
1186  float _dataRate = 0;
+
1187  bool _packetLengthQueried = false; // FSK packet length is the first byte in FIFO, length can only be queried once
+
1188  uint8_t _packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
+
1189 
+
1190  bool findChip(uint8_t ver);
+
1191  int16_t setMode(uint8_t mode);
+
1192  int16_t setActiveModem(uint8_t modem);
+
1193  void clearIRQFlags();
+
1194  void clearFIFO(size_t count); // used mostly to clear remaining bytes in FIFO after a packet read
+
1202  static uint8_t calculateBWManExp(float bandwidth);
+
1203 
+
1204  virtual void errataFix(bool rx) = 0;
+
1205 };
+
1206 
+
1207 #endif
+
1208 
+
1209 #endif
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:878
-
SX127x::getTempRaw
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1196
+
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:969
+
SX127x::getTempRaw
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition: SX127x.cpp:1287
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:356
-
SX127x::clearFHSSInt
void clearFHSSInt(void)
Clear the FHSS interrupt.
Definition: SX127x.cpp:1425
-
SX127x::invertIQ
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1385
-
SX127x::setAFCAGCTrigger
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:844
-
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:1119
+
SX127x::clearFHSSInt
void clearFHSSInt(void)
Clear the FHSS interrupt.
Definition: SX127x.cpp:1516
+
SX127x::setFifoEmptyAction
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:432
+
SX127x::invertIQ
int16_t invertIQ(bool invertIQ)
Enables/disables Invert the LoRa I and Q signals.
Definition: SX127x.cpp:1476
+
SX127x::setAFCAGCTrigger
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition: SX127x.cpp:935
+
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:1210
SX127x::setDio1Action
void setDio1Action(void(*func)(void))
Set interrupt service routine function to call when DIO1 activates.
Definition: SX127x.cpp:418
-
SX127x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1409
-
SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:956
-
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:1405
+
SX127x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX127x.cpp:1500
+
SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition: SX127x.cpp:1047
+
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:1496
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:265
-
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:500
-
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:1036
-
SX127x::disableBitSync
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:960
-
SX127x::setAFC
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:834
-
SX127x::setOokPeakThresholdStep
int16_t setOokPeakThresholdStep(uint8_t value)
Size of each decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:948
+
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:591
+
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:1127
+
SX127x::disableBitSync
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition: SX127x.cpp:1051
+
SX127x::setAFC
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition: SX127x.cpp:925
+
SX127x::setOokPeakThresholdStep
int16_t setOokPeakThresholdStep(uint8_t value)
Size of each decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1039
SX127x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX127x.cpp:425
-
SX127x::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:581
+
SX127x::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition: SX127x.cpp:672
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:310
SX127x::setDio0Action
void setDio0Action(void(*func)(void))
Set interrupt service routine function to call when DIO0 activates.
Definition: SX127x.cpp:410
-
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:760
-
SX127x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:556
-
SX127x::getDataRate
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:727
+
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:851
+
SX127x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX127x.cpp:647
+
SX127x::getDataRate
float getDataRate() const
Get data rate of the latest transmitted packet.
Definition: SX127x.cpp:818
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:142
-
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:932
-
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:1163
-
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:1032
-
SX127x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:906
-
SX127x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX127x.cpp:1040
+
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:1023
+
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:1254
+
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:1123
+
SX127x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:997
+
SX127x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX127x.cpp:1131
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:281
-
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:432
-
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:892
-
SX127x::getAFCError
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:700
-
SX127x::getModemStatus
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1153
-
SX127x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1167
+
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:513
+
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:983
+
SX127x::getAFCError
float getAFCError()
Gets current AFC error.
Definition: SX127x.cpp:791
+
SX127x::clearFifoEmptyAction
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition: SX127x.cpp:437
+
SX127x::getModemStatus
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition: SX127x.cpp:1244
+
SX127x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1258
SX127x::standby
int16_t standby() override
Sets the LoRa module to standby.
Definition: SX127x.cpp:273
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. Only available in LoRa mode.
Definition: SX127x.cpp:716
+
SX127x::fifoAdd
bool fifoAdd(uint8_t *data, int totalLen, volatile int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition: SX127x.cpp:455
+
SX127x::getSNR
float getSNR()
Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
Definition: SX127x.cpp:807
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:618
-
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:731
+
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:709
+
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:822
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:414
-
SX127x::getIRQFlags
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1138
-
SX127x::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:940
-
SX127x::setRSSIConfig
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1096
-
SX127x::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:924
-
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:818
-
SX127x::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:964
-
SX127x::setFHSSHoppingPeriod
int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)
Sets the hopping period and enables FHSS.
Definition: SX127x.cpp:1413
-
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:802
+
SX127x::getIRQFlags
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition: SX127x.cpp:1229
+
SX127x::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: SX127x.cpp:1031
+
SX127x::setRSSIConfig
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition: SX127x.cpp:1187
+
SX127x::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: SX127x.cpp:1015
+
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:909
+
SX127x::setOOK
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:1055
+
SX127x::setFHSSHoppingPeriod
int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)
Sets the hopping period and enables FHSS.
Definition: SX127x.cpp:1504
+
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:893
+
SX127x::clearFifoFullAction
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition: SX127x.cpp:450
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:245
-
SX127x::getFHSSHoppingPeriod
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition: SX127x.cpp:1417
+
SX127x::getFHSSHoppingPeriod
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition: SX127x.cpp:1508
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:200
-
SX127x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1192
-
SX127x::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: SX127x.cpp:1086
-
SX127x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:1004
+
SX127x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1283
+
SX127x::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: SX127x.cpp:1177
+
SX127x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX127x.cpp:1095
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:347
-
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:594
-
SX127x::getFrequencyError
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:647
-
SX127x::getFHSSChannel
uint8_t getFHSSChannel(void)
Gets the FHSS channel in use.
Definition: SX127x.cpp:1421
+
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:685
+
SX127x::getFrequencyError
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:738
+
SX127x::getFHSSChannel
uint8_t getFHSSChannel(void)
Gets the FHSS channel in use.
Definition: SX127x.cpp:1512
+
SX127x::setFifoFullAction
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition: SX127x.cpp:441
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
+ + +

◆ fifoAdd()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool SX127x::fifoAdd (uint8_t * data,
int totalLen,
volatile int * remLen 
)
+
+ +

Set interrupt service routine function to call when FIFO is empty.

+
Parameters
+ + +
funcPointer to interrupt service routine.
+
+
+
Returns
True when a complete packet is sent, false if more data is needed.
+
@@ -1593,6 +1656,58 @@ void 
Returns
Status Codes
+ + + +

◆ setFifoEmptyAction()

+ +
+
+ + + + + + + + +
void SX127x::setFifoEmptyAction (void(*)(void) func)
+
+ +

Set interrupt service routine function to call when FIFO is empty.

+
Parameters
+ + +
funcPointer to interrupt service routine.
+
+
+ +
+
+ +

◆ setFifoFullAction()

+ +
+
+ + + + + + + + +
void SX127x::setFifoFullAction (void(*)(void) func)
+
+ +

Set interrupt service routine function to call when FIFO is full.

+
Parameters
+ + +
funcPointer to interrupt service routine.
+
+
+
@@ -1759,8 +1874,7 @@ void 
Parameters
- +
valueStep size: RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_0_5_DB (default), RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_5_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_2_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_3_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_4_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_5_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_6_0_DB
-
valueStep size: RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_0_5_DB (default), RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_5_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_2_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_3_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_4_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_5_0_DB, RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_6_0_DB
diff --git a/class_s_x127x.js b/class_s_x127x.js index 46ee4c71..45fbf034 100644 --- a/class_s_x127x.js +++ b/class_s_x127x.js @@ -6,9 +6,13 @@ var class_s_x127x = [ "clearDio0Action", "class_s_x127x.html#a729b4f3f36096b5b15bae19c7876e823", null ], [ "clearDio1Action", "class_s_x127x.html#a9b6532a25e1730973ac08146008adca5", null ], [ "clearFHSSInt", "class_s_x127x.html#a41089d9e5b45217d3e31ac22b5326b66", null ], + [ "clearFifoEmptyAction", "class_s_x127x.html#aaa6eb4363badc1c3450ad7a4d11af4b1", null ], + [ "clearFifoFullAction", "class_s_x127x.html#a0f041e91ab2fbb6f05eef56b5addac71", null ], [ "disableAddressFiltering", "class_s_x127x.html#afe6e9bbfd75f9cad26f9f72c34c4ada5", null ], [ "disableBitSync", "class_s_x127x.html#a8025b05b8f4f2f2abb4cd803b06e2ebd", null ], [ "enableBitSync", "class_s_x127x.html#a1921e1d9fc1d888d2e73bb732e7db7aa", null ], + [ "fifoAdd", "class_s_x127x.html#a2f993bc663b8937f3683047f5e3b2509", null ], + [ "fifoGet", "class_s_x127x.html#a25b193b71ddb6015d25b0a161809d75a", null ], [ "fixedPacketLengthMode", "class_s_x127x.html#a6fb42d9cd518e9f6408a40753c0be359", null ], [ "getAFCError", "class_s_x127x.html#a5094ba2d9268340b7aba99afe5da0544", null ], [ "getChipVersion", "class_s_x127x.html#aee5324d7d854e7a2f6768221d4f362cd", null ], @@ -48,6 +52,8 @@ var class_s_x127x = [ "setDirectAction", "class_s_x127x.html#aa3f409359eafa5988e8e4c2948735238", null ], [ "setEncoding", "class_s_x127x.html#abad2d455012bd28d304589c8164390eb", null ], [ "setFHSSHoppingPeriod", "class_s_x127x.html#a7f04a7e883057908df18f06c7f74c7e1", null ], + [ "setFifoEmptyAction", "class_s_x127x.html#a6fbdfd8e2a2ad1eb7e59a73385847acb", null ], + [ "setFifoFullAction", "class_s_x127x.html#a201c31366f32c41b801724fb662265c1", null ], [ "setFrequencyDeviation", "class_s_x127x.html#a448ea8a6a6011a9cdddd4e09bd6c9679", null ], [ "setNodeAddress", "class_s_x127x.html#ab99630d50672b43fc7162ba8f3293f95", null ], [ "setOOK", "class_s_x127x.html#a24ef0af19a6b8954f956a3c3ad4286ee", null ], diff --git a/functions_c.html b/functions_c.html index 1fc3b86c..b833cf16 100644 --- a/functions_c.html +++ b/functions_c.html @@ -101,6 +101,12 @@ $(document).ready(function(){initNavTree('functions_c.html',''); initResizable()
  • clearFHSSInt() : SX127x
    • +
  • clearFifoEmptyAction() +: SX127x +
    • +
  • clearFifoFullAction() +: SX127x +
  • clearGdo0Action() : CC1101
    • diff --git a/functions_f.html b/functions_f.html index c9501a16..18942e75 100644 --- a/functions_f.html +++ b/functions_f.html @@ -85,6 +85,9 @@ $(document).ready(function(){initNavTree('functions_f.html',''); initResizable()
    Here is a list of all documented class members with links to the class documentation for each member:

    - f -

    diff --git a/functions_func_c.html b/functions_func_c.html index 8cbf4efe..f02c9caa 100644 --- a/functions_func_c.html +++ b/functions_func_c.html @@ -101,6 +101,12 @@ $(document).ready(function(){initNavTree('functions_func_c.html',''); initResiza
  • clearFHSSInt() : SX127x
    • +
  • clearFifoEmptyAction() +: SX127x +
    • +
  • clearFifoFullAction() +: SX127x +
  • clearGdo0Action() : CC1101
    • diff --git a/functions_func_f.html b/functions_func_f.html index 574c474a..b2f8e47b 100644 --- a/functions_func_f.html +++ b/functions_func_f.html @@ -85,6 +85,9 @@ $(document).ready(function(){initNavTree('functions_func_f.html',''); initResiza  

    - f -