From 5b8cceb3b24f89227ac8932cc496aee96f0f1c54 Mon Sep 17 00:00:00 2001 From: jgromes Date: Tue, 29 Mar 2022 20:01:32 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=2084dc4?= =?UTF-8?q?3d1e13688ff06dd844d9fd38e6511a2347d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _r_f69_8h_source.html | 234 +++++++++++++++++++------------------- class_physical_layer.html | 2 +- class_r_f69.html | 4 +- class_s_x1231.html | 2 +- 4 files changed, 121 insertions(+), 121 deletions(-) diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index 1bd33a53..bca5a075 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -606,150 +606,150 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
735 
743  size_t getPacketLength(bool update = true) override;
744 
-
752  int16_t setOOK(bool enableOOK);
-
753 
-
761  int16_t setOokThresholdType(uint8_t type);
-
762 
-
770  int16_t setOokFixedThreshold(uint8_t value);
-
771 
-
779  int16_t setOokPeakThresholdDecrement(uint8_t value);
-
780 
-
788  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
789 
-
797  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
-
798 
-
806  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
-
807 
-
813  int16_t disableSyncWordFiltering();
-
814 
-
820  int16_t enableContinuousModeBitSync();
-
821 
-
827  int16_t disableContinuousModeBitSync();
-
828 
-
836  int16_t setCrcFiltering(bool crcOn = true);
-
837 
-
845  int16_t setPromiscuousMode(bool promiscuous = true);
-
846 
-
855  int16_t setDataShaping(uint8_t sh) override;
-
856 
-
865  int16_t setEncoding(uint8_t encoding) override;
-
866 
-
874  int16_t setLnaTestBoost(bool value);
-
875 
-
881  float getRSSI();
-
882 
-
891  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
-
892 
-
898  uint8_t randomByte();
-
899 
-
905  int16_t getChipVersion();
-
906 
-
912  void setDirectAction(void (*func)(void));
-
913 
-
919  void readBit(RADIOLIB_PIN_TYPE pin);
-
920 
-
921 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
922  protected:
-
923 #endif
-
924  Module* _mod;
-
925 
-
926 #if !defined(RADIOLIB_GODMODE)
-
927  protected:
-
928 #endif
-
929 
-
930  float _freq = 0;
-
931  float _br = 0;
-
932  float _rxBw = 0;
-
933  bool _ook = false;
-
934  int16_t _tempOffset = 0;
-
935  int8_t _power = 0;
-
936 
-
937  size_t _packetLength = 0;
-
938  bool _packetLengthQueried = false;
-
939  uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
-
940 
-
941  bool _promiscuous = false;
-
942 
-
943  uint8_t _syncWordLength = 2;
-
944 
-
945  bool _bitSync = true;
-
946 
-
947  int16_t config();
-
948  int16_t directMode();
-
949  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
950 
-
951 #if !defined(RADIOLIB_GODMODE)
-
952  private:
-
953 #endif
-
954  int16_t setMode(uint8_t mode);
-
955  void clearIRQFlags();
-
956  void clearFIFO(size_t count);
-
957 };
-
958 
-
959 #endif
-
960 
-
961 #endif
+
753  int16_t setOOK(bool enableOOK);
+
754 
+
762  int16_t setOokThresholdType(uint8_t type);
+
763 
+
771  int16_t setOokFixedThreshold(uint8_t value);
+
772 
+
780  int16_t setOokPeakThresholdDecrement(uint8_t value);
+
781 
+
789  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
790 
+
798  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
+
799 
+
807  int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);
+
808 
+
814  int16_t disableSyncWordFiltering();
+
815 
+
821  int16_t enableContinuousModeBitSync();
+
822 
+
828  int16_t disableContinuousModeBitSync();
+
829 
+
837  int16_t setCrcFiltering(bool crcOn = true);
+
838 
+
846  int16_t setPromiscuousMode(bool promiscuous = true);
+
847 
+
856  int16_t setDataShaping(uint8_t sh) override;
+
857 
+
866  int16_t setEncoding(uint8_t encoding) override;
+
867 
+
875  int16_t setLnaTestBoost(bool value);
+
876 
+
882  float getRSSI();
+
883 
+
892  void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
+
893 
+
899  uint8_t randomByte();
+
900 
+
906  int16_t getChipVersion();
+
907 
+
913  void setDirectAction(void (*func)(void));
+
914 
+
920  void readBit(RADIOLIB_PIN_TYPE pin);
+
921 
+
922 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
923  protected:
+
924 #endif
+
925  Module* _mod;
+
926 
+
927 #if !defined(RADIOLIB_GODMODE)
+
928  protected:
+
929 #endif
+
930 
+
931  float _freq = 0;
+
932  float _br = 0;
+
933  float _rxBw = 0;
+
934  bool _ook = false;
+
935  int16_t _tempOffset = 0;
+
936  int8_t _power = 0;
+
937 
+
938  size_t _packetLength = 0;
+
939  bool _packetLengthQueried = false;
+
940  uint8_t _packetLengthConfig = RADIOLIB_RF69_PACKET_FORMAT_VARIABLE;
+
941 
+
942  bool _promiscuous = false;
+
943 
+
944  uint8_t _syncWordLength = 2;
+
945 
+
946  bool _bitSync = true;
+
947 
+
948  int16_t config();
+
949  int16_t directMode();
+
950  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
951 
+
952 #if !defined(RADIOLIB_GODMODE)
+
953  private:
+
954 #endif
+
955  int16_t setMode(uint8_t mode);
+
956  void clearIRQFlags();
+
957  void clearFIFO(size_t count);
+
958 };
+
959 
+
960 #endif
+
961 
+
962 #endif
-
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:690
+
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: RF69.cpp:694
void setDio0Action(void(*func)(void))
Sets interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:277
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:293
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
-
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:591
+
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: RF69.cpp:595
int16_t receiveDirect() override
Starts direct mode reception.
Definition: RF69.cpp:204
-
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: RF69.cpp:774
-
int16_t setOokFixedThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: RF69.cpp:407
+
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: RF69.cpp:778
+
int16_t setOokFixedThreshold(uint8_t value)
Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...
Definition: RF69.cpp:411
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method.
Definition: RF69.cpp:348
-
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:698
+
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: RF69.cpp:702
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: RF69.cpp:143
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition: RF69.cpp:281
-
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:634
+
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: RF69.cpp:638
Control class for RF69 module. Also serves as base class for SX1231.
Definition: RF69.h:440
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: RF69.cpp:285
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: RF69.cpp:249
-
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....
Definition: RF69.cpp:415
-
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:582
+
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....
Definition: RF69.cpp:419
+
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: RF69.cpp:586
int16_t enableAES()
Enables AES encryption.
Definition: RF69.cpp:241
-
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:571
-
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:681
+
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition: RF69.cpp:575
+
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition: RF69.cpp:685
int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16)
Initialization method.
Definition: RF69.cpp:12
void reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: RF69.cpp:106
-
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:651
+
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: RF69.cpp:655
int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition: RF69.cpp:114
-
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12....
Definition: RF69.cpp:458
+
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12....
Definition: RF69.cpp:462
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
-
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.
Definition: RF69.cpp:437
+
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.
Definition: RF69.cpp:441
int16_t disableAES()
Disables AES encryption.
Definition: RF69.cpp:245
RF69(Module *module)
Default constructor.
Definition: RF69.cpp:4
-
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:411
-
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition: RF69.cpp:724
-
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:672
-
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:778
-
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: RF69.cpp:385
+
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition: RF69.cpp:415
+
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition: RF69.cpp:728
+
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition: RF69.cpp:676
+
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: RF69.cpp:782
+
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again,...
Definition: RF69.cpp:385
int16_t standby() override
Sets the module to standby mode.
Definition: RF69.cpp:175
-
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:762
-
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:617
-
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:486
-
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:600
-
int16_t setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)
Sets sync word. Up to 8 bytes can be set as sync word.
Definition: RF69.cpp:548
-
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:801
-
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:660
-
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:770
-
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:647
+
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition: RF69.cpp:766
+
int16_t getTemperature()
Measures temperature.
Definition: RF69.cpp:621
+
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition: RF69.cpp:490
+
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: RF69.cpp:604
+
int16_t setSyncWord(uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)
Sets sync word. Up to 8 bytes can be set as sync word.
Definition: RF69.cpp:552
+
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: RF69.cpp:805
+
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition: RF69.cpp:664
+
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: RF69.cpp:774
+
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: RF69.cpp:651
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:744
+
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:748
void setAESKey(uint8_t *key)
Sets AES key.
Definition: RF69.cpp:237
-
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:797
+
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:801
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: RF69.cpp:183
-
int16_t setOutputPower(int8_t power, bool highPower=false)
Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to ...
Definition: RF69.cpp:510
+
int16_t setOutputPower(int8_t power, bool highPower=false)
Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to ...
Definition: RF69.cpp:514
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: RF69.cpp:233
-
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:613
-
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:400
+
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition: RF69.cpp:617
+
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition: RF69.cpp:404
int16_t sleep()
Sets the module to sleep mode.
Definition: RF69.cpp:167
-
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:805
-
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:655
+
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition: RF69.cpp:809
+
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition: RF69.cpp:659
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: RF69.cpp:300
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51
diff --git a/class_physical_layer.html b/class_physical_layer.html index 7dae2b4a..953a13c6 100644 --- a/class_physical_layer.html +++ b/class_physical_layer.html @@ -836,7 +836,7 @@ virtual Module
Returns
Status Codes
-

Implemented in SX127x, CC1101, SX126x, RF69, SX128x, Si443x, and nRF24.

+

Implemented in SX127x, CC1101, RF69, SX126x, SX128x, Si443x, and nRF24.

diff --git a/class_r_f69.html b/class_r_f69.html index 683ac1a8..334b2b93 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -214,7 +214,7 @@ void  Query modem for the packet length of received payload. More...
  int16_t setOOK (bool enableOOK) - Enables/disables OOK modulation instead of FSK. More...
+ Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled. More...
  int16_t setOokThresholdType (uint8_t type)  Selects the type of threshold in the OOK data slicer. More...
@@ -1440,7 +1440,7 @@ void  -

Enables/disables OOK modulation instead of FSK.

+

Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled.

Parameters
diff --git a/class_s_x1231.html b/class_s_x1231.html index 97fb8339..de9da140 100644 --- a/class_s_x1231.html +++ b/class_s_x1231.html @@ -221,7 +221,7 @@ void  - +
enableOOKEnable (true) or disable (false) OOK.
 Query modem for the packet length of received payload. More...
 
int16_t setOOK (bool enableOOK)
 Enables/disables OOK modulation instead of FSK. More...
 Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled. More...
 
int16_t setOokThresholdType (uint8_t type)
 Selects the type of threshold in the OOK data slicer. More...