RadioLib Universal wireless communication library for Arduino

Public Member Functions | List of all members
RFM96 Class Reference

Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges. More...

`#include <RFM96.h>`

Inheritance diagram for RFM96:

## Public Member Functions
| RFM96 (Module *mod)
| Default constructor. Called from Arduino sketch when creating new LoRa instance. More...
int16_t | begin (float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)
| LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the module. More...
int16_t | beginFSK (float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)
| FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the module. More...
int16_t | setFrequency (float freq)
| Sets carrier frequency. Allowed values range from 433.0 MHz to 470.0 MHz. More...
Public Member Functions inherited from SX1278
| SX1278 (Module *mod)
| Default constructor. Called from Arduino sketch when creating new LoRa instance. More...
int16_t | begin (float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)
| LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the module. More...
int16_t | beginFSK (float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)
| FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the module. More...
void | reset () override
| Reset method. Will reset the chip to the default state using RST pin.
int16_t | setFrequency (float freq)
| Sets carrier frequency. Allowed values range from 137.0 MHz to 525.0 MHz. More...
int16_t | setBandwidth (float bw)
| Sets LoRa link bandwidth. Allowed values are 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125, 250 and 500 kHz. Only available in LoRa mode. More...
int16_t | setSpreadingFactor (uint8_t sf)
| Sets LoRa link spreading factor. Allowed values range from 6 to 12. Only available in LoRa mode. More...
int16_t | setCodingRate (uint8_t cr)
| Sets LoRa link coding rate denominator. Allowed values range from 5 to 8. Only available in LoRa mode. More...
int16_t | setBitRate (float br) override
| Sets FSK bit rate. Allowed values range from 0.5 to 300 kbps. Only available in FSK mode. More...
int16_t | setOutputPower (int8_t power, bool useRfo=false)
| Sets transmission output power. Allowed values range from -3 to 15 dBm (RFO pin) or +2 to +17 dBm (PA_BOOST pin). High power +20 dBm operation is also supported, on the PA_BOOST pin. More...
int16_t | setGain (uint8_t gain)
| Sets gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain. Set to 0 to enable automatic gain control (recommended). More...
int16_t | setDataShaping (uint8_t sh) override
| Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. 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 | setDataShapingOOK (uint8_t sh)
| Sets filter cutoff frequency that will be used for data shaping. Allowed values are 1 for frequency equal to bit rate and 2 for frequency equal to 2x bit rate. Set to 0 to disable data shaping. Only available in FSK mode with OOK modulation. More...
float | getRSSI (bool packet=true, bool skipReceive=false)
| Gets recorded signal strength indicator. More...
int16_t | setCRC (bool enable, bool mode=false)
| Enables/disables CRC check of received packets. More...
int16_t | forceLDRO (bool enable)
| Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method, LDRO will always be set to the provided value, regardless of symbol length. To re-enable automatic LDRO configuration, call SX1278::autoLDRO() More...
int16_t | autoLDRO ()
| Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method, LDRO will be enabled automatically when symbol length exceeds 16 ms. More...
int16_t | implicitHeader (size_t len)
| Set implicit header mode for future reception/transmission. Required for spreading factor 6. More...
int16_t | explicitHeader ()
| Set explicit header mode for future reception/transmission. More...
Public Member Functions inherited from SX127x
| SX127x (Module *mod)
| Default constructor. Called internally when creating new LoRa instance. More...
Module * | getMod ()
int16_t | begin (uint8_t chipVersion, uint8_t syncWord, uint16_t preambleLength)
| Initialization method. Will be called with appropriate parameters when calling initialization method from derived class. More...
int16_t | beginFSK (uint8_t chipVersion, float freqDev, float rxBw, uint16_t preambleLength, bool enableOOK)
| Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK initialization method from derived class. More...
int16_t | transmit (uint8_t *data, size_t len, uint8_t addr=0) override
| Binary transmit method. Will transmit arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to transmit Arduino String or C-string, see PhysicalLayer::transmit. More...
int16_t | receive (uint8_t *data, size_t len) override
| Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see PhysicalLayer::receive. More...
int16_t | scanChannel ()
| Performs scan for valid LoRa preamble in the current channel. More...
int16_t | sleep ()
| Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...
int16_t | standby () override
| Sets the LoRa module to standby. More...
int16_t | standby (uint8_t mode) override
| Sets the LoRa module to standby. More...
int16_t | transmitDirect (uint32_t frf=0) override
| Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. More...
int16_t | receiveDirect () override
| Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. More...
int16_t | packetMode ()
| Disables direct mode and enables packet mode, allowing the module to receive packets. Can only be activated in FSK mode. More...
void | setDio0Action (void(*func)(void), uint32_t dir)
| Set interrupt service routine function to call when DIO0 activates. More...
void | clearDio0Action ()
| Clears interrupt service routine to call when DIO0 activates.
void | setDio1Action (void(*func)(void), uint32_t dir)
| Set interrupt service routine function to call when DIO1 activates. More...
void | clearDio1Action ()
| Clears interrupt service routine to call when DIO1 activates.
void | setFifoEmptyAction (void(*func)(void))
| Set interrupt service routine function to call when FIFO is empty. More...
void | clearFifoEmptyAction ()
| Clears interrupt service routine to call when FIFO is empty.
void | setFifoFullAction (void(*func)(void))
| Set interrupt service routine function to call when FIFO is full. More...
void | clearFifoFullAction ()
| Clears interrupt service routine to call when FIFO is full.
bool | fifoAdd (uint8_t *data, int totalLen, int *remLen)
| Set interrupt service routine function to call when FIFO is empty. More...
bool | fifoGet (volatile uint8_t *data, int totalLen, volatile int *rcvLen)
| Set interrupt service routine function to call when FIFO is sufficently full to read. More...
int16_t | startTransmit (uint8_t *data, size_t len, uint8_t addr=0) override
| Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. More...
int16_t | finishTransmit () override
| Clean up after transmission is done. More...
int16_t | startReceive (uint8_t len=0, uint8_t mode=RADIOLIB_SX127X_RXCONTINUOUS)
| Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
int16_t | startReceive (uint32_t mode, uint16_t irqFlags, uint16_t irqMask, size_t len)
| 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...
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...
int16_t | setSyncWord (uint8_t syncWord)
| Sets LoRa sync word. Only available in LoRa mode. More...
int16_t | setCurrentLimit (uint8_t currentLimit)
| Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45 to 120 mA in 5 mA steps and 120 to 240 mA in 10 mA steps. More...
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 FSK mode. More...
float | getFrequencyError (bool autoCorrect=false)
| Gets frequency error of the latest received packet. More...
float | getAFCError ()
| Gets current AFC error. More...
float | getSNR ()
| 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...
int16_t | setFrequencyDeviation (float freqDev) override
| Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and must be lower than 200 kHz. Only available in FSK mode. More...
int16_t | setRxBandwidth (float rxBw)
| Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode. More...
int16_t | setAFCBandwidth (float afcBw)
| Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode. More...
int16_t | setAFC (bool isEnabled)
| Enables or disables FSK automatic frequency correction(AFC) More...
int16_t | setAFCAGCTrigger (uint8_t trigger)
| Controls trigger of AFC and AGC. More...
int16_t | setSyncWord (uint8_t *syncWord, size_t len)
| Sets FSK sync word. Allowed sync words are up to 8 bytes long and can not contain null bytes. Only available in FSK mode. More...
int16_t | setNodeAddress (uint8_t nodeAddr)
| Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode. More...
int16_t | setBroadcastAddress (uint8_t broadAddr)
| Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK mode. More...
int16_t | disableAddressFiltering ()
| Disables FSK address filtering. 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 | setOokPeakThresholdDecrement (uint8_t value)
| Period of decrement of the RSSI threshold in the OOK demodulator. More...
int16_t | setOokFixedOrFloorThreshold (uint8_t value)
| Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Peak mode is used. More...
int16_t | setOokPeakThresholdStep (uint8_t value)
| Size of each decrement of the RSSI threshold in the OOK demodulator. More...
int16_t | enableBitSync ()
| Enable Bit synchronizer. More...
int16_t | disableBitSync ()
| Disable Bit synchronizer (not allowed in Packet mode). More...
size_t | getPacketLength (bool update=true) override
| Query modem for the packet length of received payload. More...
int16_t | fixedPacketLengthMode (uint8_t len=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
| Set modem in fixed packet length mode. Available in FSK mode only. More...
int16_t | variablePacketLengthMode (uint8_t maxLen=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
| Set modem in variable packet length mode. Available in FSK mode only. More...
uint32_t | getTimeOnAir (size_t len)
| Get expected time-on-air for a given size of payload. More...
int16_t | setCrcFiltering (bool crcOn=true)
| Enable CRC filtering and generation. More...
int16_t | setRSSIConfig (uint8_t smoothingSamples, int8_t offset=0)
| Sets RSSI measurement configuration in FSK mode. More...
int16_t | setEncoding (uint8_t encoding) override
| Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...
uint16_t | getIRQFlags ()
| Reads currently active IRQ flags, can be used to check which event caused an interrupt. In LoRa mode, this is the content of SX127X_REG_IRQ_FLAGS register. In FSK mode, this is the contents of SX127X_REG_IRQ_FLAGS_2 (MSB) and SX127X_REG_IRQ_FLAGS_1 (LSB) registers. More...
uint8_t | getModemStatus ()
| Reads modem status. Only available in LoRa mode. More...
int8_t | getTempRaw ()
| Reads uncalibrated temperature value. This function will change operating mode and should not be called during Tx, Rx or CAD. More...
void | setRfSwitchPins (uint32_t rxEn, uint32_t txEn)
| Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the `txEn` pin will be HIGH, during RX the `rxPin` will be HIGH. More...
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 those pins to automatically switch between various modes. More...
uint8_t | randomByte ()
| Get one truly random byte from RSSI noise. More...
int16_t | getChipVersion ()
| Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if SX127x is connected and working. More...
int16_t | invertIQ (bool invertIQ)
| Enable/disable inversion of the I and Q signals. More...
void | setDirectAction (void(*func)(void))
| Set interrupt service routine function to call when data bit is receveid in direct mode. More...
void | readBit (uint32_t pin)
| Function to read and process data bit in direct reception mode. More...
int16_t | setFHSSHoppingPeriod (uint8_t freqHoppingPeriod)
| Sets the hopping period and enables FHSS. More...
uint8_t | getFHSSHoppingPeriod (void)
| Gets FHSS hopping period. More...
uint8_t | getFHSSChannel (void)
| Gets the FHSS channel in use. More...
void | clearFHSSInt (void)
| Clear the FHSS interrupt.
int16_t | setDIOMapping (uint32_t pin, uint32_t value)
| Configure DIO pin mapping to get a given signal on a DIO pin (if available). More...
int16_t | setDIOPreambleDetect (bool usePreambleDetect)
| Configure DIO mapping to use RSSI or Preamble Detect for pins that support it. More...
float | getRSSI (bool packet, bool skipReceive, int16_t offset)
| Gets recorded signal strength indicator. More...
int16_t | setRSSIThreshold (float dbm)
| Sets the RSSI value above which the RSSI interrupt is signaled. 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)
| Binary transmit method. Must be implemented in module class. More...
virtual int16_t | receive (uint8_t *data, size_t len)
| Binary receive method. Must be implemented in module class. 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)
| Interrupt-driven binary transmit method. More...
virtual int16_t | readData (uint8_t *data, size_t len)
| Reads data that was received after calling startReceive method. More...
Public Member Functions inherited from PhysicalLayer
| PhysicalLayer (float step, size_t maxLen)
| Default constructor. More...
int16_t | transmit (const char *str, uint8_t addr=0)
| C-string transmit method. 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...
float | getFreqStep () const
| Gets the module frequency step size that was set in constructor. More...
virtual float | getRSSI ()
| Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. 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...
int16_t | available ()
| Get the number of direct mode bytes currently available in buffer. More...
void | dropSync ()
| Forcefully drop synchronization.
uint8_t | read (bool drop=true)
| Get data from direct mode buffer. More...
virtual void | setDio1Action (void(*func)(void))
| Sets interrupt service routine to call when DIO1 activates. More...

## Detailed Description

Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges.

## Constructor & Destructor Documentation

## ◆ RFM96()

RFM96::RFM96 | ( | Module * | mod | ) |

Default constructor. Called from Arduino sketch when creating new LoRa instance.

Parameters

  mod | Instance of Module that will be used to communicate with the LoRa chip.

## Member Function Documentation

## ◆ begin()

int16_t RFM96::begin | ( | float | freq = `434.0`,
|  | float | bw = `125.0`,
|  | uint8_t | sf = `9`,
|  | uint8_t | cr = `7`,
|  | uint8_t | syncWord = `RADIOLIB_SX127X_SYNC_WORD`,
|  | int8_t | power = `10`,
|  | uint16_t | preambleLength = `8`,
|  | uint8_t | gain = `0`
| ) |  |

LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the module.

Parameters

  freq | Carrier frequency in MHz. Allowed values range from 433.0 MHz to 470.0 MHz.
  bw | LoRa link bandwidth in kHz. Allowed values are 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125, 250 and 500 kHz.
  sf | LoRa link spreading factor. Allowed values range from 6 to 12.
  cr | LoRa link coding rate denominator. Allowed values range from 5 to 8.
  syncWord | LoRa sync word. Can be used to distinguish different networks. Note that value 0x34 is reserved for LoRaWAN networks.
  power | Transmission output power in dBm. Allowed values range from 2 to 17 dBm.
  preambleLength | Length of LoRa transmission preamble in symbols. The actual preamble length is 4.25 symbols longer than the set number. Allowed values range from 6 to 65535.
  gain | Gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain. Set to 0 to enable automatic gain control (recommended).

Returns
  Status Codes

## ◆ beginFSK()

int16_t RFM96::beginFSK | ( | float | freq = `434.0`,
|  | float | br = `4.8`,
|  | float | freqDev = `5.0`,
|  | float | rxBw = `125.0`,
|  | int8_t | power = `10`,
|  | uint16_t | preambleLength = `16`,
|  | bool | enableOOK = `false`
| ) |  |

FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the module.

Parameters

  freq | Carrier frequency in MHz. Allowed values range from 137.0 MHz to 525.0 MHz.
  br | Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 1.2 to 300.0 kbps.
  freqDev | Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.6 to 200.0 kHz. Note that the allowed range changes based on bit rate setting, so that the condition FreqDev + BitRate/2 <= 250 kHz is always met.
  rxBw | Receiver bandwidth in kHz. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25, 31.3, 41.7, 50, 62.5, 83.3, 100, 125, 166.7, 200 and 250 kHz.
  power | Transmission output power in dBm. Allowed values range from 2 to 17 dBm.
  preambleLength | Length of FSK preamble in bits.
  enableOOK | Use OOK modulation instead of FSK.

Returns
  Status Codes

## ◆ setFrequency()

int16_t RFM96::setFrequency | ( | float | freq | ) |
| virtual

Sets carrier frequency. Allowed values range from 433.0 MHz to 470.0 MHz.

Parameters

  freq | Carrier frequency to be set in MHz.

Returns
  Status Codes

Reimplemented from PhysicalLayer.

The documentation for this class was generated from the following files:

- src/modules/RFM9x/RFM96.h
- src/modules/RFM9x/RFM96.cpp