diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index 5b07dc2a..a3d2faf2 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -775,20 +775,18 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
1031
1032 bool promiscuous = false;
1033
-
1034 uint8_t syncWordLength = RADIOLIB_RF69_DEFAULT_SW_LEN;
+
1034 bool bitSync = true;
1035
-
1036 bool bitSync = true;
-
1037
-
1038 int16_t directMode();
-
1039 int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1040 void clearIRQFlags();
-
1041 void clearFIFO(size_t count);
-
1042};
+
1036 int16_t directMode();
+
1037 int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1038 void clearIRQFlags();
+
1039 void clearFIFO(size_t count);
+
1040};
+
1041
+
1042#endif
1043
1044#endif
-
1045
-
1046#endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this c...
Definition Module.h:82
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:216
@@ -797,13 +795,13 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition PhysicalLayer.cpp:155
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition PhysicalLayer.cpp:111
RF69
Control class for RF69 module. Also serves as base class for SX1231.
Definition RF69.h:479
-
RF69::getTemperature
int16_t getTemperature()
Measures temperature.
Definition RF69.cpp:773
-
RF69::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition RF69.cpp:998
+
RF69::getTemperature
int16_t getTemperature()
Measures temperature.
Definition RF69.cpp:769
+
RF69::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
Definition RF69.cpp:994
RF69::clearFifoEmptyAction
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition RF69.cpp:322
-
RF69::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition RF69.cpp:803
+
RF69::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition RF69.cpp:799
RF69::disableAES
int16_t disableAES()
Disables AES encryption.
Definition RF69.cpp:232
RF69::setFifoFullAction
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition RF69.cpp:330
-
RF69::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition RF69.cpp:747
+
RF69::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition RF69.cpp:743
RF69::enableAES
int16_t enableAES()
Enables AES encryption.
Definition RF69.cpp:228
RF69::standby
int16_t standby() override
Sets the module to standby mode.
Definition RF69.cpp:157
RF69::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition RF69.cpp:511
@@ -816,57 +814,57 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
RF69::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method. When the packet length is not known in advance...
Definition RF69.cpp:455
RF69::startReceive
int16_t startReceive() override
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition RF69.cpp:236
RF69::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition RF69.cpp:447
-
RF69::disableSyncWordFiltering
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition RF69.cpp:820
-
RF69::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition RF69.cpp:889
+
RF69::disableSyncWordFiltering
int16_t disableSyncWordFiltering()
Disable preamble and sync word filtering and generation.
Definition RF69.cpp:816
+
RF69::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RA...
Definition RF69.cpp:885
RF69::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition RF69.cpp:522
RF69::setOOK
int16_t setOOK(bool enable)
Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again,...
Definition RF69.cpp:492
-
RF69::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition RF69.cpp:756
-
RF69::readBit
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition RF69.cpp:977
+
RF69::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition RF69.cpp:752
+
RF69::readBit
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition RF69.cpp:973
RF69::begin
int16_t begin(float freq=RADIOLIB_RF69_DEFAULT_FREQ, float br=RADIOLIB_RF69_DEFAULT_BR, float freqDev=RADIOLIB_RF69_DEFAULT_FREQDEV, float rxBw=RADIOLIB_RF69_DEFAULT_RXBW, int8_t pwr=RADIOLIB_RF69_DEFAULT_POWER, uint8_t preambleLen=RADIOLIB_RF69_DEFAULT_PREAMBLELEN)
Initialization method.
Definition RF69.cpp:11
-
RF69::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition RF69.cpp:811
+
RF69::enableSyncWordFiltering
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0)
Enable sync word filtering and generation.
Definition RF69.cpp:807
RF69::packetMode
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition RF69.cpp:220
RF69::setOutputPower
int16_t setOutputPower(int8_t pwr, 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:659
-
RF69::setDIOMapping
int16_t setDIOMapping(uint32_t pin, uint32_t value) override
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition RF69.cpp:982
+
RF69::setDIOMapping
int16_t setDIOMapping(uint32_t pin, uint32_t value) override
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition RF69.cpp:978
RF69::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12....
Definition RF69.cpp:584
RF69::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition RF69.cpp:295
RF69::setFifoEmptyAction
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition RF69.cpp:311
-
RF69::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition RF69.cpp:726
-
RF69::enableContinuousModeBitSync
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition RF69.cpp:825
+
RF69::setPreambleLength
int16_t setPreambleLength(uint8_t preambleLen)
Sets preamble length.
Definition RF69.cpp:722
+
RF69::enableContinuousModeBitSync
int16_t enableContinuousModeBitSync()
Enable Bit synchronization in continuous mode.
Definition RF69.cpp:821
RF69::setFifoThreshold
void setFifoThreshold(uint8_t threshold)
Set FIFO threshold level. Be aware that threshold is also set in setFifoFullAction method....
Definition RF69.cpp:326
-
RF69::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition RF69.cpp:790
+
RF69::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition RF69.cpp:786
RF69::transmit
int16_t transmit(const 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:103
RF69::clearDio0Action
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition RF69.cpp:276
RF69::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition RF69.cpp:303
-
RF69::disableContinuousModeBitSync
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition RF69.cpp:834
-
RF69::setDirectAction
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition RF69.cpp:973
+
RF69::disableContinuousModeBitSync
int16_t disableContinuousModeBitSync()
Disable Bit synchronization in continuous mode.
Definition RF69.cpp:830
+
RF69::setDirectAction
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition RF69.cpp:969
RF69::setDio0Action
void setDio0Action(void(*func)(void))
Sets interrupt service routine to call when DIO0 activates.
Definition RF69.cpp:272
-
RF69::setLnaTestBoost
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition RF69.cpp:927
+
RF69::setLnaTestBoost
int16_t setLnaTestBoost(bool value)
Enable/disable LNA Boost mode (disabled by default).
Definition RF69.cpp:923
RF69::setBitRate
int16_t setBitRate(float br) override
Sets bit rate. Allowed values range from 0.5 to 300.0 kbps.
Definition RF69.cpp:562
RF69::fifoGet
bool fifoGet(volatile uint8_t *data, int totalLen, volatile int *rcvLen)
Set interrupt service routine function to call when FIFO is sufficiently full to read.
Definition RF69.cpp:367
RF69::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition RF69.cpp:280
RF69::setAESKey
void setAESKey(const uint8_t *key)
Sets AES key.
Definition RF69.cpp:224
RF69::setFrequency
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....
Definition RF69.cpp:526
-
RF69::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition RF69.cpp:909
+
RF69::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition RF69.cpp:905
RF69::fifoAdd
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition RF69.cpp:344
-
RF69::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition RF69.cpp:738
+
RF69::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition RF69.cpp:734
RF69::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception.
Definition RF69.cpp:191
-
RF69::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition RF69.cpp:843
-
RF69::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition RF69.cpp:945
-
RF69::setAmbientTemperature
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition RF69.cpp:769
-
RF69::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition RF69.cpp:953
+
RF69::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition RF69.cpp:839
+
RF69::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition RF69.cpp:941
+
RF69::setAmbientTemperature
void setAmbientTemperature(int16_t tempAmbient)
Sets ambient temperature. Required to correct values from on-board temperature sensor.
Definition RF69.cpp:765
+
RF69::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition RF69.cpp:949
RF69::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition RF69.cpp:307
RF69::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation.
Definition RF69.cpp:612
RF69::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition RF69.cpp:288
RF69::sleep
int16_t sleep() override
Sets the module to sleep mode.
Definition RF69.cpp:149
-
RF69::setPromiscuousMode
int16_t setPromiscuousMode(bool enable=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition RF69.cpp:851
+
RF69::setPromiscuousMode
int16_t setPromiscuousMode(bool enable=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition RF69.cpp:847
RF69::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition RF69.cpp:125
RF69::clearFifoFullAction
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition RF69.cpp:339
-
RF69::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition RF69.cpp:935
-
RF69::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition RF69.cpp:807
+
RF69::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition RF69.cpp:931
+
RF69::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition RF69.cpp:803
RF69::startTransmit
int16_t startTransmit(const 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:389
RF69::reset
void reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition RF69.cpp:95
-
RF69::setRSSIThreshold
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition RF69.cpp:939
-
RF69::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition RF69.cpp:949
+
RF69::setRSSIThreshold
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition RF69.cpp:935
+
RF69::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition RF69.cpp:945
Module::RfSwitchMode_t
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition Module.h:89