RadioLib
Universal wireless communication library for Arduino
|
Control class for RF69 module. Also serves as base class for SX1231. More...
#include <RF69.h>
Public Member Functions | |
RF69 (Module *module) | |
Default constructor. More... | |
int16_t | begin (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16) |
Initialization method. More... | |
void | reset () |
Reset method. Will reset the chip to the default state using RST pin. | |
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 PhysicalLayer. More... | |
int16_t | receive (uint8_t *data, size_t len) override |
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalLayer. More... | |
int16_t | sleep () |
Sets the module to sleep mode. More... | |
int16_t | standby () override |
Sets the module to standby mode. More... | |
int16_t | transmitDirect (uint32_t frf=0) override |
Starts direct mode transmission. More... | |
int16_t | receiveDirect () override |
Starts direct mode reception. More... | |
int16_t | packetMode () |
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-based transmissions. | |
void | setAESKey (uint8_t *key) |
Sets AES key. More... | |
int16_t | enableAES () |
Enables AES encryption. More... | |
int16_t | disableAES () |
Disables AES encryption. More... | |
void | setDio0Action (void(*func)(void)) |
Sets interrupt service routine to call when DIO0 activates. More... | |
void | clearDio0Action () |
Clears interrupt service routine to call when DIO0 activates. | |
void | setDio1Action (void(*func)(void)) |
Sets interrupt service routine to call when DIO1 activates. More... | |
void | clearDio1Action () |
Clears interrupt service routine to call when DIO1 activates. | |
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 PhysicalLayer. More... | |
int16_t | startReceive () |
Interrupt-driven receive method. GDO0 will be activated when full packet is received. More... | |
int16_t | readData (uint8_t *data, size_t len) override |
Reads data received after calling startReceive method. 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... | |
int16_t | setBitRate (float br) |
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps. More... | |
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.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz. More... | |
int16_t | setFrequencyDeviation (float freqDev) override |
Sets frequency deviation. More... | |
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 20 dBm (RF69H/HC/HCW). More... | |
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. More... | |
int16_t | setPreambleLength (uint8_t preambleLen) |
Sets preamble length. More... | |
int16_t | setNodeAddress (uint8_t nodeAddr) |
Sets node address. Calling this method will also enable address filtering for node address only. More... | |
int16_t | setBroadcastAddress (uint8_t broadAddr) |
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. More... | |
int16_t | disableAddressFiltering () |
Disables address filtering. Calling this method will also erase previously set addresses. More... | |
void | setAmbientTemperature (int16_t tempAmbient) |
Sets ambient temperature. Required to correct values from on-board temperature sensor. More... | |
int16_t | getTemperature () |
Measures temperature. More... | |
size_t | getPacketLength (bool update=true) override |
Query modem for the packet length of received payload. More... | |
int16_t | setOOK (bool enableOOK) |
Enables/disables OOK modulation instead of FSK. More... | |
int16_t | setOokThresholdType (uint8_t type) |
Selects the type of threshold in the OOK data slicer. More... | |
int16_t | fixedPacketLengthMode (uint8_t len=RF69_MAX_PACKET_LENGTH) |
Set modem in fixed packet length mode. More... | |
int16_t | variablePacketLengthMode (uint8_t maxLen=RF69_MAX_PACKET_LENGTH) |
Set modem in variable packet length mode. More... | |
int16_t | enableSyncWordFiltering (uint8_t maxErrBits=0) |
Enable sync word filtering and generation. More... | |
int16_t | disableSyncWordFiltering () |
Disable preamble and sync word filtering and generation. More... | |
int16_t | setCrcFiltering (bool crcOn=true) |
Enable CRC filtering and generation. More... | |
int16_t | setPromiscuousMode (bool promiscuous=true) |
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC). More... | |
int16_t | setDataShaping (uint8_t sh) override |
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. 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, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More... | |
int16_t | setLnaTestBoost (bool value) |
Enable/disable LNA Boost mode (disabled by default). More... | |
float | getRSSI () |
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. 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... | |
uint8_t | random () |
Get one truly random byte from RSSI noise. More... | |
int16_t | getChipVersion () |
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working. More... | |
int16_t | transmit (__FlashStringHelper *fstr, uint8_t addr=0) |
Arduino Flash String transmit method. More... | |
int16_t | transmit (String &str, uint8_t addr=0) |
Arduino String transmit method. More... | |
int16_t | transmit (const char *str, uint8_t addr=0) |
C-string transmit method. More... | |
virtual int16_t | transmit (uint8_t *data, size_t len, uint8_t addr=0)=0 |
Binary transmit method. Must be implemented in module class. More... | |
int16_t | receive (String &str, size_t len=0) |
Arduino String receive method. More... | |
virtual int16_t | receive (uint8_t *data, size_t len)=0 |
Binary receive method. Must be implemented in module class. More... | |
int16_t | startTransmit (String &str, uint8_t addr=0) |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More... | |
int16_t | startTransmit (const char *str, uint8_t addr=0) |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More... | |
virtual int16_t | startTransmit (uint8_t *data, size_t len, uint8_t addr=0)=0 |
Interrupt-driven binary transmit method. More... | |
int16_t | readData (String &str, size_t len=0) |
Reads data that was received after calling startReceive method. More... | |
virtual int16_t | readData (uint8_t *data, size_t len)=0 |
Reads data that was received after calling startReceive method. More... | |
![]() | |
PhysicalLayer (float freqStep, size_t maxPacketLength) | |
Default constructor. More... | |
int16_t | transmit (__FlashStringHelper *fstr, uint8_t addr=0) |
Arduino Flash String transmit method. More... | |
int16_t | transmit (String &str, uint8_t addr=0) |
Arduino String transmit method. More... | |
int16_t | transmit (const char *str, uint8_t addr=0) |
C-string transmit method. More... | |
int16_t | receive (String &str, size_t len=0) |
Arduino String receive method. More... | |
int16_t | startTransmit (String &str, uint8_t addr=0) |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More... | |
int16_t | startTransmit (const char *str, uint8_t addr=0) |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More... | |
int16_t | readData (String &str, size_t len=0) |
Reads data that was received after calling startReceive method. More... | |
float | getFreqStep () const |
Gets the module frequency step size that was set in constructor. More... | |
int32_t | random (int32_t max) |
Get truly random number in range 0 - max. More... | |
int32_t | random (int32_t min, int32_t max) |
Get truly random number in range min - max. More... | |
int16_t | startDirect () |
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. More... | |
int16_t | setDirectSyncWord (uint32_t syncWord, uint8_t len) |
Set sync word to be used to determine start of packet in direct reception mode. More... | |
virtual void | setDirectAction (void(*func)(void))=0 |
Set interrupt service routine function to call when data bit is receveid in direct mode. Must be implemented in module class. More... | |
virtual void | readBit (uint8_t pin)=0 |
Function to read and process data bit in direct reception mode. Must be implemented in module class. More... | |
int16_t | available () |
Get the number of direct mode bytes currently available in buffer. More... | |
uint8_t | read () |
Get data from direct mode buffer. More... | |
Control class for RF69 module. Also serves as base class for SX1231.
RF69::RF69 | ( | Module * | module | ) |
Default constructor.
mod | Instance of Module that will be used to communicate with the radio. |
int16_t RF69::begin | ( | float | freq = 434.0 , |
float | br = 48.0 , |
||
float | freqDev = 50.0 , |
||
float | rxBw = 125.0 , |
||
int8_t | power = 10 , |
||
uint8_t | preambleLen = 16 |
||
) |
Initialization method.
freq | Carrier frequency in MHz. Defaults to 434.0 MHz. |
br | Bit rate to be used in kbps. Defaults to 48.0 kbps. |
freqDev | Frequency deviation from carrier frequency in kHz Defaults to 50.0 kHz. |
rxBw | Receiver bandwidth in kHz. Defaults to 125.0 kHz. |
power | Output power in dBm. Defaults to 10 dBm. |
preambleLen | Preamble Length in bits. Defaults to 16 bits. |
int16_t RF69::disableAddressFiltering | ( | ) |
Disables address filtering. Calling this method will also erase previously set addresses.
int16_t RF69::disableAES | ( | ) |
Disables AES encryption.
int16_t RF69::disableSyncWordFiltering | ( | ) |
Disable preamble and sync word filtering and generation.
int16_t RF69::enableAES | ( | ) |
Enables AES encryption.
int16_t RF69::enableSyncWordFiltering | ( | uint8_t | maxErrBits = 0 | ) |
Enable sync word filtering and generation.
numBits | Sync word length in bits. |
int16_t RF69::fixedPacketLengthMode | ( | uint8_t | len = RF69_MAX_PACKET_LENGTH | ) |
int16_t RF69::getChipVersion | ( | ) |
Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.
|
overridevirtual |
Query modem for the packet length of received payload.
update | Update received packet length. Will return cached value when set to false. |
Implements PhysicalLayer.
float RF69::getRSSI | ( | ) |
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
int16_t RF69::getTemperature | ( | ) |
Measures temperature.
|
virtual |
int16_t PhysicalLayer::readData |
Reads data that was received after calling startReceive method.
str | Address of Arduino String to save the received data. |
len | Expected number of characters in the message. |
|
overridevirtual |
Reads data received after calling startReceive method.
data | Pointer to array to save the received binary data. |
len | Number of bytes that will be received. Must be known in advance for binary transmissions. |
Implements PhysicalLayer.
virtual int16_t PhysicalLayer::readData |
Reads data that was received after calling startReceive method.
data | Pointer to array to save the received binary data. |
len | Number of bytes that will be received. Must be known in advance for binary transmissions. |
int16_t PhysicalLayer::receive |
Arduino String receive method.
str | Address of Arduino String to save the received data. |
len | Expected number of characters in the message. Leave as 0 if expecting a unknown size packet |
|
overridevirtual |
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalLayer.
data | Binary data to be sent. |
len | Number of bytes to send. |
Implements PhysicalLayer.
virtual int16_t PhysicalLayer::receive |
Binary receive method. Must be implemented in module class.
data | Pointer to array to save the received binary data. |
len | Number of bytes that will be received. Must be known in advance for binary transmissions. |
|
overridevirtual |
void RF69::setAESKey | ( | uint8_t * | key | ) |
Sets AES key.
Key | to be used for AES encryption. Must be exactly 16 bytes long. |
void RF69::setAmbientTemperature | ( | int16_t | tempAmbient | ) |
Sets ambient temperature. Required to correct values from on-board temperature sensor.
tempAmbient | Ambient temperature in degrees Celsius. |
int16_t RF69::setBitRate | ( | float | br | ) |
Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.
br | Bit rate to be set in kbps. |
int16_t RF69::setBroadcastAddress | ( | uint8_t | broadAddr | ) |
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address.
broadAddr | Node address to be set. |
int16_t RF69::setCrcFiltering | ( | bool | crcOn = true | ) |
Enable CRC filtering and generation.
crcOn | Set or unset CRC filtering. |
|
overridevirtual |
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.
sh | Gaussian shaping bandwidth-time product that will be used for data shaping |
Implements PhysicalLayer.
void RF69::setDio0Action | ( | void(*)(void) | func | ) |
Sets interrupt service routine to call when DIO0 activates.
func | ISR to call. |
void RF69::setDio1Action | ( | void(*)(void) | func | ) |
Sets interrupt service routine to call when DIO1 activates.
func | ISR to call. |
|
overridevirtual |
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING.
encoding | Encoding to be used. |
Implements PhysicalLayer.
int16_t RF69::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.
freq | Carrier frequency to be set in MHz. |
|
overridevirtual |
Sets frequency deviation.
freqDev | Frequency deviation to be set in kHz. |
Implements PhysicalLayer.
int16_t RF69::setLnaTestBoost | ( | bool | value | ) |
Enable/disable LNA Boost mode (disabled by default).
value | True to enable, false to disable. |
int16_t RF69::setNodeAddress | ( | uint8_t | nodeAddr | ) |
Sets node address. Calling this method will also enable address filtering for node address only.
nodeAddr | Node address to be set. |
int16_t RF69::setOOK | ( | bool | enableOOK | ) |
Enables/disables OOK modulation instead of FSK.
enableOOK | Enable (true) or disable (false) OOK. |
int16_t RF69::setOokThresholdType | ( | uint8_t | type | ) |
Selects the type of threshold in the OOK data slicer.
type | Threshold type: RF69_OOK_THRESH_PEAK(default), RF69_OOK_THRESH_FIXED or RF69_OOK_THRESH_AVERAGE |
int16_t RF69::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 20 dBm (RF69H/HC/HCW).
power | Output power to be set in dBm. |
highPower | Set to true when using modules high power port (RF69H/HC/HCW). Defaults to false (models without high power port - RF69C/CW). |
int16_t RF69::setPreambleLength | ( | uint8_t | preambleLen | ) |
Sets preamble length.
preambleLen | Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192. |
int16_t RF69::setPromiscuousMode | ( | bool | promiscuous = true | ) |
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC).
promiscuous | Set or unset promiscuous mode. |
void RF69::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!
rxEn | RX enable pin. |
txEn | TX enable pin. |
int16_t RF69::setRxBandwidth | ( | float | rxBw | ) |
Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz.
rxBw | Receiver bandwidth to be set in kHz. |
int16_t RF69::setSyncWord | ( | uint8_t * | syncWord, |
size_t | len, | ||
uint8_t | maxErrBits = 0 |
||
) |
Sets sync word. Up to 8 bytes can be set as sync word.
syncWord | Pointer to the array of sync word bytes. |
len | Sync word length in bytes. |
maxErrBits | Maximum allowed number of bit errors in received sync word. Defaults to 0. |
int16_t RF69::sleep | ( | ) |
Sets the module to sleep mode.
|
overridevirtual |
int16_t RF69::startReceive | ( | ) |
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
int16_t PhysicalLayer::startTransmit |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes.
str | C-string that will be transmitted. |
addr | Node address to transmit the packet to. Only used in FSK mode. |
int16_t PhysicalLayer::startTransmit |
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes.
str | Address of Arduino String that will be transmitted. |
addr | Node address to transmit the packet to. Only used in FSK mode. |
|
overridevirtual |
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer.
data | Binary data to be sent. |
len | Number of bytes to send. |
addr | Address to send the data to. Will only be added if address filtering was enabled. |
Implements PhysicalLayer.
virtual int16_t PhysicalLayer::startTransmit |
Interrupt-driven binary transmit method.
data | Binary data that will be transmitted. |
len | Length of binary data to transmit (in bytes). |
addr | Node address to transmit the packet to. Only used in FSK mode. |
int16_t PhysicalLayer::transmit |
Arduino Flash String transmit method.
str | Pointer to Arduino Flash String that will be transmitted. |
addr | Node address to transmit the packet to. Only used in FSK mode. |
int16_t PhysicalLayer::transmit |
C-string transmit method.
str | C-string that will be transmitted. |
addr | Node address to transmit the packet to. Only used in FSK mode. |
int16_t PhysicalLayer::transmit |
Arduino String transmit method.
str | Address of Arduino string that will be transmitted. |
addr | Node address to transmit the packet to. Only used in FSK mode. |
|
overridevirtual |
Blocking binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer.
data | Binary data to be sent. |
len | Number of bytes to send. |
addr | Address to send the data to. Will only be added if address filtering was enabled. |
Implements PhysicalLayer.
virtual int16_t PhysicalLayer::transmit |
Binary transmit method. Must be implemented in module class.
data | Binary data that will be transmitted. |
len | Length of binary data to transmit (in bytes). |
addr | Node address to transmit the packet to. Only used in FSK mode. |
|
overridevirtual |
Starts direct mode transmission.
frf | Raw RF frequency value. Defaults to 0, required for quick frequency shifts in RTTY. |
Implements PhysicalLayer.
int16_t RF69::variablePacketLengthMode | ( | uint8_t | maxLen = RF69_MAX_PACKET_LENGTH | ) |