ClusterDuck Protocol
Public Member Functions | List of all members
RFM97 Class Reference

Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges. More...

#include <RFM97.h>

Inheritance diagram for RFM97:
RFM95 SX1278 SX127x PhysicalLayer

Public Member Functions

 RFM97 (Module *mod)
 Default constructor. Called from Arduino sketch when creating new LoRa instance. More...
 
int16_t setSpreadingFactor (uint8_t sf)
 Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode. More...
 
- Public Member Functions inherited from RFM95
 RFM95 (Module *mod)
 Default constructor. Called from Arduino sketch when creating new LoRa instance. More...
 
int16_t begin (float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=SX127X_SYNC_WORD, int8_t power=17, uint8_t currentLimit=100, 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 setFrequency (float freq)
 Sets carrier frequency. Allowed values range from 868.0 MHz to 915.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=SX127X_SYNC_WORD, int8_t power=17, uint8_t currentLimit=100, 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=48.0, float freqDev=50.0, float rxBw=125.0, int8_t power=13, uint8_t currentLimit=100, 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 ()
 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 setOutputPower (int8_t power)
 Sets transmission output power. Allowed values range from 2 to 17 dBm. 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). Only available in LoRa mode. More...
 
int16_t setDataShaping (float sh)
 Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are 0.3, 0.5 or 1.0. Set to 0 to disable data shaping. Only available in FSK mode with FSK modulation. 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 ()
 Gets recorded signal strength indicator of the latest received packet for LoRa modem, or current RSSI level for FSK modem. More...
 
int16_t setCRC (bool enableCRC)
 Enables/disables CRC check of received packets. More...
 
- Public Member Functions inherited from SX127x
 SX127x (Module *mod)
 Default constructor. Called internally when creating new LoRa instance. More...
 
int16_t begin (uint8_t chipVersion, uint8_t syncWord, uint8_t currentLimit, 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 br, float freqDev, float rxBw, uint8_t currentLimit, 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)
 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)
 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 ()
 Sets the LoRa module to standby. More...
 
int16_t transmitDirect (uint32_t FRF=0)
 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 ()
 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))
 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))
 Set interrupt service routine function 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)
 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 startReceive (uint8_t len=0, uint8_t mode=SX127X_RXCONTINUOUS)
 Interrupt-driven receive method. DIO0 will be activated when full valid packet is received. More...
 
int16_t readData (uint8_t *data, size_t len)
 Reads data that was received after calling startReceive method. This method reads len characters. 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 preamble length. Allowed values range from 6 to 65535. Only available in LoRa mode. More...
 
float getFrequencyError (bool autoCorrect=false)
 Gets frequency error of the latest received packet. More...
 
float getSNR ()
 Gets signal-to-noise ratio of the latest received packet. More...
 
float getDataRate ()
 Get data rate of the latest transmitted packet. More...
 
int16_t setBitRate (float br)
 Sets FSK bit rate. Allowed values range from 1.2 to 300 kbps. Only available in FSK mode. More...
 
int16_t setFrequencyDeviation (float freqDev)
 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 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...
 
size_t getPacketLength (bool update=true)
 Query modem for the packet length of received payload. More...
 
int16_t fixedPacketLengthMode (uint8_t len=SX127X_MAX_PACKET_LENGTH_FSK)
 Set modem in fixed packet length mode. Available in FSK mode only. More...
 
int16_t variablePacketLengthMode (uint8_t maxLen=SX127X_MAX_PACKET_LENGTH_FSK)
 Set modem in variable packet length mode. Available in FSK mode only. 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)
 Sets transmission encoding. Only available in FSK mode. More...
 
void regDump ()
 
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...
 
- Public Member Functions inherited from PhysicalLayer
 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 ()
 Gets the module frequency step size that was set in constructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SX1278
int16_t setBandwidthRaw (uint8_t newBandwidth)
 
int16_t setSpreadingFactorRaw (uint8_t newSpreadingFactor)
 
int16_t setCodingRateRaw (uint8_t newCodingRate)
 
int16_t configFSK ()
 
- Protected Member Functions inherited from SX127x
int16_t setFrequencyRaw (float newFreq)
 
int16_t config ()
 
int16_t configFSK ()
 
int16_t getActiveModem ()
 
int16_t directMode ()
 
int16_t setPacketMode (uint8_t mode, uint8_t len)
 
- Protected Attributes inherited from SX127x
Module_mod
 
float _freq
 
float _bw
 
uint8_t _sf
 
uint8_t _cr
 
float _br
 
float _rxBw
 
bool _ook
 

Detailed Description

Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges.

Constructor & Destructor Documentation

◆ RFM97()

RFM97::RFM97 ( Module mod)

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

Parameters
modInstance of Module that will be used to communicate with the LoRa chip.

Member Function Documentation

◆ setSpreadingFactor()

int16_t RFM97::setSpreadingFactor ( uint8_t  sf)

Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode.

Parameters
sfLoRa link spreading factor to be set.
Returns
Status Codes

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