From b4d5a51dc4551f60cc58c913c37185c12e060ec6 Mon Sep 17 00:00:00 2001 From: jgromes Date: Sat, 15 Jul 2023 17:40:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20d1e36?= =?UTF-8?q?91c3228cf56f495710fb22dd7894b938e5f=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 | 224 ++++++++++++------------ _r_f69_8h_source.html | 254 +++++++++++++-------------- _s_x126x_8h_source.html | 378 ++++++++++++++++++++-------------------- _s_x127x_8h_source.html | 304 ++++++++++++++++---------------- _s_x128x_8h_source.html | 276 ++++++++++++++--------------- _si443x_8h_source.html | 144 +++++++-------- class_c_c1101.html | 4 +- class_l_l_c_c68.html | 2 +- class_r_f69.html | 4 +- class_r_f_m95.html | 2 +- class_r_f_m96.html | 2 +- class_r_f_m97.html | 2 +- class_s_t_m32_w_lx.html | 2 +- class_s_x1231.html | 2 +- class_s_x1261.html | 2 +- class_s_x1262.html | 2 +- class_s_x1268.html | 2 +- class_s_x126x.html | 4 +- class_s_x1272.html | 2 +- class_s_x1273.html | 2 +- class_s_x1276.html | 2 +- class_s_x1277.html | 2 +- class_s_x1278.html | 2 +- class_s_x1279.html | 2 +- class_s_x127x.html | 4 +- class_s_x1280.html | 2 +- class_s_x1281.html | 2 +- class_s_x1282.html | 2 +- class_s_x128x.html | 4 +- class_si4430.html | 2 +- class_si4431.html | 2 +- class_si4432.html | 2 +- class_si443x.html | 4 +- classn_r_f24.html | 4 +- n_r_f24_8h_source.html | 122 ++++++------- 35 files changed, 886 insertions(+), 886 deletions(-) diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index f12db3d9..3eef88f9 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -680,118 +680,118 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
705 
714  int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
715 
-
723  int16_t readData(uint8_t* data, size_t len) override;
-
724 
-
725  // configuration methods
-
726 
-
733  int16_t setFrequency(float freq);
-
734 
-
740  int16_t setBitRate(float br);
-
741 
-
747  int16_t setRxBandwidth(float rxBw);
-
748 
-
754  int16_t setFrequencyDeviation(float freqDev) override;
-
755 
-
761  int16_t getFrequencyDeviation(float *freqDev);
-
762 
-
768  int16_t setOutputPower(int8_t pwr);
-
769 
-
778  int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
779 
-
788  int16_t setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
789 
-
795  int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold);
-
796 
-
804  int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
-
805 
-
810  int16_t disableAddressFiltering();
-
811 
-
817  int16_t setOOK(bool enableOOK);
-
818 
-
824  float getRSSI();
-
825 
-
830  uint8_t getLQI() const;
-
831 
-
837  size_t getPacketLength(bool update = true) override;
-
838 
-
844  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
-
845 
-
851  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
-
852 
-
859  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false);
-
860 
-
866  int16_t disableSyncWordFiltering(bool requireCarrierSense = false);
-
867 
-
873  int16_t setCrcFiltering(bool enable = true);
-
874 
-
880  int16_t setPromiscuousMode(bool enable = true);
-
881 
-
887  bool getPromiscuousMode();
-
888 
-
895  int16_t setDataShaping(uint8_t sh) override;
-
896 
-
903  int16_t setEncoding(uint8_t encoding) override;
-
904 
-
906  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
907 
-
909  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
910 
-
915  uint8_t randomByte();
-
916 
-
922  int16_t getChipVersion();
-
923 
-
924  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
929  void setDirectAction(void (*func)(void));
-
930 
-
935  void readBit(uint32_t pin);
-
936  #endif
-
937 
-
944  int16_t setDIOMapping(uint32_t pin, uint32_t value);
-
945 
-
946  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
947  protected:
-
948  #endif
-
949  Module* mod;
-
950 
-
951  // SPI read overrides to set bit for burst write and status registers access
-
952  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
-
953  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
-
954  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
-
955  uint8_t SPIreadRegister(uint8_t reg);
-
956  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
-
957  void SPIwriteRegister(uint8_t reg, uint8_t data);
-
958 
-
959  void SPIsendCommand(uint8_t cmd);
-
960 
-
961  #if !defined(RADIOLIB_GODMODE)
-
962  protected:
-
963  #endif
-
964 
-
965  float frequency = RADIOLIB_CC1101_DEFAULT_FREQ;
-
966  float bitRate = RADIOLIB_CC1101_DEFAULT_BR;
-
967  uint8_t rawRSSI = 0;
-
968  uint8_t rawLQI = 0;
-
969  uint8_t modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
-
970 
-
971  size_t packetLength = 0;
-
972  bool packetLengthQueried = false;
-
973  uint8_t packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
-
974 
-
975  bool promiscuous = false;
-
976  bool crcOn = true;
-
977  bool directModeEnabled = true;
-
978 
-
979  int8_t power = RADIOLIB_CC1101_DEFAULT_POWER;
-
980 
-
981  int16_t config();
-
982  int16_t transmitDirect(bool sync, uint32_t frf);
-
983  int16_t receiveDirect(bool sync);
-
984  int16_t directMode(bool sync);
-
985  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
-
986  int16_t setPacketMode(uint8_t mode, uint16_t len);
-
987 };
-
988 
-
989 #endif
+
724  int16_t readData(uint8_t* data, size_t len) override;
+
725 
+
726  // configuration methods
+
727 
+
734  int16_t setFrequency(float freq);
+
735 
+
741  int16_t setBitRate(float br);
+
742 
+
748  int16_t setRxBandwidth(float rxBw);
+
749 
+
755  int16_t setFrequencyDeviation(float freqDev) override;
+
756 
+
762  int16_t getFrequencyDeviation(float *freqDev);
+
763 
+
769  int16_t setOutputPower(int8_t pwr);
+
770 
+
779  int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
780 
+
789  int16_t setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
790 
+
796  int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold);
+
797 
+
805  int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
+
806 
+
811  int16_t disableAddressFiltering();
+
812 
+
818  int16_t setOOK(bool enableOOK);
+
819 
+
825  float getRSSI();
+
826 
+
831  uint8_t getLQI() const;
+
832 
+
838  size_t getPacketLength(bool update = true) override;
+
839 
+
845  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
+
846 
+
852  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
+
853 
+
860  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false);
+
861 
+
867  int16_t disableSyncWordFiltering(bool requireCarrierSense = false);
+
868 
+
874  int16_t setCrcFiltering(bool enable = true);
+
875 
+
881  int16_t setPromiscuousMode(bool enable = true);
+
882 
+
888  bool getPromiscuousMode();
+
889 
+
896  int16_t setDataShaping(uint8_t sh) override;
+
897 
+
904  int16_t setEncoding(uint8_t encoding) override;
+
905 
+
907  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
908 
+
910  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
911 
+
916  uint8_t randomByte();
+
917 
+
923  int16_t getChipVersion();
+
924 
+
925  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
930  void setDirectAction(void (*func)(void));
+
931 
+
936  void readBit(uint32_t pin);
+
937  #endif
+
938 
+
945  int16_t setDIOMapping(uint32_t pin, uint32_t value);
+
946 
+
947  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
948  protected:
+
949  #endif
+
950  Module* mod;
+
951 
+
952  // SPI read overrides to set bit for burst write and status registers access
+
953  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
954  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
+
955  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
+
956  uint8_t SPIreadRegister(uint8_t reg);
+
957  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
+
958  void SPIwriteRegister(uint8_t reg, uint8_t data);
+
959 
+
960  void SPIsendCommand(uint8_t cmd);
+
961 
+
962  #if !defined(RADIOLIB_GODMODE)
+
963  protected:
+
964  #endif
+
965 
+
966  float frequency = RADIOLIB_CC1101_DEFAULT_FREQ;
+
967  float bitRate = RADIOLIB_CC1101_DEFAULT_BR;
+
968  uint8_t rawRSSI = 0;
+
969  uint8_t rawLQI = 0;
+
970  uint8_t modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
+
971 
+
972  size_t packetLength = 0;
+
973  bool packetLengthQueried = false;
+
974  uint8_t packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
+
975 
+
976  bool promiscuous = false;
+
977  bool crcOn = true;
+
978  bool directModeEnabled = true;
+
979 
+
980  int8_t power = RADIOLIB_CC1101_DEFAULT_POWER;
+
981 
+
982  int16_t config();
+
983  int16_t transmitDirect(bool sync, uint32_t frf);
+
984  int16_t receiveDirect(bool sync);
+
985  int16_t directMode(bool sync);
+
986  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
+
987  int16_t setPacketMode(uint8_t mode, uint16_t len);
+
988 };
+
989 
+
990 #endif
CC1101
Control class for CC1101 module.
Definition: CC1101.h:531
CC1101::setDIOMapping
int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: CC1101.cpp:1028
CC1101::setPromiscuousMode
int16_t setPromiscuousMode(bool enable=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:907
diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index ce166503..3dfa18a6 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -646,133 +646,133 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
703 
712  int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
713 
-
721  int16_t readData(uint8_t* data, size_t len) override;
-
722 
-
723  // configuration methods
-
724 
-
731  int16_t setFrequency(float freq);
-
732 
-
738  int16_t getFrequency(float *freq);
-
739 
-
745  int16_t setBitRate(float br);
-
746 
-
753  int16_t setRxBandwidth(float rxBw);
-
754 
-
760  int16_t setFrequencyDeviation(float freqDev) override;
-
761 
-
767  int16_t getFrequencyDeviation(float *freqDev);
-
768 
-
777  int16_t setOutputPower(int8_t pwr, bool highPower = false);
-
778 
-
785  int16_t setSyncWord(uint8_t* syncWord, size_t len, uint8_t maxErrBits = 0);
-
786 
-
792  int16_t setPreambleLength(uint8_t preambleLen);
-
793 
-
799  int16_t setNodeAddress(uint8_t nodeAddr);
-
800 
-
806  int16_t setBroadcastAddress(uint8_t broadAddr);
-
807 
-
812  int16_t disableAddressFiltering();
-
813 
-
814  // measurement methods
-
815 
-
820  void setAmbientTemperature(int16_t tempAmbient);
-
821 
-
826  int16_t getTemperature();
-
827 
-
833  size_t getPacketLength(bool update = true) override;
-
834 
-
841  int16_t setOOK(bool enable);
-
842 
-
849  int16_t setOokThresholdType(uint8_t type);
-
850 
-
858  int16_t setOokFixedThreshold(uint8_t value);
-
859 
-
865  int16_t setOokPeakThresholdDecrement(uint8_t value);
-
866 
-
872  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
873 
-
879  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
880 
-
886  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
-
887 
-
892  int16_t disableSyncWordFiltering();
-
893 
-
898  int16_t enableContinuousModeBitSync();
-
899 
-
904  int16_t disableContinuousModeBitSync();
-
905 
-
911  int16_t setCrcFiltering(bool crcOn = true);
-
912 
-
918  int16_t setPromiscuousMode(bool enable = true);
-
919 
-
927  int16_t setDataShaping(uint8_t sh) override;
-
928 
-
935  int16_t setEncoding(uint8_t encoding) override;
-
936 
-
942  int16_t setLnaTestBoost(bool value);
-
943 
-
948  float getRSSI();
-
949 
-
955  int16_t setRSSIThreshold(float dbm);
-
956 
-
958  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
959 
-
961  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
962 
-
967  uint8_t randomByte();
-
968 
-
973  int16_t getChipVersion();
-
974 
-
975  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
980  void setDirectAction(void (*func)(void));
-
981 
-
986  void readBit(uint32_t pin);
-
987  #endif
-
988 
-
995  int16_t setDIOMapping(uint32_t pin, uint32_t value);
-
996 
-
997 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
998  protected:
-
999 #endif
-
1000  Module* mod;
-
1001 
-
1002 #if !defined(RADIOLIB_GODMODE)
-
1003  protected:
-
1004 #endif
-
1005 
-
1006  float frequency = RADIOLIB_RF69_DEFAULT_FREQ;
-
1007  float bitRate = RADIOLIB_RF69_DEFAULT_BR;
-
1008  float rxBandwidth = RADIOLIB_RF69_DEFAULT_RXBW;
-
1009  bool ookEnabled = false;
-
1010  int16_t tempOffset = 0;
-
1011  int8_t power = RADIOLIB_RF69_DEFAULT_POWER;
-
1012 
-
1013  size_t packetLength = 0;
-
1014  bool packetLengthQueried = false;
-
1015  uint8_t packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
-
1016 
-
1017  bool promiscuous = false;
-
1018 
-
1019  uint8_t syncWordLength = RADIOLIB_RF69_DEFAULT_SW_LEN;
-
1020 
-
1021  bool bitSync = true;
-
1022 
-
1023  int16_t config();
-
1024  int16_t directMode();
-
1025  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1026 
-
1027 #if !defined(RADIOLIB_GODMODE)
-
1028  private:
-
1029 #endif
-
1030  int16_t setMode(uint8_t mode);
-
1031  void clearIRQFlags();
-
1032  void clearFIFO(size_t count);
-
1033 };
-
1034 
-
1035 #endif
-
1036 
-
1037 #endif
+
722  int16_t readData(uint8_t* data, size_t len) override;
+
723 
+
724  // configuration methods
+
725 
+
732  int16_t setFrequency(float freq);
+
733 
+
739  int16_t getFrequency(float *freq);
+
740 
+
746  int16_t setBitRate(float br);
+
747 
+
754  int16_t setRxBandwidth(float rxBw);
+
755 
+
761  int16_t setFrequencyDeviation(float freqDev) override;
+
762 
+
768  int16_t getFrequencyDeviation(float *freqDev);
+
769 
+
778  int16_t setOutputPower(int8_t pwr, bool highPower = false);
+
779 
+
786  int16_t setSyncWord(uint8_t* syncWord, size_t len, uint8_t maxErrBits = 0);
+
787 
+
793  int16_t setPreambleLength(uint8_t preambleLen);
+
794 
+
800  int16_t setNodeAddress(uint8_t nodeAddr);
+
801 
+
807  int16_t setBroadcastAddress(uint8_t broadAddr);
+
808 
+
813  int16_t disableAddressFiltering();
+
814 
+
815  // measurement methods
+
816 
+
821  void setAmbientTemperature(int16_t tempAmbient);
+
822 
+
827  int16_t getTemperature();
+
828 
+
834  size_t getPacketLength(bool update = true) override;
+
835 
+
842  int16_t setOOK(bool enable);
+
843 
+
850  int16_t setOokThresholdType(uint8_t type);
+
851 
+
859  int16_t setOokFixedThreshold(uint8_t value);
+
860 
+
866  int16_t setOokPeakThresholdDecrement(uint8_t value);
+
867 
+
873  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
874 
+
880  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
881 
+
887  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
+
888 
+
893  int16_t disableSyncWordFiltering();
+
894 
+
899  int16_t enableContinuousModeBitSync();
+
900 
+
905  int16_t disableContinuousModeBitSync();
+
906 
+
912  int16_t setCrcFiltering(bool crcOn = true);
+
913 
+
919  int16_t setPromiscuousMode(bool enable = true);
+
920 
+
928  int16_t setDataShaping(uint8_t sh) override;
+
929 
+
936  int16_t setEncoding(uint8_t encoding) override;
+
937 
+
943  int16_t setLnaTestBoost(bool value);
+
944 
+
949  float getRSSI();
+
950 
+
956  int16_t setRSSIThreshold(float dbm);
+
957 
+
959  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
960 
+
962  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
963 
+
968  uint8_t randomByte();
+
969 
+
974  int16_t getChipVersion();
+
975 
+
976  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
981  void setDirectAction(void (*func)(void));
+
982 
+
987  void readBit(uint32_t pin);
+
988  #endif
+
989 
+
996  int16_t setDIOMapping(uint32_t pin, uint32_t value);
+
997 
+
998 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
999  protected:
+
1000 #endif
+
1001  Module* mod;
+
1002 
+
1003 #if !defined(RADIOLIB_GODMODE)
+
1004  protected:
+
1005 #endif
+
1006 
+
1007  float frequency = RADIOLIB_RF69_DEFAULT_FREQ;
+
1008  float bitRate = RADIOLIB_RF69_DEFAULT_BR;
+
1009  float rxBandwidth = RADIOLIB_RF69_DEFAULT_RXBW;
+
1010  bool ookEnabled = false;
+
1011  int16_t tempOffset = 0;
+
1012  int8_t power = RADIOLIB_RF69_DEFAULT_POWER;
+
1013 
+
1014  size_t packetLength = 0;
+
1015  bool packetLengthQueried = false;
+
1016  uint8_t packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
+
1017 
+
1018  bool promiscuous = false;
+
1019 
+
1020  uint8_t syncWordLength = RADIOLIB_RF69_DEFAULT_SW_LEN;
+
1021 
+
1022  bool bitSync = true;
+
1023 
+
1024  int16_t config();
+
1025  int16_t directMode();
+
1026  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1027 
+
1028 #if !defined(RADIOLIB_GODMODE)
+
1029  private:
+
1030 #endif
+
1031  int16_t setMode(uint8_t mode);
+
1032  void clearIRQFlags();
+
1033  void clearFIFO(size_t count);
+
1034 };
+
1035 
+
1036 #endif
+
1037 
+
1038 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 1a5bfae9..8d3f1604 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -589,195 +589,195 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
666 
671  uint16_t getIrqStatus();
672 
-
680  int16_t readData(uint8_t* data, size_t len) override;
-
681 
-
690  int16_t startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
-
691 
-
696  int16_t getChannelScanResult();
-
697 
-
698  // configuration methods
-
699 
-
705  int16_t setBandwidth(float bw);
-
706 
-
712  int16_t setSpreadingFactor(uint8_t sf);
-
713 
-
719  int16_t setCodingRate(uint8_t cr);
-
720 
-
727  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
728 
-
734  int16_t setCurrentLimit(float currentLimit);
-
735 
-
740  float getCurrentLimit();
-
741 
-
747  int16_t setPreambleLength(size_t preambleLength) override;
-
748 
-
754  int16_t setFrequencyDeviation(float freqDev) override;
-
755 
-
761  int16_t setBitRate(float br);
-
762 
-
768  int16_t setDataRate(DataRate_t dr) override;
-
769 
-
776  int16_t setRxBandwidth(float rxBw);
-
777 
-
786  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
-
787 
-
795  int16_t setDataShaping(uint8_t sh) override;
-
796 
-
803  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
-
804 
-
812  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
813 
-
819  int16_t setNodeAddress(uint8_t nodeAddr);
-
820 
-
827  int16_t setBroadcastAddress(uint8_t broadAddr);
-
828 
-
833  int16_t disableAddressFiltering();
-
834 
-
843  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
844 
-
852  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
-
853 
-
863  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
864 
-
869  int16_t setDio2AsRfSwitch(bool enable = true);
-
870 
-
875  float getDataRate() const;
-
876 
-
882  float getRSSI(bool packet = true);
-
883 
-
888  float getSNR();
-
889 
-
897  float getFrequencyError();
-
898 
-
904  size_t getPacketLength(bool update = true) override;
-
905 
-
911  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
912 
-
918  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
919 
-
925  uint32_t getTimeOnAir(size_t len);
-
926 
-
932  int16_t implicitHeader(size_t len);
-
933 
-
938  int16_t explicitHeader();
-
939 
-
944  int16_t setRegulatorLDO();
-
945 
-
950  int16_t setRegulatorDCDC();
-
951 
-
957  int16_t setEncoding(uint8_t encoding) override;
-
958 
-
960  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
961 
-
963  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
964 
-
973  int16_t forceLDRO(bool enable);
-
974 
-
981  int16_t autoLDRO();
-
982 
-
987  uint8_t randomByte();
-
988 
-
994  int16_t invertIQ(bool enable) override;
-
995 
-
996  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
1001  void setDirectAction(void (*func)(void));
-
1002 
-
1007  void readBit(uint32_t pin);
-
1008  #endif
-
1009 
-
1019  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
-
1020 
-
1028  int16_t spectralScanStart(uint16_t numSamples, uint8_t window = RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
-
1029 
-
1033  void spectralScanAbort();
-
1034 
-
1039  int16_t spectralScanGetStatus();
-
1040 
-
1046  int16_t spectralScanGetResult(uint16_t* results);
-
1047 
-
1048 #if !defined(RADIOLIB_GODMODE)
-
1049  protected:
-
1050 #endif
-
1051  // SX126x SPI command implementations
-
1052  int16_t setFs();
-
1053  int16_t setTx(uint32_t timeout = 0);
-
1054  int16_t setRx(uint32_t timeout);
-
1055  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
1056  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);
-
1057  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1058  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1059  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1060  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1061  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
1062  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
1063  int16_t setRfFrequency(uint32_t frf);
-
1064  int16_t calibrateImage(uint8_t* data);
-
1065  uint8_t getPacketType();
-
1066  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
-
1067  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1068  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
-
1069  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
-
1070  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
-
1071  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
1072  int16_t setRegulatorMode(uint8_t mode);
-
1073  uint8_t getStatus();
-
1074  uint32_t getPacketStatus();
-
1075  uint16_t getDeviceErrors();
-
1076  int16_t clearDeviceErrors();
-
1077 
-
1078  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
1079  int16_t setFrequencyRaw(float freq);
-
1080  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1081  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
1082  int16_t directMode();
-
1083  int16_t packetMode();
-
1084 
-
1085  // fixes to errata
-
1086  int16_t fixSensitivity();
-
1087  int16_t fixPaClamping(bool enable = true);
-
1088  int16_t fixImplicitTimeout();
-
1089  int16_t fixInvertedIQ(uint8_t iqConfig);
-
1090 
-
1091 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1092  protected:
-
1093 #endif
-
1094  Module* mod;
-
1095 
-
1096  // common low-level SPI interface
-
1097  static int16_t SPIparseStatus(uint8_t in);
-
1098 
-
1099 #if !defined(RADIOLIB_GODMODE)
-
1100  protected:
-
1101 #endif
-
1102 
-
1103  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
-
1104  uint16_t preambleLengthLoRa = 0;
-
1105  float bandwidthKhz = 0;
-
1106  bool ldroAuto = true;
-
1107 
-
1108  uint32_t bitRate = 0, frequencyDev = 0;
-
1109  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
-
1110  uint16_t preambleLengthFSK = 0;
-
1111  float rxBandwidthKhz = 0;
-
1112 
-
1113  float dataRateMeasured = 0;
-
1114 
-
1115  uint32_t tcxoDelay = 0;
-
1116 
-
1117  size_t implicitLen = 0;
-
1118  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
-
1119  const char* chipType;
-
1120 
-
1121  // Allow subclasses to define different TX modes
-
1122  uint8_t txMode = Module::MODE_TX;
-
1123 
-
1124  int16_t config(uint8_t modem);
-
1125  bool findChip(const char* verStr);
-
1126 };
-
1127 
-
1128 #endif
-
1129 
-
1130 #endif
+
681  int16_t readData(uint8_t* data, size_t len) override;
+
682 
+
691  int16_t startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);
+
692 
+
697  int16_t getChannelScanResult();
+
698 
+
699  // configuration methods
+
700 
+
706  int16_t setBandwidth(float bw);
+
707 
+
713  int16_t setSpreadingFactor(uint8_t sf);
+
714 
+
720  int16_t setCodingRate(uint8_t cr);
+
721 
+
728  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
729 
+
735  int16_t setCurrentLimit(float currentLimit);
+
736 
+
741  float getCurrentLimit();
+
742 
+
748  int16_t setPreambleLength(size_t preambleLength) override;
+
749 
+
755  int16_t setFrequencyDeviation(float freqDev) override;
+
756 
+
762  int16_t setBitRate(float br);
+
763 
+
769  int16_t setDataRate(DataRate_t dr) override;
+
770 
+
777  int16_t setRxBandwidth(float rxBw);
+
778 
+
787  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
+
788 
+
796  int16_t setDataShaping(uint8_t sh) override;
+
797 
+
804  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
805 
+
813  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
814 
+
820  int16_t setNodeAddress(uint8_t nodeAddr);
+
821 
+
828  int16_t setBroadcastAddress(uint8_t broadAddr);
+
829 
+
834  int16_t disableAddressFiltering();
+
835 
+
844  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
+
845 
+
853  int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);
+
854 
+
864  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
865 
+
870  int16_t setDio2AsRfSwitch(bool enable = true);
+
871 
+
876  float getDataRate() const;
+
877 
+
883  float getRSSI(bool packet = true);
+
884 
+
889  float getSNR();
+
890 
+
898  float getFrequencyError();
+
899 
+
905  size_t getPacketLength(bool update = true) override;
+
906 
+
912  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
913 
+
919  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
920 
+
926  uint32_t getTimeOnAir(size_t len);
+
927 
+
933  int16_t implicitHeader(size_t len);
+
934 
+
939  int16_t explicitHeader();
+
940 
+
945  int16_t setRegulatorLDO();
+
946 
+
951  int16_t setRegulatorDCDC();
+
952 
+
958  int16_t setEncoding(uint8_t encoding) override;
+
959 
+
961  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
962 
+
964  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
965 
+
974  int16_t forceLDRO(bool enable);
+
975 
+
982  int16_t autoLDRO();
+
983 
+
988  uint8_t randomByte();
+
989 
+
995  int16_t invertIQ(bool enable) override;
+
996 
+
997  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
1002  void setDirectAction(void (*func)(void));
+
1003 
+
1008  void readBit(uint32_t pin);
+
1009  #endif
+
1010 
+
1020  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
+
1021 
+
1029  int16_t spectralScanStart(uint16_t numSamples, uint8_t window = RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
+
1030 
+
1034  void spectralScanAbort();
+
1035 
+
1040  int16_t spectralScanGetStatus();
+
1041 
+
1047  int16_t spectralScanGetResult(uint16_t* results);
+
1048 
+
1049 #if !defined(RADIOLIB_GODMODE)
+
1050  protected:
+
1051 #endif
+
1052  // SX126x SPI command implementations
+
1053  int16_t setFs();
+
1054  int16_t setTx(uint32_t timeout = 0);
+
1055  int16_t setRx(uint32_t timeout);
+
1056  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1057  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);
+
1058  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1059  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1060  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1061  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1062  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
1063  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
1064  int16_t setRfFrequency(uint32_t frf);
+
1065  int16_t calibrateImage(uint8_t* data);
+
1066  uint8_t getPacketType();
+
1067  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+
1068  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1069  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+
1070  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
+
1071  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+
1072  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
1073  int16_t setRegulatorMode(uint8_t mode);
+
1074  uint8_t getStatus();
+
1075  uint32_t getPacketStatus();
+
1076  uint16_t getDeviceErrors();
+
1077  int16_t clearDeviceErrors();
+
1078 
+
1079  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
1080  int16_t setFrequencyRaw(float freq);
+
1081  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1082  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
1083  int16_t directMode();
+
1084  int16_t packetMode();
+
1085 
+
1086  // fixes to errata
+
1087  int16_t fixSensitivity();
+
1088  int16_t fixPaClamping(bool enable = true);
+
1089  int16_t fixImplicitTimeout();
+
1090  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1091 
+
1092 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1093  protected:
+
1094 #endif
+
1095  Module* mod;
+
1096 
+
1097  // common low-level SPI interface
+
1098  static int16_t SPIparseStatus(uint8_t in);
+
1099 
+
1100 #if !defined(RADIOLIB_GODMODE)
+
1101  protected:
+
1102 #endif
+
1103 
+
1104  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+
1105  uint16_t preambleLengthLoRa = 0;
+
1106  float bandwidthKhz = 0;
+
1107  bool ldroAuto = true;
+
1108 
+
1109  uint32_t bitRate = 0, frequencyDev = 0;
+
1110  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
+
1111  uint16_t preambleLengthFSK = 0;
+
1112  float rxBandwidthKhz = 0;
+
1113 
+
1114  float dataRateMeasured = 0;
+
1115 
+
1116  uint32_t tcxoDelay = 0;
+
1117 
+
1118  size_t implicitLen = 0;
+
1119  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+
1120  const char* chipType;
+
1121 
+
1122  // Allow subclasses to define different TX modes
+
1123  uint8_t txMode = Module::MODE_TX;
+
1124 
+
1125  int16_t config(uint8_t modem);
+
1126  bool findChip(const char* verStr);
+
1127 };
+
1128 
+
1129 #endif
+
1130 
+
1131 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Module::MODE_TX
@ MODE_TX
Definition: Module.h:71
diff --git a/_s_x127x_8h_source.html b/_s_x127x_8h_source.html index 37a18d03..61c78e33 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -742,158 +742,158 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
811 
820  int16_t startReceive(uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len);
821 
-
829  int16_t readData(uint8_t* data, size_t len) override;
-
830 
-
836  int16_t startChannelScan();
-
837 
-
838  // configuration methods
-
839 
-
845  int16_t setSyncWord(uint8_t syncWord);
-
846 
-
852  int16_t setCurrentLimit(uint8_t currentLimit);
-
853 
-
859  int16_t setPreambleLength(size_t preambleLength) override;
-
860 
-
866  float getFrequencyError(bool autoCorrect = false);
-
867 
-
872  float getAFCError();
-
873 
-
878  float getSNR();
-
879 
-
884  float getDataRate() const;
-
885 
-
891  int16_t setFrequencyDeviation(float freqDev) override;
-
892 
-
898  int16_t setRxBandwidth(float rxBw);
-
899 
-
905  int16_t setAFCBandwidth(float afcBw);
-
906 
-
912  int16_t setAFC(bool isEnabled);
-
913 
-
919  int16_t setAFCAGCTrigger(uint8_t trigger);
-
920 
-
927  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
-
928 
-
934  int16_t setNodeAddress(uint8_t nodeAddr);
-
935 
-
941  int16_t setBroadcastAddress(uint8_t broadAddr);
-
942 
-
947  int16_t disableAddressFiltering();
-
948 
-
954  int16_t setOOK(bool enableOOK);
-
955 
-
961  int16_t setOokThresholdType(uint8_t type);
-
962 
-
968  int16_t setOokPeakThresholdDecrement(uint8_t value);
-
969 
-
975  int16_t setOokFixedOrFloorThreshold(uint8_t value);
-
976 
-
982  int16_t setOokPeakThresholdStep(uint8_t value);
-
983 
-
988  int16_t enableBitSync();
-
989 
-
994  int16_t disableBitSync();
-
995 
-
1001  size_t getPacketLength(bool update = true) override;
-
1002 
-
1008  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
-
1009 
-
1015  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
-
1016 
-
1022  uint32_t getTimeOnAir(size_t len);
-
1023 
-
1029  int16_t setCrcFiltering(bool enable = true);
-
1030 
-
1038  int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
-
1039 
-
1046  int16_t setEncoding(uint8_t encoding) override;
-
1047 
-
1054  uint16_t getIRQFlags();
-
1055 
-
1060  uint8_t getModemStatus();
-
1061 
-
1067  int8_t getTempRaw();
-
1068 
-
1070  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
1071 
-
1073  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
1074 
-
1079  uint8_t randomByte();
-
1080 
-
1085  int16_t getChipVersion();
-
1086 
-
1092  int16_t invertIQ(bool enable) override;
-
1093 
-
1094  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
1099  void setDirectAction(void (*func)(void));
-
1100 
-
1105  void readBit(uint32_t pin);
-
1106  #endif
-
1107 
-
1113  int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod);
-
1114 
-
1119  uint8_t getFHSSHoppingPeriod(void);
-
1120 
-
1125  uint8_t getFHSSChannel(void);
-
1126 
-
1130  void clearFHSSInt(void);
-
1131 
-
1138  int16_t setDIOMapping(uint32_t pin, uint32_t value);
-
1139 
-
1145  int16_t setDIOPreambleDetect(bool usePreambleDetect);
-
1146 
-
1153  float getRSSI(bool packet, bool skipReceive, int16_t offset);
-
1154 
-
1160  int16_t setRSSIThreshold(float dbm);
-
1161 
-
1162 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1163  protected:
-
1164 #endif
-
1165  Module* mod;
-
1166 
-
1167 #if !defined(RADIOLIB_GODMODE)
-
1168  protected:
-
1169 #endif
-
1170 
-
1171  float frequency = 0;
-
1172  float bandwidth = 0;
-
1173  uint8_t spreadingFactor = 0;
-
1174  uint8_t codingRate = 0;
-
1175  float bitRate = 0;
-
1176  bool ookEnabled = false;
-
1177  bool crcEnabled = false;
-
1178  bool crcOn = true; // default value used in FSK mode
-
1179  size_t packetLength = 0;
-
1180 
-
1181  int16_t setFrequencyRaw(float newFreq);
-
1182  int16_t setBitRateCommon(float br, uint8_t fracRegAddr);
-
1183  int16_t config();
-
1184  int16_t configFSK();
-
1185  int16_t getActiveModem();
-
1186  int16_t directMode();
-
1187  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1188 
-
1189 #if !defined(RADIOLIB_GODMODE)
-
1190  private:
-
1191 #endif
-
1192  float dataRate = 0;
-
1193  bool packetLengthQueried = false; // FSK packet length is the first byte in FIFO, length can only be queried once
-
1194  uint8_t packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
-
1195 
-
1196  bool findChip(uint8_t ver);
-
1197  int16_t setMode(uint8_t mode);
-
1198  int16_t setActiveModem(uint8_t modem);
-
1199  void clearIRQFlags();
-
1200  void clearFIFO(size_t count); // used mostly to clear remaining bytes in FIFO after a packet read
-
1201 
-
1207  static uint8_t calculateBWManExp(float bandwidth);
-
1208 
-
1209  virtual void errataFix(bool rx) = 0;
-
1210 };
-
1211 
-
1212 #endif
-
1213 
-
1214 #endif
+
830  int16_t readData(uint8_t* data, size_t len) override;
+
831 
+
837  int16_t startChannelScan();
+
838 
+
839  // configuration methods
+
840 
+
846  int16_t setSyncWord(uint8_t syncWord);
+
847 
+
853  int16_t setCurrentLimit(uint8_t currentLimit);
+
854 
+
860  int16_t setPreambleLength(size_t preambleLength) override;
+
861 
+
867  float getFrequencyError(bool autoCorrect = false);
+
868 
+
873  float getAFCError();
+
874 
+
879  float getSNR();
+
880 
+
885  float getDataRate() const;
+
886 
+
892  int16_t setFrequencyDeviation(float freqDev) override;
+
893 
+
899  int16_t setRxBandwidth(float rxBw);
+
900 
+
906  int16_t setAFCBandwidth(float afcBw);
+
907 
+
913  int16_t setAFC(bool isEnabled);
+
914 
+
920  int16_t setAFCAGCTrigger(uint8_t trigger);
+
921 
+
928  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
929 
+
935  int16_t setNodeAddress(uint8_t nodeAddr);
+
936 
+
942  int16_t setBroadcastAddress(uint8_t broadAddr);
+
943 
+
948  int16_t disableAddressFiltering();
+
949 
+
955  int16_t setOOK(bool enableOOK);
+
956 
+
962  int16_t setOokThresholdType(uint8_t type);
+
963 
+
969  int16_t setOokPeakThresholdDecrement(uint8_t value);
+
970 
+
976  int16_t setOokFixedOrFloorThreshold(uint8_t value);
+
977 
+
983  int16_t setOokPeakThresholdStep(uint8_t value);
+
984 
+
989  int16_t enableBitSync();
+
990 
+
995  int16_t disableBitSync();
+
996 
+
1002  size_t getPacketLength(bool update = true) override;
+
1003 
+
1009  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
+
1010 
+
1016  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
+
1017 
+
1023  uint32_t getTimeOnAir(size_t len);
+
1024 
+
1030  int16_t setCrcFiltering(bool enable = true);
+
1031 
+
1039  int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);
+
1040 
+
1047  int16_t setEncoding(uint8_t encoding) override;
+
1048 
+
1055  uint16_t getIRQFlags();
+
1056 
+
1061  uint8_t getModemStatus();
+
1062 
+
1068  int8_t getTempRaw();
+
1069 
+
1071  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
1072 
+
1074  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
1075 
+
1080  uint8_t randomByte();
+
1081 
+
1086  int16_t getChipVersion();
+
1087 
+
1093  int16_t invertIQ(bool enable) override;
+
1094 
+
1095  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
1100  void setDirectAction(void (*func)(void));
+
1101 
+
1106  void readBit(uint32_t pin);
+
1107  #endif
+
1108 
+
1114  int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod);
+
1115 
+
1120  uint8_t getFHSSHoppingPeriod(void);
+
1121 
+
1126  uint8_t getFHSSChannel(void);
+
1127 
+
1131  void clearFHSSInt(void);
+
1132 
+
1139  int16_t setDIOMapping(uint32_t pin, uint32_t value);
+
1140 
+
1146  int16_t setDIOPreambleDetect(bool usePreambleDetect);
+
1147 
+
1154  float getRSSI(bool packet, bool skipReceive, int16_t offset);
+
1155 
+
1161  int16_t setRSSIThreshold(float dbm);
+
1162 
+
1163 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1164  protected:
+
1165 #endif
+
1166  Module* mod;
+
1167 
+
1168 #if !defined(RADIOLIB_GODMODE)
+
1169  protected:
+
1170 #endif
+
1171 
+
1172  float frequency = 0;
+
1173  float bandwidth = 0;
+
1174  uint8_t spreadingFactor = 0;
+
1175  uint8_t codingRate = 0;
+
1176  float bitRate = 0;
+
1177  bool ookEnabled = false;
+
1178  bool crcEnabled = false;
+
1179  bool crcOn = true; // default value used in FSK mode
+
1180  size_t packetLength = 0;
+
1181 
+
1182  int16_t setFrequencyRaw(float newFreq);
+
1183  int16_t setBitRateCommon(float br, uint8_t fracRegAddr);
+
1184  int16_t config();
+
1185  int16_t configFSK();
+
1186  int16_t getActiveModem();
+
1187  int16_t directMode();
+
1188  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1189 
+
1190 #if !defined(RADIOLIB_GODMODE)
+
1191  private:
+
1192 #endif
+
1193  float dataRate = 0;
+
1194  bool packetLengthQueried = false; // FSK packet length is the first byte in FIFO, length can only be queried once
+
1195  uint8_t packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;
+
1196 
+
1197  bool findChip(uint8_t ver);
+
1198  int16_t setMode(uint8_t mode);
+
1199  int16_t setActiveModem(uint8_t modem);
+
1200  void clearIRQFlags();
+
1201  void clearFIFO(size_t count); // used mostly to clear remaining bytes in FIFO after a packet read
+
1202 
+
1208  static uint8_t calculateBWManExp(float bandwidth);
+
1209 
+
1210  virtual void errataFix(bool rx) = 0;
+
1211 };
+
1212 
+
1213 #endif
+
1214 
+
1215 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index ebf599bf..1185a891 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -494,144 +494,144 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
557 
562  uint16_t getIrqStatus();
563 
-
571  int16_t readData(uint8_t* data, size_t len) override;
-
572 
-
573  // configuration methods
-
574 
-
580  int16_t setFrequency(float freq);
-
581 
-
587  int16_t setBandwidth(float bw);
-
588 
-
594  int16_t setSpreadingFactor(uint8_t sf);
-
595 
-
603  int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);
-
604 
-
610  int16_t setOutputPower(int8_t pwr);
-
611 
-
617  int16_t setPreambleLength(uint32_t preambleLength);
-
618 
-
625  int16_t setBitRate(float br);
-
626 
-
632  int16_t setFrequencyDeviation(float freqDev) override;
-
633 
-
640  int16_t setDataShaping(uint8_t sh) override;
-
641 
-
649  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
-
650 
-
657  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
658 
-
666  int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
-
667 
-
673  int16_t setWhitening(bool enabled);
-
674 
-
680  int16_t setAccessAddress(uint32_t addr);
-
681 
-
687  int16_t setHighSensitivityMode(bool enable);
-
688 
-
694  int16_t setGainControl(uint8_t gain = 0);
-
695 
-
700  float getRSSI();
-
701 
-
706  float getSNR();
-
707 
-
712  float getFrequencyError();
-
713 
-
719  size_t getPacketLength(bool update = true) override;
-
720 
-
726  uint32_t getTimeOnAir(size_t len);
-
727 
-
732  int16_t implicitHeader(size_t len);
-
733 
-
739  int16_t explicitHeader();
-
740 
-
746  int16_t setEncoding(uint8_t encoding) override;
-
747 
-
749  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
750 
-
752  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
753 
-
758  uint8_t randomByte();
-
759 
-
765  int16_t invertIQ(bool enable);
-
766 
-
767  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
772  void setDirectAction(void (*func)(void));
-
773 
-
778  void readBit(uint32_t pin);
-
779  #endif
-
780 
-
781 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
782  protected:
-
783 #endif
-
784  Module* mod;
-
785 
-
786 #if !defined(RADIOLIB_GODMODE)
-
787  protected:
-
788 #endif
-
789 
-
790  // cached LoRa parameters
-
791  float bandwidthKhz = 0;
-
792  uint8_t bandwidth = 0, spreadingFactor = 0, codingRateLoRa = 0;
-
793  uint8_t preambleLengthLoRa = 0, headerType = 0, payloadLen = 0, crcLoRa = 0;
-
794 
-
795  // SX128x SPI command implementations
-
796  uint8_t getStatus();
-
797  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
798  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
799  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
800  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
801  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
802  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
803  int16_t setCad();
-
804  uint8_t getPacketType();
-
805  int16_t setRfFrequency(uint32_t frf);
-
806  int16_t setTxParams(uint8_t pwr, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
-
807  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
808  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
-
809  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncLen, uint8_t syncMatch, uint8_t crcLen, uint8_t whiten, uint8_t payLen = 0xFF, uint8_t hdrType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
-
810  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTest, uint8_t whiten);
-
811  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t hdrType, uint8_t payLen, uint8_t crc, uint8_t invIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
-
812  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
-
813  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
-
814  int16_t setRangingRole(uint8_t role);
-
815  int16_t setPacketType(uint8_t type);
-
816 
-
817  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
818 
-
819 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
820  private:
-
821 #endif
-
822 
-
823  // common low-level SPI interface
-
824  static int16_t SPIparseStatus(uint8_t in);
-
825 
-
826 #if !defined(RADIOLIB_GODMODE)
-
827  private:
-
828 #endif
-
829  // common parameters
-
830  uint8_t power = 0;
-
831 
-
832  // cached LoRa parameters
-
833  uint8_t invertIQEnabled = RADIOLIB_SX128X_LORA_IQ_STANDARD;
-
834 
-
835  // cached GFSK parameters
-
836  float modIndexReal = 0;
-
837  uint16_t bitRateKbps = 0;
-
838  uint8_t bitRate = 0, modIndex = 0, shaping = 0;
-
839  uint8_t preambleLengthGFSK = 0, syncWordLen = 0, syncWordMatch = 0, crcGFSK = 0, whitening = 0;
-
840 
-
841  // cached FLRC parameters
-
842  uint8_t codingRateFLRC = 0;
-
843 
-
844  // cached BLE parameters
-
845  uint8_t connectionState = 0, crcBLE = 0, bleTestPayload = 0;
-
846 
-
847  int16_t config(uint8_t modem);
-
848 };
-
849 
-
850 #endif
-
851 
-
852 #endif
+
572  int16_t readData(uint8_t* data, size_t len) override;
+
573 
+
574  // configuration methods
+
575 
+
581  int16_t setFrequency(float freq);
+
582 
+
588  int16_t setBandwidth(float bw);
+
589 
+
595  int16_t setSpreadingFactor(uint8_t sf);
+
596 
+
604  int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);
+
605 
+
611  int16_t setOutputPower(int8_t pwr);
+
612 
+
618  int16_t setPreambleLength(uint32_t preambleLength);
+
619 
+
626  int16_t setBitRate(float br);
+
627 
+
633  int16_t setFrequencyDeviation(float freqDev) override;
+
634 
+
641  int16_t setDataShaping(uint8_t sh) override;
+
642 
+
650  int16_t setSyncWord(uint8_t* syncWord, uint8_t len);
+
651 
+
658  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
659 
+
667  int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
+
668 
+
674  int16_t setWhitening(bool enabled);
+
675 
+
681  int16_t setAccessAddress(uint32_t addr);
+
682 
+
688  int16_t setHighSensitivityMode(bool enable);
+
689 
+
695  int16_t setGainControl(uint8_t gain = 0);
+
696 
+
701  float getRSSI();
+
702 
+
707  float getSNR();
+
708 
+
713  float getFrequencyError();
+
714 
+
720  size_t getPacketLength(bool update = true) override;
+
721 
+
727  uint32_t getTimeOnAir(size_t len);
+
728 
+
733  int16_t implicitHeader(size_t len);
+
734 
+
740  int16_t explicitHeader();
+
741 
+
747  int16_t setEncoding(uint8_t encoding) override;
+
748 
+
750  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
751 
+
753  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
754 
+
759  uint8_t randomByte();
+
760 
+
766  int16_t invertIQ(bool enable);
+
767 
+
768  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
773  void setDirectAction(void (*func)(void));
+
774 
+
779  void readBit(uint32_t pin);
+
780  #endif
+
781 
+
782 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
783  protected:
+
784 #endif
+
785  Module* mod;
+
786 
+
787 #if !defined(RADIOLIB_GODMODE)
+
788  protected:
+
789 #endif
+
790 
+
791  // cached LoRa parameters
+
792  float bandwidthKhz = 0;
+
793  uint8_t bandwidth = 0, spreadingFactor = 0, codingRateLoRa = 0;
+
794  uint8_t preambleLengthLoRa = 0, headerType = 0, payloadLen = 0, crcLoRa = 0;
+
795 
+
796  // SX128x SPI command implementations
+
797  uint8_t getStatus();
+
798  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
799  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
800  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
801  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
802  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
803  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
804  int16_t setCad();
+
805  uint8_t getPacketType();
+
806  int16_t setRfFrequency(uint32_t frf);
+
807  int16_t setTxParams(uint8_t pwr, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
+
808  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
809  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
+
810  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncLen, uint8_t syncMatch, uint8_t crcLen, uint8_t whiten, uint8_t payLen = 0xFF, uint8_t hdrType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
+
811  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTest, uint8_t whiten);
+
812  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t hdrType, uint8_t payLen, uint8_t crc, uint8_t invIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
+
813  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
+
814  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
+
815  int16_t setRangingRole(uint8_t role);
+
816  int16_t setPacketType(uint8_t type);
+
817 
+
818  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
819 
+
820 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
821  private:
+
822 #endif
+
823 
+
824  // common low-level SPI interface
+
825  static int16_t SPIparseStatus(uint8_t in);
+
826 
+
827 #if !defined(RADIOLIB_GODMODE)
+
828  private:
+
829 #endif
+
830  // common parameters
+
831  uint8_t power = 0;
+
832 
+
833  // cached LoRa parameters
+
834  uint8_t invertIQEnabled = RADIOLIB_SX128X_LORA_IQ_STANDARD;
+
835 
+
836  // cached GFSK parameters
+
837  float modIndexReal = 0;
+
838  uint16_t bitRateKbps = 0;
+
839  uint8_t bitRate = 0, modIndex = 0, shaping = 0;
+
840  uint8_t preambleLengthGFSK = 0, syncWordLen = 0, syncWordMatch = 0, crcGFSK = 0, whitening = 0;
+
841 
+
842  // cached FLRC parameters
+
843  uint8_t codingRateFLRC = 0;
+
844 
+
845  // cached BLE parameters
+
846  uint8_t connectionState = 0, crcBLE = 0, bleTestPayload = 0;
+
847 
+
848  int16_t config(uint8_t modem);
+
849 };
+
850 
+
851 #endif
+
852 
+
853 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html index e63f6a25..908a62ec 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -691,78 +691,78 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
701 
710  int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
711 
-
719  int16_t readData(uint8_t* data, size_t len) override;
-
720 
-
721  // configuration methods
-
722 
-
728  int16_t setBitRate(float br);
-
729 
-
735  int16_t setFrequencyDeviation(float freqDev) override;
-
736 
-
742  int16_t setRxBandwidth(float rxBw);
-
743 
-
749  int16_t setSyncWord(uint8_t* syncWord, size_t len);
-
750 
-
756  int16_t setPreambleLength(uint8_t preambleLen);
-
757 
-
763  size_t getPacketLength(bool update = true) override;
-
764 
-
771  int16_t setEncoding(uint8_t encoding) override;
-
772 
-
779  int16_t setDataShaping(uint8_t sh) override;
-
780 
-
782  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
783 
-
785  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
786 
-
791  uint8_t randomByte();
-
792 
-
797  int16_t getChipVersion();
-
798 
-
799  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
-
804  void setDirectAction(void (*func)(void));
-
805 
-
810  void readBit(uint32_t pin);
-
811  #endif
-
812 
-
818  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SI443X_MAX_PACKET_LENGTH);
-
819 
-
825  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SI443X_MAX_PACKET_LENGTH);
-
826 
-
827 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
828  protected:
-
829 #endif
-
830  Module* mod;
-
831 
-
832 #if !defined(RADIOLIB_GODMODE)
-
833  protected:
-
834 #endif
-
835 
-
836  float bitRate = 0;
-
837  float frequencyDev = 0;
-
838  float frequency = 0;
-
839 
-
840  size_t packetLength = 0;
-
841  bool packetLengthQueried = false;
-
842  uint8_t packetLengthConfig = RADIOLIB_SI443X_FIXED_PACKET_LENGTH_ON;
-
843 
-
844  int16_t setFrequencyRaw(float newFreq);
-
845  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
846 
-
847 #if !defined(RADIOLIB_GODMODE)
-
848  private:
-
849 #endif
-
850  bool findChip();
-
851  void clearIRQFlags();
-
852  void clearFIFO(size_t count);
-
853  int16_t config();
-
854  int16_t updateClockRecovery();
-
855  int16_t directMode();
-
856 };
-
857 
-
858 #endif
-
859 
-
860 #endif
+
720  int16_t readData(uint8_t* data, size_t len) override;
+
721 
+
722  // configuration methods
+
723 
+
729  int16_t setBitRate(float br);
+
730 
+
736  int16_t setFrequencyDeviation(float freqDev) override;
+
737 
+
743  int16_t setRxBandwidth(float rxBw);
+
744 
+
750  int16_t setSyncWord(uint8_t* syncWord, size_t len);
+
751 
+
757  int16_t setPreambleLength(uint8_t preambleLen);
+
758 
+
764  size_t getPacketLength(bool update = true) override;
+
765 
+
772  int16_t setEncoding(uint8_t encoding) override;
+
773 
+
780  int16_t setDataShaping(uint8_t sh) override;
+
781 
+
783  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
784 
+
786  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
787 
+
792  uint8_t randomByte();
+
793 
+
798  int16_t getChipVersion();
+
799 
+
800  #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
+
805  void setDirectAction(void (*func)(void));
+
806 
+
811  void readBit(uint32_t pin);
+
812  #endif
+
813 
+
819  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SI443X_MAX_PACKET_LENGTH);
+
820 
+
826  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SI443X_MAX_PACKET_LENGTH);
+
827 
+
828 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
829  protected:
+
830 #endif
+
831  Module* mod;
+
832 
+
833 #if !defined(RADIOLIB_GODMODE)
+
834  protected:
+
835 #endif
+
836 
+
837  float bitRate = 0;
+
838  float frequencyDev = 0;
+
839  float frequency = 0;
+
840 
+
841  size_t packetLength = 0;
+
842  bool packetLengthQueried = false;
+
843  uint8_t packetLengthConfig = RADIOLIB_SI443X_FIXED_PACKET_LENGTH_ON;
+
844 
+
845  int16_t setFrequencyRaw(float newFreq);
+
846  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
847 
+
848 #if !defined(RADIOLIB_GODMODE)
+
849  private:
+
850 #endif
+
851  bool findChip();
+
852  void clearIRQFlags();
+
853  void clearFIFO(size_t count);
+
854  int16_t config();
+
855  int16_t updateClockRecovery();
+
856  int16_t directMode();
+
857 };
+
858 
+
859 #endif
+
860 
+
861 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
diff --git a/class_c_c1101.html b/class_c_c1101.html index 6d64eb1f..b20131b8 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -188,7 +188,7 @@ void  Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
  int16_t readData (uint8_t *data, size_t len) override - Reads data received after calling startReceive method. More...
+ Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
  int16_t setFrequency (float freq)  Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464.0 MHz and 779.0 to 928.0 MHz. More...
@@ -871,7 +871,7 @@ void  -

Reads data received after calling startReceive method.

+

Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index 54b19485..c105c1bb 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -222,7 +222,7 @@ void  - + diff --git a/class_r_f69.html b/class_r_f69.html index b0ca02df..10c1a2bd 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -215,7 +215,7 @@ void  - + @@ -1081,7 +1081,7 @@ void 
dataPointer to array to save the received binary data.
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz. More...
-

Reads data received after calling startReceive method.

+

Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/class_r_f_m95.html b/class_r_f_m95.html index 4064420b..5592005a 100644 --- a/class_r_f_m95.html +++ b/class_r_f_m95.html @@ -290,7 +290,7 @@ void  - + diff --git a/class_r_f_m96.html b/class_r_f_m96.html index 13be6a5a..5b590d14 100644 --- a/class_r_f_m96.html +++ b/class_r_f_m96.html @@ -289,7 +289,7 @@ void  - + diff --git a/class_r_f_m97.html b/class_r_f_m97.html index 555b5185..1a324e0d 100644 --- a/class_r_f_m97.html +++ b/class_r_f_m97.html @@ -297,7 +297,7 @@ void  - + diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index afeb8742..b417e45e 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -244,7 +244,7 @@ void  - + diff --git a/class_s_x1231.html b/class_s_x1231.html index 80b838aa..ec6704f9 100644 --- a/class_s_x1231.html +++ b/class_s_x1231.html @@ -222,7 +222,7 @@ void  - + diff --git a/class_s_x1261.html b/class_s_x1261.html index 9ab41a28..40f25626 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -213,7 +213,7 @@ void  - + diff --git a/class_s_x1262.html b/class_s_x1262.html index 553dd788..0bb835eb 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -211,7 +211,7 @@ void  - + diff --git a/class_s_x1268.html b/class_s_x1268.html index 22bde2f6..575d0e21 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -208,7 +208,7 @@ void  - + diff --git a/class_s_x126x.html b/class_s_x126x.html index 321c2fef..d2782ac9 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -194,7 +194,7 @@ void  - + @@ -1134,7 +1134,7 @@ bool 
dataPointer to array to save the received binary data.
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-

Reads data received after calling startReceive method.

+

Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/class_s_x1272.html b/class_s_x1272.html index c552b3e3..eff773c9 100644 --- a/class_s_x1272.html +++ b/class_s_x1272.html @@ -276,7 +276,7 @@ void  - + diff --git a/class_s_x1273.html b/class_s_x1273.html index 7fbc54de..b51739e4 100644 --- a/class_s_x1273.html +++ b/class_s_x1273.html @@ -286,7 +286,7 @@ void  - + diff --git a/class_s_x1276.html b/class_s_x1276.html index 56a14349..d6b8bc97 100644 --- a/class_s_x1276.html +++ b/class_s_x1276.html @@ -289,7 +289,7 @@ void  - + diff --git a/class_s_x1277.html b/class_s_x1277.html index dd863b52..2bb08796 100644 --- a/class_s_x1277.html +++ b/class_s_x1277.html @@ -295,7 +295,7 @@ void  - + diff --git a/class_s_x1278.html b/class_s_x1278.html index daf4dc51..06896696 100644 --- a/class_s_x1278.html +++ b/class_s_x1278.html @@ -281,7 +281,7 @@ void  - + diff --git a/class_s_x1279.html b/class_s_x1279.html index a2b5eb85..63d5aa1c 100644 --- a/class_s_x1279.html +++ b/class_s_x1279.html @@ -286,7 +286,7 @@ void  - + diff --git a/class_s_x127x.html b/class_s_x127x.html index d921c57e..6506fae1 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -222,7 +222,7 @@ void  - + @@ -1293,7 +1293,7 @@ void 
dataPointer to array to save the received binary data.
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t startChannelScan ()
 Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. More...
-

Reads data that was received after calling startReceive method. This method reads len characters.

+

Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/class_s_x1280.html b/class_s_x1280.html index ee3ef189..5c9164ed 100644 --- a/class_s_x1280.html +++ b/class_s_x1280.html @@ -208,7 +208,7 @@ void  - + diff --git a/class_s_x1281.html b/class_s_x1281.html index a6922731..d6dc8c45 100644 --- a/class_s_x1281.html +++ b/class_s_x1281.html @@ -195,7 +195,7 @@ void  - + diff --git a/class_s_x1282.html b/class_s_x1282.html index 7bbb3a09..ca33a8b3 100644 --- a/class_s_x1282.html +++ b/class_s_x1282.html @@ -212,7 +212,7 @@ void  - + diff --git a/class_s_x128x.html b/class_s_x128x.html index 754e36cf..280325b0 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -191,7 +191,7 @@ void  - + @@ -1048,7 +1048,7 @@ void 
dataPointer to array to save the received binary data.
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz. More...
 Reads the current IRQ status. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz. More...
-

Reads data received after calling startReceive method.

+

Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/class_si4430.html b/class_si4430.html index 17058cca..ccc0b9d2 100644 --- a/class_si4430.html +++ b/class_si4430.html @@ -205,7 +205,7 @@ void  - + diff --git a/class_si4431.html b/class_si4431.html index 60bfc988..72a18c81 100644 --- a/class_si4431.html +++ b/class_si4431.html @@ -202,7 +202,7 @@ void  - + diff --git a/class_si4432.html b/class_si4432.html index 92a7da40..91fc0b2f 100644 --- a/class_si4432.html +++ b/class_si4432.html @@ -193,7 +193,7 @@ void  - + diff --git a/class_si443x.html b/class_si443x.html index e0a32b9c..920dff2d 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -180,7 +180,7 @@ void  - + @@ -648,7 +648,7 @@ void 
dataPointer to array to save the received binary data.
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setBitRate (float br)
 Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setBitRate (float br)
 Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setBitRate (float br)
 Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. More...
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data that was received after calling startReceive method. This method reads len characters. More...
 Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setBitRate (float br)
 Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps. More...
-

Reads data that was received after calling startReceive method. This method reads len characters.

+

Reads data that was received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/classn_r_f24.html b/classn_r_f24.html index 4cfac686..24f9e796 100644 --- a/classn_r_f24.html +++ b/classn_r_f24.html @@ -170,7 +170,7 @@ void  - + @@ -588,7 +588,7 @@ void 
dataPointer to array to save the received binary data.
 Interrupt-driven receive method, implemented for compatibility with PhysicalLayer. More...
 
int16_t readData (uint8_t *data, size_t len) override
 Reads data received after calling startReceive method. More...
 Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! More...
 
int16_t setFrequency (float freq)
 Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz. More...
-

Reads data received after calling startReceive method.

+

Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData!

Parameters
diff --git a/n_r_f24_8h_source.html b/n_r_f24_8h_source.html index 8947b99f..be3e98f2 100644 --- a/n_r_f24_8h_source.html +++ b/n_r_f24_8h_source.html @@ -321,67 +321,67 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
323 
332  int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
333 
-
340  int16_t readData(uint8_t* data, size_t len) override;
-
341 
-
342  // configuration methods
-
343 
-
349  int16_t setFrequency(float freq);
-
350 
-
356  int16_t setBitRate(float br);
-
357 
-
363  int16_t setOutputPower(int8_t pwr);
-
364 
-
370  int16_t setAddressWidth(uint8_t addrWidth);
-
371 
-
378  int16_t setTransmitPipe(uint8_t* addr);
-
379 
-
388  int16_t setReceivePipe(uint8_t pipeNum, uint8_t* addr);
-
389 
-
397  int16_t setReceivePipe(uint8_t pipeNum, uint8_t addrByte);
-
398 
-
404  int16_t disablePipe(uint8_t pipeNum);
-
405 
-
411  int16_t getStatus(uint8_t mask = 0xFF);
-
412 
-
417  bool isCarrierDetected();
-
418 
-
424  int16_t setFrequencyDeviation(float freqDev) override;
-
425 
-
431  size_t getPacketLength(bool update = true) override;
-
432 
-
438  int16_t setCrcFiltering(bool crcOn = true);
-
439 
-
445  int16_t setAutoAck(bool autoAckOn = true);
-
446 
-
453  int16_t setAutoAck(uint8_t pipeNum, bool autoAckOn);
-
454 
-
460  int16_t setDataShaping(uint8_t sh) override;
-
461 
-
467  int16_t setEncoding(uint8_t encoding) override;
-
468 
-
469 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
470  protected:
-
471 #endif
-
472  Module* mod;
-
473 
-
474  void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
-
475  void SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);
-
476  void SPItransfer(uint8_t cmd, bool write = false, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
-
477 
-
478 #if !defined(RADIOLIB_GODMODE)
-
479  protected:
-
480 #endif
-
481 
-
482  int16_t frequency = RADIOLIB_NRF24_DEFAULT_FREQ;
-
483  int16_t dataRate = RADIOLIB_NRF24_DEFAULT_DR;
-
484  int8_t power = RADIOLIB_NRF24_DEFAULT_POWER;
-
485  uint8_t addressWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;
-
486 
-
487  int16_t config();
-
488  void clearIRQ();
-
489 };
-
490 
-
491 #endif
+
341  int16_t readData(uint8_t* data, size_t len) override;
+
342 
+
343  // configuration methods
+
344 
+
350  int16_t setFrequency(float freq);
+
351 
+
357  int16_t setBitRate(float br);
+
358 
+
364  int16_t setOutputPower(int8_t pwr);
+
365 
+
371  int16_t setAddressWidth(uint8_t addrWidth);
+
372 
+
379  int16_t setTransmitPipe(uint8_t* addr);
+
380 
+
389  int16_t setReceivePipe(uint8_t pipeNum, uint8_t* addr);
+
390 
+
398  int16_t setReceivePipe(uint8_t pipeNum, uint8_t addrByte);
+
399 
+
405  int16_t disablePipe(uint8_t pipeNum);
+
406 
+
412  int16_t getStatus(uint8_t mask = 0xFF);
+
413 
+
418  bool isCarrierDetected();
+
419 
+
425  int16_t setFrequencyDeviation(float freqDev) override;
+
426 
+
432  size_t getPacketLength(bool update = true) override;
+
433 
+
439  int16_t setCrcFiltering(bool crcOn = true);
+
440 
+
446  int16_t setAutoAck(bool autoAckOn = true);
+
447 
+
454  int16_t setAutoAck(uint8_t pipeNum, bool autoAckOn);
+
455 
+
461  int16_t setDataShaping(uint8_t sh) override;
+
462 
+
468  int16_t setEncoding(uint8_t encoding) override;
+
469 
+
470 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
471  protected:
+
472 #endif
+
473  Module* mod;
+
474 
+
475  void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
+
476  void SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);
+
477  void SPItransfer(uint8_t cmd, bool write = false, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
+
478 
+
479 #if !defined(RADIOLIB_GODMODE)
+
480  protected:
+
481 #endif
+
482 
+
483  int16_t frequency = RADIOLIB_NRF24_DEFAULT_FREQ;
+
484  int16_t dataRate = RADIOLIB_NRF24_DEFAULT_DR;
+
485  int8_t power = RADIOLIB_NRF24_DEFAULT_POWER;
+
486  uint8_t addressWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;
+
487 
+
488  int16_t config();
+
489  void clearIRQ();
+
490 };
+
491 
+
492 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
dataPointer to array to save the received binary data.