commit/155e614b08b26f1e7c113223a2358720a1dfcd5d/_s_x126x_8h_source.html

 #if !defined(_RADIOLIB_SX126X_H)

 #define _RADIOLIB_SX126X_H


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


 #if !defined(RADIOLIB_EXCLUDE_SX126X)


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


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


 // SX126X physical layer properties

 #define RADIOLIB_SX126X_FREQUENCY_STEP_SIZE                    0.9536743164

 #define RADIOLIB_SX126X_MAX_PACKET_LENGTH                      255

 #define RADIOLIB_SX126X_CRYSTAL_FREQ                           32.0

 #define RADIOLIB_SX126X_DIV_EXPONENT                           25


 // SX126X SPI commands

 // operational modes commands

 #define RADIOLIB_SX126X_CMD_NOP                                0x00

 #define RADIOLIB_SX126X_CMD_SET_SLEEP                          0x84

 #define RADIOLIB_SX126X_CMD_SET_STANDBY                        0x80

 #define RADIOLIB_SX126X_CMD_SET_FS                             0xC1

 #define RADIOLIB_SX126X_CMD_SET_TX                             0x83

 #define RADIOLIB_SX126X_CMD_SET_RX                             0x82

 #define RADIOLIB_SX126X_CMD_STOP_TIMER_ON_PREAMBLE             0x9F

 #define RADIOLIB_SX126X_CMD_SET_RX_DUTY_CYCLE                  0x94

 #define RADIOLIB_SX126X_CMD_SET_CAD                            0xC5

 #define RADIOLIB_SX126X_CMD_SET_TX_CONTINUOUS_WAVE             0xD1

 #define RADIOLIB_SX126X_CMD_SET_TX_INFINITE_PREAMBLE           0xD2

 #define RADIOLIB_SX126X_CMD_SET_REGULATOR_MODE                 0x96

 #define RADIOLIB_SX126X_CMD_CALIBRATE                          0x89

 #define RADIOLIB_SX126X_CMD_CALIBRATE_IMAGE                    0x98

 #define RADIOLIB_SX126X_CMD_SET_PA_CONFIG                      0x95

 #define RADIOLIB_SX126X_CMD_SET_RX_TX_FALLBACK_MODE            0x93


 // register and buffer access commands

 #define RADIOLIB_SX126X_CMD_WRITE_REGISTER                     0x0D

 #define RADIOLIB_SX126X_CMD_READ_REGISTER                      0x1D

 #define RADIOLIB_SX126X_CMD_WRITE_BUFFER                       0x0E

 #define RADIOLIB_SX126X_CMD_READ_BUFFER                        0x1E


 // DIO and IRQ control

 #define RADIOLIB_SX126X_CMD_SET_DIO_IRQ_PARAMS                 0x08

 #define RADIOLIB_SX126X_CMD_GET_IRQ_STATUS                     0x12

 #define RADIOLIB_SX126X_CMD_CLEAR_IRQ_STATUS                   0x02

 #define RADIOLIB_SX126X_CMD_SET_DIO2_AS_RF_SWITCH_CTRL         0x9D

 #define RADIOLIB_SX126X_CMD_SET_DIO3_AS_TCXO_CTRL              0x97


 // RF, modulation and packet commands

 #define RADIOLIB_SX126X_CMD_SET_RF_FREQUENCY                   0x86

 #define RADIOLIB_SX126X_CMD_SET_PACKET_TYPE                    0x8A

 #define RADIOLIB_SX126X_CMD_GET_PACKET_TYPE                    0x11

 #define RADIOLIB_SX126X_CMD_SET_TX_PARAMS                      0x8E

 #define RADIOLIB_SX126X_CMD_SET_MODULATION_PARAMS              0x8B

 #define RADIOLIB_SX126X_CMD_SET_PACKET_PARAMS                  0x8C

 #define RADIOLIB_SX126X_CMD_SET_CAD_PARAMS                     0x88

 #define RADIOLIB_SX126X_CMD_SET_BUFFER_BASE_ADDRESS            0x8F

 #define RADIOLIB_SX126X_CMD_SET_LORA_SYMB_NUM_TIMEOUT          0x0A


 // status commands

 #define RADIOLIB_SX126X_CMD_GET_STATUS                         0xC0

 #define RADIOLIB_SX126X_CMD_GET_RSSI_INST                      0x15

 #define RADIOLIB_SX126X_CMD_GET_RX_BUFFER_STATUS               0x13

 #define RADIOLIB_SX126X_CMD_GET_PACKET_STATUS                  0x14

 #define RADIOLIB_SX126X_CMD_GET_DEVICE_ERRORS                  0x17

 #define RADIOLIB_SX126X_CMD_CLEAR_DEVICE_ERRORS                0x07

 #define RADIOLIB_SX126X_CMD_GET_STATS                          0x10

 #define RADIOLIB_SX126X_CMD_RESET_STATS                        0x00


 #define RADIOLIB_SX126X_CMD_PRAM_UPDATE                        0xD9

 #define RADIOLIB_SX126X_CMD_SET_LBT_SCAN_PARAMS                0x9A

 #define RADIOLIB_SX126X_CMD_SET_SPECTR_SCAN_PARAMS             0x9B


 // SX126X register map

 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_0                0x029F // SX1268 datasheet v1.1, section 9.6

 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_1                0x02A0 // SX1268 datasheet v1.1, section 9.6

 #define RADIOLIB_SX126X_REG_RX_GAIN_RETENTION_2                0x02A1 // SX1268 datasheet v1.1, section 9.6

 #define RADIOLIB_SX126X_REG_VERSION_STRING                     0x0320

 #define RADIOLIB_SX126X_REG_HOPPING_ENABLE                     0x0385

 #define RADIOLIB_SX126X_REG_LR_FHSS_PACKET_LENGTH              0x0386

 #define RADIOLIB_SX126X_REG_LR_FHSS_NUM_HOPPING_BLOCKS         0x0387

 #define RADIOLIB_SX126X_REG_LR_FHSS_NUM_SYMBOLS_FREQX_MSB(X)   (0x0388 + (X)*6)

 #define RADIOLIB_SX126X_REG_LR_FHSS_NUM_SYMBOLS_FREQX_LSB(X)   (0x0389 + (X)*6)

 #define RADIOLIB_SX126X_REG_LR_FHSS_FREQX_0(X)                 (0x038A + (X)*6)

 #define RADIOLIB_SX126X_REG_LR_FHSS_FREQX_1(X)                 (0x038B + (X)*6)

 #define RADIOLIB_SX126X_REG_LR_FHSS_FREQX_2(X)                 (0x038C + (X)*6)

 #define RADIOLIB_SX126X_REG_LR_FHSS_FREQX_3(X)                 (0x038D + (X)*6)

 #define RADIOLIB_SX126X_REG_SPECTRAL_SCAN_RESULT               0x0401

 #define RADIOLIB_SX126X_REG_DIOX_OUT_ENABLE                    0x0580

 #define RADIOLIB_SX126X_REG_DIOX_DRIVE_STRENGTH                0x0582

 #define RADIOLIB_SX126X_REG_DIOX_IN_ENABLE                     0x0583

 #define RADIOLIB_SX126X_REG_DIOX_PULL_UP_CTRL                  0x0584

 #define RADIOLIB_SX126X_REG_DIOX_PULL_DOWN_CTRL                0x0585

 #define RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_0                0x0587

 #define RADIOLIB_SX126X_REG_PATCH_UPDATE_ENABLE                0x0610

 #define RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_1                0x0680

 #define RADIOLIB_SX126X_REG_WHITENING_INITIAL_MSB              0x06B8

 #define RADIOLIB_SX126X_REG_WHITENING_INITIAL_LSB              0x06B9

 #define RADIOLIB_SX126X_REG_RX_TX_PLD_LEN                      0x06BB

 #define RADIOLIB_SX126X_REG_CRC_INITIAL_MSB                    0x06BC

 #define RADIOLIB_SX126X_REG_CRC_INITIAL_LSB                    0x06BD

 #define RADIOLIB_SX126X_REG_CRC_POLYNOMIAL_MSB                 0x06BE

 #define RADIOLIB_SX126X_REG_CRC_POLYNOMIAL_LSB                 0x06BF

 #define RADIOLIB_SX126X_REG_SYNC_WORD_0                        0x06C0

 #define RADIOLIB_SX126X_REG_SYNC_WORD_1                        0x06C1

 #define RADIOLIB_SX126X_REG_SYNC_WORD_2                        0x06C2

 #define RADIOLIB_SX126X_REG_SYNC_WORD_3                        0x06C3

 #define RADIOLIB_SX126X_REG_SYNC_WORD_4                        0x06C4

 #define RADIOLIB_SX126X_REG_SYNC_WORD_5                        0x06C5

 #define RADIOLIB_SX126X_REG_SYNC_WORD_6                        0x06C6

 #define RADIOLIB_SX126X_REG_SYNC_WORD_7                        0x06C7

 #define RADIOLIB_SX126X_REG_NODE_ADDRESS                       0x06CD

 #define RADIOLIB_SX126X_REG_BROADCAST_ADDRESS                  0x06CE

 #define RADIOLIB_SX126X_REG_PAYLOAD_LENGTH                     0x0702

 #define RADIOLIB_SX126X_REG_PACKET_PARAMS                      0x0704

 #define RADIOLIB_SX126X_REG_IQ_CONFIG                          0x0736

 #define RADIOLIB_SX126X_REG_LORA_SYNC_WORD_MSB                 0x0740

 #define RADIOLIB_SX126X_REG_LORA_SYNC_WORD_LSB                 0x0741

 #define RADIOLIB_SX126X_REG_FREQ_ERROR                         0x076B

 #define RADIOLIB_SX126X_REG_SPECTRAL_SCAN_STATUS               0x07CD

 #define RADIOLIB_SX126X_REG_RX_ADDR_PTR                        0x0803

 #define RADIOLIB_SX126X_REG_RANDOM_NUMBER_0                    0x0819

 #define RADIOLIB_SX126X_REG_RANDOM_NUMBER_1                    0x081A

 #define RADIOLIB_SX126X_REG_RANDOM_NUMBER_2                    0x081B

 #define RADIOLIB_SX126X_REG_RANDOM_NUMBER_3                    0x081C

 #define RADIOLIB_SX126X_REG_SENSITIVITY_CONFIG                 0x0889 // SX1268 datasheet v1.1, section 15.1

 #define RADIOLIB_SX126X_REG_RF_FREQUENCY_0                     0x088B

 #define RADIOLIB_SX126X_REG_RF_FREQUENCY_1                     0x088C

 #define RADIOLIB_SX126X_REG_RF_FREQUENCY_2                     0x088D

 #define RADIOLIB_SX126X_REG_RF_FREQUENCY_3                     0x088E

 #define RADIOLIB_SX126X_REG_RSSI_AVG_WINDOW                    0x089B

 #define RADIOLIB_SX126X_REG_RX_GAIN                            0x08AC

 #define RADIOLIB_SX126X_REG_TX_CLAMP_CONFIG                    0x08D8

 #define RADIOLIB_SX126X_REG_LNA_CAP_TUNE_N                     0x08E3

 #define RADIOLIB_SX126X_REG_LNA_CAP_TUNE_P                     0x08E4

 #define RADIOLIB_SX126X_REG_OCP_CONFIGURATION                  0x08E7

 #define RADIOLIB_SX126X_REG_RTC_CTRL                           0x0902

 #define RADIOLIB_SX126X_REG_XTA_TRIM                           0x0911

 #define RADIOLIB_SX126X_REG_XTB_TRIM                           0x0912

 #define RADIOLIB_SX126X_REG_DIO3_OUT_VOLTAGE_CTRL              0x0920

 #define RADIOLIB_SX126X_REG_EVENT_MASK                         0x0944

 #define RADIOLIB_SX126X_REG_PATCH_MEMORY_BASE                  0x8000


 // SX126X SPI command variables

 //RADIOLIB_SX126X_CMD_SET_SLEEP                                                MSB   LSB   DESCRIPTION

 #define RADIOLIB_SX126X_SLEEP_START_COLD                       0b00000000  //  2     2     sleep mode: cold start, configuration is lost (default)

 #define RADIOLIB_SX126X_SLEEP_START_WARM                       0b00000100  //  2     2                 warm start, configuration is retained

 #define RADIOLIB_SX126X_SLEEP_RTC_OFF                          0b00000000  //  0     0     wake on RTC timeout: disabled

 #define RADIOLIB_SX126X_SLEEP_RTC_ON                           0b00000001  //  0     0                          enabled


 //RADIOLIB_SX126X_CMD_SET_STANDBY

 #define RADIOLIB_SX126X_STANDBY_RC                             0x00        //  7     0     standby mode: 13 MHz RC oscillator

 #define RADIOLIB_SX126X_STANDBY_XOSC                           0x01        //  7     0                   32 MHz crystal oscillator


 //RADIOLIB_SX126X_CMD_SET_RX

 #define RADIOLIB_SX126X_RX_TIMEOUT_NONE                        0x000000    //  23    0     Rx timeout duration: no timeout (Rx single mode)

 #define RADIOLIB_SX126X_RX_TIMEOUT_INF                         0xFFFFFF    //  23    0                          infinite (Rx continuous mode)


 //RADIOLIB_SX126X_CMD_SET_TX

 #define RADIOLIB_SX126X_TX_TIMEOUT_NONE                        0x000000    //  23    0     Tx timeout duration: no timeout (Tx single mode)


 //RADIOLIB_SX126X_CMD_STOP_TIMER_ON_PREAMBLE

 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_OFF                   0x00        //  7     0     stop timer on: sync word or header (default)

 #define RADIOLIB_SX126X_STOP_ON_PREAMBLE_ON                    0x01        //  7     0                    preamble detection


 //RADIOLIB_SX126X_CMD_SET_REGULATOR_MODE

 #define RADIOLIB_SX126X_REGULATOR_LDO                          0x00        //  7     0     set regulator mode: LDO (default)

 #define RADIOLIB_SX126X_REGULATOR_DC_DC                        0x01        //  7     0                         DC-DC


 //RADIOLIB_SX126X_CMD_CALIBRATE

 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_OFF                    0b00000000  //  6     6     image calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_IMAGE_ON                     0b01000000  //  6     6                        enabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_OFF               0b00000000  //  5     5     ADC bulk P calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_P_ON                0b00100000  //  5     5                             enabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_OFF               0b00000000  //  4     4     ADC bulk N calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_BULK_N_ON                0b00010000  //  4     4                             enabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_OFF                0b00000000  //  3     3     ADC pulse calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_ADC_PULSE_ON                 0b00001000  //  3     3                            enabled

 #define RADIOLIB_SX126X_CALIBRATE_PLL_OFF                      0b00000000  //  2     2     PLL calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_PLL_ON                       0b00000100  //  2     2                      enabled

 #define RADIOLIB_SX126X_CALIBRATE_RC13M_OFF                    0b00000000  //  1     1     13 MHz RC osc. calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_RC13M_ON                     0b00000010  //  1     1                                 enabled

 #define RADIOLIB_SX126X_CALIBRATE_RC64K_OFF                    0b00000000  //  0     0     64 kHz RC osc. calibration: disabled

 #define RADIOLIB_SX126X_CALIBRATE_RC64K_ON                     0b00000001  //  0     0                                 enabled

 #define RADIOLIB_SX126X_CALIBRATE_ALL                          0b01111111  //  6     0     calibrate all blocks


 //RADIOLIB_SX126X_CMD_CALIBRATE_IMAGE

 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_1                      0x6B

 #define RADIOLIB_SX126X_CAL_IMG_430_MHZ_2                      0x6F

 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_1                      0x75

 #define RADIOLIB_SX126X_CAL_IMG_470_MHZ_2                      0x81

 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_1                      0xC1

 #define RADIOLIB_SX126X_CAL_IMG_779_MHZ_2                      0xC5

 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_1                      0xD7

 #define RADIOLIB_SX126X_CAL_IMG_863_MHZ_2                      0xDB

 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_1                      0xE1

 #define RADIOLIB_SX126X_CAL_IMG_902_MHZ_2                      0xE9


 //RADIOLIB_SX126X_CMD_SET_PA_CONFIG

 #define RADIOLIB_SX126X_PA_CONFIG_HP_MAX                       0x07

 #define RADIOLIB_SX126X_PA_CONFIG_PA_LUT                       0x01

 #define RADIOLIB_SX126X_PA_CONFIG_SX1262_8                     0x00


 //RADIOLIB_SX126X_CMD_SET_RX_TX_FALLBACK_MODE

 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_FS                 0x40        //  7     0     after Rx/Tx go to: FS mode

 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_XOSC         0x30        //  7     0                        standby with crystal oscillator

 #define RADIOLIB_SX126X_RX_TX_FALLBACK_MODE_STDBY_RC           0x20        //  7     0                        standby with RC oscillator (default)


 //RADIOLIB_SX126X_CMD_SET_DIO_IRQ_PARAMS

 #define RADIOLIB_SX126X_IRQ_LR_FHSS_HOP                      0b0100000000000000  //  14    14    PA ramped up during LR-FHSS hop

 #define RADIOLIB_SX126X_IRQ_TIMEOUT                          0b0000001000000000  //  9     9     Rx or Tx timeout

 #define RADIOLIB_SX126X_IRQ_CAD_DETECTED                     0b0000000100000000  //  8     8     channel activity detected

 #define RADIOLIB_SX126X_IRQ_CAD_DONE                         0b0000000010000000  //  7     7     channel activity detection finished

 #define RADIOLIB_SX126X_IRQ_CRC_ERR                          0b0000000001000000  //  6     6     wrong CRC received

 #define RADIOLIB_SX126X_IRQ_HEADER_ERR                       0b0000000000100000  //  5     5     LoRa header CRC error

 #define RADIOLIB_SX126X_IRQ_HEADER_VALID                     0b0000000000010000  //  4     4     valid LoRa header received

 #define RADIOLIB_SX126X_IRQ_SYNC_WORD_VALID                  0b0000000000001000  //  3     3     valid sync word detected

 #define RADIOLIB_SX126X_IRQ_RADIOLIB_PREAMBLE_DETECTED       0b0000000000000100  //  2     2     preamble detected

 #define RADIOLIB_SX126X_IRQ_RX_DONE                          0b0000000000000010  //  1     1     packet received

 #define RADIOLIB_SX126X_IRQ_TX_DONE                          0b0000000000000001  //  0     0     packet transmission completed

 #define RADIOLIB_SX126X_IRQ_RX_DEFAULT                       0b0000001001100010  //  14    0     default for Rx (RX_DONE, TIMEOUT, CRC_ERR and HEADER_ERR)

 #define RADIOLIB_SX126X_IRQ_ALL                              0b0100001111111111  //  14    0     all interrupts

 #define RADIOLIB_SX126X_IRQ_NONE                             0b0000000000000000  //  14     0    no interrupts


 //RADIOLIB_SX126X_CMD_SET_DIO2_AS_RF_SWITCH_CTRL

 #define RADIOLIB_SX126X_DIO2_AS_IRQ                            0x00        //  7     0     DIO2 configuration: IRQ

 #define RADIOLIB_SX126X_DIO2_AS_RF_SWITCH                      0x01        //  7     0                         RF switch control


 //RADIOLIB_SX126X_CMD_SET_DIO3_AS_TCXO_CTRL

 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_6                        0x00        //  7     0     DIO3 voltage output for TCXO: 1.6 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_7                        0x01        //  7     0                                   1.7 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_1_8                        0x02        //  7     0                                   1.8 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_2                        0x03        //  7     0                                   2.2 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_4                        0x04        //  7     0                                   2.4 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_2_7                        0x05        //  7     0                                   2.7 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_0                        0x06        //  7     0                                   3.0 V

 #define RADIOLIB_SX126X_DIO3_OUTPUT_3_3                        0x07        //  7     0                                   3.3 V


 //RADIOLIB_SX126X_CMD_SET_PACKET_TYPE

 #define RADIOLIB_SX126X_PACKET_TYPE_GFSK                       0x00        //  7     0     packet type: GFSK

 #define RADIOLIB_SX126X_PACKET_TYPE_LORA                       0x01        //  7     0                  LoRa

 #define RADIOLIB_SX126X_PACKET_TYPE_LR_FHSS                    0x03        //  7     0                  LR-FHSS


 //RADIOLIB_SX126X_CMD_SET_TX_PARAMS

 #define RADIOLIB_SX126X_PA_RAMP_10U                            0x00        //  7     0     ramp time: 10 us

 #define RADIOLIB_SX126X_PA_RAMP_20U                            0x01        //  7     0                20 us

 #define RADIOLIB_SX126X_PA_RAMP_40U                            0x02        //  7     0                40 us

 #define RADIOLIB_SX126X_PA_RAMP_80U                            0x03        //  7     0                80 us

 #define RADIOLIB_SX126X_PA_RAMP_200U                           0x04        //  7     0                200 us

 #define RADIOLIB_SX126X_PA_RAMP_800U                           0x05        //  7     0                800 us

 #define RADIOLIB_SX126X_PA_RAMP_1700U                          0x06        //  7     0                1700 us

 #define RADIOLIB_SX126X_PA_RAMP_3400U                          0x07        //  7     0                3400 us


 //RADIOLIB_SX126X_CMD_SET_MODULATION_PARAMS

 #define RADIOLIB_SX126X_GFSK_FILTER_NONE                       0x00        //  7     0     GFSK filter: none

 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_3                  0x08        //  7     0                  Gaussian, BT = 0.3

 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_5                  0x09        //  7     0                  Gaussian, BT = 0.5

 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_0_7                  0x0A        //  7     0                  Gaussian, BT = 0.7

 #define RADIOLIB_SX126X_GFSK_FILTER_GAUSS_1                    0x0B        //  7     0                  Gaussian, BT = 1

 #define RADIOLIB_SX126X_GFSK_RX_BW_4_8                         0x1F        //  7     0     GFSK Rx bandwidth: 4.8 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_5_8                         0x17        //  7     0                        5.8 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_7_3                         0x0F        //  7     0                        7.3 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_9_7                         0x1E        //  7     0                        9.7 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_11_7                        0x16        //  7     0                        11.7 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_14_6                        0x0E        //  7     0                        14.6 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_19_5                        0x1D        //  7     0                        19.5 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_23_4                        0x15        //  7     0                        23.4 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_29_3                        0x0D        //  7     0                        29.3 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_39_0                        0x1C        //  7     0                        39.0 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_46_9                        0x14        //  7     0                        46.9 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_58_6                        0x0C        //  7     0                        58.6 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_78_2                        0x1B        //  7     0                        78.2 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_93_8                        0x13        //  7     0                        93.8 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_117_3                       0x0B        //  7     0                        117.3 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_156_2                       0x1A        //  7     0                        156.2 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_187_2                       0x12        //  7     0                        187.2 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_234_3                       0x0A        //  7     0                        234.3 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_312_0                       0x19        //  7     0                        312.0 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_373_6                       0x11        //  7     0                        373.6 kHz

 #define RADIOLIB_SX126X_GFSK_RX_BW_467_0                       0x09        //  7     0                        467.0 kHz

 #define RADIOLIB_SX126X_LORA_BW_7_8                            0x00        //  7     0     LoRa bandwidth: 7.8 kHz

 #define RADIOLIB_SX126X_LORA_BW_10_4                           0x08        //  7     0                     10.4 kHz

 #define RADIOLIB_SX126X_LORA_BW_15_6                           0x01        //  7     0                     15.6 kHz

 #define RADIOLIB_SX126X_LORA_BW_20_8                           0x09        //  7     0                     20.8 kHz

 #define RADIOLIB_SX126X_LORA_BW_31_25                          0x02        //  7     0                     31.25 kHz

 #define RADIOLIB_SX126X_LORA_BW_41_7                           0x0A        //  7     0                     41.7 kHz

 #define RADIOLIB_SX126X_LORA_BW_62_5                           0x03        //  7     0                     62.5 kHz

 #define RADIOLIB_SX126X_LORA_BW_125_0                          0x04        //  7     0                     125.0 kHz

 #define RADIOLIB_SX126X_LORA_BW_250_0                          0x05        //  7     0                     250.0 kHz

 #define RADIOLIB_SX126X_LORA_BW_500_0                          0x06        //  7     0                     500.0 kHz

 #define RADIOLIB_SX126X_LORA_CR_4_5                            0x01        //  7     0     LoRa coding rate: 4/5

 #define RADIOLIB_SX126X_LORA_CR_4_6                            0x02        //  7     0                       4/6

 #define RADIOLIB_SX126X_LORA_CR_4_7                            0x03        //  7     0                       4/7

 #define RADIOLIB_SX126X_LORA_CR_4_8                            0x04        //  7     0                       4/8

 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_OFF        0x00        //  7     0     LoRa low data rate optimization: disabled

 #define RADIOLIB_SX126X_LORA_LOW_DATA_RATE_OPTIMIZE_ON         0x01        //  7     0                                      enabled


 //RADIOLIB_SX126X_CMD_SET_PACKET_PARAMS

 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_OFF               0x00        //  7     0     GFSK minimum preamble length before reception starts: detector disabled

 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_8                 0x04        //  7     0                                                           8 bits

 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16                0x05        //  7     0                                                           16 bits

 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_24                0x06        //  7     0                                                           24 bits

 #define RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_32                0x07        //  7     0                                                           32 bits

 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_OFF                  0x00        //  7     0     GFSK address filtering: disabled

 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE                 0x01        //  7     0                             node only

 #define RADIOLIB_SX126X_GFSK_ADDRESS_FILT_NODE_BROADCAST       0x02        //  7     0                             node and broadcast

 #define RADIOLIB_SX126X_GFSK_PACKET_FIXED                      0x00        //  7     0     GFSK packet type: fixed (payload length known in advance to both sides)

 #define RADIOLIB_SX126X_GFSK_PACKET_VARIABLE                   0x01        //  7     0                       variable (payload length added to packet)

 #define RADIOLIB_SX126X_GFSK_CRC_OFF                           0x01        //  7     0     GFSK packet CRC: disabled

 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE                        0x00        //  7     0                      1 byte

 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE                        0x02        //  7     0                      2 byte

 #define RADIOLIB_SX126X_GFSK_CRC_1_BYTE_INV                    0x04        //  7     0                      1 byte, inverted

 #define RADIOLIB_SX126X_GFSK_CRC_2_BYTE_INV                    0x06        //  7     0                      2 byte, inverted

 #define RADIOLIB_SX126X_GFSK_WHITENING_OFF                     0x00        //  7     0     GFSK data whitening: disabled

 #define RADIOLIB_SX126X_GFSK_WHITENING_ON                      0x01        //  7     0                          enabled

 #define RADIOLIB_SX126X_LORA_HEADER_EXPLICIT                   0x00        //  7     0     LoRa header mode: explicit

 #define RADIOLIB_SX126X_LORA_HEADER_IMPLICIT                   0x01        //  7     0                       implicit

 #define RADIOLIB_SX126X_LORA_CRC_OFF                           0x00        //  7     0     LoRa CRC mode: disabled

 #define RADIOLIB_SX126X_LORA_CRC_ON                            0x01        //  7     0                    enabled

 #define RADIOLIB_SX126X_LORA_IQ_STANDARD                       0x00        //  7     0     LoRa IQ setup: standard

 #define RADIOLIB_SX126X_LORA_IQ_INVERTED                       0x01        //  7     0                    inverted


 //RADIOLIB_SX126X_CMD_SET_CAD_PARAMS

 #define RADIOLIB_SX126X_CAD_ON_1_SYMB                          0x00        //  7     0     number of symbols used for CAD: 1

 #define RADIOLIB_SX126X_CAD_ON_2_SYMB                          0x01        //  7     0                                     2

 #define RADIOLIB_SX126X_CAD_ON_4_SYMB                          0x02        //  7     0                                     4

 #define RADIOLIB_SX126X_CAD_ON_8_SYMB                          0x03        //  7     0                                     8

 #define RADIOLIB_SX126X_CAD_ON_16_SYMB                         0x04        //  7     0                                     16

 #define RADIOLIB_SX126X_CAD_GOTO_STDBY                         0x00        //  7     0     after CAD is done, always go to STDBY_RC mode

 #define RADIOLIB_SX126X_CAD_GOTO_RX                            0x01        //  7     0     after CAD is done, go to Rx mode if activity is detected

 #define RADIOLIB_SX126X_CAD_PARAM_DEFAULT                      0xFF        //  7     0     used by the CAD methods to specify default parameter value

 #define RADIOLIB_SX126X_CAD_PARAM_DET_MIN                      10          //  7     0     default detMin CAD parameter


 //RADIOLIB_SX126X_CMD_GET_STATUS

 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_RC                   0b00100000  //  6     4     current chip mode: STDBY_RC

 #define RADIOLIB_SX126X_STATUS_MODE_STDBY_XOSC                 0b00110000  //  6     4                        STDBY_XOSC

 #define RADIOLIB_SX126X_STATUS_MODE_FS                         0b01000000  //  6     4                        FS

 #define RADIOLIB_SX126X_STATUS_MODE_RX                         0b01010000  //  6     4                        RX

 #define RADIOLIB_SX126X_STATUS_MODE_TX                         0b01100000  //  6     4                        TX

 #define RADIOLIB_SX126X_STATUS_DATA_AVAILABLE                  0b00000100  //  3     1     command status: packet received and data can be retrieved

 #define RADIOLIB_SX126X_STATUS_CMD_TIMEOUT                     0b00000110  //  3     1                     SPI command timed out

 #define RADIOLIB_SX126X_STATUS_CMD_INVALID                     0b00001000  //  3     1                     invalid SPI command

 #define RADIOLIB_SX126X_STATUS_CMD_FAILED                      0b00001010  //  3     1                     SPI command failed to execute

 #define RADIOLIB_SX126X_STATUS_TX_DONE                         0b00001100  //  3     1                     packet transmission done

 #define RADIOLIB_SX126X_STATUS_SPI_FAILED                      0b11111111  //  7     0     SPI transaction failed


 //RADIOLIB_SX126X_CMD_GET_PACKET_STATUS

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PREAMBLE_ERR            0b10000000  //  7     7     GFSK Rx status: preamble error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_SYNC_ERR                0b01000000  //  6     6                     sync word error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ADRS_ERR                0b00100000  //  5     5                     address error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_CRC_ERR                 0b00010000  //  4     4                     CRC error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_LENGTH_ERR              0b00001000  //  3     3                     length error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_ABORT_ERR               0b00000100  //  2     2                     abort error

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_RECEIVED         0b00000010  //  2     2                     packet received

 #define RADIOLIB_SX126X_GFSK_RX_STATUS_PACKET_SENT             0b00000001  //  2     2                     packet sent


 //RADIOLIB_SX126X_CMD_GET_DEVICE_ERRORS

 #define RADIOLIB_SX126X_PA_RAMP_ERR                           0b100000000  //  8     8     device errors: PA ramping failed

 #define RADIOLIB_SX126X_PLL_LOCK_ERR                          0b001000000  //  6     6                    PLL failed to lock

 #define RADIOLIB_SX126X_XOSC_START_ERR                        0b000100000  //  5     5                    crystal oscillator failed to start

 #define RADIOLIB_SX126X_IMG_CALIB_ERR                         0b000010000  //  4     4                    image calibration failed

 #define RADIOLIB_SX126X_ADC_CALIB_ERR                         0b000001000  //  3     3                    ADC calibration failed

 #define RADIOLIB_SX126X_PLL_CALIB_ERR                         0b000000100  //  2     2                    PLL calibration failed

 #define RADIOLIB_SX126X_RC13M_CALIB_ERR                       0b000000010  //  1     1                    RC13M calibration failed

 #define RADIOLIB_SX126X_RC64K_CALIB_ERR                       0b000000001  //  0     0                    RC64K calibration failed


 //RADIOLIB_SX126X_CMD_SET_LBT_SCAN_PARAMS + RADIOLIB_SX126X_CMD_SET_SPECTR_SCAN_PARAMS

 #define RADIOLIB_SX126X_SCAN_INTERVAL_7_68_US                  10          //  7     0     RSSI reading interval: 7.68 us

 #define RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US                  11          //  7     0                            8.20 us

 #define RADIOLIB_SX126X_SCAN_INTERVAL_8_68_US                  12          //  7     0                            8.68 us


 // SX126X SPI register variables

 //RADIOLIB_SX126X_REG_HOPPING_ENABLE

 #define RADIOLIB_SX126X_HOPPING_ENABLED                        0b00000001  //  0     0     intra-packet hopping for LR-FHSS: enabled

 #define RADIOLIB_SX126X_HOPPING_DISABLED                       0b00000000  //  0     0                                       (disabled)


 //RADIOLIB_SX126X_REG_LORA_SYNC_WORD_MSB + LSB

 #define RADIOLIB_SX126X_SYNC_WORD_PUBLIC                       0x34        // actually 0x3444  NOTE: The low nibbles in each byte (0x_4_4) are masked out since apparently, they're reserved.

 #define RADIOLIB_SX126X_SYNC_WORD_PRIVATE                      0x12        // actually 0x1424        You couldn't make this up if you tried.


 // RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_1

 #define RADIOLIB_SX126X_TX_BITBANG_1_DISABLED                  0b00000000  //  6     4     Tx bitbang: disabled (default)

 #define RADIOLIB_SX126X_TX_BITBANG_1_ENABLED                   0b00010000  //  6     4                 enabled


 // RADIOLIB_SX126X_REG_TX_BITBANG_ENABLE_0

 #define RADIOLIB_SX126X_TX_BITBANG_0_DISABLED                  0b00000000  //  3     0     Tx bitbang: disabled (default)

 #define RADIOLIB_SX126X_TX_BITBANG_0_ENABLED                   0b00001100  //  3     0                 enabled


 // RADIOLIB_SX126X_REG_DIOX_OUT_ENABLE

 #define RADIOLIB_SX126X_DIO1_OUT_DISABLED                      0b00000010  //  1     1     DIO1 output: disabled

 #define RADIOLIB_SX126X_DIO1_OUT_ENABLED                       0b00000000  //  1     1                  enabled

 #define RADIOLIB_SX126X_DIO2_OUT_DISABLED                      0b00000100  //  2     2     DIO2 output: disabled

 #define RADIOLIB_SX126X_DIO2_OUT_ENABLED                       0b00000000  //  2     2                  enabled

 #define RADIOLIB_SX126X_DIO3_OUT_DISABLED                      0b00001000  //  3     3     DIO3 output: disabled

 #define RADIOLIB_SX126X_DIO3_OUT_ENABLED                       0b00000000  //  3     3                  enabled


 // RADIOLIB_SX126X_REG_DIOX_IN_ENABLE

 #define RADIOLIB_SX126X_DIO1_IN_DISABLED                       0b00000000  //  1     1     DIO1 input: disabled

 #define RADIOLIB_SX126X_DIO1_IN_ENABLED                        0b00000010  //  1     1                 enabled

 #define RADIOLIB_SX126X_DIO2_IN_DISABLED                       0b00000000  //  2     2     DIO2 input: disabled

 #define RADIOLIB_SX126X_DIO2_IN_ENABLED                        0b00000100  //  2     2                 enabled

 #define RADIOLIB_SX126X_DIO3_IN_DISABLED                       0b00000000  //  3     3     DIO3 input: disabled

 #define RADIOLIB_SX126X_DIO3_IN_ENABLED                        0b00001000  //  3     3                 enabled


 // RADIOLIB_SX126X_REG_RX_GAIN

 #define RADIOLIB_SX126X_RX_GAIN_BOOSTED                        0x96        //  7     0     Rx gain: boosted

 #define RADIOLIB_SX126X_RX_GAIN_POWER_SAVING                   0x94        //  7     0              power saving

 #define RADIOLIB_SX126X_RX_GAIN_SPECTRAL_SCAN                  0xCB        //  7     0              spectral scan


 // RADIOLIB_SX126X_REG_PATCH_UPDATE_ENABLE

 #define RADIOLIB_SX126X_PATCH_UPDATE_DISABLED                  0b00000000  //  4     4     patch update: disabled

 #define RADIOLIB_SX126X_PATCH_UPDATE_ENABLED                   0b00010000  //  4     4                   enabled


 // RADIOLIB_SX126X_REG_SPECTRAL_SCAN_STATUS

 #define RADIOLIB_SX126X_SPECTRAL_SCAN_NONE                     0x00        //  7     0     spectral scan status: none

 #define RADIOLIB_SX126X_SPECTRAL_SCAN_ONGOING                  0x0F        //  7     0                           ongoing

 #define RADIOLIB_SX126X_SPECTRAL_SCAN_ABORTED                  0xF0        //  7     0                           aborted

 #define RADIOLIB_SX126X_SPECTRAL_SCAN_COMPLETED                0xFF        //  7     0                           completed


 // RADIOLIB_SX126X_REG_RSSI_AVG_WINDOW

 #define RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT           (0x05 << 2) //  7     0     default RSSI average window


 #define RADIOLIB_SX126X_SPECTRAL_SCAN_RES_SIZE                 (33)


 class SX126x: public PhysicalLayer {

   public:

     // introduce PhysicalLayer overloads

     using PhysicalLayer::transmit;

     using PhysicalLayer::receive;

     using PhysicalLayer::startTransmit;

     using PhysicalLayer::readData;


     SX126x(Module* mod);


     Module* getMod();


     bool XTAL;


     // basic methods


     int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);


     int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO = false);


     int16_t reset(bool verify = true);


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


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


     int16_t transmitDirect(uint32_t frf = 0) override;


     int16_t receiveDirect() override;


     int16_t scanChannel(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);


     int16_t sleep(bool retainConfig = true);


     int16_t standby() override;


     int16_t standby(uint8_t mode);


     // interrupt methods


     void setDio1Action(void (*func)(void));


     void clearDio1Action();


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


     int16_t finishTransmit() override;


     int16_t startReceive(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, size_t len = 0);


     int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);


     int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);


     uint16_t getIrqStatus();


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


     int16_t startChannelScan(uint8_t symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT);


     int16_t getChannelScanResult();


     // configuration methods


     int16_t setBandwidth(float bw);


     int16_t setSpreadingFactor(uint8_t sf);


     int16_t setCodingRate(uint8_t cr);


     int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);


     int16_t setCurrentLimit(float currentLimit);


     float getCurrentLimit();


     int16_t setPreambleLength(uint16_t preambleLength);


     int16_t setFrequencyDeviation(float freqDev) override;


     int16_t setBitRate(float br);


     int16_t setRxBandwidth(float rxBw);


     int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);


     int16_t setDataShaping(uint8_t sh) override;


     int16_t setSyncWord(uint8_t* syncWord, uint8_t len);


     int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);


     int16_t setNodeAddress(uint8_t nodeAddr);


     int16_t setBroadcastAddress(uint8_t broadAddr);


     int16_t disableAddressFiltering();


     int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);


     int16_t setWhitening(bool enabled, uint16_t initial = 0x0100);


     int16_t setTCXO(float voltage, uint32_t delay = 5000);


     int16_t setDio2AsRfSwitch(bool enable = true);


     float getDataRate() const;


     float getRSSI();


     float getSNR();


     float getFrequencyError();


     size_t getPacketLength(bool update = true) override;


     int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);


     int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);


     uint32_t getTimeOnAir(size_t len);


     float getRSSIInst();


     int16_t implicitHeader(size_t len);


     int16_t explicitHeader();


     int16_t setRegulatorLDO();


     int16_t setRegulatorDCDC();


     int16_t setEncoding(uint8_t encoding) override;


     void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);


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


     int16_t forceLDRO(bool enable);


     int16_t autoLDRO();


     uint8_t randomByte();


     #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)

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


     void readBit(RADIOLIB_PIN_TYPE pin);

     #endif


     int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);


     int16_t spectralScanStart(uint16_t numScans, uint8_t window = RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);


     void spectralScanAbort();


     int16_t spectralScanGetStatus();


     int16_t spectralScanGetResult(uint16_t* results);


 #if !defined(RADIOLIB_GODMODE)

   protected:

 #endif

     // SX126x SPI command implementations

     int16_t setTx(uint32_t timeout = 0);

     int16_t setRx(uint32_t timeout);

     int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);

     int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);

     int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);

     int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);

     int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);

     int16_t readBuffer(uint8_t* data, uint8_t numBytes);

     int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);

     virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);

     int16_t setRfFrequency(uint32_t frf);

     int16_t calibrateImage(uint8_t* data);

     uint8_t getPacketType();

     int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);

     int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);

     int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);

     int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);

     int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);

     int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);

     int16_t setRegulatorMode(uint8_t mode);

     uint8_t getStatus();

     uint32_t getPacketStatus();

     uint16_t getDeviceErrors();

     int16_t clearDeviceErrors();


     int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);

     int16_t setFrequencyRaw(float freq);

     int16_t setPacketMode(uint8_t mode, uint8_t len);

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

     int16_t directMode();

     int16_t packetMode();


     // fixes to errata

     int16_t fixSensitivity();

     int16_t fixPaClamping(bool enable = true);

     int16_t fixImplicitTimeout();

     int16_t fixInvertedIQ(uint8_t iqConfig);


 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)

   protected:

 #endif

     Module* _mod;


     // common low-level SPI interface

     static int16_t SPIparseStatus(uint8_t in);


 #if !defined(RADIOLIB_GODMODE)

   protected:

 #endif


     uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;

     uint16_t _preambleLength = 0;

     float _bwKhz = 0;

     bool _ldroAuto = true;


     uint32_t _br = 0, _freqDev = 0;

     uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;

     uint16_t _preambleLengthFSK = 0;

     float _rxBwKhz = 0;


     float _dataRate = 0;


     uint32_t _tcxoDelay = 0;


     size_t _implicitLen = 0;

     const char* _chipType;


     // Allow subclasses to define different TX modes

     uint8_t _tx_mode = Module::MODE_TX;


     int16_t config(uint8_t modem);

     bool findChip(const char* verStr);

 };


 #endif


 #endif

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

Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35

Module::MODE_TX
@ MODE_TX
Definition: Module.h:64

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

PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12

PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153

PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134

PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:113

PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60

SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:432

SX126x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1248

SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:580

SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:462

SX126x::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX126x.cpp:1225

SX126x::startReceive
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:539

SX126x::startChannelScan
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:688

SX126x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:1000

SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1346

SX126x::setRfSwitchPins
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1358

SX126x::uploadPatch
int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)
Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...
Definition: SX126x.cpp:1418

SX126x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1354

SX126x::beginFSK
int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX126x.cpp:95

SX126x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:735

SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1342

SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1366

SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1080

SX126x::spectralScanGetStatus
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1487

SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1507

SX126x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:900

SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1350

SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:553

SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1184

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

SX126x::spectralScanStart
int16_t spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1467

SX126x::scanChannel
int16_t scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:420

SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:450

SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:858

SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:882

SX126x::getTimeOnAir
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1296

SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1387

SX126x::spectralScanAbort
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1483

SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:346

SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:531

SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:823

SX126x::setRxBoostedGainMode
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:963

SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:330

SX126x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1292

SX126x::begin
int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:13

SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1125

SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1659

SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:189

SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:812

SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:836

SX126x::SX126x
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:4

SX126x::setPreambleLength
int16_t setPreambleLength(uint16_t preambleLength)
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:845

SX126x::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12

SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1378

SX126x::setDirectAction
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: SX126x.cpp:1409

SX126x::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1288

SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1097

SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:714

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

SX126x::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1053

SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1221

SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&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: SX126x.cpp:1362

SX126x::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:452

SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1338

SX126x::getRSSIInst
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1331

SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1232

SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1560

SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1495

SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:786

SX126x::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:153

SX126x::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:134

SX126x::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60

SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1114

SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:799

SX126x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1413

Module::RfSwitchMode_t
Definition: Module.h:42