RadioLib/_s_x127x_8h_source.html

#if !defined(_RADIOLIB_SX127X_H)

#define _RADIOLIB_SX127X_H


#include "../../TypeDef.h"


#if !RADIOLIB_EXCLUDE_SX127X


#include "../../Module.h"


#include "../../protocols/PhysicalLayer/PhysicalLayer.h"


// SX127x physical layer properties

#define RADIOLIB_SX127X_FREQUENCY_STEP_SIZE                     61.03515625

#define RADIOLIB_SX127X_MAX_PACKET_LENGTH                       255

#define RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK                   64 // as per datasheet Rev. 7, page 66, the FSK FIFO is just 64 bytes

#define RADIOLIB_SX127X_CRYSTAL_FREQ                            32.0f

#define RADIOLIB_SX127X_DIV_EXPONENT                            19


// SX127x series common LoRa registers

#define RADIOLIB_SX127X_REG_FIFO                                0x00

#define RADIOLIB_SX127X_REG_OP_MODE                             0x01

#define RADIOLIB_SX127X_REG_FRF_MSB                             0x06

#define RADIOLIB_SX127X_REG_FRF_MID                             0x07

#define RADIOLIB_SX127X_REG_FRF_LSB                             0x08

#define RADIOLIB_SX127X_REG_PA_CONFIG                           0x09

#define RADIOLIB_SX127X_REG_PA_RAMP                             0x0A

#define RADIOLIB_SX127X_REG_OCP                                 0x0B

#define RADIOLIB_SX127X_REG_LNA                                 0x0C

#define RADIOLIB_SX127X_REG_FIFO_ADDR_PTR                       0x0D

#define RADIOLIB_SX127X_REG_FIFO_TX_BASE_ADDR                   0x0E

#define RADIOLIB_SX127X_REG_FIFO_RX_BASE_ADDR                   0x0F

#define RADIOLIB_SX127X_REG_FIFO_RX_CURRENT_ADDR                0x10

#define RADIOLIB_SX127X_REG_IRQ_FLAGS_MASK                      0x11

#define RADIOLIB_SX127X_REG_IRQ_FLAGS                           0x12

#define RADIOLIB_SX127X_REG_RX_NB_BYTES                         0x13

#define RADIOLIB_SX127X_REG_RX_HEADER_CNT_VALUE_MSB             0x14

#define RADIOLIB_SX127X_REG_RX_HEADER_CNT_VALUE_LSB             0x15

#define RADIOLIB_SX127X_REG_RX_PACKET_CNT_VALUE_MSB             0x16

#define RADIOLIB_SX127X_REG_RX_PACKET_CNT_VALUE_LSB             0x17

#define RADIOLIB_SX127X_REG_MODEM_STAT                          0x18

#define RADIOLIB_SX127X_REG_PKT_SNR_VALUE                       0x19

#define RADIOLIB_SX127X_REG_PKT_RSSI_VALUE                      0x1A

#define RADIOLIB_SX127X_REG_RSSI_VALUE                          0x1B

#define RADIOLIB_SX127X_REG_HOP_CHANNEL                         0x1C

#define RADIOLIB_SX127X_REG_MODEM_CONFIG_1                      0x1D

#define RADIOLIB_SX127X_REG_MODEM_CONFIG_2                      0x1E

#define RADIOLIB_SX127X_REG_SYMB_TIMEOUT_LSB                    0x1F

#define RADIOLIB_SX127X_REG_PREAMBLE_MSB                        0x20

#define RADIOLIB_SX127X_REG_PREAMBLE_LSB                        0x21

#define RADIOLIB_SX127X_REG_PAYLOAD_LENGTH                      0x22

#define RADIOLIB_SX127X_REG_MAX_PAYLOAD_LENGTH                  0x23

#define RADIOLIB_SX127X_REG_HOP_PERIOD                          0x24

#define RADIOLIB_SX127X_REG_FIFO_RX_BYTE_ADDR                   0x25

#define RADIOLIB_SX127X_REG_FEI_MSB                             0x28

#define RADIOLIB_SX127X_REG_FEI_MID                             0x29

#define RADIOLIB_SX127X_REG_FEI_LSB                             0x2A

#define RADIOLIB_SX127X_REG_RSSI_WIDEBAND                       0x2C

#define RADIOLIB_SX127X_REG_DETECT_OPTIMIZE                     0x31

#define RADIOLIB_SX127X_REG_INVERT_IQ                           0x33

#define RADIOLIB_SX127X_REG_DETECTION_THRESHOLD                 0x37

#define RADIOLIB_SX127X_REG_SYNC_WORD                           0x39

#define RADIOLIB_SX127X_REG_INVERT_IQ2                          0x3B

#define RADIOLIB_SX127X_REG_DIO_MAPPING_1                       0x40

#define RADIOLIB_SX127X_REG_DIO_MAPPING_2                       0x41

#define RADIOLIB_SX127X_REG_VERSION                             0x42


// SX127x common LoRa modem settings

// RADIOLIB_SX127X_REG_OP_MODE                                                MSB   LSB   DESCRIPTION

#define RADIOLIB_SX127X_FSK_OOK                                 0b00000000  //  7     7   FSK/OOK mode

#define RADIOLIB_SX127X_LORA                                    0b10000000  //  7     7   LoRa mode

#define RADIOLIB_SX127X_ACCESS_SHARED_REG_OFF                   0b00000000  //  6     6   access LoRa registers (0x0D:0x3F) in LoRa mode

#define RADIOLIB_SX127X_ACCESS_SHARED_REG_ON                    0b01000000  //  6     6   access FSK registers (0x0D:0x3F) in LoRa mode

#define RADIOLIB_SX127X_SLEEP                                   0b00000000  //  2     0   sleep

#define RADIOLIB_SX127X_STANDBY                                 0b00000001  //  2     0   standby

#define RADIOLIB_SX127X_FSTX                                    0b00000010  //  2     0   frequency synthesis TX

#define RADIOLIB_SX127X_TX                                      0b00000011  //  2     0   transmit

#define RADIOLIB_SX127X_FSRX                                    0b00000100  //  2     0   frequency synthesis RX

#define RADIOLIB_SX127X_RXCONTINUOUS                            0b00000101  //  2     0   receive continuous

#define RADIOLIB_SX127X_RXSINGLE                                0b00000110  //  2     0   receive single

#define RADIOLIB_SX127X_CAD                                     0b00000111  //  2     0   channel activity detection


// RADIOLIB_SX127X_REG_PA_CONFIG

#define RADIOLIB_SX127X_PA_SELECT_RFO                           0b00000000  //  7     7   RFO pin output, power limited to +14 dBm

#define RADIOLIB_SX127X_PA_SELECT_BOOST                         0b10000000  //  7     7   PA_BOOST pin output, power limited to +20 dBm

#define RADIOLIB_SX127X_OUTPUT_POWER                            0b00001111  //  3     0   output power: P_out = 2 + OUTPUT_POWER [dBm] for PA_SELECT_BOOST

                                                                            //                          P_out = -1 + OUTPUT_POWER [dBm] for PA_SELECT_RFO


// RADIOLIB_SX127X_REG_OCP

#define RADIOLIB_SX127X_OCP_OFF                                 0b00000000  //  5     5   PA overload current protection disabled

#define RADIOLIB_SX127X_OCP_ON                                  0b00100000  //  5     5   PA overload current protection enabled

#define RADIOLIB_SX127X_OCP_TRIM                                0b00001011  //  4     0   OCP current: I_max(OCP_TRIM = 0b1011) = 100 mA


// RADIOLIB_SX127X_REG_LNA

#define RADIOLIB_SX127X_LNA_GAIN_1                              0b00100000  //  7     5   LNA gain setting:   max gain

#define RADIOLIB_SX127X_LNA_GAIN_2                              0b01000000  //  7     5                       .

#define RADIOLIB_SX127X_LNA_GAIN_3                              0b01100000  //  7     5                       .

#define RADIOLIB_SX127X_LNA_GAIN_4                              0b10000000  //  7     5                       .

#define RADIOLIB_SX127X_LNA_GAIN_5                              0b10100000  //  7     5                       .

#define RADIOLIB_SX127X_LNA_GAIN_6                              0b11000000  //  7     5                       min gain

#define RADIOLIB_SX127X_LNA_BOOST_OFF                           0b00000000  //  1     0   default LNA current

#define RADIOLIB_SX127X_LNA_BOOST_ON                            0b00000011  //  1     0   150% LNA current


// RADIOLIB_SX127X_REG_MODEM_CONFIG_2

#define RADIOLIB_SX127X_SF_6                                    0b01100000  //  7     4   spreading factor:   64 chips/bit

#define RADIOLIB_SX127X_SF_7                                    0b01110000  //  7     4                       128 chips/bit

#define RADIOLIB_SX127X_SF_8                                    0b10000000  //  7     4                       256 chips/bit

#define RADIOLIB_SX127X_SF_9                                    0b10010000  //  7     4                       512 chips/bit

#define RADIOLIB_SX127X_SF_10                                   0b10100000  //  7     4                       1024 chips/bit

#define RADIOLIB_SX127X_SF_11                                   0b10110000  //  7     4                       2048 chips/bit

#define RADIOLIB_SX127X_SF_12                                   0b11000000  //  7     4                       4096 chips/bit

#define RADIOLIB_SX127X_TX_MODE_SINGLE                          0b00000000  //  3     3   single TX

#define RADIOLIB_SX127X_TX_MODE_CONT                            0b00001000  //  3     3   continuous TX

#define RADIOLIB_SX127X_RX_TIMEOUT_MSB                          0b00000000  //  1     0


// RADIOLIB_SX127X_REG_SYMB_TIMEOUT_LSB

#define RADIOLIB_SX127X_RX_TIMEOUT_LSB                          0b01100100  //  7     0   10-bit RX operation timeout


// RADIOLIB_SX127X_REG_PREAMBLE_MSB + REG_PREAMBLE_LSB

#define RADIOLIB_SX127X_PREAMBLE_LENGTH_MSB                     0b00000000  //  7     0   2-byte preamble length setting: l_P = PREAMBLE_LENGTH + 4.25

#define RADIOLIB_SX127X_PREAMBLE_LENGTH_LSB                     0b00001000  //  7     0       where l_p = preamble length


// RADIOLIB_SX127X_REG_DETECT_OPTIMIZE

#define RADIOLIB_SX127X_DETECT_OPTIMIZE_SF_6                    0b00000101  //  2     0   SF6 detection optimization

#define RADIOLIB_SX127X_DETECT_OPTIMIZE_SF_7_12                 0b00000011  //  2     0   SF7 to SF12 detection optimization


// RADIOLIB_SX127X_REG_INVERT_IQ

#define RADIOLIB_SX127X_INVERT_IQ_RXPATH_ON                     0b01000000  //  6     6   I and Q signals are inverted

#define RADIOLIB_SX127X_INVERT_IQ_RXPATH_OFF                    0b00000000  //  6     6   normal mode

#define RADIOLIB_SX127X_INVERT_IQ_TXPATH_ON                     0b00000001  //  0     0   I and Q signals are inverted

#define RADIOLIB_SX127X_INVERT_IQ_TXPATH_OFF                    0b00000000  //  0     0   normal mode


// RADIOLIB_SX127X_REG_DETECTION_THRESHOLD

#define RADIOLIB_SX127X_DETECTION_THRESHOLD_SF_6                0b00001100  //  7     0   SF6 detection threshold

#define RADIOLIB_SX127X_DETECTION_THRESHOLD_SF_7_12             0b00001010  //  7     0   SF7 to SF12 detection threshold


// RADIOLIB_SX127X_REG_PA_DAC

#define RADIOLIB_SX127X_PA_BOOST_OFF                            0b00000100  //  2     0   PA_BOOST disabled

#define RADIOLIB_SX127X_PA_BOOST_ON                             0b00000111  //  2     0   +20 dBm on PA_BOOST when OUTPUT_POWER = 0b1111


// RADIOLIB_SX127X_REG_HOP_PERIOD

#define RADIOLIB_SX127X_HOP_PERIOD_OFF                          0b00000000  //  7     0   number of periods between frequency hops; 0 = disabled

#define RADIOLIB_SX127X_HOP_PERIOD_MAX                          0b11111111  //  7     0


// RADIOLIB_SX127X_REG_IRQ_FLAGS

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_RX_TIMEOUT               0b10000000  //  7     7   timeout

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_RX_DONE                  0b01000000  //  6     6   packet reception complete

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_PAYLOAD_CRC_ERROR        0b00100000  //  5     5   payload CRC error

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_VALID_HEADER             0b00010000  //  4     4   valid header received

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_TX_DONE                  0b00001000  //  3     3   payload transmission complete

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_CAD_DONE                 0b00000100  //  2     2   CAD complete

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_FHSS_CHANGE_CHANNEL      0b00000010  //  1     1   FHSS change channel

#define RADIOLIB_SX127X_CLEAR_IRQ_FLAG_CAD_DETECTED             0b00000001  //  0     0   valid LoRa signal detected during CAD operation


// RADIOLIB_SX127X_REG_IRQ_FLAGS_MASK

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_RX_TIMEOUT                0b01111111  //  7     7   timeout

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_RX_DONE                   0b10111111  //  6     6   packet reception complete

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_PAYLOAD_CRC_ERROR         0b11011111  //  5     5   payload CRC error

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_VALID_HEADER              0b11101111  //  4     4   valid header received

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_TX_DONE                   0b11110111  //  3     3   payload transmission complete

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_CAD_DONE                  0b11111011  //  2     2   CAD complete

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_FHSS_CHANGE_CHANNEL       0b11111101  //  1     1   FHSS change channel

#define RADIOLIB_SX127X_MASK_IRQ_FLAG_CAD_DETECTED              0b11111110  //  0     0   valid LoRa signal detected during CAD operation


// RADIOLIB_SX127X_REG_FIFO_TX_BASE_ADDR

#define RADIOLIB_SX127X_FIFO_TX_BASE_ADDR_MAX                   0b00000000  //  7     0   allocate the entire FIFO buffer for TX only


// RADIOLIB_SX127X_REG_FIFO_RX_BASE_ADDR

#define RADIOLIB_SX127X_FIFO_RX_BASE_ADDR_MAX                   0b00000000  //  7     0   allocate the entire FIFO buffer for RX only


// RADIOLIB_SX127X_REG_SYNC_WORD

#define RADIOLIB_SX127X_SYNC_WORD                               0x12        //  7     0   default LoRa sync word

#define RADIOLIB_SX127X_SYNC_WORD_LORAWAN                       0x34        //  7     0   sync word reserved for LoRaWAN networks


// RADIOLIB_SX127X_REG_INVERT_IQ2

#define RADIOLIB_SX127X_IQ2_ENABLE                              0x19        //  7     0   enable optimize for inverted IQ

#define RADIOLIB_SX127X_IQ2_DISABLE                             0x1D        //  7     0   reset optimize for inverted IQ


// SX127x series common FSK registers

// NOTE: FSK register names that are conflicting with LoRa registers are marked with "_FSK" suffix

#define RADIOLIB_SX127X_REG_BITRATE_MSB                         0x02

#define RADIOLIB_SX127X_REG_BITRATE_LSB                         0x03

#define RADIOLIB_SX127X_REG_FDEV_MSB                            0x04

#define RADIOLIB_SX127X_REG_FDEV_LSB                            0x05

#define RADIOLIB_SX127X_REG_RX_CONFIG                           0x0D

#define RADIOLIB_SX127X_REG_RSSI_CONFIG                         0x0E

#define RADIOLIB_SX127X_REG_RSSI_COLLISION                      0x0F

#define RADIOLIB_SX127X_REG_RSSI_THRESH                         0x10

#define RADIOLIB_SX127X_REG_RSSI_VALUE_FSK                      0x11

#define RADIOLIB_SX127X_REG_RX_BW                               0x12

#define RADIOLIB_SX127X_REG_AFC_BW                              0x13

#define RADIOLIB_SX127X_REG_OOK_PEAK                            0x14

#define RADIOLIB_SX127X_REG_OOK_FIX                             0x15

#define RADIOLIB_SX127X_REG_OOK_AVG                             0x16

#define RADIOLIB_SX127X_REG_AFC_FEI                             0x1A

#define RADIOLIB_SX127X_REG_AFC_MSB                             0x1B

#define RADIOLIB_SX127X_REG_AFC_LSB                             0x1C

#define RADIOLIB_SX127X_REG_FEI_MSB_FSK                         0x1D

#define RADIOLIB_SX127X_REG_FEI_LSB_FSK                         0x1E

#define RADIOLIB_SX127X_REG_PREAMBLE_DETECT                     0x1F

#define RADIOLIB_SX127X_REG_RX_TIMEOUT_1                        0x20

#define RADIOLIB_SX127X_REG_RX_TIMEOUT_2                        0x21

#define RADIOLIB_SX127X_REG_RX_TIMEOUT_3                        0x22

#define RADIOLIB_SX127X_REG_RX_DELAY                            0x23

#define RADIOLIB_SX127X_REG_OSC                                 0x24

#define RADIOLIB_SX127X_REG_PREAMBLE_MSB_FSK                    0x25

#define RADIOLIB_SX127X_REG_PREAMBLE_LSB_FSK                    0x26

#define RADIOLIB_SX127X_REG_SYNC_CONFIG                         0x27

#define RADIOLIB_SX127X_REG_SYNC_VALUE_1                        0x28

#define RADIOLIB_SX127X_REG_SYNC_VALUE_2                        0x29

#define RADIOLIB_SX127X_REG_SYNC_VALUE_3                        0x2A

#define RADIOLIB_SX127X_REG_SYNC_VALUE_4                        0x2B

#define RADIOLIB_SX127X_REG_SYNC_VALUE_5                        0x2C

#define RADIOLIB_SX127X_REG_SYNC_VALUE_6                        0x2D

#define RADIOLIB_SX127X_REG_SYNC_VALUE_7                        0x2E

#define RADIOLIB_SX127X_REG_SYNC_VALUE_8                        0x2F

#define RADIOLIB_SX127X_REG_PACKET_CONFIG_1                     0x30

#define RADIOLIB_SX127X_REG_PACKET_CONFIG_2                     0x31

#define RADIOLIB_SX127X_REG_PAYLOAD_LENGTH_FSK                  0x32

#define RADIOLIB_SX127X_REG_NODE_ADRS                           0x33

#define RADIOLIB_SX127X_REG_BROADCAST_ADRS                      0x34

#define RADIOLIB_SX127X_REG_FIFO_THRESH                         0x35

#define RADIOLIB_SX127X_REG_SEQ_CONFIG_1                        0x36

#define RADIOLIB_SX127X_REG_SEQ_CONFIG_2                        0x37

#define RADIOLIB_SX127X_REG_TIMER_RESOL                         0x38

#define RADIOLIB_SX127X_REG_TIMER1_COEF                         0x39

#define RADIOLIB_SX127X_REG_TIMER2_COEF                         0x3A

#define RADIOLIB_SX127X_REG_IMAGE_CAL                           0x3B

#define RADIOLIB_SX127X_REG_TEMP                                0x3C

#define RADIOLIB_SX127X_REG_LOW_BAT                             0x3D

#define RADIOLIB_SX127X_REG_IRQ_FLAGS_1                         0x3E

#define RADIOLIB_SX127X_REG_IRQ_FLAGS_2                         0x3F


// SX127x common FSK modem settings

// RADIOLIB_SX127X_REG_OP_MODE

#define RADIOLIB_SX127X_MODULATION_FSK                          0b00000000  //  6     5   FSK modulation scheme

#define RADIOLIB_SX127X_MODULATION_OOK                          0b00100000  //  6     5   OOK modulation scheme

#define RADIOLIB_SX127X_RX                                      0b00000101  //  2     0   receiver mode


// RADIOLIB_SX127X_REG_BITRATE_MSB + SX127X_REG_BITRATE_LSB

#define RADIOLIB_SX127X_BITRATE_MSB                             0x1A        //  7     0   bit rate setting: BitRate = F(XOSC)/(BITRATE + BITRATE_FRAC/16)

#define RADIOLIB_SX127X_BITRATE_LSB                             0x0B        //  7     0                     default value: 4.8 kbps


// RADIOLIB_SX127X_REG_FDEV_MSB + SX127X_REG_FDEV_LSB

#define RADIOLIB_SX127X_FDEV_MSB                                0x00        //  5     0   frequency deviation: Fdev = Fstep * FDEV

#define RADIOLIB_SX127X_FDEV_LSB                                0x52        //  7     0                        default value: 5 kHz


// RADIOLIB_SX127X_REG_RX_CONFIG

#define RADIOLIB_SX127X_RESTART_RX_ON_COLLISION_OFF             0b00000000  //  7     7   automatic receiver restart disabled (default)

#define RADIOLIB_SX127X_RESTART_RX_ON_COLLISION_ON              0b10000000  //  7     7   automatically restart receiver if it gets saturated or on packet collision

#define RADIOLIB_SX127X_RESTART_RX_WITHOUT_PLL_LOCK             0b01000000  //  6     6   manually restart receiver without frequency change

#define RADIOLIB_SX127X_RESTART_RX_WITH_PLL_LOCK                0b00100000  //  5     5   manually restart receiver with frequency change

#define RADIOLIB_SX127X_AFC_AUTO_OFF                            0b00000000  //  4     4   no AFC performed (default)

#define RADIOLIB_SX127X_AFC_AUTO_ON                             0b00010000  //  4     4   AFC performed at each receiver startup

#define RADIOLIB_SX127X_AGC_AUTO_OFF                            0b00000000  //  3     3   LNA gain set manually by register

#define RADIOLIB_SX127X_AGC_AUTO_ON                             0b00001000  //  3     3   LNA gain controlled by AGC

#define RADIOLIB_SX127X_RX_TRIGGER_NONE                         0b00000000  //  2     0   receiver startup at: none

#define RADIOLIB_SX127X_RX_TRIGGER_RSSI_INTERRUPT               0b00000001  //  2     0                        RSSI interrupt

#define RADIOLIB_SX127X_RX_TRIGGER_PREAMBLE_DETECT              0b00000110  //  2     0                        preamble detected

#define RADIOLIB_SX127X_RX_TRIGGER_BOTH                         0b00000111  //  2     0                        RSSI interrupt and preamble detected


// RADIOLIB_SX127X_REG_RSSI_CONFIG

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_2                0b00000000  //  2     0   number of samples for RSSI average: 2

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_4                0b00000001  //  2     0                                       4

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_8                0b00000010  //  2     0                                       8 (default)

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_16               0b00000011  //  2     0                                       16

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_32               0b00000100  //  2     0                                       32

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_64               0b00000101  //  2     0                                       64

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_128              0b00000110  //  2     0                                       128

#define RADIOLIB_SX127X_RSSI_SMOOTHING_SAMPLES_256              0b00000111  //  2     0                                       256


// RADIOLIB_SX127X_REG_RSSI_COLLISION

#define RADIOLIB_SX127X_RSSI_COLLISION_THRESHOLD                0x0A        //  7     0   RSSI threshold in dB that will be considered a collision, default value: 10 dB


// RADIOLIB_SX127X_REG_RSSI_THRESH

#define RADIOLIB_SX127X_RSSI_THRESHOLD                          0xFF        //  7     0   RSSI threshold that will trigger RSSI interrupt, RssiThreshold = RSSI_THRESHOLD / 2 [dBm]


// RADIOLIB_SX127X_REG_RX_BW

#define RADIOLIB_SX127X_RX_BW_MANT_16                           0b00000000  //  4     3   channel filter bandwidth: RxBw = F(XOSC) / (RxBwMant * 2^(RxBwExp + 2)) [kHz]

#define RADIOLIB_SX127X_RX_BW_MANT_20                           0b00001000  //  4     3

#define RADIOLIB_SX127X_RX_BW_MANT_24                           0b00010000  //  4     3   default RxBwMant parameter

#define RADIOLIB_SX127X_RX_BW_EXP                               0b00000101  //  2     0   default RxBwExp parameter

#define RADIOLIB_SX127X_RX_BW_2_6                               (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x07)

#define RADIOLIB_SX127X_RX_BW_3_1                               (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x07)

#define RADIOLIB_SX127X_RX_BW_3_9                               (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x07)

#define RADIOLIB_SX127X_RX_BW_5_2                               (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x06)

#define RADIOLIB_SX127X_RX_BW_6_3                               (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x06)

#define RADIOLIB_SX127X_RX_BW_7_8                               (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x06)

#define RADIOLIB_SX127X_RX_BW_10_4                              (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x05)

#define RADIOLIB_SX127X_RX_BW_12_5                              (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x05)

#define RADIOLIB_SX127X_RX_BW_15_6                              (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x05)

#define RADIOLIB_SX127X_RX_BW_20_8                              (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x04)

#define RADIOLIB_SX127X_RX_BW_25_0                              (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x04)

#define RADIOLIB_SX127X_RX_BW_31_3                              (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x04)

#define RADIOLIB_SX127X_RX_BW_41_7                              (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x03)

#define RADIOLIB_SX127X_RX_BW_50_0                              (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x03)

#define RADIOLIB_SX127X_RX_BW_62_5                              (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x03)

#define RADIOLIB_SX127X_RX_BW_83_3                              (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x02)

#define RADIOLIB_SX127X_RX_BW_100                               (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x02)

#define RADIOLIB_SX127X_RX_BW_125                               (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x02)

#define RADIOLIB_SX127X_RX_BW_167                               (RADIOLIB_SX127X_RX_BW_MANT_24 | 0x01)

#define RADIOLIB_SX127X_RX_BW_200                               (RADIOLIB_SX127X_RX_BW_MANT_20 | 0x01)

#define RADIOLIB_SX127X_RX_BW_250                               (RADIOLIB_SX127X_RX_BW_MANT_16 | 0x01)


// RADIOLIB_SX127X_REG_AFC_BW

#define RADIOLIB_SX127X_RX_BW_MANT_AFC                          0b00001000  //  4     3   default RxBwMant parameter used during AFC

#define RADIOLIB_SX127X_RX_BW_EXP_AFC                           0b00000011  //  2     0   default RxBwExp parameter used during AFC


// RADIOLIB_SX127X_REG_OOK_PEAK

#define RADIOLIB_SX127X_BIT_SYNC_OFF                            0b00000000  //  5     5   bit synchronizer disabled (not allowed in packet mode)

#define RADIOLIB_SX127X_BIT_SYNC_ON                             0b00100000  //  5     5   bit synchronizer enabled (default)

#define RADIOLIB_SX127X_OOK_THRESH_FIXED                        0b00000000  //  4     3   OOK threshold type: fixed value

#define RADIOLIB_SX127X_OOK_THRESH_PEAK                         0b00001000  //  4     3                       peak mode (default)

#define RADIOLIB_SX127X_OOK_THRESH_AVERAGE                      0b00010000  //  4     3                       average mode

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_0_5_DB             0b00000000  //  2     0   OOK demodulator step size: 0.5 dB (default)

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_0_DB             0b00000001  //  2     0                              1.0 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_1_5_DB             0b00000010  //  2     0                              1.5 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_2_0_DB             0b00000011  //  2     0                              2.0 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_3_0_DB             0b00000100  //  2     0                              3.0 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_4_0_DB             0b00000101  //  2     0                              4.0 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_5_0_DB             0b00000110  //  2     0                              5.0 dB

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_STEP_6_0_DB             0b00000111  //  2     0                              6.0 dB


// RADIOLIB_SX127X_REG_OOK_FIX

#define RADIOLIB_SX127X_OOK_FIXED_THRESHOLD                     0x0C        //  7     0   default fixed threshold for OOK data slicer


// RADIOLIB_SX127X_REG_OOK_AVG

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_1_1_CHIP            0b00000000  //  7     5   OOK demodulator step period: once per chip (default)

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_1_2_CHIP            0b00100000  //  7     5                                once every 2 chips

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_1_4_CHIP            0b01000000  //  7     5                                once every 4 chips

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_1_8_CHIP            0b01100000  //  7     5                                once every 8 chips

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_2_1_CHIP            0b10000000  //  7     5                                2 times per chip

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_4_1_CHIP            0b10100000  //  7     5                                4 times per chip

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_8_1_CHIP            0b11000000  //  7     5                                8 times per chip

#define RADIOLIB_SX127X_OOK_PEAK_THRESH_DEC_16_1_CHIP           0b11100000  //  7     5                                16 times per chip

#define RADIOLIB_SX127X_OOK_AVERAGE_OFFSET_0_DB                 0b00000000  //  3     2   OOK average threshold offset: 0.0 dB (default)

#define RADIOLIB_SX127X_OOK_AVERAGE_OFFSET_2_DB                 0b00000100  //  3     2                                 2.0 dB

#define RADIOLIB_SX127X_OOK_AVERAGE_OFFSET_4_DB                 0b00001000  //  3     2                                 4.0 dB

#define RADIOLIB_SX127X_OOK_AVERAGE_OFFSET_6_DB                 0b00001100  //  3     2                                 6.0 dB

#define RADIOLIB_SX127X_OOK_AVG_THRESH_FILT_32_PI               0b00000000  //  1     0   OOK average filter coefficient: chip rate / 32*pi

#define RADIOLIB_SX127X_OOK_AVG_THRESH_FILT_8_PI                0b00000001  //  1     0                                   chip rate / 8*pi

#define RADIOLIB_SX127X_OOK_AVG_THRESH_FILT_4_PI                0b00000010  //  1     0                                   chip rate / 4*pi (default)

#define RADIOLIB_SX127X_OOK_AVG_THRESH_FILT_2_PI                0b00000011  //  1     0                                   chip rate / 2*pi


// RADIOLIB_SX127X_REG_AFC_FEI

#define RADIOLIB_SX127X_AGC_START                               0b00010000  //  4     4   manually start AGC sequence

#define RADIOLIB_SX127X_AFC_CLEAR                               0b00000010  //  1     1   manually clear AFC register

#define RADIOLIB_SX127X_AFC_AUTO_CLEAR_OFF                      0b00000000  //  0     0   AFC register will not be cleared at the start of AFC (default)

#define RADIOLIB_SX127X_AFC_AUTO_CLEAR_ON                       0b00000001  //  0     0   AFC register will be cleared at the start of AFC


// RADIOLIB_SX127X_REG_PREAMBLE_DETECT

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_OFF                   0b00000000  //  7     7   preamble detection disabled

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_ON                    0b10000000  //  7     7   preamble detection enabled (default)

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_1_BYTE                0b00000000  //  6     5   preamble detection size: 1 byte (default)

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_2_BYTE                0b00100000  //  6     5                            2 bytes

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_3_BYTE                0b01000000  //  6     5                            3 bytes

#define RADIOLIB_SX127X_PREAMBLE_DETECTOR_TOL                   0x0A        //  4     0   default number of tolerated errors per chip (4 chips per bit)


// RADIOLIB_SX127X_REG_RX_TIMEOUT_1

#define RADIOLIB_SX127X_TIMEOUT_RX_RSSI_OFF                     0x00        //  7     0   disable receiver timeout when RSSI interrupt doesn't occur (default)


// RADIOLIB_SX127X_REG_RX_TIMEOUT_2

#define RADIOLIB_SX127X_TIMEOUT_RX_PREAMBLE_OFF                 0x00        //  7     0   disable receiver timeout when preamble interrupt doesn't occur (default)


// RADIOLIB_SX127X_REG_RX_TIMEOUT_3

#define RADIOLIB_SX127X_TIMEOUT_SIGNAL_SYNC_OFF                 0x00        //  7     0   disable receiver timeout when sync address interrupt doesn't occur (default)


// RADIOLIB_SX127X_REG_OSC

#define RADIOLIB_SX127X_RC_CAL_START                            0b00000000  //  3     3   manually start RC oscillator calibration

#define RADIOLIB_SX127X_CLK_OUT_FXOSC                           0b00000000  //  2     0   ClkOut frequency: F(XOSC)

#define RADIOLIB_SX127X_CLK_OUT_FXOSC_2                         0b00000001  //  2     0                     F(XOSC) / 2

#define RADIOLIB_SX127X_CLK_OUT_FXOSC_4                         0b00000010  //  2     0                     F(XOSC) / 4

#define RADIOLIB_SX127X_CLK_OUT_FXOSC_8                         0b00000011  //  2     0                     F(XOSC) / 8

#define RADIOLIB_SX127X_CLK_OUT_FXOSC_16                        0b00000100  //  2     0                     F(XOSC) / 16

#define RADIOLIB_SX127X_CLK_OUT_FXOSC_32                        0b00000101  //  2     0                     F(XOSC) / 32

#define RADIOLIB_SX127X_CLK_OUT_RC                              0b00000110  //  2     0                     RC

#define RADIOLIB_SX127X_CLK_OUT_OFF                             0b00000111  //  2     0                     disabled (default)


// RADIOLIB_SX127X_REG_PREAMBLE_MSB_FSK + SX127X_REG_PREAMBLE_LSB_FSK

#define RADIOLIB_SX127X_PREAMBLE_SIZE_MSB                       0x00        //  7     0   preamble size in bytes

#define RADIOLIB_SX127X_PREAMBLE_SIZE_LSB                       0x03        //  7     0     default value: 3 bytes


// RADIOLIB_SX127X_REG_SYNC_CONFIG

#define RADIOLIB_SX127X_AUTO_RESTART_RX_MODE_OFF                0b00000000  //  7     6   Rx mode restart after packet reception: disabled

#define RADIOLIB_SX127X_AUTO_RESTART_RX_MODE_NO_PLL             0b01000000  //  7     6                                           enabled, don't wait for PLL lock

#define RADIOLIB_SX127X_AUTO_RESTART_RX_MODE_PLL                0b10000000  //  7     6                                           enabled, wait for PLL lock (default)

#define RADIOLIB_SX127X_PREAMBLE_POLARITY_AA                    0b00000000  //  5     5   preamble polarity: 0xAA = 0b10101010 (default)

#define RADIOLIB_SX127X_PREAMBLE_POLARITY_55                    0b00100000  //  5     5                      0x55 = 0b01010101

#define RADIOLIB_SX127X_SYNC_OFF                                0b00000000  //  4     4   sync word disabled

#define RADIOLIB_SX127X_SYNC_ON                                 0b00010000  //  4     4   sync word enabled (default)

#define RADIOLIB_SX127X_SYNC_SIZE                               0x03        //  2     0   sync word size in bytes, SyncSize = SYNC_SIZE + 1 bytes


// RADIOLIB_SX127X_REG_SYNC_VALUE_1 - SX127X_REG_SYNC_VALUE_8

#define RADIOLIB_SX127X_SYNC_VALUE_1                            0x01        //  7     0   sync word: 1st byte (MSB)

#define RADIOLIB_SX127X_SYNC_VALUE_2                            0x01        //  7     0              2nd byte

#define RADIOLIB_SX127X_SYNC_VALUE_3                            0x01        //  7     0              3rd byte

#define RADIOLIB_SX127X_SYNC_VALUE_4                            0x01        //  7     0              4th byte

#define RADIOLIB_SX127X_SYNC_VALUE_5                            0x01        //  7     0              5th byte

#define RADIOLIB_SX127X_SYNC_VALUE_6                            0x01        //  7     0              6th byte

#define RADIOLIB_SX127X_SYNC_VALUE_7                            0x01        //  7     0              7th byte

#define RADIOLIB_SX127X_SYNC_VALUE_8                            0x01        //  7     0              8th byte (LSB)


// RADIOLIB_SX127X_REG_PACKET_CONFIG_1

#define RADIOLIB_SX127X_PACKET_FIXED                            0b00000000  //  7     7   packet format: fixed length

#define RADIOLIB_SX127X_PACKET_VARIABLE                         0b10000000  //  7     7                  variable length (default)

#define RADIOLIB_SX127X_DC_FREE_NONE                            0b00000000  //  6     5   DC-free encoding: disabled (default)

#define RADIOLIB_SX127X_DC_FREE_MANCHESTER                      0b00100000  //  6     5                     Manchester

#define RADIOLIB_SX127X_DC_FREE_WHITENING                       0b01000000  //  6     5                     Whitening

#define RADIOLIB_SX127X_CRC_OFF                                 0b00000000  //  4     4   CRC disabled

#define RADIOLIB_SX127X_CRC_ON                                  0b00010000  //  4     4   CRC enabled (default)

#define RADIOLIB_SX127X_CRC_AUTOCLEAR_OFF                       0b00001000  //  3     3   keep FIFO on CRC mismatch, issue payload ready interrupt

#define RADIOLIB_SX127X_CRC_AUTOCLEAR_ON                        0b00000000  //  3     3   clear FIFO on CRC mismatch, do not issue payload ready interrupt

#define RADIOLIB_SX127X_ADDRESS_FILTERING_OFF                   0b00000000  //  2     1   address filtering: none (default)

#define RADIOLIB_SX127X_ADDRESS_FILTERING_NODE                  0b00000010  //  2     1                      node

#define RADIOLIB_SX127X_ADDRESS_FILTERING_NODE_BROADCAST        0b00000100  //  2     1                      node or broadcast

#define RADIOLIB_SX127X_CRC_WHITENING_TYPE_CCITT                0b00000000  //  0     0   CRC and whitening algorithms: CCITT CRC with standard whitening (default)

#define RADIOLIB_SX127X_CRC_WHITENING_TYPE_IBM                  0b00000001  //  0     0                                 IBM CRC with alternate whitening


// RADIOLIB_SX127X_REG_PACKET_CONFIG_2

#define RADIOLIB_SX127X_DATA_MODE_PACKET                        0b01000000  //  6     6   data mode: packet (default)

#define RADIOLIB_SX127X_DATA_MODE_CONTINUOUS                    0b00000000  //  6     6              continuous

#define RADIOLIB_SX127X_IO_HOME_OFF                             0b00000000  //  5     5   io-homecontrol compatibility disabled (default)

#define RADIOLIB_SX127X_IO_HOME_ON                              0b00100000  //  5     5   io-homecontrol compatibility enabled


// RADIOLIB_SX127X_REG_FIFO_THRESH

#define RADIOLIB_SX127X_TX_START_FIFO_LEVEL                     0b00000000  //  7     7   start packet transmission when: number of bytes in FIFO exceeds FIFO_THRESHOLD

#define RADIOLIB_SX127X_TX_START_FIFO_NOT_EMPTY                 0b10000000  //  7     7                                   at least one byte in FIFO (default)

#define RADIOLIB_SX127X_FIFO_THRESH                             0x1F        //  5     0   FIFO level threshold


// RADIOLIB_SX127X_REG_SEQ_CONFIG_1

#define RADIOLIB_SX127X_SEQUENCER_START                         0b10000000  //  7     7   manually start sequencer

#define RADIOLIB_SX127X_SEQUENCER_STOP                          0b01000000  //  6     6   manually stop sequencer

#define RADIOLIB_SX127X_IDLE_MODE_STANDBY                       0b00000000  //  5     5   chip mode during sequencer idle mode: standby (default)

#define RADIOLIB_SX127X_IDLE_MODE_SLEEP                         0b00100000  //  5     5                                         sleep

#define RADIOLIB_SX127X_FROM_START_LP_SELECTION                 0b00000000  //  4     3   mode that will be set after starting sequencer: low power selection (default)

#define RADIOLIB_SX127X_FROM_START_RECEIVE                      0b00001000  //  4     3                                                   receive

#define RADIOLIB_SX127X_FROM_START_TRANSMIT                     0b00010000  //  4     3                                                   transmit

#define RADIOLIB_SX127X_FROM_START_TRANSMIT_FIFO_LEVEL          0b00011000  //  4     3                                                   transmit on a FIFO level interrupt

#define RADIOLIB_SX127X_LP_SELECTION_SEQ_OFF                    0b00000000  //  2     2   mode that will be set after exiting low power selection: sequencer off (default)

#define RADIOLIB_SX127X_LP_SELECTION_IDLE                       0b00000100  //  2     2                                                            idle state

#define RADIOLIB_SX127X_FROM_IDLE_TRANSMIT                      0b00000000  //  1     1   mode that will be set after exiting idle mode: transmit (default)

#define RADIOLIB_SX127X_FROM_IDLE_RECEIVE                       0b00000010  //  1     1                                                  receive

#define RADIOLIB_SX127X_FROM_TRANSMIT_LP_SELECTION              0b00000000  //  0     0   mode that will be set after exiting transmit mode: low power selection (default)

#define RADIOLIB_SX127X_FROM_TRANSMIT_RECEIVE                   0b00000001  //  0     0                                                      receive


// RADIOLIB_SX127X_REG_SEQ_CONFIG_2

#define RADIOLIB_SX127X_FROM_RECEIVE_PACKET_RECEIVED_PAYLOAD    0b00100000  //  7     5   mode that will be set after exiting receive mode: packet received on payload ready interrupt (default)

#define RADIOLIB_SX127X_FROM_RECEIVE_LP_SELECTION               0b01000000  //  7     5                                                     low power selection

#define RADIOLIB_SX127X_FROM_RECEIVE_PACKET_RECEIVED_CRC_OK     0b01100000  //  7     5                                                     packet received on CRC OK interrupt

#define RADIOLIB_SX127X_FROM_RECEIVE_SEQ_OFF_RSSI               0b10000000  //  7     5                                                     sequencer off on RSSI interrupt

#define RADIOLIB_SX127X_FROM_RECEIVE_SEQ_OFF_SYNC_ADDR          0b10100000  //  7     5                                                     sequencer off on sync address interrupt

#define RADIOLIB_SX127X_FROM_RECEIVE_SEQ_OFF_PREAMBLE_DETECT    0b11000000  //  7     5                                                     sequencer off on preamble detect interrupt

#define RADIOLIB_SX127X_FROM_RX_TIMEOUT_RECEIVE                 0b00000000  //  4     3   mode that will be set after Rx timeout: receive (default)

#define RADIOLIB_SX127X_FROM_RX_TIMEOUT_TRANSMIT                0b00001000  //  4     3                                           transmit

#define RADIOLIB_SX127X_FROM_RX_TIMEOUT_LP_SELECTION            0b00010000  //  4     3                                           low power selection

#define RADIOLIB_SX127X_FROM_RX_TIMEOUT_SEQ_OFF                 0b00011000  //  4     3                                           sequencer off

#define RADIOLIB_SX127X_FROM_PACKET_RECEIVED_SEQ_OFF            0b00000000  //  2     0   mode that will be set after packet received: sequencer off (default)

#define RADIOLIB_SX127X_FROM_PACKET_RECEIVED_TRANSMIT           0b00000001  //  2     0                                                transmit

#define RADIOLIB_SX127X_FROM_PACKET_RECEIVED_LP_SELECTION       0b00000010  //  2     0                                                low power selection

#define RADIOLIB_SX127X_FROM_PACKET_RECEIVED_RECEIVE_FS         0b00000011  //  2     0                                                receive via FS

#define RADIOLIB_SX127X_FROM_PACKET_RECEIVED_RECEIVE            0b00000100  //  2     0                                                receive


// RADIOLIB_SX127X_REG_TIMER_RESOL

#define RADIOLIB_SX127X_TIMER1_OFF                              0b00000000  //  3     2   timer 1 resolution: disabled (default)

#define RADIOLIB_SX127X_TIMER1_RESOLUTION_64_US                 0b00000100  //  3     2                       64 us

#define RADIOLIB_SX127X_TIMER1_RESOLUTION_4_1_MS                0b00001000  //  3     2                       4.1 ms

#define RADIOLIB_SX127X_TIMER1_RESOLUTION_262_MS                0b00001100  //  3     2                       262 ms

#define RADIOLIB_SX127X_TIMER2_OFF                              0b00000000  //  3     2   timer 2 resolution: disabled (default)

#define RADIOLIB_SX127X_TIMER2_RESOLUTION_64_US                 0b00000001  //  3     2                       64 us

#define RADIOLIB_SX127X_TIMER2_RESOLUTION_4_1_MS                0b00000010  //  3     2                       4.1 ms

#define RADIOLIB_SX127X_TIMER2_RESOLUTION_262_MS                0b00000011  //  3     2                       262 ms


// RADIOLIB_SX127X_REG_TIMER1_COEF

#define RADIOLIB_SX127X_TIMER1_COEFFICIENT                      0xF5        //  7     0   multiplication coefficient for timer 1


// RADIOLIB_SX127X_REG_TIMER2_COEF

#define RADIOLIB_SX127X_TIMER2_COEFFICIENT                      0x20        //  7     0   multiplication coefficient for timer 2


// RADIOLIB_SX127X_REG_IMAGE_CAL

#define RADIOLIB_SX127X_AUTO_IMAGE_CAL_OFF                      0b00000000  //  7     7   temperature calibration disabled (default)

#define RADIOLIB_SX127X_AUTO_IMAGE_CAL_ON                       0b10000000  //  7     7   temperature calibration enabled

#define RADIOLIB_SX127X_IMAGE_CAL_START                         0b01000000  //  6     6   start temperature calibration

#define RADIOLIB_SX127X_IMAGE_CAL_RUNNING                       0b00100000  //  5     5   temperature calibration is on-going

#define RADIOLIB_SX127X_IMAGE_CAL_COMPLETE                      0b00000000  //  5     5   temperature calibration finished

#define RADIOLIB_SX127X_TEMP_CHANGED                            0b00001000  //  3     3   temperature changed more than TEMP_THRESHOLD since last calibration

#define RADIOLIB_SX127X_TEMP_THRESHOLD_5_DEG_C                  0b00000000  //  2     1   temperature change threshold: 5 deg. C

#define RADIOLIB_SX127X_TEMP_THRESHOLD_10_DEG_C                 0b00000010  //  2     1                                 10 deg. C (default)

#define RADIOLIB_SX127X_TEMP_THRESHOLD_15_DEG_C                 0b00000100  //  2     1                                 15 deg. C

#define RADIOLIB_SX127X_TEMP_THRESHOLD_20_DEG_C                 0b00000110  //  2     1                                 20 deg. C

#define RADIOLIB_SX127X_TEMP_MONITOR_ON                         0b00000000  //  0     0   temperature monitoring enabled (default)

#define RADIOLIB_SX127X_TEMP_MONITOR_OFF                        0b00000001  //  0     0   temperature monitoring disabled


// RADIOLIB_SX127X_REG_LOW_BAT

#define RADIOLIB_SX127X_LOW_BAT_OFF                             0b00000000  //  3     3   low battery detector disabled

#define RADIOLIB_SX127X_LOW_BAT_ON                              0b00001000  //  3     3   low battery detector enabled

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_1_695_V               0b00000000  //  2     0   battery voltage threshold: 1.695 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_1_764_V               0b00000001  //  2     0                              1.764 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_1_835_V               0b00000010  //  2     0                              1.835 V (default)

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_1_905_V               0b00000011  //  2     0                              1.905 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_1_976_V               0b00000100  //  2     0                              1.976 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_2_045_V               0b00000101  //  2     0                              2.045 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_2_116_V               0b00000110  //  2     0                              2.116 V

#define RADIOLIB_SX127X_LOW_BAT_THRESHOLD_2_185_V               0b00000111  //  2     0                              2.185 V


// RADIOLIB_SX127X_REG_IRQ_FLAGS_1

#define RADIOLIB_SX127X_FLAG_MODE_READY                         0b10000000  //  7     7   requested mode is ready

#define RADIOLIB_SX127X_FLAG_RX_READY                           0b01000000  //  6     6   reception ready (after RSSI, AGC, AFC)

#define RADIOLIB_SX127X_FLAG_TX_READY                           0b00100000  //  5     5   transmission ready (after PA ramp-up)

#define RADIOLIB_SX127X_FLAG_PLL_LOCK                           0b00010000  //  4     4   PLL locked

#define RADIOLIB_SX127X_FLAG_RSSI                               0b00001000  //  3     3   RSSI value exceeds RSSI threshold

#define RADIOLIB_SX127X_FLAG_TIMEOUT                            0b00000100  //  2     2   timeout occurred

#define RADIOLIB_SX127X_FLAG_PREAMBLE_DETECT                    0b00000010  //  1     1   valid preamble was detected

#define RADIOLIB_SX127X_FLAG_SYNC_ADDRESS_MATCH                 0b00000001  //  0     0   sync address matched


// RADIOLIB_SX127X_REG_IRQ_FLAGS_2

#define RADIOLIB_SX127X_FLAG_FIFO_FULL                          0b10000000  //  7     7   FIFO is full

#define RADIOLIB_SX127X_FLAG_FIFO_EMPTY                         0b01000000  //  6     6   FIFO is empty

#define RADIOLIB_SX127X_FLAG_FIFO_LEVEL                         0b00100000  //  5     5   number of bytes in FIFO exceeds FIFO_THRESHOLD

#define RADIOLIB_SX127X_FLAG_FIFO_OVERRUN                       0b00010000  //  4     4   FIFO overrun occurred

#define RADIOLIB_SX127X_FLAG_PACKET_SENT                        0b00001000  //  3     3   packet was successfully sent

#define RADIOLIB_SX127X_FLAG_PAYLOAD_READY                      0b00000100  //  2     2   packet was successfully received

#define RADIOLIB_SX127X_FLAG_CRC_OK                             0b00000010  //  1     1   CRC check passed

#define RADIOLIB_SX127X_FLAG_LOW_BAT                            0b00000001  //  0     0   battery voltage dropped below threshold

#define RADIOLIB_SX127X_FLAGS_ALL                               0xFFFF


// RADIOLIB_SX127X_REG_DIO_MAPPING_1

#define RADIOLIB_SX127X_DIO0_LORA_RX_DONE                       0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO0_LORA_TX_DONE                       0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO0_LORA_CAD_DONE                      0b10000000  //  7     6

#define RADIOLIB_SX127X_DIO0_CONT_MODE_READY                    0b11000000  //  7     6

#define RADIOLIB_SX127X_DIO0_CONT_SYNC_ADDRESS                  0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO0_CONT_RSSI_PREAMBLE_DETECT          0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO0_CONT_RX_READY                      0b10000000  //  7     6

#define RADIOLIB_SX127X_DIO0_CONT_TX_READY                      0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO0_PACK_PAYLOAD_READY                 0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO0_PACK_PACKET_SENT                   0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO0_PACK_CRC_OK                        0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO0_PACK_TEMP_CHANGE_LOW_BAT           0b11000000  //  7     6

#define RADIOLIB_SX127X_DIO1_LORA_RX_TIMEOUT                    0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO1_LORA_FHSS_CHANGE_CHANNEL           0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO1_LORA_CAD_DETECTED                  0b00100000  //  5     4

#define RADIOLIB_SX127X_DIO1_CONT_DCLK                          0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO1_CONT_RSSI_PREAMBLE_DETECT          0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO1_PACK_FIFO_LEVEL                    0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO1_PACK_FIFO_EMPTY                    0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO1_PACK_FIFO_FULL                     0b00100000  //  5     4

#define RADIOLIB_SX127X_DIO2_LORA_FHSS_CHANGE_CHANNEL           0b00000000  //  3     2

#define RADIOLIB_SX127X_DIO2_CONT_DATA                          0b00000000  //  3     2

#define RADIOLIB_SX127X_DIO2_PACK_FIFO_FULL                     0b00000000  //  3     2

#define RADIOLIB_SX127X_DIO2_PACK_RX_READY                      0b00000100  //  3     2

#define RADIOLIB_SX127X_DIO2_PACK_TIMEOUT                       0b00001000  //  3     2

#define RADIOLIB_SX127X_DIO2_PACK_SYNC_ADDRESS                  0b00011000  //  3     2

#define RADIOLIB_SX127X_DIO3_LORA_CAD_DONE                      0b00000000  //  1     0

#define RADIOLIB_SX127X_DIO3_LORA_VALID_HEADER                  0b00000001  //  1     0

#define RADIOLIB_SX127X_DIO3_LORA_PAYLOAD_CRC_ERROR             0b00000010  //  1     0

#define RADIOLIB_SX127X_DIO3_CONT_TIMEOUT                       0b00000000  //  1     0

#define RADIOLIB_SX127X_DIO3_CONT_RSSI_PREAMBLE_DETECT          0b00000001  //  1     0

#define RADIOLIB_SX127X_DIO3_CONT_TEMP_CHANGE_LOW_BAT           0b00000011  //  1     0

#define RADIOLIB_SX127X_DIO3_PACK_FIFO_EMPTY                    0b00000000  //  1     0

#define RADIOLIB_SX127X_DIO3_PACK_TX_READY                      0b00000001  //  1     0


// RADIOLIB_SX127X_REG_DIO_MAPPING_2

#define RADIOLIB_SX127X_DIO4_LORA_CAD_DETECTED                  0b10000000  //  7     6

#define RADIOLIB_SX127X_DIO4_LORA_PLL_LOCK                      0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO4_CONT_TEMP_CHANGE_LOW_BAT           0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO4_CONT_PLL_LOCK                      0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO4_CONT_TIMEOUT                       0b10000000  //  7     6

#define RADIOLIB_SX127X_DIO4_CONT_MODE_READY                    0b11000000  //  7     6

#define RADIOLIB_SX127X_DIO4_PACK_TEMP_CHANGE_LOW_BAT           0b00000000  //  7     6

#define RADIOLIB_SX127X_DIO4_PACK_PLL_LOCK                      0b01000000  //  7     6

#define RADIOLIB_SX127X_DIO4_PACK_TIMEOUT                       0b10000000  //  7     6

#define RADIOLIB_SX127X_DIO4_PACK_RSSI_PREAMBLE_DETECT          0b11000000  //  7     6

#define RADIOLIB_SX127X_DIO5_LORA_MODE_READY                    0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO5_LORA_CLK_OUT                       0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO5_CONT_CLK_OUT                       0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO5_CONT_PLL_LOCK                      0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO5_CONT_RSSI_PREAMBLE_DETECT          0b00100000  //  5     4

#define RADIOLIB_SX127X_DIO5_CONT_MODE_READY                    0b00110000  //  5     4

#define RADIOLIB_SX127X_DIO5_PACK_CLK_OUT                       0b00000000  //  5     4

#define RADIOLIB_SX127X_DIO5_PACK_PLL_LOCK                      0b00010000  //  5     4

#define RADIOLIB_SX127X_DIO5_PACK_DATA                          0b00100000  //  5     4

#define RADIOLIB_SX127X_DIO5_PACK_MODE_READY                    0b00110000  //  5     4

#define RADIOLIB_SX127X_DIO_MAP_PREAMBLE_DETECT                 0b00000001  //  0     0

#define RADIOLIB_SX127X_DIO_MAP_RSSI                            0b00000000  //  0     0


// SX1272_REG_PLL_HOP + SX1278_REG_PLL_HOP

#define RADIOLIB_SX127X_FAST_HOP_OFF                            0b00000000  //  7     7   carrier frequency validated when FRF registers are written

#define RADIOLIB_SX127X_FAST_HOP_ON                             0b10000000  //  7     7   carrier frequency validated when FS modes are requested


// SX1272_REG_TCXO + SX1278_REG_TCXO

#define RADIOLIB_SX127X_TCXO_INPUT_EXTERNAL                     0b00000000  //  4     4   use external crystal oscillator

#define RADIOLIB_SX127X_TCXO_INPUT_EXTERNAL_CLIPPED             0b00010000  //  4     4   use external crystal oscillator clipped sine connected to XTA pin


// SX1272_REG_PLL + SX1278_REG_PLL

#define RADIOLIB_SX127X_PLL_BANDWIDTH_75_KHZ                    0b00000000  //  7     6   PLL bandwidth: 75 kHz

#define RADIOLIB_SX127X_PLL_BANDWIDTH_150_KHZ                   0b01000000  //  7     6                  150 kHz

#define RADIOLIB_SX127X_PLL_BANDWIDTH_225_KHZ                   0b10000000  //  7     6                  225 kHz

#define RADIOLIB_SX127X_PLL_BANDWIDTH_300_KHZ                   0b11000000  //  7     6                  300 kHz (default)


class SX127x: public PhysicalLayer {

  public:

    // introduce PhysicalLayer overloads

    using PhysicalLayer::transmit;

    using PhysicalLayer::receive;

    using PhysicalLayer::startTransmit;

    using PhysicalLayer::startReceive;

    using PhysicalLayer::readData;


    // constructor


    explicit SX127x(Module* mod);


    uint8_t gain = 0;


    bool enableOOK = false;


    // basic methods


    int16_t begin(const uint8_t* chipVersions, uint8_t numVersions, uint8_t syncWord, uint16_t preambleLength);


    virtual void reset();


    int16_t beginFSK(const uint8_t* chipVersions, uint8_t numVersions, float freqDev, float rxBw, uint16_t preambleLength);


    int16_t transmit(const uint8_t* data, size_t len, uint8_t addr = 0) override;


    int16_t receive(uint8_t* data, size_t len, RadioLibTime_t timeout = 0) override;


    int16_t scanChannel() override;


    int16_t scanChannel(const ChannelScanConfig_t &config) override;


    int16_t sleep() override;


    int16_t standby() override;


    int16_t standby(uint8_t mode) override;


    int16_t transmitDirect(uint32_t frf = 0) override;


    int16_t receiveDirect() override;


    int16_t packetMode();


    // interrupt methods


    void setDio0Action(void (*func)(void), uint32_t dir);


    void clearDio0Action();


    void setDio1Action(void (*func)(void), uint32_t dir);


    void clearDio1Action();


    void setPacketReceivedAction(void (*func)(void)) override;


    void clearPacketReceivedAction() override;


    void setPacketSentAction(void (*func)(void)) override;


    void clearPacketSentAction() override;


    void setChannelScanAction(void (*func)(void)) override;


    void clearChannelScanAction() override;


    void setFifoEmptyAction(void (*func)(void));


    void clearFifoEmptyAction();


    void setFifoThreshold(uint8_t threshold);


    void setFifoFullAction(void (*func)(void));


    void clearFifoFullAction();


    bool fifoAdd(uint8_t* data, int totalLen, int* remLen);


    bool fifoGet(volatile uint8_t* data, int totalLen, volatile int* rcvLen);


    int16_t finishTransmit() override;


    int16_t startReceive() override;


    int16_t readData(uint8_t* data, size_t len) override;


    int16_t finishReceive() override;


    int16_t startChannelScan() override;


    int16_t startChannelScan(const ChannelScanConfig_t &cfg) override;


    int16_t getChannelScanResult() override;


    // configuration methods


    int16_t setSyncWord(uint8_t syncWord);


    int16_t setCurrentLimit(uint8_t currentLimit);


    int16_t setPreambleLength(size_t preambleLength) override;


    int16_t invertPreamble(bool enable);


    float getFrequencyError(bool autoCorrect = false);


    float getAFCError();


    float getSNR() override;


    int16_t setFrequencyDeviation(float freqDev) override;


    int16_t setRxBandwidth(float rxBw);


    int16_t setAFCBandwidth(float afcBw);


    int16_t setAFC(bool isEnabled);


    int16_t setAFCAGCTrigger(uint8_t trigger);


    int16_t setSyncWord(uint8_t* syncWord, size_t len) override;


    int16_t setNodeAddress(uint8_t nodeAddr);


    int16_t setBroadcastAddress(uint8_t broadAddr);


    int16_t disableAddressFiltering();


    int16_t setOOK(bool enable);


    int16_t setOokThresholdType(uint8_t type);


    int16_t setOokPeakThresholdDecrement(uint8_t value);


    int16_t setOokFixedOrFloorThreshold(uint8_t value);


    int16_t setOokPeakThresholdStep(uint8_t value);


    int16_t enableBitSync();


    int16_t disableBitSync();


    size_t getPacketLength(bool update = true) override;


    int16_t getLoRaRxHeaderInfo(uint8_t* cr, bool* hasCRC);


    int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);


    int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);


    float getNumSymbols(size_t len, DataRate_t dr, PacketConfig_t pc);


    RadioLibTime_t getTimeOnAir(size_t len) override;


    RadioLibTime_t calculateTimeOnAir(ModemType_t modem, DataRate_t dr, PacketConfig_t pc, size_t len) override;


    RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;


    uint32_t getIrqFlags() override;


    int16_t setIrqFlags(uint32_t irq) override;


    int16_t clearIrqFlags(uint32_t irq) override;


    int16_t setCrcFiltering(bool enable = true);


    int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset = 0);


    int16_t setEncoding(uint8_t encoding) override;


    uint16_t getIRQFlags();


    uint8_t getModemStatus();


    int8_t getTempRaw();


    void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);


    void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);


    uint8_t randomByte() override;


    int16_t getChipVersion();


    int16_t invertIQ(bool enable) override;


    int16_t getModem(ModemType_t* modem) override;


    int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t* cfg) override;


    int16_t launchMode() override;


    #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE

    void setDirectAction(void (*func)(void)) override;


    void readBit(uint32_t pin) override;

    #endif


    int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod);


    uint8_t getFHSSHoppingPeriod(void);


    uint8_t getFHSSChannel(void);


    void clearFHSSInt(void);


    int16_t setDIOMapping(uint32_t pin, uint32_t value);


    int16_t setDIOPreambleDetect(bool usePreambleDetect);


    int16_t setRSSIThreshold(float dbm);


    int16_t setLowBatteryThreshold(int8_t level, uint32_t pin = RADIOLIB_NC);


#if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL

  protected:

#endif

    Module* getMod() override;


#if !RADIOLIB_GODMODE

  protected:

#endif

    float frequency = 0;

    float bandwidth = 125;

    uint8_t spreadingFactor = 9;

    size_t packetLength = 0;

    uint8_t codingRate = 0;

    bool crcEnabled = false;

    bool ookEnabled = false;

    bool implicitHdr = false;

    bool ldroAuto = true;

    bool ldroEnabled = false;


    virtual int16_t configFSK();

    int16_t getActiveModem();

    int16_t setFrequencyRaw(float newFreq);

    int16_t setBitRateCommon(float br, uint8_t fracRegAddr);

    float getRSSICommon(bool packet, bool skipReceive, int16_t offset);

    int16_t setHeaderType(uint8_t headerType, uint8_t bitIndex, size_t len = 0xFF);


#if !RADIOLIB_GODMODE

  private:

#endif

    Module* mod;


    float bitRate = 0, frequencyDev = 0;

    bool crcOn = true; // default value used in FSK mode

    bool packetLengthQueried = false; // FSK packet length is the first byte in FIFO, length can only be queried once

    uint8_t packetLengthConfig = RADIOLIB_SX127X_PACKET_VARIABLE;

    uint8_t rxMode = RADIOLIB_SX127X_RXCONTINUOUS;


    int16_t config();

    int16_t directMode();

    int16_t setPacketMode(uint8_t mode, uint8_t len);

    bool findChip(const uint8_t* vers, uint8_t num);

    int16_t setMode(uint8_t mode);

    int16_t setActiveModem(uint8_t modem);

    void clearFIFO(size_t count); // used mostly to clear remaining bytes in FIFO after a packet read

    int16_t findRxBw(float rxBw, const uint8_t* lut, size_t lutSize, float rxBwMax, uint8_t* val);

    int16_t setRxBw(float rxBw, bool afc);


    virtual void errataFix(bool rx); // should be implemented in derived class

};


#endif


#endif

Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:69

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:78

PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:390

PhysicalLayer::startReceive
virtual int16_t startReceive()
Sets module to received mode using its default configuration.
Definition PhysicalLayer.cpp:131

PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition PhysicalLayer.cpp:225

PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition PhysicalLayer.cpp:53

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:156

PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len, RadioLibTime_t timeout=0)
Binary receive method. Must be implemented in module class.
Definition PhysicalLayer.cpp:111

SX127x
Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...
Definition SX127x.h:604

SX127x::packetMode
int16_t packetMode()
Disables direct mode and enables packet mode, allowing the module to receive packets....
Definition SX127x.cpp:374

SX127x::clearChannelScanAction
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition SX127x.cpp:429

SX127x::readBit
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition SX127x.cpp:1919

SX127x::clearFifoFullAction
void clearFifoFullAction()
Clears interrupt service routine to call when FIFO is full.
Definition SX127x.cpp:455

SX127x::setDIOMapping
int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition SX127x.cpp:1945

SX127x::scanChannel
int16_t scanChannel() override
Performs scan for valid LoRa preamble in the current channel.
Definition SX127x.cpp:258

SX127x::reset
virtual void reset()
Reset method. Will reset the chip to the default state using RST pin. Should be implemented in derive...
Definition SX127x.cpp:254

SX127x::setOokFixedOrFloorThreshold
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 Pe...
Definition SX127x.cpp:1054

SX127x::enableBitSync
int16_t enableBitSync()
Enable Bit synchronizer.
Definition SX127x.cpp:1078

SX127x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in variable packet length mode. Available in FSK mode only.
Definition SX127x.cpp:1173

SX127x::sleep
int16_t sleep() override
Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data ...
Definition SX127x.cpp:282

SX127x::setFifoFullAction
void setFifoFullAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is full.
Definition SX127x.cpp:446

SX127x::getIrqFlags
uint32_t getIrqFlags() override
Read currently active IRQ flags.
Definition SX127x.cpp:1288

SX127x::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 SX127x.cpp:488

SX127x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.
Definition SX127x.cpp:860

SX127x::getModemStatus
uint8_t getModemStatus()
Reads modem status. Only available in LoRa mode.
Definition SX127x.cpp:1488

SX127x::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition SX127x.cpp:421

SX127x::getModem
int16_t getModem(ModemType_t *modem) override
Get modem currently in use by the radio.
Definition SX127x.cpp:1734

SX127x::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition SX127x.cpp:417

SX127x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition SX127x.cpp:1712

SX127x::fifoAdd
bool fifoAdd(uint8_t *data, int totalLen, int *remLen)
Set interrupt service routine function to call when FIFO is empty.
Definition SX127x.cpp:465

SX127x::stageMode
int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t *cfg) override
Stage mode of the radio to be launched later using launchMode.
Definition SX127x.cpp:1750

SX127x::setCurrentLimit
int16_t setCurrentLimit(uint8_t currentLimit)
Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...
Definition SX127x.cpp:641

SX127x::clearFHSSInt
void clearFHSSInt(void)
Clear the FHSS interrupt.
Definition SX127x.cpp:1936

SX127x::setAFC
int16_t setAFC(bool isEnabled)
Enables or disables FSK automatic frequency correction(AFC)
Definition SX127x.cpp:940

SX127x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
Definition SX127x.cpp:829

SX127x::getLoRaRxHeaderInfo
int16_t getLoRaRxHeaderInfo(uint8_t *cr, bool *hasCRC)
Get LoRa header information from last received packet. Only valid in explicit header mode.
Definition SX127x.cpp:1155

SX127x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition SX127x.cpp:1127

SX127x::getSNR
float getSNR() override
Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
Definition SX127x.cpp:782

SX127x::setOokPeakThresholdStep
int16_t setOokPeakThresholdStep(uint8_t value)
Size of each decrement of the RSSI threshold in the OOK demodulator.
Definition SX127x.cpp:1070

SX127x::getAFCError
float getAFCError()
Gets current AFC error.
Definition SX127x.cpp:766

SX127x::setRSSIThreshold
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition SX127x.cpp:1419

SX127x::launchMode
int16_t launchMode() override
Launch previously staged mode.
Definition SX127x.cpp:1891

SX127x::receive
int16_t receive(uint8_t *data, size_t len, RadioLibTime_t timeout=0) override
Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa ...
Definition SX127x.cpp:207

SX127x::getFHSSChannel
uint8_t getFHSSChannel(void)
Gets the FHSS channel in use.
Definition SX127x.cpp:1932

SX127x::invertPreamble
int16_t invertPreamble(bool enable)
Invert FSK preamble polarity. The default (non-inverted) is 0x55, the inverted is 0xAA.
Definition SX127x.cpp:694

SX127x::setAFCBandwidth
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition SX127x.cpp:864

SX127x::getNumSymbols
float getNumSymbols(size_t len, DataRate_t dr, PacketConfig_t pc)
Convert from bytes to LoRa symbols.
Definition SX127x.cpp:1177

SX127x::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition SX127x.cpp:413

SX127x::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition SX127x.cpp:588

SX127x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition SX127x.cpp:1169

SX127x::setFifoEmptyAction
void setFifoEmptyAction(void(*func)(void))
Set interrupt service routine function to call when FIFO is empty.
Definition SX127x.cpp:433

SX127x::clearDio0Action
void clearDio0Action()
Clears interrupt service routine to call when DIO0 activates.
Definition SX127x.cpp:391

SX127x::transmit
int16_t transmit(const 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 ...
Definition SX127x.cpp:167

SX127x::standby
int16_t standby() override
Sets the LoRa module to standby.
Definition SX127x.cpp:295

SX127x::setDio1Action
void setDio1Action(void(*func)(void), uint32_t dir)
Set interrupt service routine function to call when DIO1 activates.
Definition SX127x.cpp:395

SX127x::setDIOPreambleDetect
int16_t setDIOPreambleDetect(bool usePreambleDetect)
Configure DIO mapping to use RSSI or Preamble Detect for pins that support it.
Definition SX127x.cpp:1955

SX127x::setFifoThreshold
void setFifoThreshold(uint8_t threshold)
Set FIFO threshold level. Be aware that threshold is also set in setFifoFullAction method....
Definition SX127x.cpp:442

SX127x::begin
int16_t begin(const uint8_t *chipVersions, uint8_t numVersions, uint8_t syncWord, uint16_t preambleLength)
Initialization method. Will be called with appropriate parameters when calling initialization method ...
Definition SX127x.cpp:11

SX127x::setFHSSHoppingPeriod
int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)
Sets the hopping period and enables FHSS.
Definition SX127x.cpp:1924

SX127x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition SX127x.cpp:510

SX127x::disableBitSync
int16_t disableBitSync()
Disable Bit synchronizer (not allowed in Packet mode).
Definition SX127x.cpp:1082

SX127x::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition SX127x.cpp:621

SX127x::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in ...
Definition SX127x.cpp:665

SX127x::setOokThresholdType
int16_t setOokThresholdType(uint8_t type)
Selects the type of threshold in the OOK data slicer.
Definition SX127x.cpp:1046

SX127x::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 SX127x.cpp:1498

SX127x::getTempRaw
int8_t getTempRaw()
Reads uncalibrated temperature value. This function will change operating mode and should not be call...
Definition SX127x.cpp:1535

SX127x::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition SX127x.cpp:1506

SX127x::calculateTimeOnAir
RadioLibTime_t calculateTimeOnAir(ModemType_t modem, DataRate_t dr, PacketConfig_t pc, size_t len) override
Calculate the expected time-on-air for a given modem, data rate, packet configuration and payload siz...
Definition SX127x.cpp:1197

SX127x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition SX127x.cpp:402

SX127x::setLowBatteryThreshold
int16_t setLowBatteryThreshold(int8_t level, uint32_t pin=RADIOLIB_NC)
Set low battery indicator threshold.
Definition SX127x.cpp:2020

SX127x::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition SX127x.cpp:1219

SX127x::clearIrqFlags
int16_t clearIrqFlags(uint32_t irq) override
Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition SX127x.cpp:1394

SX127x::receiveDirect
int16_t receiveDirect() override
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition SX127x.cpp:337

SX127x::clearFifoEmptyAction
void clearFifoEmptyAction()
Clears interrupt service routine to call when FIFO is empty.
Definition SX127x.cpp:438

SX127x::beginFSK
int16_t beginFSK(const uint8_t *chipVersions, uint8_t numVersions, float freqDev, float rxBw, uint16_t preambleLength)
Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK init...
Definition SX127x.cpp:71

SX127x::setOokPeakThresholdDecrement
int16_t setOokPeakThresholdDecrement(uint8_t value)
Period of decrement of the RSSI threshold in the OOK demodulator.
Definition SX127x.cpp:1062

SX127x::setIrqFlags
int16_t setIrqFlags(uint32_t irq) override
Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). NOTE: Unlike other ...
Definition SX127x.cpp:1292

SX127x::setAFCAGCTrigger
int16_t setAFCAGCTrigger(uint8_t trigger)
Controls trigger of AFC and AGC.
Definition SX127x.cpp:950

SX127x::setCrcFiltering
int16_t setCrcFiltering(bool enable=true)
Enable CRC filtering and generation.
Definition SX127x.cpp:1409

SX127x::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 SX127x.cpp:1502

SX127x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode.
Definition SX127x.cpp:1000

SX127x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition SX127x.cpp:1454

SX127x::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition SX127x.cpp:383

SX127x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...
Definition SX127x.cpp:1014

SX127x::readData
int16_t readData(uint8_t *data, size_t len) override
Reads data that was received after calling startReceive method. When the packet length is not known i...
Definition SX127x.cpp:523

SX127x::setChannelScanAction
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition SX127x.cpp:425

SX127x::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word. Only available in LoRa mode.
Definition SX127x.cpp:628

SX127x::getIRQFlags
uint16_t getIRQFlags()
Reads currently active IRQ flags, can be used to check which event caused an interrupt....
Definition SX127x.cpp:1473

SX127x::finishReceive
int16_t finishReceive() override
Clean up after reception is done.
Definition SX127x.cpp:579

SX127x::setRSSIConfig
int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)
Sets RSSI measurement configuration in FSK mode.
Definition SX127x.cpp:1425

SX127x::getFHSSHoppingPeriod
uint8_t getFHSSHoppingPeriod(void)
Gets FHSS hopping period.
Definition SX127x.cpp:1928

SX127x::calculateRxTimeout
RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override
Calculate the timeout value for this specific module / series (in number of symbols or units of time)
Definition SX127x.cpp:1270

SX127x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition SX127x.cpp:409

SX127x::setOOK
int16_t setOOK(bool enable)
Enables/disables OOK modulation instead of FSK.
Definition SX127x.cpp:1086

SX127x::setDirectAction
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition SX127x.cpp:1915

SX127x::setDio0Action
void setDio0Action(void(*func)(void), uint32_t dir)
Set interrupt service routine function to call when DIO0 activates.
Definition SX127x.cpp:387

SX127x::getChipVersion
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition SX127x.cpp:1531

SX127x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition SX127x.cpp:308

SX127x::getFrequencyError
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition SX127x.cpp:713

SX127x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition SX127x.cpp:1028

SX127x::enableOOK
bool enableOOK
Use OOK modulation instead of FSK.
Definition SX127x.h:632

SX127x::gain
uint8_t gain
Gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the ...
Definition SX127x.h:626

RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:679

Module::RfSwitchMode_t
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition Module.h:85

ChannelScanConfig_t
Common channel scan configuration structure.
Definition PhysicalLayer.h:165

DataRate_t
Common data rate structure.
Definition PhysicalLayer.h:74

PacketConfig_t
Common packet configuration structure.
Definition PhysicalLayer.h:119

RadioModeConfig_t
Definition PhysicalLayer.h:208