From fbc896d2ae7c9c76d5cb1120f747e40c48012c8e Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 28 Jan 2022 17:53:05 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=206acf8?= =?UTF-8?q?feacce5b1e91d3f0a14a134145cfc332ce4=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 | 110 ++++++++++++++++++++-------------------- _s_x127x_8h_source.html | 2 +- class_c_c1101.html | 4 +- class_r_f_m95.html | 2 +- class_r_f_m96.html | 2 +- class_r_f_m97.html | 2 +- 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 +- 13 files changed, 69 insertions(+), 69 deletions(-) diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index a101c44b..8613d174 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -677,60 +677,60 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
860 
869  int16_t setDataShaping(uint8_t sh) override;
870 
-
878  int16_t setEncoding(uint8_t encoding) override;
-
879 
-
888  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
889 
-
895  uint8_t randomByte();
-
896 
-
902  int16_t getChipVersion();
-
903 
-
909  void setDirectAction(void (*func)(void));
-
910 
-
916  void readBit(RADIOLIB_PIN_TYPE pin);
-
917 
-
918  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
919  protected:
-
920  #endif
-
921  Module* _mod;
-
922 
-
923  // SPI read overrides to set bit for burst write and status registers access
-
924  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
-
925  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
-
926  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
-
927  uint8_t SPIreadRegister(uint8_t reg);
-
928  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
-
929  void SPIwriteRegister(uint8_t reg, uint8_t data);
-
930 
-
931  void SPIsendCommand(uint8_t cmd);
-
932 
-
933  #if !defined(RADIOLIB_GODMODE)
-
934  protected:
-
935  #endif
-
936 
-
937  float _freq = 0;
-
938  float _br = 0;
-
939  uint8_t _rawRSSI = 0;
-
940  uint8_t _rawLQI = 0;
-
941  uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
-
942 
-
943  size_t _packetLength = 0;
-
944  bool _packetLengthQueried = false;
-
945  uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
-
946 
-
947  bool _promiscuous = false;
-
948  bool _crcOn = true;
-
949 
-
950  uint8_t _syncWordLength = 2;
-
951  int8_t _power = 0;
-
952 
-
953  int16_t config();
-
954  int16_t directMode();
-
955  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
-
956  int16_t setPacketMode(uint8_t mode, uint16_t len);
-
957 };
-
958 
-
959 #endif
+
879  int16_t setEncoding(uint8_t encoding) override;
+
880 
+
889  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
890 
+
896  uint8_t randomByte();
+
897 
+
903  int16_t getChipVersion();
+
904 
+
910  void setDirectAction(void (*func)(void));
+
911 
+
917  void readBit(RADIOLIB_PIN_TYPE pin);
+
918 
+
919  #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
920  protected:
+
921  #endif
+
922  Module* _mod;
+
923 
+
924  // SPI read overrides to set bit for burst write and status registers access
+
925  int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
926  int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
+
927  void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
+
928  uint8_t SPIreadRegister(uint8_t reg);
+
929  void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data, size_t len);
+
930  void SPIwriteRegister(uint8_t reg, uint8_t data);
+
931 
+
932  void SPIsendCommand(uint8_t cmd);
+
933 
+
934  #if !defined(RADIOLIB_GODMODE)
+
935  protected:
+
936  #endif
+
937 
+
938  float _freq = 0;
+
939  float _br = 0;
+
940  uint8_t _rawRSSI = 0;
+
941  uint8_t _rawLQI = 0;
+
942  uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
+
943 
+
944  size_t _packetLength = 0;
+
945  bool _packetLengthQueried = false;
+
946  uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
+
947 
+
948  bool _promiscuous = false;
+
949  bool _crcOn = true;
+
950 
+
951  uint8_t _syncWordLength = 2;
+
952  int8_t _power = 0;
+
953 
+
954  int16_t config();
+
955  int16_t directMode();
+
956  static void getExpMant(float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
+
957  int16_t setPacketMode(uint8_t mode, uint16_t len);
+
958 };
+
959 
+
960 #endif
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
@@ -744,7 +744,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
CC1101::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:866
CC1101::transmit
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: CC1101.cpp:102
CC1101::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition: CC1101.cpp:507
-
CC1101::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.
Definition: CC1101.cpp:814
+
CC1101::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition: CC1101.cpp:814
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
CC1101::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: CC1101.cpp:336
CC1101::setGdo2Action
void setGdo2Action(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)
Sets interrupt service routine to call when GDO2 activates.
Definition: CC1101.cpp:226
diff --git a/_s_x127x_8h_source.html b/_s_x127x_8h_source.html index 6b8b4426..c5424e17 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -855,7 +855,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
SX127x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX127x.cpp:1124
SX127x::standby
int16_t standby() override
Sets the LoRa module to standby.
Definition: SX127x.cpp:287
SX127x
Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...
Definition: SX127x.h:547
-
SX127x::getSNR
float getSNR()
Gets signal-to-noise ratio of the latest received packet.
Definition: SX127x.cpp:729
+
SX127x::getSNR
float getSNR()
Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
Definition: SX127x.cpp:729
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:631
diff --git a/class_c_c1101.html b/class_c_c1101.html index 30c31313..dc4d2bdf 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -224,7 +224,7 @@ void  Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADIOLIB_SHAPING_0_5. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
  int16_t setEncoding (uint8_t encoding) override - Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING. More...
+ Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER, and RADIOLIB_ENCODING_WHITENING. Note that encoding on CC1101 is applied to the entire stream including preamble, sync word, and CRC. More...
  void setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)  Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...
@@ -1085,7 +1085,7 @@ void  -

Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.

+

Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER, and RADIOLIB_ENCODING_WHITENING. Note that encoding on CC1101 is applied to the entire stream including preamble, sync word, and CRC.

Parameters
diff --git a/class_r_f_m95.html b/class_r_f_m95.html index d2d794e6..1c025466 100644 --- a/class_r_f_m95.html +++ b/class_r_f_m95.html @@ -256,7 +256,7 @@ void  - + diff --git a/class_r_f_m96.html b/class_r_f_m96.html index 0380c8fc..7ff4a224 100644 --- a/class_r_f_m96.html +++ b/class_r_f_m96.html @@ -255,7 +255,7 @@ void  - + diff --git a/class_r_f_m97.html b/class_r_f_m97.html index 1607478a..1e31f84f 100644 --- a/class_r_f_m97.html +++ b/class_r_f_m97.html @@ -263,7 +263,7 @@ void  - + diff --git a/class_s_x1272.html b/class_s_x1272.html index 3f3a46cf..a7cc43f5 100644 --- a/class_s_x1272.html +++ b/class_s_x1272.html @@ -242,7 +242,7 @@ void  - + diff --git a/class_s_x1273.html b/class_s_x1273.html index d2c563eb..da8ebf96 100644 --- a/class_s_x1273.html +++ b/class_s_x1273.html @@ -252,7 +252,7 @@ void  - + diff --git a/class_s_x1276.html b/class_s_x1276.html index ef6f8c04..3ee6c61b 100644 --- a/class_s_x1276.html +++ b/class_s_x1276.html @@ -255,7 +255,7 @@ void  - + diff --git a/class_s_x1277.html b/class_s_x1277.html index 7b2b325d..f48ea3c8 100644 --- a/class_s_x1277.html +++ b/class_s_x1277.html @@ -258,7 +258,7 @@ void  - + diff --git a/class_s_x1278.html b/class_s_x1278.html index 5d9e4bf6..60db5034 100644 --- a/class_s_x1278.html +++ b/class_s_x1278.html @@ -247,7 +247,7 @@ void  - + diff --git a/class_s_x1279.html b/class_s_x1279.html index d4389d7a..118c55f0 100644 --- a/class_s_x1279.html +++ b/class_s_x1279.html @@ -255,7 +255,7 @@ void  - + diff --git a/class_s_x127x.html b/class_s_x127x.html index 2837620e..0011db2d 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -197,7 +197,7 @@ void  - + @@ -840,7 +840,7 @@ void 
encodingEncoding to be used.
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
 Gets current AFC error. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. More...
 
float getDataRate () const
 Get data rate of the latest transmitted packet. More...
-

Gets signal-to-noise ratio of the latest received packet.

+

Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.

Returns
Last packet signal-to-noise ratio (SNR).