commit/c69e98de90135ef92ca6d8292779209ff4b5d226/_s_x128x_8h_source.html

 #if !defined(_RADIOLIB_SX128X_H)

 #define _RADIOLIB_SX128X_H


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


 #if !defined(RADIOLIB_EXCLUDE_SX128X)


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


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


 // SX128X physical layer properties

 #define RADIOLIB_SX128X_FREQUENCY_STEP_SIZE                    198.3642578

 #define RADIOLIB_SX128X_MAX_PACKET_LENGTH                      255

 #define RADIOLIB_SX128X_CRYSTAL_FREQ                           52.0

 #define RADIOLIB_SX128X_DIV_EXPONENT                           18


 // SX128X SPI commands

 #define RADIOLIB_SX128X_CMD_NOP                                0x00

 #define RADIOLIB_SX128X_CMD_GET_STATUS                         0xC0

 #define RADIOLIB_SX128X_CMD_WRITE_REGISTER                     0x18

 #define RADIOLIB_SX128X_CMD_READ_REGISTER                      0x19

 #define RADIOLIB_SX128X_CMD_WRITE_BUFFER                       0x1A

 #define RADIOLIB_SX128X_CMD_READ_BUFFER                        0x1B

 #define RADIOLIB_SX128X_CMD_SET_SLEEP                          0x84

 #define RADIOLIB_SX128X_CMD_SET_STANDBY                        0x80

 #define RADIOLIB_SX128X_CMD_SET_FS                             0xC1

 #define RADIOLIB_SX128X_CMD_SET_TX                             0x83

 #define RADIOLIB_SX128X_CMD_SET_RX                             0x82

 #define RADIOLIB_SX128X_CMD_SET_RX_DUTY_CYCLE                  0x94

 #define RADIOLIB_SX128X_CMD_SET_CAD                            0xC5

 #define RADIOLIB_SX128X_CMD_SET_TX_CONTINUOUS_WAVE             0xD1

 #define RADIOLIB_SX128X_CMD_SET_TX_CONTINUOUS_PREAMBLE         0xD2

 #define RADIOLIB_SX128X_CMD_SET_PACKET_TYPE                    0x8A

 #define RADIOLIB_SX128X_CMD_GET_PACKET_TYPE                    0x03

 #define RADIOLIB_SX128X_CMD_SET_RF_FREQUENCY                   0x86

 #define RADIOLIB_SX128X_CMD_SET_TX_PARAMS                      0x8E

 #define RADIOLIB_SX128X_CMD_SET_CAD_PARAMS                     0x88

 #define RADIOLIB_SX128X_CMD_SET_BUFFER_BASE_ADDRESS            0x8F

 #define RADIOLIB_SX128X_CMD_SET_MODULATION_PARAMS              0x8B

 #define RADIOLIB_SX128X_CMD_SET_PACKET_PARAMS                  0x8C

 #define RADIOLIB_SX128X_CMD_GET_RX_BUFFER_STATUS               0x17

 #define RADIOLIB_SX128X_CMD_GET_PACKET_STATUS                  0x1D

 #define RADIOLIB_SX128X_CMD_GET_RSSI_INST                      0x1F

 #define RADIOLIB_SX128X_CMD_SET_DIO_IRQ_PARAMS                 0x8D

 #define RADIOLIB_SX128X_CMD_GET_IRQ_STATUS                     0x15

 #define RADIOLIB_SX128X_CMD_CLEAR_IRQ_STATUS                   0x97

 #define RADIOLIB_SX128X_CMD_SET_REGULATOR_MODE                 0x96

 #define RADIOLIB_SX128X_CMD_SET_SAVE_CONTEXT                   0xD5

 #define RADIOLIB_SX128X_CMD_SET_AUTO_TX                        0x98

 #define RADIOLIB_SX128X_CMD_SET_AUTO_FS                        0x9E

 #define RADIOLIB_SX128X_CMD_SET_PERF_COUNTER_MODE              0x9C

 #define RADIOLIB_SX128X_CMD_SET_LONG_PREAMBLE                  0x9B

 #define RADIOLIB_SX128X_CMD_SET_UART_SPEED                     0x9D

 #define RADIOLIB_SX128X_CMD_SET_RANGING_ROLE                   0xA3

 #define RADIOLIB_SX128X_CMD_SET_ADVANCED_RANGING               0x9A


 // SX128X register map

 #define RADIOLIB_SX128X_REG_GAIN_MODE                          0x0891

 #define RADIOLIB_SX128X_REG_MANUAL_GAIN_CONTROL_ENABLE_2       0x0895

 #define RADIOLIB_SX128X_REG_MANUAL_GAIN_SETTING                0x089E

 #define RADIOLIB_SX128X_REG_MANUAL_GAIN_CONTROL_ENABLE_1       0x089F

 #define RADIOLIB_SX128X_REG_SYNCH_PEAK_ATTENUATION             0x08C2

 #define RADIOLIB_SX128X_REG_LORA_FIXED_PAYLOAD_LENGTH          0x0901

 #define RADIOLIB_SX128X_REG_LORA_HEADER_MODE                   0x0903

 #define RADIOLIB_SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_3      0x0912

 #define RADIOLIB_SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_2      0x0913

 #define RADIOLIB_SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_1      0x0914

 #define RADIOLIB_SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_0      0x0915

 #define RADIOLIB_SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_3       0x0916

 #define RADIOLIB_SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_2       0x0917

 #define RADIOLIB_SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_1       0x0918

 #define RADIOLIB_SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_0       0x0919

 #define RADIOLIB_SX128X_REG_RANGING_FILTER_WINDOW_SIZE         0x091E

 #define RADIOLIB_SX128X_REG_RANGING_FILTER_RESET               0x0923

 #define RADIOLIB_SX128X_REG_RANGING_TYPE                       0x0924

 #define RADIOLIB_SX128X_REG_LORA_SF_CONFIG                     0x0925

 #define RADIOLIB_SX128X_REG_RANGING_ADDRESS_SWITCH             0x0927

 #define RADIOLIB_SX128X_REG_RANGING_CALIBRATION_BYTE_2         0x092B

 #define RADIOLIB_SX128X_REG_RANGING_CALIBRATION_MSB            0x092C

 #define RADIOLIB_SX128X_REG_RANGING_CALIBRATION_LSB            0x092D

 #define RADIOLIB_SX128X_REG_SLAVE_RANGING_ADDRESS_WIDTH        0x0931

 #define RADIOLIB_SX128X_REG_FREQ_ERROR_CORRECTION              0x093C

 #define RADIOLIB_SX128X_REG_LORA_SYNC_WORD_MSB                 0x0944

 #define RADIOLIB_SX128X_REG_LORA_SYNC_WORD_LSB                 0x0945

 #define RADIOLIB_SX128X_REG_RANGING_FILTER_RSSI_OFFSET         0x0953

 #define RADIOLIB_SX128X_REG_FEI_MSB                            0x0954

 #define RADIOLIB_SX128X_REG_FEI_MID                            0x0955

 #define RADIOLIB_SX128X_REG_FEI_LSB                            0x0956

 #define RADIOLIB_SX128X_REG_RANGING_ADDRESS_MSB                0x095F

 #define RADIOLIB_SX128X_REG_RANGING_ADDRESS_LSB                0x0960

 #define RADIOLIB_SX128X_REG_RANGING_RESULT_MSB                 0x0961

 #define RADIOLIB_SX128X_REG_RANGING_RESULT_MID                 0x0962

 #define RADIOLIB_SX128X_REG_RANGING_RESULT_LSB                 0x0963

 #define RADIOLIB_SX128X_REG_RANGING_RSSI                       0x0964

 #define RADIOLIB_SX128X_REG_RANGING_LORA_CLOCK_ENABLE          0x097F

 #define RADIOLIB_SX128X_REG_PACKET_PREAMBLE_SETTINGS           0x09C1

 #define RADIOLIB_SX128X_REG_WHITENING_INITIAL_VALUE            0x09C5

 #define RADIOLIB_SX128X_REG_CRC_POLYNOMIAL_MSB                 0x09C6

 #define RADIOLIB_SX128X_REG_CRC_POLYNOMIAL_LSB                 0x09C7

 #define RADIOLIB_SX128X_REG_CRC_INITIAL_MSB                    0x09C8

 #define RADIOLIB_SX128X_REG_CRC_INITIAL_LSB                    0x09C9

 #define RADIOLIB_SX128X_REG_BLE_CRC_INITIAL_MSB                0x09C7

 #define RADIOLIB_SX128X_REG_BLE_CRC_INITIAL_MID                (RADIOLIB_SX128X_REG_CRC_INITIAL_MSB)

 #define RADIOLIB_SX128X_REG_BLE_CRC_INITIAL_LSB                (RADIOLIB_SX128X_REG_CRC_INITIAL_LSB)

 #define RADIOLIB_SX128X_REG_SYNCH_ADDRESS_CONTROL              0x09CD

 #define RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_4                 0x09CE

 #define RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_3                 0x09CF

 #define RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_2                 0x09D0

 #define RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_1                 0x09D1

 #define RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_0                 0x09D2

 #define RADIOLIB_SX128X_REG_SYNC_WORD_2_BYTE_4                 0x09D3

 #define RADIOLIB_SX128X_REG_SYNC_WORD_2_BYTE_3                 0x09D4

 #define RADIOLIB_SX128X_REG_SYNC_WORD_2_BYTE_2                 0x09D5

 #define RADIOLIB_SX128X_REG_SYNC_WORD_2_BYTE_1                 0x09D6

 #define RADIOLIB_SX128X_REG_SYNC_WORD_2_BYTE_0                 0x09D7

 #define RADIOLIB_SX128X_REG_SYNC_WORD_3_BYTE_4                 0x09D8

 #define RADIOLIB_SX128X_REG_SYNC_WORD_3_BYTE_3                 0x09D9

 #define RADIOLIB_SX128X_REG_SYNC_WORD_3_BYTE_2                 0x09DA

 #define RADIOLIB_SX128X_REG_SYNC_WORD_3_BYTE_1                 0x09DB

 #define RADIOLIB_SX128X_REG_SYNC_WORD_3_BYTE_0                 0x09DC

 #define RADIOLIB_SX128X_REG_ACCESS_ADDRESS_BYTE_3              (RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_3)

 #define RADIOLIB_SX128X_REG_ACCESS_ADDRESS_BYTE_2              (RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_2)

 #define RADIOLIB_SX128X_REG_ACCESS_ADDRESS_BYTE_1              (RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_1)

 #define RADIOLIB_SX128X_REG_ACCESS_ADDRESS_BYTE_0              (RADIOLIB_SX128X_REG_SYNC_WORD_1_BYTE_0)


 // SX128X SPI command variables

 //RADIOLIB_SX128X_CMD_GET_STATUS                                               MSB   LSB   DESCRIPTION

 #define RADIOLIB_SX128X_STATUS_MODE_STDBY_RC                   0b01000000  //  7     5     current chip mode: STDBY_RC

 #define RADIOLIB_SX128X_STATUS_MODE_STDBY_XOSC                 0b01100000  //  7     5                        STDBY_XOSC

 #define RADIOLIB_SX128X_STATUS_MODE_FS                         0b10000000  //  7     5                        FS

 #define RADIOLIB_SX128X_STATUS_MODE_RX                         0b10100000  //  7     5                        Rx

 #define RADIOLIB_SX128X_STATUS_MODE_TX                         0b11000000  //  7     5                        Tx

 #define RADIOLIB_SX128X_STATUS_CMD_PROCESSED                   0b00000100  //  4     2     command status: processing OK

 #define RADIOLIB_SX128X_STATUS_DATA_AVAILABLE                  0b00001000  //  4     2                     data available

 #define RADIOLIB_SX128X_STATUS_CMD_TIMEOUT                     0b00001100  //  4     2                     timeout

 #define RADIOLIB_SX128X_STATUS_CMD_ERROR                       0b00010000  //  4     2                     processing error

 #define RADIOLIB_SX128X_STATUS_CMD_FAILED                      0b00010100  //  4     2                     failed to execute

 #define RADIOLIB_SX128X_STATUS_TX_DONE                         0b00011000  //  4     2                     transmission finished

 #define RADIOLIB_SX128X_STATUS_BUSY                            0b00000001  //  0     0     chip busy

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


 //RADIOLIB_SX128X_CMD_SET_SLEEP

 #define RADIOLIB_SX128X_SLEEP_DATA_BUFFER_FLUSH                0b00000000  //  1     1     data buffer behavior in sleep mode: flush

 #define RADIOLIB_SX128X_SLEEP_DATA_BUFFER_RETAIN               0b00000010  //  1     1                                         retain

 #define RADIOLIB_SX128X_SLEEP_DATA_RAM_FLUSH                   0b00000000  //  0     0     data RAM (configuration) behavior in sleep mode: flush

 #define RADIOLIB_SX128X_SLEEP_DATA_RAM_RETAIN                  0b00000001  //  0     0                                                      retain


 //RADIOLIB_SX128X_CMD_SET_STANDBY

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

 #define RADIOLIB_SX128X_STANDBY_XOSC                           0x01        //  7     0                   52 MHz crystal oscillator


 //RADIOLIB_SX128X_CMD_SET_TX + RADIOLIB_SX128X_CMD_SET_RX + RADIOLIB_SX128X_CMD_SET_RX_DUTY_CYCLE

 #define RADIOLIB_SX128X_PERIOD_BASE_15_625_US                  0x00        //  7     0     time period step: 15.625 us

 #define RADIOLIB_SX128X_PERIOD_BASE_62_5_US                    0x01        //  7     0                       62.5 us

 #define RADIOLIB_SX128X_PERIOD_BASE_1_MS                       0x02        //  7     0                       1 ms

 #define RADIOLIB_SX128X_PERIOD_BASE_4_MS                       0x03        //  7     0                       4 ms


 //RADIOLIB_SX128X_CMD_SET_TX

 #define RADIOLIB_SX128X_TX_TIMEOUT_NONE                        0x0000      //  15    0     Tx timeout duration: no timeout (Tx single mode)


 //RADIOLIB_SX128X_CMD_SET_RX

 #define RADIOLIB_SX128X_RX_TIMEOUT_NONE                        0x0000      //  15    0     Rx timeout duration: no timeout (Rx single mode)

 #define RADIOLIB_SX128X_RX_TIMEOUT_INF                         0xFFFF      //  15    0                          infinite (Rx continuous mode)


 //RADIOLIB_SX128X_CMD_SET_PACKET_TYPE

 #define RADIOLIB_SX128X_PACKET_TYPE_GFSK                       0x00        //  7     0     packet type: (G)FSK

 #define RADIOLIB_SX128X_PACKET_TYPE_LORA                       0x01        //  7     0                  LoRa

 #define RADIOLIB_SX128X_PACKET_TYPE_RANGING                    0x02        //  7     0                  ranging engine

 #define RADIOLIB_SX128X_PACKET_TYPE_FLRC                       0x03        //  7     0                  FLRC

 #define RADIOLIB_SX128X_PACKET_TYPE_BLE                        0x04        //  7     0                  BLE


 //RADIOLIB_SX128X_CMD_SET_TX_PARAMS

 #define RADIOLIB_SX128X_PA_RAMP_02_US                          0x00        //  7     0     PA ramp time: 2 us

 #define RADIOLIB_SX128X_PA_RAMP_04_US                          0x20        //  7     0                   4 us

 #define RADIOLIB_SX128X_PA_RAMP_06_US                          0x40        //  7     0                   6 us

 #define RADIOLIB_SX128X_PA_RAMP_08_US                          0x60        //  7     0                   8 us

 #define RADIOLIB_SX128X_PA_RAMP_10_US                          0x80        //  7     0                   10 us

 #define RADIOLIB_SX128X_PA_RAMP_12_US                          0xA0        //  7     0                   12 us

 #define RADIOLIB_SX128X_PA_RAMP_16_US                          0xC0        //  7     0                   16 us

 #define RADIOLIB_SX128X_PA_RAMP_20_US                          0xE0        //  7     0                   20 us


 //RADIOLIB_SX128X_CMD_SET_CAD_PARAMS

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

 #define RADIOLIB_SX128X_CAD_ON_2_SYMB                          0x20        //  7     0                                     2

 #define RADIOLIB_SX128X_CAD_ON_4_SYMB                          0x40        //  7     0                                     4

 #define RADIOLIB_SX128X_CAD_ON_8_SYMB                          0x60        //  7     0                                     8

 #define RADIOLIB_SX128X_CAD_ON_16_SYMB                         0x80        //  7     0                                     16


 //RADIOLIB_SX128X_CMD_SET_MODULATION_PARAMS

 #define RADIOLIB_SX128X_BLE_GFSK_BR_2_000_BW_2_4               0x04        //  7     0     GFSK/BLE bit rate and bandwidth setting: 2.0 Mbps   2.4 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_1_600_BW_2_4               0x28        //  7     0                                              1.6 Mbps   2.4 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_1_000_BW_2_4               0x4C        //  7     0                                              1.0 Mbps   2.4 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_1_000_BW_1_2               0x45        //  7     0                                              1.0 Mbps   1.2 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_800_BW_2_4               0x70        //  7     0                                              0.8 Mbps   2.4 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_800_BW_1_2               0x69        //  7     0                                              0.8 Mbps   1.2 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_500_BW_1_2               0x8D        //  7     0                                              0.5 Mbps   1.2 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_500_BW_0_6               0x86        //  7     0                                              0.5 Mbps   0.6 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_400_BW_1_2               0xB1        //  7     0                                              0.4 Mbps   1.2 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_400_BW_0_6               0xAA        //  7     0                                              0.4 Mbps   0.6 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_250_BW_0_6               0xCE        //  7     0                                              0.25 Mbps  0.6 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_250_BW_0_3               0xC7        //  7     0                                              0.25 Mbps  0.3 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_BR_0_125_BW_0_3               0xEF        //  7     0                                              0.125 Mbps 0.3 MHz

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_0_35                  0x00        //  7     0     GFSK/BLE modulation index: 0.35

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_0_50                  0x01        //  7     0                                0.50

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_0_75                  0x02        //  7     0                                0.75

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_1_00                  0x03        //  7     0                                1.00

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_1_25                  0x04        //  7     0                                1.25

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_1_50                  0x05        //  7     0                                1.50

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_1_75                  0x06        //  7     0                                1.75

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_2_00                  0x07        //  7     0                                2.00

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_2_25                  0x08        //  7     0                                2.25

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_2_50                  0x09        //  7     0                                2.50

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_2_75                  0x0A        //  7     0                                2.75

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_3_00                  0x0B        //  7     0                                3.00

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_3_25                  0x0C        //  7     0                                3.25

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_3_50                  0x0D        //  7     0                                3.50

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_3_75                  0x0E        //  7     0                                3.75

 #define RADIOLIB_SX128X_BLE_GFSK_MOD_IND_4_00                  0x0F        //  7     0                                4.00

 #define RADIOLIB_SX128X_BLE_GFSK_BT_OFF                        0x00        //  7     0     GFSK Gaussian filter BT product: filter disabled

 #define RADIOLIB_SX128X_BLE_GFSK_BT_1_0                        0x10        //  7     0                                      1.0

 #define RADIOLIB_SX128X_BLE_GFSK_BT_0_5                        0x20        //  7     0                                      0.5

 #define RADIOLIB_SX128X_FLRC_BR_1_300_BW_1_2                   0x45        //  7     0     FLRC bit rate and bandwidth setting: 1.3 Mbps   1.2 MHz

 #define RADIOLIB_SX128X_FLRC_BR_1_000_BW_1_2                   0x69        //  7     0                                          1.04 Mbps  1.2 MHz

 #define RADIOLIB_SX128X_FLRC_BR_0_650_BW_0_6                   0x86        //  7     0                                          0.65 Mbps  0.6 MHz

 #define RADIOLIB_SX128X_FLRC_BR_0_520_BW_0_6                   0xAA        //  7     0                                          0.52 Mbps  0.6 MHz

 #define RADIOLIB_SX128X_FLRC_BR_0_325_BW_0_3                   0xC7        //  7     0                                          0.325 Mbps 0.3 MHz

 #define RADIOLIB_SX128X_FLRC_BR_0_260_BW_0_3                   0xEB        //  7     0                                          0.260 Mbps 0.3 MHz

 #define RADIOLIB_SX128X_FLRC_CR_1_2                            0x00        //  7     0     FLRC coding rate: 1/2

 #define RADIOLIB_SX128X_FLRC_CR_3_4                            0x02        //  7     0                       3/4

 #define RADIOLIB_SX128X_FLRC_CR_1_0                            0x04        //  7     0                       1/1

 #define RADIOLIB_SX128X_FLRC_BT_OFF                            0x00        //  7     0     FLRC Gaussian filter BT product: filter disabled

 #define RADIOLIB_SX128X_FLRC_BT_1_0                            0x10        //  7     0                                      1.0

 #define RADIOLIB_SX128X_FLRC_BT_0_5                            0x20        //  7     0                                      0.5

 #define RADIOLIB_SX128X_LORA_SF_5                              0x50        //  7     0     LoRa spreading factor: 5

 #define RADIOLIB_SX128X_LORA_SF_6                              0x60        //  7     0                            6

 #define RADIOLIB_SX128X_LORA_SF_7                              0x70        //  7     0                            7

 #define RADIOLIB_SX128X_LORA_SF_8                              0x80        //  7     0                            8

 #define RADIOLIB_SX128X_LORA_SF_9                              0x90        //  7     0                            9

 #define RADIOLIB_SX128X_LORA_SF_10                             0xA0        //  7     0                            10

 #define RADIOLIB_SX128X_LORA_SF_11                             0xB0        //  7     0                            11

 #define RADIOLIB_SX128X_LORA_SF_12                             0xC0        //  7     0                            12

 #define RADIOLIB_SX128X_LORA_BW_1625_00                        0x0A        //  7     0     LoRa bandwidth: 1625.0 kHz

 #define RADIOLIB_SX128X_LORA_BW_812_50                         0x18        //  7     0                     812.5 kHz

 #define RADIOLIB_SX128X_LORA_BW_406_25                         0x26        //  7     0                     406.25 kHz

 #define RADIOLIB_SX128X_LORA_BW_203_125                        0x34        //  7     0                     203.125 kHz

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

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

 #define RADIOLIB_SX128X_LORA_CR_4_7                            0x03        //  7     0                       4/7

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

 #define RADIOLIB_SX128X_LORA_CR_4_5_LI                         0x05        //  7     0                       4/5, long interleaving

 #define RADIOLIB_SX128X_LORA_CR_4_6_LI                         0x06        //  7     0                       4/6, long interleaving

 #define RADIOLIB_SX128X_LORA_CR_4_7_LI                         0x07        //  7     0                       4/7, long interleaving


 //RADIOLIB_SX128X_CMD_SET_PACKET_PARAMS

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_OFF                0x00        //  7     0     GFSK/FLRC sync word used: none

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_1                  0x10        //  7     0                               sync word 1

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_2                  0x20        //  7     0                               sync word 2

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_1_2                0x30        //  7     0                               sync words 1 and 2

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_3                  0x40        //  7     0                               sync word 3

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_1_3                0x50        //  7     0                               sync words 1 and 3

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_2_3                0x60        //  7     0                               sync words 2 and 3

 #define RADIOLIB_SX128X_GFSK_FLRC_SYNC_WORD_1_2_3              0x70        //  7     0                               sync words 1, 2 and 3

 #define RADIOLIB_SX128X_GFSK_FLRC_PACKET_FIXED                 0x00        //  7     0     GFSK/FLRC packet length mode: fixed

 #define RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE              0x20        //  7     0                                   variable

 #define RADIOLIB_SX128X_GFSK_FLRC_CRC_OFF                      0x00        //  7     0     GFSK/FLRC packet CRC: none

 #define RADIOLIB_SX128X_GFSK_FLRC_CRC_1_BYTE                   0x10        //  7     0                           1 byte

 #define RADIOLIB_SX128X_GFSK_FLRC_CRC_2_BYTE                   0x20        //  7     0                           2 bytes

 #define RADIOLIB_SX128X_GFSK_FLRC_CRC_3_BYTE                   0x30        //  7     0                           3 bytes (FLRC only)

 #define RADIOLIB_SX128X_GFSK_BLE_WHITENING_ON                  0x00        //  7     0     GFSK/BLE whitening: enabled

 #define RADIOLIB_SX128X_GFSK_BLE_WHITENING_OFF                 0x08        //  7     0                         disabled

 #define RADIOLIB_SX128X_BLE_PAYLOAD_LENGTH_MAX_31              0x00        //  7     0     BLE maximum payload length: 31 bytes

 #define RADIOLIB_SX128X_BLE_PAYLOAD_LENGTH_MAX_37              0x20        //  7     0                                 37 bytes

 #define RADIOLIB_SX128X_BLE_PAYLOAD_LENGTH_TEST                0x40        //  7     0                                 63 bytes (test mode)

 #define RADIOLIB_SX128X_BLE_PAYLOAD_LENGTH_MAX_255             0x80        //  7     0                                 255 bytes (Bluetooth 4.2 and above)

 #define RADIOLIB_SX128X_BLE_CRC_OFF                            0x00        //  7     0     BLE packet CRC: none

 #define RADIOLIB_SX128X_BLE_CRC_3_BYTE                         0x10        //  7     0                     3 byte

 #define RADIOLIB_SX128X_BLE_PRBS_9                             0x00        //  7     0     BLE test payload contents: PRNG sequence using x^9 + x^5 + x

 #define RADIOLIB_SX128X_BLE_EYELONG                            0x04        //  7     0                                repeated 0xF0

 #define RADIOLIB_SX128X_BLE_EYESHORT                           0x08        //  7     0                                repeated 0xAA

 #define RADIOLIB_SX128X_BLE_PRBS_15                            0x0C        //  7     0                                PRNG sequence using x^15 + x^14 + x^13 + x^12 + x^2 + x + 1

 #define RADIOLIB_SX128X_BLE_ALL_1                              0x10        //  7     0                                repeated 0xFF

 #define RADIOLIB_SX128X_BLE_ALL_0                              0x14        //  7     0                                repeated 0x00

 #define RADIOLIB_SX128X_BLE_EYELONG_INV                        0x18        //  7     0                                repeated 0x0F

 #define RADIOLIB_SX128X_BLE_EYESHORT_INV                       0x1C        //  7     0                                repeated 0x55

 #define RADIOLIB_SX128X_FLRC_SYNC_WORD_OFF                     0x00        //  7     0     FLRC sync word: disabled

 #define RADIOLIB_SX128X_FLRC_SYNC_WORD_ON                      0x04        //  7     0                     enabled

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

 #define RADIOLIB_SX128X_LORA_HEADER_IMPLICIT                   0x80        //  7     0                       implicit

 #define RADIOLIB_SX128X_LORA_CRC_OFF                           0x00        //  7     0     LoRa packet CRC: disabled

 #define RADIOLIB_SX128X_LORA_CRC_ON                            0x20        //  7     0                      enabled

 #define RADIOLIB_SX128X_LORA_IQ_STANDARD                       0x40        //  7     0     LoRa IQ: standard

 #define RADIOLIB_SX128X_LORA_IQ_INVERTED                       0x00        //  7     0              inverted


 //RADIOLIB_SX128X_CMD_GET_PACKET_STATUS

 #define RADIOLIB_SX128X_PACKET_STATUS_SYNC_ERROR               0b01000000  //  6     6     packet status errors byte: sync word error

 #define RADIOLIB_SX128X_PACKET_STATUS_LENGTH_ERROR             0b00100000  //  5     5                                packet length error

 #define RADIOLIB_SX128X_PACKET_STATUS_CRC_ERROR                0b00010000  //  4     4                                CRC error

 #define RADIOLIB_SX128X_PACKET_STATUS_ABORT_ERROR              0b00001000  //  3     3                                packet reception aborted

 #define RADIOLIB_SX128X_PACKET_STATUS_HEADER_RECEIVED          0b00000100  //  2     2                                header received

 #define RADIOLIB_SX128X_PACKET_STATUS_PACKET_RECEIVED          0b00000010  //  1     1                                packet received

 #define RADIOLIB_SX128X_PACKET_STATUS_PACKET_CTRL_BUSY         0b00000001  //  0     0                                packet controller is busy

 #define RADIOLIB_SX128X_PACKET_STATUS_RX_PID                   0b11000000  //  7     6     packet status status byte: PID field of the received packet

 #define RADIOLIB_SX128X_PACKET_STATUS_NO_ACK                   0b00100000  //  5     5                                NO_ACK field of the received packet

 #define RADIOLIB_SX128X_PACKET_STATUS_RX_PID_ERROR             0b00010000  //  4     4                                PID field error

 #define RADIOLIB_SX128X_PACKET_STATUS_PACKET_SENT              0b00000001  //  0     0                                packet sent

 #define RADIOLIB_SX128X_PACKET_STATUS_SYNC_DET_ERROR           0b00000000  //  2     0     packet status sync byte: sync word detection error

 #define RADIOLIB_SX128X_PACKET_STATUS_SYNC_DET_1               0b00000001  //  2     0                              detected sync word 1

 #define RADIOLIB_SX128X_PACKET_STATUS_SYNC_DET_2               0b00000010  //  2     0                              detected sync word 2

 #define RADIOLIB_SX128X_PACKET_STATUS_SYNC_DET_3               0b00000100  //  2     0                              detected sync word 3


 //RADIOLIB_SX128X_CMD_SET_DIO_IRQ_PARAMS

 #define RADIOLIB_SX128X_IRQ_RADIOLIB_PREAMBLE_DETECTED                  0x8000      //  15    15    interrupt source: preamble detected

 #define RADIOLIB_SX128X_IRQ_ADVANCED_RANGING_DONE              0x8000      //  15    15                      advanced ranging done

 #define RADIOLIB_SX128X_IRQ_RX_TX_TIMEOUT                      0x4000      //  14    14                      Rx or Tx timeout

 #define RADIOLIB_SX128X_IRQ_CAD_DETECTED                       0x2000      //  13    13                      channel activity detected

 #define RADIOLIB_SX128X_IRQ_CAD_DONE                           0x1000      //  12    12                      CAD finished

 #define RADIOLIB_SX128X_IRQ_RANGING_SLAVE_REQ_VALID            0x0800      //  11    11                      ranging request valid (slave)

 #define RADIOLIB_SX128X_IRQ_RANGING_MASTER_TIMEOUT             0x0400      //  10    10                      ranging timeout (master)

 #define RADIOLIB_SX128X_IRQ_RANGING_MASTER_RES_VALID           0x0200      //  9     9                       ranging result valid (master)

 #define RADIOLIB_SX128X_IRQ_RANGING_SLAVE_REQ_DISCARD          0x0100      //  8     8                       ranging result valid (master)

 #define RADIOLIB_SX128X_IRQ_RANGING_SLAVE_RESP_DONE            0x0080      //  7     7                       ranging response complete (slave)

 #define RADIOLIB_SX128X_IRQ_CRC_ERROR                          0x0040      //  6     6                       CRC error

 #define RADIOLIB_SX128X_IRQ_HEADER_ERROR                       0x0020      //  5     5                       header error

 #define RADIOLIB_SX128X_IRQ_HEADER_VALID                       0x0010      //  4     4                       header valid

 #define RADIOLIB_SX128X_IRQ_SYNC_WORD_ERROR                    0x0008      //  3     3                       sync word error

 #define RADIOLIB_SX128X_IRQ_SYNC_WORD_VALID                    0x0004      //  2     2                       sync word valid

 #define RADIOLIB_SX128X_IRQ_RX_DONE                            0x0002      //  1     1                       Rx done

 #define RADIOLIB_SX128X_IRQ_TX_DONE                            0x0001      //  0     0                       Tx done

 #define RADIOLIB_SX128X_IRQ_NONE                               0x0000      //  15    0                       none

 #define RADIOLIB_SX128X_IRQ_ALL                                0xFFFF      //  15    0                       all


 //RADIOLIB_SX128X_CMD_SET_REGULATOR_MODE

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

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


 //RADIOLIB_SX128X_CMD_SET_RANGING_ROLE

 #define RADIOLIB_SX128X_RANGING_ROLE_MASTER                    0x01        //  7     0     ranging role: master

 #define RADIOLIB_SX128X_RANGING_ROLE_SLAVE                     0x00        //  7     0                   slave


 //RADIOLIB_SX128X_REG_LORA_SYNC_WORD_1 - RADIOLIB_SX128X_REG_LORA_SYNC_WORD_2

 #define RADIOLIB_SX128X_SYNC_WORD_PRIVATE                      0x12


 class SX128x: public PhysicalLayer {

   public:

     // introduce PhysicalLayer overloads

     using PhysicalLayer::transmit;

     using PhysicalLayer::receive;

     using PhysicalLayer::startTransmit;

     using PhysicalLayer::readData;


     SX128x(Module* mod);


     Module* getMod();


     // basic methods


     int16_t begin(float freq = 2400.0, float bw = 812.5, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 12);


     int16_t beginGFSK(float freq = 2400.0, uint16_t br = 800, float freqDev = 400.0, int8_t power = 10, uint16_t preambleLength = 16);


     int16_t beginBLE(float freq = 2400.0, uint16_t br = 800, float freqDev = 400.0, int8_t power = 10, uint8_t dataShaping = RADIOLIB_SHAPING_0_5);


     int16_t beginFLRC(float freq = 2400.0, uint16_t br = 650, uint8_t cr = 3, int8_t power = 10, uint16_t preambleLength = 16, uint8_t dataShaping = RADIOLIB_SHAPING_0_5);


     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();


     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(uint16_t timeout = RADIOLIB_SX128X_RX_TIMEOUT_INF);


     uint16_t getIrqStatus();


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


     // configuration methods


     int16_t setFrequency(float freq);


     int16_t setBandwidth(float bw);


     int16_t setSpreadingFactor(uint8_t sf);


     int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);


     int16_t setOutputPower(int8_t power);


     int16_t setPreambleLength(uint32_t preambleLength);


     int16_t setBitRate(float br);


     int16_t setFrequencyDeviation(float freqDev) override;


     int16_t setDataShaping(uint8_t sh) override;


     int16_t setSyncWord(uint8_t* syncWord, uint8_t len);


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


     int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);


     int16_t setWhitening(bool enabled);


     int16_t setAccessAddress(uint32_t addr);


     int16_t setHighSensitivityMode(bool hsm = false);


     int16_t setGainControl(uint8_t gain = 0);


     float getRSSI();


     float getSNR();


     float getFrequencyError();


     size_t getPacketLength(bool update = true) override;


     uint32_t getTimeOnAir(size_t len);


     int16_t implicitHeader(size_t len);


     int16_t explicitHeader();


     int16_t setEncoding(uint8_t encoding) override;


     void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);


     uint8_t randomByte();


     int16_t getLastError();


     #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)

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


     void readBit(RADIOLIB_PIN_TYPE pin);

     #endif


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

   protected:

 #endif

     Module* _mod;


 #if !defined(RADIOLIB_GODMODE)

   protected:

 #endif


     // cached LoRa parameters

     float _bwKhz = 0;

     uint8_t _bw = 0, _sf = 0, _cr = 0;

     uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;


     // SX128x SPI command implementations

     uint8_t getStatus();

     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 setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);

     int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);

     int16_t setCad();

     uint8_t getPacketType();

     int16_t setRfFrequency(uint32_t frf);

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

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

     int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);

     int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);

     int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);

     int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);

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

     int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);

     int16_t setRangingRole(uint8_t role);

     int16_t setPacketType(uint8_t type);


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


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

   private:

 #endif


     // common low-level SPI interface

     int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);

     int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);

     int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);

     int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);

     int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);


 #if !defined(RADIOLIB_GODMODE)

   private:

 #endif

     // common parameters

     uint8_t _pwr = 0;


     // cached GFSK parameters

     float _modIndexReal = 0;

     uint16_t _brKbps = 0;

     uint8_t _br = 0, _modIndex = 0, _shaping = 0;

     uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;


     // cached FLRC parameters

     uint8_t _crFLRC = 0;


     // cached BLE parameters

     uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;


     int16_t _lastError = RADIOLIB_ERR_NONE;


     int16_t config(uint8_t modem);

     int16_t checkCommandResult();

 };


 #endif


 #endif

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

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

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

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

SX128x
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350

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

SX128x::setSyncWord
int16_t setSyncWord(uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:875

SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:707

SX128x::sleep
int16_t sleep(bool retainConfig=true)
Sets the module to sleep mode.
Definition: SX128x.cpp:417

SX128x::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:601

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

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

SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:812

SX128x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1126

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

SX128x::readBit
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1263

SX128x::beginBLE
int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for BLE modem.
Definition: SX128x.cpp:130

SX128x::setGainControl
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1046

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

SX128x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:517

SX128x::setBitRate
int16_t setBitRate(float br)
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:755

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

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

SX128x::setHighSensitivityMode
int16_t setHighSensitivityMode(bool hsm=false)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1029

SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1238

SX128x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:372

SX128x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1106

SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:998

SX128x::beginGFSK
int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint16_t preambleLength=16)
Initialization method for GFSK modem.
Definition: SX128x.cpp:67

SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1018

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

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

SX128x::randomByte
uint8_t randomByte()
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1246

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

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

SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:673

SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:934

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

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

SX128x::getLastError
int16_t getLastError()
Get the last recorded transaction error.
Definition: SX128x.cpp:1252

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

SX128x::beginFLRC
int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t power=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for FLRC modem.
Definition: SX128x.cpp:179

SX128x::begin
int16_t begin(float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=12)
Initialization method for LoRa modem.
Definition: SX128x.cpp:12

SX128x::startReceive
int16_t startReceive(uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX128x.cpp:525

SX128x::setOutputPower
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:701

SX128x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1364

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

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

SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:609

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

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

SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1257

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

RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:25

RADIOLIB_ERR_NONE
#define RADIOLIB_ERR_NONE
No error, method executed successfully.
Definition: TypeDef.h:77