RadioLib Universal wireless communication library for Arduino

LR11x0.h
1 #if !defined(_RADIOLIB_LR11X0_H)
2 #define _RADIOLIB_LR11X0_H
3
4 #include "../../TypeDef.h"
5
6 #if !RADIOLIB_EXCLUDE_LR11X0
7
8 #include "../../Module.h"
9
10 #include "../../protocols/PhysicalLayer/PhysicalLayer.h"
11
12 // LR11X0 physical layer properties
13 #define RADIOLIB_LR11X0_FREQUENCY_STEP_SIZE 1.0
14 #define RADIOLIB_LR11X0_MAX_PACKET_LENGTH 255
15 #define RADIOLIB_LR11X0_CRYSTAL_FREQ 32.0
16 #define RADIOLIB_LR11X0_DIV_EXPONENT 25
17
18 // LR11X0 SPI commands
19 #define RADIOLIB_LR11X0_CMD_NOP (0x0000)
20 #define RADIOLIB_LR11X0_CMD_WRITE_REG_MEM (0x0105)
21 #define RADIOLIB_LR11X0_CMD_READ_REG_MEM (0x0106)
22 #define RADIOLIB_LR11X0_CMD_WRITE_BUFFER (0x0109)
23 #define RADIOLIB_LR11X0_CMD_READ_BUFFER (0x010A)
24 #define RADIOLIB_LR11X0_CMD_CLEAR_RX_BUFFER (0x010B)
25 #define RADIOLIB_LR11X0_CMD_WRITE_REG_MEM_MASK (0x010C)
26 #define RADIOLIB_LR11X0_CMD_GET_STATUS (0x0100)
27 #define RADIOLIB_LR11X0_CMD_GET_VERSION (0x0101)
28 #define RADIOLIB_LR11X0_CMD_GET_ERRORS (0x010D)
29 #define RADIOLIB_LR11X0_CMD_CLEAR_ERRORS (0x010E)
30 #define RADIOLIB_LR11X0_CMD_CALIBRATE (0x010F)
31 #define RADIOLIB_LR11X0_CMD_SET_REG_MODE (0x0110)
32 #define RADIOLIB_LR11X0_CMD_CALIB_IMAGE (0x0111)
33 #define RADIOLIB_LR11X0_CMD_SET_DIO_AS_RF_SWITCH (0x0112)
34 #define RADIOLIB_LR11X0_CMD_SET_DIO_IRQ_PARAMS (0x0113)
35 #define RADIOLIB_LR11X0_CMD_CLEAR_IRQ (0x0114)
36 #define RADIOLIB_LR11X0_CMD_CONFIG_LF_LOCK (0x0116)
37 #define RADIOLIB_LR11X0_CMD_SET_TCXO_MODE (0x0117)
38 #define RADIOLIB_LR11X0_CMD_REBOOT (0x0118)
39 #define RADIOLIB_LR11X0_CMD_GET_VBAT (0x0119)
40 #define RADIOLIB_LR11X0_CMD_GET_TEMP (0x011A)
41 #define RADIOLIB_LR11X0_CMD_SET_SLEEP (0x011B)
42 #define RADIOLIB_LR11X0_CMD_SET_STANDBY (0x011C)
43 #define RADIOLIB_LR11X0_CMD_SET_FS (0x011D)
44 #define RADIOLIB_LR11X0_CMD_GET_RANDOM_NUMBER (0x0120)
45 #define RADIOLIB_LR11X0_CMD_ERASE_INFO_PAGE (0x0121)
46 #define RADIOLIB_LR11X0_CMD_WRITE_INFO_PAGE (0x0122)
47 #define RADIOLIB_LR11X0_CMD_READ_INFO_PAGE (0x0123)
48 #define RADIOLIB_LR11X0_CMD_GET_CHIP_EUI (0x0125)
49 #define RADIOLIB_LR11X0_CMD_GET_SEMTECH_JOIN_EUI (0x0126)
50 #define RADIOLIB_LR11X0_CMD_DERIVE_ROOT_KEYS_AND_GET_PIN (0x0127)
51 #define RADIOLIB_LR11X0_CMD_ENABLE_SPI_CRC (0x0128)
52 #define RADIOLIB_LR11X0_CMD_DRIVE_DIOS_IN_SLEEP_MODE (0x012A)
53 #define RADIOLIB_LR11X0_CMD_RESET_STATS (0x0200)
54 #define RADIOLIB_LR11X0_CMD_GET_STATS (0x0201)
55 #define RADIOLIB_LR11X0_CMD_GET_PACKET_TYPE (0x0202)
56 #define RADIOLIB_LR11X0_CMD_GET_RX_BUFFER_STATUS (0x0203)
57 #define RADIOLIB_LR11X0_CMD_GET_PACKET_STATUS (0x0204)
58 #define RADIOLIB_LR11X0_CMD_GET_RSSI_INST (0x0205)
59 #define RADIOLIB_LR11X0_CMD_SET_GFSK_SYNC_WORD (0x0206)
60 #define RADIOLIB_LR11X0_CMD_SET_LORA_PUBLIC_NETWORK (0x0208)
61 #define RADIOLIB_LR11X0_CMD_SET_RX (0x0209)
62 #define RADIOLIB_LR11X0_CMD_SET_TX (0x020A)
63 #define RADIOLIB_LR11X0_CMD_SET_RF_FREQUENCY (0x020B)
64 #define RADIOLIB_LR11X0_CMD_AUTO_TX_RX (0x020C)
65 #define RADIOLIB_LR11X0_CMD_SET_CAD_PARAMS (0x020D)
66 #define RADIOLIB_LR11X0_CMD_SET_PACKET_TYPE (0x020E)
67 #define RADIOLIB_LR11X0_CMD_SET_MODULATION_PARAMS (0x020F)
68 #define RADIOLIB_LR11X0_CMD_SET_PACKET_PARAMS (0x0210)
69 #define RADIOLIB_LR11X0_CMD_SET_TX_PARAMS (0x0211)
70 #define RADIOLIB_LR11X0_CMD_SET_PACKET_ADRS (0x0212)
71 #define RADIOLIB_LR11X0_CMD_SET_RX_TX_FALLBACK_MODE (0x0213)
72 #define RADIOLIB_LR11X0_CMD_SET_RX_DUTY_CYCLE (0x0214)
73 #define RADIOLIB_LR11X0_CMD_SET_PA_CONFIG (0x0215)
74 #define RADIOLIB_LR11X0_CMD_STOP_TIMEOUT_ON_PREAMBLE (0x0217)
75 #define RADIOLIB_LR11X0_CMD_SET_CAD (0x0218)
76 #define RADIOLIB_LR11X0_CMD_SET_TX_CW (0x0219)
77 #define RADIOLIB_LR11X0_CMD_SET_TX_INFINITE_PREAMBLE (0x021A)
78 #define RADIOLIB_LR11X0_CMD_SET_LORA_SYNCH_TIMEOUT (0x021B)
79 #define RADIOLIB_LR11X0_CMD_SET_RANGING_ADDR (0x021C)
80 #define RADIOLIB_LR11X0_CMD_SET_RANGING_REQ_ADDR (0x021D)
81 #define RADIOLIB_LR11X0_CMD_GET_RANGING_RESULT (0x021E)
82 #define RADIOLIB_LR11X0_CMD_SET_RANGING_TX_RX_DELAY (0x021F)
83 #define RADIOLIB_LR11X0_CMD_SET_GFSK_CRC_PARAMS (0x0224)
84 #define RADIOLIB_LR11X0_CMD_SET_GFSK_WHIT_PARAMS (0x0225)
85 #define RADIOLIB_LR11X0_CMD_SET_RX_BOOSTED (0x0227)
86 #define RADIOLIB_LR11X0_CMD_SET_RANGING_PARAMETER (0x0228)
87 #define RADIOLIB_LR11X0_CMD_SET_LORA_SYNC_WORD (0x022B)
88 #define RADIOLIB_LR11X0_CMD_LR_FHSS_BUILD_FRAME (0x022C)
89 #define RADIOLIB_LR11X0_CMD_LR_FHSS_SET_SYNC_WORD (0x022D)
90 #define RADIOLIB_LR11X0_CMD_CONFIG_BLE_BEACON (0x022E)
91 #define RADIOLIB_LR11X0_CMD_GET_LORA_RX_HEADER_INFOS (0x0230)
92 #define RADIOLIB_LR11X0_CMD_BLE_BEACON_SEND (0x0231)
93 #define RADIOLIB_LR11X0_CMD_WIFI_SCAN (0x0300)
94 #define RADIOLIB_LR11X0_CMD_WIFI_SCAN_TIME_LIMIT (0x0301)
95 #define RADIOLIB_LR11X0_CMD_WIFI_COUNTRY_CODE (0x0302)
96 #define RADIOLIB_LR11X0_CMD_WIFI_COUNTRY_CODE_TIME_LIMIT (0x0303)
97 #define RADIOLIB_LR11X0_CMD_WIFI_GET_NB_RESULTS (0x0305)
98 #define RADIOLIB_LR11X0_CMD_WIFI_READ_RESULTS (0x0306)
99 #define RADIOLIB_LR11X0_CMD_WIFI_RESET_CUMUL_TIMINGS (0x0307)
100 #define RADIOLIB_LR11X0_CMD_WIFI_READ_CUMUL_TIMINGS (0x0308)
101 #define RADIOLIB_LR11X0_CMD_WIFI_GET_NB_COUNTRY_CODE_RESULTS (0x0309)
102 #define RADIOLIB_LR11X0_CMD_WIFI_READ_COUNTRY_CODE_RESULTS (0x030A)
103 #define RADIOLIB_LR11X0_CMD_WIFI_CFG_TIMESTAMP_AP_PHONE (0x030B)
104 #define RADIOLIB_LR11X0_CMD_WIFI_READ_VERSION (0x0320)
105 #define RADIOLIB_LR11X0_CMD_GNSS_SET_CONSTELLATION_TO_USE (0x0400)
106 #define RADIOLIB_LR11X0_CMD_GNSS_READ_CONSTELLATION_TO_USE (0x0401)
107 #define RADIOLIB_LR11X0_CMD_GNSS_SET_ALMANAC_UPDATE (0x0402)
108 #define RADIOLIB_LR11X0_CMD_GNSS_READ_ALMANAC_UPDATE (0x0403)
109 #define RADIOLIB_LR11X0_CMD_GNSS_READ_VERSION (0x0406)
110 #define RADIOLIB_LR11X0_CMD_GNSS_READ_SUPPORTED_CONSTELLATIONS (0x0407)
111 #define RADIOLIB_LR11X0_CMD_GNSS_SET_MODE (0x0408)
112 #define RADIOLIB_LR11X0_CMD_GNSS_AUTONOMOUS (0x0409)
113 #define RADIOLIB_LR11X0_CMD_GNSS_ASSISTED (0x040A)
114 #define RADIOLIB_LR11X0_CMD_GNSS_SET_ASSISTANCE_POSITION (0x0410)
115 #define RADIOLIB_LR11X0_CMD_GNSS_READ_ASSISTANCE_POSITION (0x0411)
116 #define RADIOLIB_LR11X0_CMD_GNSS_PUSH_SOLVER_MSG (0x0414)
117 #define RADIOLIB_LR11X0_CMD_GNSS_PUSH_DM_MSG (0x0415)
118 #define RADIOLIB_LR11X0_CMD_GNSS_GET_CONTEXT_STATUS (0x0416)
119 #define RADIOLIB_LR11X0_CMD_GNSS_GET_NB_SV_DETECTED (0x0417)
120 #define RADIOLIB_LR11X0_CMD_GNSS_GET_SV_DETECTED (0x0418)
121 #define RADIOLIB_LR11X0_CMD_GNSS_GET_CONSUMPTION (0x0419)
122 #define RADIOLIB_LR11X0_CMD_GNSS_GET_RESULT_SIZE (0x040C)
123 #define RADIOLIB_LR11X0_CMD_GNSS_READ_RESULTS (0x040D)
124 #define RADIOLIB_LR11X0_CMD_GNSS_ALMANAC_FULL_UPDATE (0x040E)
125 #define RADIOLIB_LR11X0_CMD_GNSS_GET_SV_VISIBLE (0x041F)
126 #define RADIOLIB_LR11X0_CMD_CRYPTO_SET_KEY (0x0502)
127 #define RADIOLIB_LR11X0_CMD_CRYPTO_DERIVE_KEY (0x0503)
128 #define RADIOLIB_LR11X0_CMD_CRYPTO_PROCESS_JOIN_ACCEPT (0x0504)
129 #define RADIOLIB_LR11X0_CMD_CRYPTO_COMPUTE_AES_CMAC (0x0505)
130 #define RADIOLIB_LR11X0_CMD_CRYPTO_VERIFY_AES_CMAC (0x0506)
131 #define RADIOLIB_LR11X0_CMD_CRYPTO_AES_ENCRYPT_01 (0x0507)
132 #define RADIOLIB_LR11X0_CMD_CRYPTO_AES_ENCRYPT (0x0508)
133 #define RADIOLIB_LR11X0_CMD_CRYPTO_AES_DECRYPT (0x0509)
134 #define RADIOLIB_LR11X0_CMD_CRYPTO_STORE_TO_FLASH (0x050A)
135 #define RADIOLIB_LR11X0_CMD_CRYPTO_RESTORE_FROM_FLASH (0x050B)
136 #define RADIOLIB_LR11X0_CMD_CRYPTO_SET_PARAM (0x050D)
137 #define RADIOLIB_LR11X0_CMD_CRYPTO_GET_PARAM (0x050E)
138 #define RADIOLIB_LR11X0_CMD_CRYPTO_CHECK_ENCRYPTED_FIRMWARE_IMAGE (0x050F)
139 #define RADIOLIB_LR11X0_CMD_CRYPTO_CHECK_ENCRYPTED_FIRMWARE_IMAGE_RESULT (0x0510)
140 #define RADIOLIB_LR11X0_CMD_BOOT_ERASE_FLASH (0x8000)
141 #define RADIOLIB_LR11X0_CMD_BOOT_WRITE_FLASH_ENCRYPTED (0x8003)
142 #define RADIOLIB_LR11X0_CMD_BOOT_REBOOT (0x8005)
143 #define RADIOLIB_LR11X0_CMD_BOOT_GET_PIN (0x800B)
144 #define RADIOLIB_LR11X0_CMD_BOOT_GET_CHIP_EUI (0x800C)
145 #define RADIOLIB_LR11X0_CMD_BOOT_GET_JOIN_EUI (0x800D)
146
147 // LR11X0 register map
148 #define RADIOLIB_LR11X0_REG_SF6_SX127X_COMPAT (0x00F20414)
149 #define RADIOLIB_LR11X0_REG_LORA_HIGH_POWER_FIX (0x00F30054)
150
151 // LR11X0 SPI command variables
152
153 // RADIOLIB_LR11X0_CMD_GET_STATUS MSB LSB DESCRIPTION
154 #define RADIOLIB_LR11X0_STAT_1_CMD_FAIL (0x00UL << 1) // 3 1 command status: last command could not be executed
155 #define RADIOLIB_LR11X0_STAT_1_CMD_PERR (0x01UL << 1) // 3 1 processing error
156 #define RADIOLIB_LR11X0_STAT_1_CMD_OK (0x02UL << 1) // 3 1 successfully processed
157 #define RADIOLIB_LR11X0_STAT_1_CMD_DAT (0x03UL << 1) // 3 1 successfully processed, data is being transmitted
158 #define RADIOLIB_LR11X0_STAT_1_IRQ_INACTIVE (0x00UL << 0) // 0 0 interrupt status: inactive
159 #define RADIOLIB_LR11X0_STAT_1_IRQ_ACTIVE (0x01UL << 0) // 0 0 at least 1 interrupt active
160 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_CLEARED (0x00UL << 4) // 7 4 reset status: cleared
161 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_ANALOG (0x01UL << 4) // 7 4 analog (power on, brown-out)
162 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_EXTERNAL (0x02UL << 4) // 7 4 NRESET pin
163 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_SYSTEM (0x03UL << 4) // 7 4 system
164 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_WATCHDOG (0x04UL << 4) // 7 4 watchdog
165 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_WAKEUP (0x05UL << 4) // 7 4 NSS toggling wake-up
166 #define RADIOLIB_LR11X0_STAT_2_CMD_RST_RTC (0x06UL << 4) // 7 4 realtime clock
167 #define RADIOLIB_LR11X0_STAT_2_MODE_SLEEP (0x00UL << 1) // 3 1 chip mode: sleep
168 #define RADIOLIB_LR11X0_STAT_2_MODE_STBY_RC (0x01UL << 1) // 3 1 standby with RC oscillator
169 #define RADIOLIB_LR11X0_STAT_2_MODE_STBY_OSC (0x02UL << 1) // 3 1 standby with external oscillator
170 #define RADIOLIB_LR11X0_STAT_2_MODE_FS (0x03UL << 1) // 3 1 frequency synthesis
171 #define RADIOLIB_LR11X0_STAT_2_MODE_RX (0x04UL << 1) // 3 1 receive
172 #define RADIOLIB_LR11X0_STAT_2_MODE_TX (0x05UL << 1) // 3 1 transmit
173 #define RADIOLIB_LR11X0_STAT_2_MODE_WIFI_GNSS (0x06UL << 1) // 3 1 WiFi or GNSS geolocation
174 #define RADIOLIB_LR11X0_STAT_2_BOOT (0x00UL << 0) // 0 0 code executed from: bootloader
175 #define RADIOLIB_LR11X0_STAT_2_FLASH (0x01UL << 0) // 0 0 flash
176
177 // RADIOLIB_LR11X0_CMD_WRITE_REG_MEM
178 #define RADIOLIB_LR11X0_SPI_MAX_READ_WRITE_LEN (256) // 7 0 maximum length of read/write SPI payload in bytes
179
180 // RADIOLIB_LR11X0_CMD_GET_VERSION
181 #define RADIOLIB_LR11X0_HW_LR1110 (0x01UL << 0) // 7 0 HW version: LR1110
182 #define RADIOLIB_LR11X0_HW_LR1120 (0x02UL << 0) // 7 0 LR1120
183 #define RADIOLIB_LR11X0_HW_LR1121 (0x03UL << 0) // 7 0 LR1121
184 #define RADIOLIB_LR11X0_HW_BOOT (0xDFUL << 0) // 7 0 bootloader mode
185
186 // RADIOLIB_LR11X0_CMD_GET_ERRORS
187 #define RADIOLIB_LR11X0_ERROR_STAT_LF_RC_CALIB_ERR (0x01UL << 0) // 15 0 error: low frequency RC not calibrated
188 #define RADIOLIB_LR11X0_ERROR_STAT_HF_RC_CALIB_ERR (0x01UL << 1) // 15 0 high frequency RC not calibrated
189 #define RADIOLIB_LR11X0_ERROR_STAT_ADC_CALIB_ERR (0x01UL << 2) // 15 0 ADC not calibrated
190 #define RADIOLIB_LR11X0_ERROR_STAT_PLL_CALIB_ERR (0x01UL << 3) // 15 0 PLL not calibrated
191 #define RADIOLIB_LR11X0_ERROR_STAT_IMG_CALIB_ERR (0x01UL << 4) // 15 0 image rejection not calibrated
192 #define RADIOLIB_LR11X0_ERROR_STAT_HF_XOSC_START_ERR (0x01UL << 5) // 15 0 high frequency oscillator failed to start
193 #define RADIOLIB_LR11X0_ERROR_STAT_LF_XOSC_START_ERR (0x01UL << 6) // 15 0 low frequency oscillator failed to start
194 #define RADIOLIB_LR11X0_ERROR_STAT_PLL_LOCK_ERR (0x01UL << 7) // 15 0 PLL failed to lock
195 #define RADIOLIB_LR11X0_ERROR_STAT_RX_ADC_OFFSET_ERR (0x01UL << 8) // 15 0 ADC offset not calibrated
196
197 // RADIOLIB_LR11X0_CMD_CALIBRATE
198 #define RADIOLIB_LR11X0_CALIBRATE_PLL_TX (0x01UL << 5) // 5 5 calibrate: Tx PLL
199 #define RADIOLIB_LR11X0_CALIBRATE_IMG (0x01UL << 4) // 4 4 image rejection
200 #define RADIOLIB_LR11X0_CALIBRATE_ADC (0x01UL << 3) // 3 3 A/D converter
201 #define RADIOLIB_LR11X0_CALIBRATE_PLL (0x01UL << 2) // 2 2 PLL
202 #define RADIOLIB_LR11X0_CALIBRATE_HF_RC (0x01UL << 1) // 1 1 high frequency RC
203 #define RADIOLIB_LR11X0_CALIBRATE_LF_RC (0x01UL << 0) // 0 0 low frequency RC
204 #define RADIOLIB_LR11X0_CALIBRATE_ALL (0x3FUL << 0) // 5 0 everything
205
206 // RADIOLIB_LR11X0_CMD_SET_REG_MODE
207 #define RADIOLIB_LR11X0_REG_MODE_LDO (0x00UL << 0) // 0 0 regulator mode: LDO in all modes
208 #define RADIOLIB_LR11X0_REG_MODE_DC_DC (0x01UL << 0) // 0 0 DC-DC and LDO
209
210 // RADIOLIB_LR11X0_CMD_SET_DIO_AS_RF_SWITCH
211 #define RADIOLIB_LR11X0_RFSW_DIO5_ENABLED (0x01UL << 0) // 4 0 RF switch: DIO5 enabled
212 #define RADIOLIB_LR11X0_RFSW_DIO5_DISABLED (0x00UL << 0) // 4 0 DIO5 disabled (default)
213 #define RADIOLIB_LR11X0_RFSW_DIO6_ENABLED (0x01UL << 1) // 4 0 RF switch: DIO6 enabled
214 #define RADIOLIB_LR11X0_RFSW_DIO6_DISABLED (0x00UL << 1) // 4 0 DIO6 disabled (default)
215 #define RADIOLIB_LR11X0_RFSW_DIO7_ENABLED (0x01UL << 2) // 4 0 RF switch: DIO7 enabled
216 #define RADIOLIB_LR11X0_RFSW_DIO7_DISABLED (0x00UL << 2) // 4 0 DIO7 disabled (default)
217 #define RADIOLIB_LR11X0_RFSW_DIO8_ENABLED (0x01UL << 3) // 4 0 RF switch: DIO8 enabled
218 #define RADIOLIB_LR11X0_RFSW_DIO8_DISABLED (0x00UL << 3) // 4 0 DIO8 disabled (default)
219 #define RADIOLIB_LR11X0_RFSW_DIO10_ENABLED (0x01UL << 4) // 4 0 RF switch: DIO10 enabled
220 #define RADIOLIB_LR11X0_RFSW_DIO10_DISABLED (0x00UL << 4) // 4 0 DIO10 disabled (default)
221
222 // RADIOLIB_LR11X0_CMD_SET_DIO_IRQ_PARAMS
223 #define RADIOLIB_LR11X0_IRQ_TX_DONE (0x01UL << 2) // 31 0 interrupt: packet transmitted
224 #define RADIOLIB_LR11X0_IRQ_RX_DONE (0x01UL << 3) // 31 0 packet received
225 #define RADIOLIB_LR11X0_IRQ_PREAMBLE_DETECTED (0x01UL << 4) // 31 0 preamble detected
226 #define RADIOLIB_LR11X0_IRQ_SYNC_WORD_HEADER_VALID (0x01UL << 5) // 31 0 sync word or LoRa header valid
227 #define RADIOLIB_LR11X0_IRQ_HEADER_ERR (0x01UL << 6) // 31 0 LoRa header CRC error
228 #define RADIOLIB_LR11X0_IRQ_CRC_ERR (0x01UL << 7) // 31 0 packet CRC error
229 #define RADIOLIB_LR11X0_IRQ_CAD_DONE (0x01UL << 8) // 31 0 CAD completed
230 #define RADIOLIB_LR11X0_IRQ_CAD_DETECTED (0x01UL << 9) // 31 0 CAD detected
231 #define RADIOLIB_LR11X0_IRQ_TIMEOUT (0x01UL << 10) // 31 0 Rx or Tx timeout
232 #define RADIOLIB_LR11X0_IRQ_LR_FHSS_HOP (0x01UL << 11) // 31 0 FHSS hop
233 #define RADIOLIB_LR11X0_IRQ_GNSS_DONE (0x01UL << 19) // 31 0 GNSS scan finished
234 #define RADIOLIB_LR11X0_IRQ_WIFI_DONE (0x01UL << 20) // 31 0 WiFi scan finished
235 #define RADIOLIB_LR11X0_IRQ_LBD (0x01UL << 21) // 31 0 low battery detected
236 #define RADIOLIB_LR11X0_IRQ_CMD_ERROR (0x01UL << 22) // 31 0 command error
237 #define RADIOLIB_LR11X0_IRQ_ERROR (0x01UL << 23) // 31 0 some other error than CMD_ERR
238 #define RADIOLIB_LR11X0_IRQ_FSK_LEN_ERROR (0x01UL << 24) // 31 0 FSK packet received with length error
239 #define RADIOLIB_LR11X0_IRQ_FSK_ADDR_ERROR (0x01UL << 25) // 31 0 FSK packet received with address error
240 #define RADIOLIB_LR11X0_IRQ_LORA_RX_TIMESTAMP (0x01UL << 27) // 31 0 last LoRa symbol was received (timestamp source)
241 #define RADIOLIB_LR11X0_IRQ_ALL (0x0BF80FFCUL) // 31 0 all interrupts
242 #define RADIOLIB_LR11X0_IRQ_NONE (0x00UL << 0) // 31 0 no interrupts
243
244 // RADIOLIB_LR11X0_CMD_CONFIG_LF_LOCK
245 #define RADIOLIB_LR11X0_LF_CLK_RC (0x00UL << 0) // 1 0 32.768 kHz source: RC oscillator
246 #define RADIOLIB_LR11X0_LF_CLK_XOSC (0x01UL << 0) // 1 0 crystal oscillator
247 #define RADIOLIB_LR11X0_LF_CLK_EXT (0x02UL << 0) // 1 0 external signal on DIO11
248 #define RADIOLIB_LR11X0_LF_BUSY_RELEASE_DISABLED (0x00UL << 2) // 2 2
249 #define RADIOLIB_LR11X0_LF_BUSY_RELEASE_ENABLED (0x01UL << 2) // 2 2
250
251 // RADIOLIB_LR11X0_CMD_SET_TCXO_MODE
252 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_1_6 (0x00UL << 0) // 2 0 TCXO supply voltage: 1.6V
253 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_1_7 (0x01UL << 0) // 2 0 1.7V
254 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_1_8 (0x02UL << 0) // 2 0 1.8V
255 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_2_2 (0x03UL << 0) // 2 0 2.2V
256 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_2_4 (0x04UL << 0) // 2 0 2.4V
257 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_2_7 (0x05UL << 0) // 2 0 2.7V
258 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_3_0 (0x06UL << 0) // 2 0 3.0V
259 #define RADIOLIB_LR11X0_TCXO_VOLTAGE_3_3 (0x07UL << 0) // 2 0 3.3V
260
261 // RADIOLIB_LR11X0_CMD_SET_SLEEP
262 #define RADIOLIB_LR11X0_SLEEP_RETENTION_DISABLED (0x00UL << 0) // 0 0 configuration retention in sleep mode: disabled
263 #define RADIOLIB_LR11X0_SLEEP_RETENTION_ENABLED (0x01UL << 0) // 0 0 enabled
264 #define RADIOLIB_LR11X0_SLEEP_WAKEUP_DISABLED (0x00UL << 0) // 1 1 automated wakeup: disabled
265 #define RADIOLIB_LR11X0_SLEEP_WAKEUP_ENABLED (0x01UL << 0) // 1 1 enabled
266
267 // RADIOLIB_LR11X0_CMD_SET_STANDBY
268 #define RADIOLIB_LR11X0_STANDBY_RC (0x00UL << 0) // 7 0 standby mode: RC oscillator
269 #define RADIOLIB_LR11X0_STANDBY_XOSC (0x00UL << 0) // 7 0 XTAL/TCXO oscillator
270
271 // RADIOLIB_LR11X0_CMD_ERASE_INFO_PAGE
272 #define RADIOLIB_LR11X0_INFO_PAGE (1)
273
274 // RADIOLIB_LR11X0_CMD_GET_CHIP_EUI
275 #define RADIOLIB_LR11X0_EUI_LEN (8)
276
277 // RADIOLIB_LR11X0_CMD_DERIVE_ROOT_KEYS_AND_GET_PIN
278 #define RADIOLIB_LR11X0_PIN_LEN (4)
279
280 // RADIOLIB_LR11X0_CMD_GET_PACKET_STATUS
281 #define RADIOLIB_LR11X0_RX_STATUS_ADDR_ERR (0x01UL << 5) // 7 0 Rx status: address filtering error
282 #define RADIOLIB_LR11X0_RX_STATUS_CRC_ERR (0x01UL << 4) // 7 0 CRC error
283 #define RADIOLIB_LR11X0_RX_STATUS_LEN_ERR (0x01UL << 3) // 7 0 length filtering error
284 #define RADIOLIB_LR11X0_RX_STATUS_ABORTED (0x01UL << 2) // 7 0 packet reception aborted
285 #define RADIOLIB_LR11X0_RX_STATUS_PACKET_RECEIVED (0x01UL << 1) // 7 0 packet received
286 #define RADIOLIB_LR11X0_RX_STATUS_PACKET_SENT (0x01UL << 0) // 7 0 packet sent
287
288 // RADIOLIB_LR11X0_CMD_SET_GFSK_SYNC_WORD
289 #define RADIOLIB_LR11X0_GFSK_SYNC_WORD_LEN (8)
290
291 // RADIOLIB_LR11X0_CMD_SET_LORA_PUBLIC_NETWORK
292 #define RADIOLIB_LR11X0_LORA_PRIVATE_NETWORK (0x00UL << 0) // 7 0 LoRa sync word: private network
293 #define RADIOLIB_LR11X0_LORA_PUBLIC_NETWORK (0x01UL << 0) // 7 0 public network
294
295 // RADIOLIB_LR11X0_CMD_SET_RX
296 #define RADIOLIB_LR11X0_RX_TIMEOUT_NONE (0x000000UL) // 23 0 Rx timeout duration: no timeout (Rx single mode)
297 #define RADIOLIB_LR11X0_RX_TIMEOUT_INF (0xFFFFFFUL) // 23 0 infinite (Rx continuous mode)
298
299 // RADIOLIB_LR11X0_CMD_SET_TX
300 #define RADIOLIB_LR11X0_TX_TIMEOUT_NONE (0x000000UL) // 23 0 disable Tx timeout
301
302 // RADIOLIB_LR11X0_CMD_AUTO_TX_RX
303 #define RADIOLIB_LR11X0_AUTO_TX_RX_DISABLED (0xFFFFFFUL) // 23 0 disable auto Tx/Rx mode
304 #define RADIOLIB_LR11X0_AUTO_TX_RX_SKIP_INT (0x000000UL) // 23 0 skip intermediary mode
305 #define RADIOLIB_LR11X0_AUTO_INTERMEDIARY_MODE_SLEEP (0x00UL << 0) // 1 0 intermediary mode: sleep
306 #define RADIOLIB_LR11X0_AUTO_INTERMEDIARY_MODE_STBY_RC (0x01UL << 0) // 1 0 standby with RC
307 #define RADIOLIB_LR11X0_AUTO_INTERMEDIARY_MODE_STBY_XOSC (0x02UL << 0) // 1 0 standby with XOSC
308 #define RADIOLIB_LR11X0_AUTO_INTERMEDIARY_MODE_FS (0x03UL << 0) // 1 0 frequency synthesis
309 #define RADIOLIB_LR11X0_AUTO_TX_RX_TIMEOUT_DISABLED (0x000000UL) // 23 0 disable timeout of the second mode
310
311 // RADIOLIB_LR11X0_CMD_SET_CAD_PARAMS
312 #define RADIOLIB_LR11X0_CAD_EXIT_MODE_STBY_RC (0x00UL << 0) // 7 0 mode to set after CAD: standby with RC
313 #define RADIOLIB_LR11X0_CAD_EXIT_MODE_RX (0x01UL << 0) // 7 0 receive if activity detected
314 #define RADIOLIB_LR11X0_CAD_EXIT_MODE_LBT (0x10UL << 0) // 7 0 transmit if no activity detected
315 #define RADIOLIB_LR11X0_CAD_PARAM_DEFAULT (0xFFUL << 0) // 7 0 used by the CAD methods to specify default parameter value
316
317 // RADIOLIB_LR11X0_CMD_SET_PACKET_TYPE
318 #define RADIOLIB_LR11X0_PACKET_TYPE_NONE (0x00UL << 0) // 2 0 packet type: none
319 #define RADIOLIB_LR11X0_PACKET_TYPE_GFSK (0x01UL << 0) // 2 0 (G)FSK
320 #define RADIOLIB_LR11X0_PACKET_TYPE_LORA (0x02UL << 0) // 2 0 LoRa
321 #define RADIOLIB_LR11X0_PACKET_TYPE_SIGFOX (0x03UL << 0) // 2 0 Sigfox
322 #define RADIOLIB_LR11X0_PACKET_TYPE_LR_FHSS (0x04UL << 0) // 2 0 GMSK/LR-FHSS
323 #define RADIOLIB_LR11X0_PACKET_TYPE_RANGING (0x05UL << 0) // 2 0 ranging
324 #define RADIOLIB_LR11X0_PACKET_TYPE_BLE (0x06UL << 0) // 2 0 BLE beacon
325
326 // RADIOLIB_LR11X0_CMD_SET_MODULATION_PARAMS
327 #define RADIOLIB_LR11X0_LORA_BW_62_5 (0x03UL << 0) // 7 0 LoRa bandwidth: 62.5 kHz
328 #define RADIOLIB_LR11X0_LORA_BW_125_0 (0x04UL << 0) // 7 0 125.0 kHz
329 #define RADIOLIB_LR11X0_LORA_BW_250_0 (0x05UL << 0) // 7 0 250.0 kHz
330 #define RADIOLIB_LR11X0_LORA_BW_500_0 (0x06UL << 0) // 7 0 500.0 kHz
331 #define RADIOLIB_LR11X0_LORA_CR_4_5_SHORT (0x01UL << 0) // 7 0 coding rate: 4/5 with short interleaver
332 #define RADIOLIB_LR11X0_LORA_CR_4_6_SHORT (0x02UL << 0) // 7 0 4/6 with short interleaver
333 #define RADIOLIB_LR11X0_LORA_CR_4_7_SHORT (0x03UL << 0) // 7 0 4/7 with short interleaver
334 #define RADIOLIB_LR11X0_LORA_CR_4_8_SHORT (0x04UL << 0) // 7 0 4/8 with short interleaver
335 #define RADIOLIB_LR11X0_LORA_CR_4_5_LONG (0x05UL << 0) // 7 0 4/5 with long interleaver
336 #define RADIOLIB_LR11X0_LORA_CR_4_6_LONG (0x06UL << 0) // 7 0 4/6 with long interleaver
337 #define RADIOLIB_LR11X0_LORA_CR_4_8_LONG (0x07UL << 0) // 7 0 4/8 with long interleaver
338 #define RADIOLIB_LR11X0_LORA_LDRO_DISABLED (0x00UL << 0) // 7 0 low data rate optimize: disabled
339 #define RADIOLIB_LR11X0_LORA_LDRO_ENABLED (0x01UL << 0) // 7 0 enabled
340 #define RADIOLIB_LR11X0_GFSK_BIT_RATE_DIV_DISABLED (0x00UL << 31) // 31 0 divide bit rate value by 256: disabled
341 #define RADIOLIB_LR11X0_GFSK_BIT_RATE_DIV_ENABLED (0x01UL << 31) // 31 0 enabled
342 #define RADIOLIB_LR11X0_GFSK_SHAPING_NONE (0x00UL << 0) // 7 0 shaping filter: none
343 #define RADIOLIB_LR11X0_GFSK_SHAPING_GAUSSIAN_BT_0_3 (0x08UL << 0) // 7 0 Gaussian, BT = 0.3
344 #define RADIOLIB_LR11X0_GFSK_SHAPING_GAUSSIAN_BT_0_5 (0x09UL << 0) // 7 0 Gaussian, BT = 0.5
345 #define RADIOLIB_LR11X0_GFSK_SHAPING_GAUSSIAN_BT_0_7 (0x0AUL << 0) // 7 0 Gaussian, BT = 0.7
346 #define RADIOLIB_LR11X0_GFSK_SHAPING_GAUSSIAN_BT_1_0 (0x0BUL << 0) // 7 0 Gaussian, BT = 1.0
347 #define RADIOLIB_LR11X0_GFSK_SHAPING_RAISED_COSINE_BT_0_7 (0x16UL << 0) // 7 0 raised cosine, BT = 0.7
348 #define RADIOLIB_LR11X0_GFSK_RX_BW_4_8 (0x1FUL << 0) // 7 0 GFSK Rx bandwidth: 4.8 kHz
349 #define RADIOLIB_LR11X0_GFSK_RX_BW_5_8 (0x17UL << 0) // 7 0 5.8 kHz
350 #define RADIOLIB_LR11X0_GFSK_RX_BW_7_3 (0x0FUL << 0) // 7 0 7.3 kHz
351 #define RADIOLIB_LR11X0_GFSK_RX_BW_9_7 (0x1EUL << 0) // 7 0 9.7 kHz
352 #define RADIOLIB_LR11X0_GFSK_RX_BW_11_7 (0x16UL << 0) // 7 0 11.7 kHz
353 #define RADIOLIB_LR11X0_GFSK_RX_BW_14_6 (0x0EUL << 0) // 7 0 14.6 kHz
354 #define RADIOLIB_LR11X0_GFSK_RX_BW_19_5 (0x1DUL << 0) // 7 0 19.5 kHz
355 #define RADIOLIB_LR11X0_GFSK_RX_BW_23_4 (0x15UL << 0) // 7 0 23.4 kHz
356 #define RADIOLIB_LR11X0_GFSK_RX_BW_29_3 (0x0DUL << 0) // 7 0 29.3 kHz
357 #define RADIOLIB_LR11X0_GFSK_RX_BW_39_0 (0x1CUL << 0) // 7 0 39.0 kHz
358 #define RADIOLIB_LR11X0_GFSK_RX_BW_46_9 (0x14UL << 0) // 7 0 46.9 kHz
359 #define RADIOLIB_LR11X0_GFSK_RX_BW_58_6 (0x0CUL << 0) // 7 0 58.6 kHz
360 #define RADIOLIB_LR11X0_GFSK_RX_BW_78_2 (0x1BUL << 0) // 7 0 78.2 kHz
361 #define RADIOLIB_LR11X0_GFSK_RX_BW_93_8 (0x13UL << 0) // 7 0 93.8 kHz
362 #define RADIOLIB_LR11X0_GFSK_RX_BW_117_3 (0x0BUL << 0) // 7 0 117.3 kHz
363 #define RADIOLIB_LR11X0_GFSK_RX_BW_156_2 (0x1AUL << 0) // 7 0 156.2 kHz
364 #define RADIOLIB_LR11X0_GFSK_RX_BW_187_2 (0x12UL << 0) // 7 0 187.2 kHz
365 #define RADIOLIB_LR11X0_GFSK_RX_BW_234_3 (0x0AUL << 0) // 7 0 234.3 kHz
366 #define RADIOLIB_LR11X0_GFSK_RX_BW_312_0 (0x19UL << 0) // 7 0 312.0 kHz
367 #define RADIOLIB_LR11X0_GFSK_RX_BW_373_6 (0x11UL << 0) // 7 0 373.6 kHz
368 #define RADIOLIB_LR11X0_GFSK_RX_BW_467_0 (0x09UL << 0) // 7 0 467.0 kHz
369 #define RADIOLIB_LR11X0_LR_FHSS_BIT_RATE (0x8001E848UL) // 31 0 LR FHSS bit rate: 488.28215 bps
370 #define RADIOLIB_LR11X0_LR_FHSS_SHAPING_GAUSSIAN_BT_1_0 (0x0BUL << 0) // 7 0 shaping filter: Gaussian, BT = 1.0
371 #define RADIOLIB_LR11X0_SIGFOX_SHAPING_GAUSSIAN_BT_0_7 (0x16UL << 0) // 7 0 shaping filter: Gaussian, BT = 0.7
372
373 // RADIOLIB_LR11X0_CMD_SET_PACKET_PARAMS
374 #define RADIOLIB_LR11X0_LORA_HEADER_EXPLICIT (0x00UL << 0) // 7 0 LoRa header mode: explicit
375 #define RADIOLIB_LR11X0_LORA_HEADER_IMPLICIT (0x01UL << 0) // 7 0 implicit
376 #define RADIOLIB_LR11X0_LORA_PAYLOAD_LEN_ANY (0x00UL << 0) // 7 0 accept any payload length
377 #define RADIOLIB_LR11X0_LORA_CRC_ENABLED (0x01UL << 0) // 7 0 CRC: enabled
378 #define RADIOLIB_LR11X0_LORA_CRC_DISABLED (0x00UL << 0) // 7 0 disabled
379 #define RADIOLIB_LR11X0_LORA_IQ_STANDARD (0x00UL << 0) // 7 0 IQ setup: standard
380 #define RADIOLIB_LR11X0_LORA_IQ_INVERTED (0x01UL << 0) // 7 0 inverted
381 #define RADIOLIB_LR11X0_GFSK_PREAMBLE_DETECT_DISABLED (0x00UL << 0) // 7 0 preamble detector: disabled
382 #define RADIOLIB_LR11X0_GFSK_PREAMBLE_DETECT_8_BITS (0x04UL << 0) // 7 0 8 bits
383 #define RADIOLIB_LR11X0_GFSK_PREAMBLE_DETECT_16_BITS (0x05UL << 0) // 7 0 16 bits
384 #define RADIOLIB_LR11X0_GFSK_PREAMBLE_DETECT_24_BITS (0x06UL << 0) // 7 0 24 bits
385 #define RADIOLIB_LR11X0_GFSK_PREAMBLE_DETECT_32_BITS (0x07UL << 0) // 7 0 32 bits
386 #define RADIOLIB_LR11X0_GFSK_ADDR_FILTER_DISABLED (0x00UL << 0) // 7 0 address filtering: disabled
387 #define RADIOLIB_LR11X0_GFSK_ADDR_FILTER_NODE (0x01UL << 0) // 7 0 node address
388 #define RADIOLIB_LR11X0_GFSK_ADDR_FILTER_NODE_BROADCAST (0x02UL << 0) // 7 0 node and broadcast address
389 #define RADIOLIB_LR11X0_GFSK_PACKET_LENGTH_FIXED (0x00UL << 0) // 7 0 packet length: fixed
390 #define RADIOLIB_LR11X0_GFSK_PACKET_LENGTH_VARIABLE (0x01UL << 0) // 7 0 variable
391 #define RADIOLIB_LR11X0_GFSK_PACKET_LENGTH_VARIABLE_SX128X (0x02UL << 0) // 7 0 variable, SX128x 9-bit length encoding
392 #define RADIOLIB_LR11X0_GFSK_PAYLOAD_LEN_ANY (0x00UL << 0) // 7 0 accept any payload length
393 #define RADIOLIB_LR11X0_GFSK_CRC_DISABLED (0x01UL << 0) // 7 0 CRC: disabled
394 #define RADIOLIB_LR11X0_GFSK_CRC_1_BYTE (0x00UL << 0) // 7 0 1-byte
395 #define RADIOLIB_LR11X0_GFSK_CRC_2_BYTE (0x02UL << 0) // 7 0 2-byte
396 #define RADIOLIB_LR11X0_GFSK_CRC_1_BYTE_INV (0x04UL << 0) // 7 0 1-byte, inverted
397 #define RADIOLIB_LR11X0_GFSK_CRC_2_BYTE_INV (0x06UL << 0) // 7 0 2-byte, inverted
398 #define RADIOLIB_LR11X0_GFSK_WHITENING_DISABLED (0x00UL << 0) // 7 0 whitening: disabled
399 #define RADIOLIB_LR11X0_GFSK_WHITENING_ENABLED (0x01UL << 0) // 7 0 enabled
400
401 // RADIOLIB_LR11X0_CMD_SET_TX_PARAMS
402 #define RADIOLIB_LR11X0_PA_RAMP_48U (0x02UL << 0) // 7 0 PA ramp time: 48 us
403
404 // RADIOLIB_LR11X0_CMD_SET_RX_TX_FALLBACK_MODE
405 #define RADIOLIB_LR11X0_FALLBACK_MODE_STBY_RC (0x01UL << 0) // 1 0 fallback mode after Rx/Tx: standby with RC
406 #define RADIOLIB_LR11X0_FALLBACK_MODE_STBY_XOSC (0x02UL << 0) // 1 0 standby with XOSC
407 #define RADIOLIB_LR11X0_FALLBACK_MODE_FS (0x03UL << 0) // 1 0 frequency synthesis
408
409 // RADIOLIB_LR11X0_CMD_SET_RX_DUTY_CYCLE
410 #define RADIOLIB_LR11X0_RX_DUTY_CYCLE_MODE_RX (0x00UL << 0) // 0 0 mode in Rx windows: Rx (default)
411 #define RADIOLIB_LR11X0_RX_DUTY_CYCLE_MODE_CAD (0x01UL << 0) // 0 0 CAD
412 #define RADIOLIB_LR11X0_TIMING_STEP (1.0f/32768.0f) // 23 0 timing step fo delays
413
414 // RADIOLIB_LR11X0_CMD_SET_PA_CONFIG
415 #define RADIOLIB_LR11X0_PA_SEL_LP (0x00UL << 0) // 7 0 PA select: low power PA
416 #define RADIOLIB_LR11X0_PA_SEL_HP (0x01UL << 0) // 7 0 high power PA
417 #define RADIOLIB_LR11X0_PA_SEL_HF (0x02UL << 0) // 7 0 high frequency PA
418 #define RADIOLIB_LR11X0_PA_SUPPLY_INTERNAL (0x00UL << 0) // 7 0 PA power source: internal
419 #define RADIOLIB_LR11X0_PA_SUPPLY_VBAT (0x01UL << 0) // 7 0 VBAT (required for >= 14 dBm)
420
421 // RADIOLIB_LR11X0_CMD_STOP_TIMEOUT_ON_PREAMBLE
422 #define RADIOLIB_LR11X0_STOP_ON_SYNC_HEADER (0x00UL << 0) // 0 0 stop timeout on: sync word or header (default)
423 #define RADIOLIB_LR11X0_STOP_ON_PREAMBLE (0x01UL << 0) // 0 0 preamble
424
425 // RADIOLIB_LR11X0_CMD_GET_RANGING_RESULT
426 #define RADIOLIB_LR11X0_RANGING_RESULT_DISTANCE (0) // 7 0 ranging result type: distance
427 #define RADIOLIB_LR11X0_RANGING_RESULT_RSSI (1) // 7 0 RSSI
428
429 // RADIOLIB_LR11X0_CMD_SET_RX_BOOSTED
430 #define RADIOLIB_LR11X0_RX_BOOSTED_ENABLED (0x01UL << 0) // 0 0 Rx boosted mode: enabled
431 #define RADIOLIB_LR11X0_RX_BOOSTED_DISABLED (0x00UL << 0) // 0 0 disabled
432
433 // RADIOLIB_LR11X0_CMD_SET_LORA_SYNC_WORD
434 #define RADIOLIB_LR11X0_LORA_SYNC_WORD_PRIVATE (0x12)
435 #define RADIOLIB_LR11X0_LORA_SYNC_WORD_PUBLIC (0x34)
436
437 // RADIOLIB_LR11X0_CMD_LR_FHSS_BUILD_FRAME
438 #define RADIOLIB_LR11X0_LR_FHSS_CR_5_6 (0x00UL << 0) // 7 0 LR FHSS coding rate: 5/6
439 #define RADIOLIB_LR11X0_LR_FHSS_CR_2_3 (0x01UL << 0) // 7 0 2/3
440 #define RADIOLIB_LR11X0_LR_FHSS_CR_1_2 (0x02UL << 0) // 7 0 1/2
441 #define RADIOLIB_LR11X0_LR_FHSS_CR_1_3 (0x03UL << 0) // 7 0 1/3
442 #define RADIOLIB_LR11X0_LR_FHSS_MOD_TYPE_GMSK (0x00UL << 0) // 7 0 LR FHSS modulation: GMSK
443 #define RADIOLIB_LR11X0_LR_FHSS_GRID_STEP_FCC (0x00UL << 0) // 7 0 LR FHSS step size: 25.390625 kHz (FCC)
444 #define RADIOLIB_LR11X0_LR_FHSS_GRID_STEP_NON_FCC (0x01UL << 0) // 7 0 3.90625 kHz (non-FCC)
445 #define RADIOLIB_LR11X0_LR_FHSS_HOPPING_DISABLED (0x00UL << 0) // 7 0 LR FHSS hopping: disabled
446 #define RADIOLIB_LR11X0_LR_FHSS_HOPPING_ENABLED (0x01UL << 0) // 7 0 enabled
447 #define RADIOLIB_LR11X0_LR_FHSS_BW_39_06 (0x00UL << 0) // 7 0 LR FHSS bandwidth: 39.06 kHz
448 #define RADIOLIB_LR11X0_LR_FHSS_BW_85_94 (0x01UL << 0) // 7 0 85.94 kHz
449 #define RADIOLIB_LR11X0_LR_FHSS_BW_136_72 (0x02UL << 0) // 7 0 136.72 kHz
450 #define RADIOLIB_LR11X0_LR_FHSS_BW_183_59 (0x03UL << 0) // 7 0 183.59 kHz
451 #define RADIOLIB_LR11X0_LR_FHSS_BW_335_94 (0x04UL << 0) // 7 0 335.94 kHz
452 #define RADIOLIB_LR11X0_LR_FHSS_BW_386_72 (0x05UL << 0) // 7 0 386.72 kHz
453 #define RADIOLIB_LR11X0_LR_FHSS_BW_722_66 (0x06UL << 0) // 7 0 722.66 kHz
454 #define RADIOLIB_LR11X0_LR_FHSS_BW_773_44 (0x07UL << 0) // 7 0 773.44 kHz
455 #define RADIOLIB_LR11X0_LR_FHSS_BW_1523_4 (0x08UL << 0) // 7 0 1523.4 kHz
456 #define RADIOLIB_LR11X0_LR_FHSS_BW_1574_2 (0x09UL << 0) // 7 0 1574.2 kHz
457
458 // RADIOLIB_LR11X0_CMD_GET_LORA_RX_HEADER_INFOS
459 #define RADIOLIB_LR11X0_LAST_HEADER_CRC_ENABLED (0x01UL << 4) // 4 4 last header CRC: enabled
460 #define RADIOLIB_LR11X0_LAST_HEADER_CRC_DISABLED (0x00UL << 4) // 4 4 disabled
461
462 // RADIOLIB_LR11X0_CMD_WIFI_SCAN
463 #define RADIOLIB_LR11X0_WIFI_SCAN_802_11_B (0x01UL << 0) // 7 0 Wi-Fi type to scan: 802.11b
464 #define RADIOLIB_LR11X0_WIFI_SCAN_802_11_G (0x02UL << 0) // 7 0 802.11g
465 #define RADIOLIB_LR11X0_WIFI_SCAN_802_11_N (0x03UL << 0) // 7 0 802.11n
466 #define RADIOLIB_LR11X0_WIFI_SCAN_ALL (0x04UL << 0) // 7 0 all (802.11b first)
467 #define RADIOLIB_LR11X0_WIFI_ACQ_MODE_BEACON_ONLY (0x01UL << 0) // 7 0 Wi-Fi acquisition mode: beacon only
468 #define RADIOLIB_LR11X0_WIFI_ACQ_MODE_BEACON_PACKET (0x02UL << 0) // 7 0 beacon and packet
469 #define RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_TRAFFIC (0x03UL << 0) // 7 0 full traffic
470 #define RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON (0x04UL << 0) // 7 0 full beacon
471 #define RADIOLIB_LR11X0_WIFI_ACQ_MODE_SSID_BEACON (0x05UL << 0) // 7 0 SSID beacon
472 #define RADIOLIB_LR11X0_WIFI_ABORT_ON_TIMEOUT_ENABLED (0x01UL << 0) // 7 0 abort scanning on preamble timeout: enabled
473 #define RADIOLIB_LR11X0_WIFI_ABORT_ON_TIMEOUT_DISABLED (0x00UL << 0) // 7 0 disabled
474
475 // RADIOLIB_LR11X0_CMD_WIFI_READ_RESULTS
476 #define RADIOLIB_LR11X0_WIFI_RESULT_TYPE_COMPLETE (0x01UL << 0) // 7 0 Wi-Fi scan result type: complete
477 #define RADIOLIB_LR11X0_WIFI_RESULT_TYPE_BASIC (0x04UL << 0) // 7 0 basic
478
479 // RADIOLIB_LR11X0_CMD_GNSS_SET_CONSTELLATION_TO_USE
480 #define RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS (0x01UL << 0) // 7 0 GNSS constellation to use: GPS
481 #define RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU (0x01UL << 1) // 7 0 BeiDou
482
483 // RADIOLIB_LR11X0_CMD_GNSS_SET_MODE
484 #define RADIOLIB_LR11X0_GNSS_MODE_SINGLE_SCAN (0x00UL << 0) // 7 0 GNSS scanning mode: single/legacy
485 #define RADIOLIB_LR11X0_GNSS_MODE_SINGLE_MULTIPLE (0x03UL << 1) // 7 0 multiple/advanced
486
487 // RADIOLIB_LR11X0_CMD_GNSS_AUTONOMOUS
488 #define RADIOLIB_LR11X0_GNSS_RES_PSEUDO_DOPPLER_ENABLED (0x01UL << 0) // 0 0 GNSS results in NAV message: pseudo-range (in single scan mode) or Doppler information (in multiple scan mode)
489 #define RADIOLIB_LR11X0_GNSS_RES_PSEUDO_DOPPLER_DISABLED (0x00UL << 0) // 0 0 not included
490 #define RADIOLIB_LR11X0_GNSS_RES_DOPPLER_ENABLED (0x01UL << 1) // 1 1 Doppler information
491 #define RADIOLIB_LR11X0_GNSS_RES_DOPPLER_DISABLED (0x00UL << 1) // 1 1 not included
492 #define RADIOLIB_LR11X0_GNSS_NB_SV_ALL (0x00UL << 0) // 7 0 include all detected satellites
493 #define RADIOLIB_LR11X0_GNSS_AUTO_EFFORT_MODE (0x00UL << 0) // 7 0 reserved, always 0
494
495 // RADIOLIB_LR11X0_CMD_GNSS_ASSISTED
496 #define RADIOLIB_LR11X0_GNSS_ASSIST_LOW_POWER (0x00UL << 0) // 7 0 effort mode: low power
497 #define RADIOLIB_LR11X0_GNSS_ASSIST_BEST_EFFORT (0x01UL << 0) // 7 0 best effort
498
499 // RADIOLIB_LR11X0_CMD_GNSS_GET_CONTEXT_STATUS
500 #define RADIOLIB_LR11X0_GNSS_CONTEXT_ERR_NONE (0x00UL << 0) // 7 4 error code: none
501 #define RADIOLIB_LR11X0_GNSS_CONTEXT_ERR_ALMANAC_OLD (0x01UL << 0) // 7 4 almanac too old
502 #define RADIOLIB_LR11X0_GNSS_CONTEXT_ERR_ALMANAC_CRC (0x02UL << 0) // 7 4 almanac CRC mismatch
503 #define RADIOLIB_LR11X0_GNSS_CONTEXT_ERR_FLASH (0x03UL << 0) // 7 4 flash integrity error
504 #define RADIOLIB_LR11X0_GNSS_CONTEXT_ERR_ALMANAC_UPD (0x04UL << 0) // 7 4 almanac update not allowed
505 #define RADIOLIB_LR11X0_GNSS_CONTEXT_FREQ_SPACE_250_HZ (0x00UL << 0) // 8 7 frequency search space: 250 Hz
506 #define RADIOLIB_LR11X0_GNSS_CONTEXT_FREQ_SPACE_500_HZ (0x01UL << 0) // 8 7 500 H
507 #define RADIOLIB_LR11X0_GNSS_CONTEXT_FREQ_SPACE_1000_HZ (0x02UL << 0) // 8 7 1000 Hz
508 #define RADIOLIB_LR11X0_GNSS_CONTEXT_FREQ_SPACE_2000_HZ (0x03UL << 0) // 8 7 2000 Hz
509
510 // RADIOLIB_LR11X0_CMD_GNSS_GET_SV_VISIBLE
511 #define RADIOLIB_LR11X0_SV_CONSTELLATION_GPS (0x00UL << 0) // 7 0 GNSS constellation: GPS
512 #define RADIOLIB_LR11X0_SV_CONSTELLATION_BEIDOU (0x01UL << 0) // 7 0 BeiDou
513
514 // RADIOLIB_LR11X0_CMD_GNSS_ALMANAC_FULL_UPDATE
515 #define RADIOLIB_LR11X0_GNSS_ALMANAC_HEADER_ID (0x80UL << 0) // 7 0 starting byte of GNSS almanac header
516 #define RADIOLIB_LR11X0_GNSS_ALMANAC_BLOCK_SIZE (20)
517
518 // RADIOLIB_LR11X0_CMD_CRYPTO_SET_KEY
519 #define RADIOLIB_LR11X0_CRYPTO_STATUS_SUCCESS (0x00UL << 0) // 7 0 crypto engine status: success
520 #define RADIOLIB_LR11X0_CRYPTO_STATUS_FAIL_CMAC (0x01UL << 0) // 7 0 MIC check failed
521 #define RADIOLIB_LR11X0_CRYPTO_STATUS_INV_KEY_ID (0x03UL << 0) // 7 0 key/parameter source or destination ID error
522 #define RADIOLIB_LR11X0_CRYPTO_STATUS_BUF_SIZE (0x05UL << 0) // 7 0 data buffer size invalid
523 #define RADIOLIB_LR11X0_CRYPTO_STATUS_ERROR (0x06UL << 0) // 7 0 generic error
524
525 // RADIOLIB_LR11X0_CMD_CRYPTO_PROCESS_JOIN_ACCEPT
526 #define RADIOLIB_LR11X0_CRYPTO_LORAWAN_VERSION_1_0 (0x00UL << 0) // 7 0 LoRaWAN version: 1.0.x
527 #define RADIOLIB_LR11X0_CRYPTO_LORAWAN_VERSION_1_1 (0x01UL << 0) // 7 0 1.1
528
529 // LR11X0 SPI register variables
530
531 // RADIOLIB_LR11X0_REG_SF6_SX127X_COMPAT
532 #define RADIOLIB_LR11X0_SF6_SX126X (0x00UL << 18) // 18 18 SF6 mode: SX126x series
533 #define RADIOLIB_LR11X0_SF6_SX127X (0x01UL << 18) // 18 18 SX127x series
534
535 // RADIOLIB_LR11X0_REG_LORA_HIGH_POWER_FIX
536 #define RADIOLIB_LR11X0_LORA_HIGH_POWER_FIX (0x00UL << 30) // 30 30 fix for errata
537
538
543 class LR11x0: public PhysicalLayer {
544 public:
545 // introduce PhysicalLayer overloads
546 using PhysicalLayer::transmit;
547 using PhysicalLayer::receive;
548 using PhysicalLayer::startTransmit;
549 using PhysicalLayer::readData;
550
555 LR11x0(Module* mod);
556
560 bool XTAL;
561
572 int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage);
573
583 int16_t beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage);
584
589 int16_t reset();
590
599 int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
600
608 int16_t receive(uint8_t* data, size_t len) override;
609
615 int16_t transmitDirect(uint32_t frf = 0) override;
616
622 int16_t receiveDirect() override;
623
628 int16_t scanChannel() override;
629
637 int16_t scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
638
643 int16_t standby() override;
644
652 int16_t standby(uint8_t mode, bool wakeup = true);
653
661 int16_t sleep(bool retainConfig = true, uint32_t sleepTime = 0);
662
663 // interrupt methods
664
669 void setDio1Action(void (*func)(void));
670
674 void clearDio1Action();
675
680 void setPacketReceivedAction(void (*func)(void));
681
685 void clearPacketReceivedAction();
686
691 void setPacketSentAction(void (*func)(void));
692
696 void clearPacketSentAction();
697
706 int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
707
712 int16_t finishTransmit() override;
713
720 int16_t startReceive();
721
733 int16_t startReceive(uint32_t timeout, uint32_t irqFlags = RADIOLIB_LR11X0_IRQ_RX_DONE, size_t len = 0);
734
739 uint32_t getIrqStatus();
740
749 int16_t readData(uint8_t* data, size_t len) override;
750
756 int16_t startChannelScan() override;
757
766 int16_t startChannelScan(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
767
772 int16_t getChannelScanResult() override;
773
774 // configuration methods
775
781 int16_t setBandwidth(float bw);
782
789 int16_t setSpreadingFactor(uint8_t sf, bool legacy = false);
790
798 int16_t setCodingRate(uint8_t cr, bool longInterleave = false);
799
805 int16_t setSyncWord(uint8_t syncWord);
806
812 int16_t setBitRate(float br);
813
819 int16_t setFrequencyDeviation(float freqDev) override;
820
827 int16_t setRxBandwidth(float rxBw);
828
835 int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
836
844 int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
845
851 int16_t setNodeAddress(uint8_t nodeAddr);
852
859 int16_t setBroadcastAddress(uint8_t broadAddr);
860
865 int16_t disableAddressFiltering();
866
874 int16_t setDataShaping(uint8_t sh) override;
875
881 int16_t setEncoding(uint8_t encoding) override;
882
888 int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
889
895 int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
896
904 int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
905
911 int16_t setDataRate(DataRate_t dr) override;
912
918 int16_t checkDataRate(DataRate_t dr) override;
919
925 int16_t setPreambleLength(size_t preambleLength) override;
926
935 int16_t setTCXO(float voltage, uint32_t delay = 5000);
936
945 int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);
946
952 int16_t invertIQ(bool enable) override;
953
958 float getRSSI();
959
964 float getSNR();
965
970 float getFrequencyError();
971
977 size_t getPacketLength(bool update = true) override;
978
984 size_t getPacketLength(bool update, uint8_t* offset);
985
991 uint32_t getTimeOnAir(size_t len) override;
992
997 float getDataRate() const;
998
999 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
1000 protected:
1001 #endif
1002 Module* getMod();
1003
1004 // LR11x0 SPI command implementations
1005 int16_t writeRegMem32(uint32_t addr, uint32_t* data, size_t len);
1006 int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
1007 int16_t writeBuffer8(uint8_t* data, size_t len);
1008 int16_t readBuffer8(uint8_t* data, size_t len, size_t offset);
1009 int16_t clearRxBuffer(void);
1010 int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);
1011
1012 int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);
1013 int16_t getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
1014 int16_t getErrors(uint16_t* err);
1015 int16_t clearErrors(void);
1016 int16_t calibrate(uint8_t params);
1017 int16_t setRegMode(uint8_t mode);
1018 int16_t calibImage(float freq1, float freq2);
1019 int16_t setDioAsRfSwitch(uint8_t en, uint8_t stbyCfg, uint8_t rxCfg, uint8_t txCfg, uint8_t txHpCfg, uint8_t gnssCfg, uint8_t wifiCfg);
1020 int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
1021 int16_t clearIrq(uint32_t irq);
1022 int16_t configLfClock(uint8_t setup);
1023 int16_t setTcxoMode(uint8_t tune, uint32_t delay);
1024 int16_t reboot(bool stay);
1025 int16_t getVbat(float* vbat);
1026 int16_t getTemp(float* temp);
1027 int16_t setFs(void);
1028 int16_t getRandomNumber(uint32_t* rnd);
1029 int16_t eraseInfoPage(void);
1030 int16_t writeInfoPage(uint16_t addr, uint32_t* data, size_t len);
1031 int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
1032 int16_t getChipEui(uint8_t* eui);
1033 int16_t getSemtechJoinEui(uint8_t* eui);
1034 int16_t deriveRootKeysAndGetPin(uint8_t* pin);
1035 int16_t enableSpiCrc(bool en);
1036 int16_t driveDiosInSleepMode(bool en);
1037
1038 int16_t resetStats(void);
1039 int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
1040 int16_t getPacketType(uint8_t* type);
1041 int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
1042 int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
1043 int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
1044 int16_t getRssiInst(float* rssi);
1045 int16_t setGfskSyncWord(uint8_t* sync);
1046 int16_t setLoRaPublicNetwork(bool pub);
1047 int16_t setRx(uint32_t timeout);
1048 int16_t setTx(uint32_t timeout);
1049 int16_t setRfFrequency(uint32_t rfFreq);
1050 int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
1051 int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
1052 int16_t setPacketType(uint8_t type);
1053 int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
1054 int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
1055 int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
1056 int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
1057 int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
1058 int16_t setPacketParamsGFSK(uint16_t preambleLen, uint8_t preambleDetectorLen, uint8_t syncWordLen, uint8_t addrCmp, uint8_t packType, uint8_t payloadLen, uint8_t crcType, uint8_t whiten);
1059 int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
1060 int16_t setTxParams(int8_t pwr, uint8_t ramp);
1061 int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
1062 int16_t setRxTxFallbackMode(uint8_t mode);
1063 int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
1064 int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
1065 int16_t stopTimeoutOnPreamble(bool stop);
1066 int16_t setCad(void);
1067 int16_t setTxCw(void);
1068 int16_t setTxInfinitePreamble(void);
1069 int16_t setLoRaSynchTimeout(uint8_t symbolNum);
1070 int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
1071 int16_t setRangingReqAddr(uint32_t addr);
1072 int16_t getRangingResult(uint8_t type, float* res);
1073 int16_t setRangingTxRxDelay(uint32_t delay);
1074 int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
1075 int16_t setGfskWhitParams(uint16_t seed);
1076 int16_t setRxBoosted(bool en);
1077 int16_t setRangingParameter(uint8_t symbolNum);
1078 int16_t setLoRaSyncWord(uint8_t sync);
1079 int16_t lrFhssBuildFrame(uint8_t hdrCount, uint8_t cr, uint8_t grid, bool hop, uint8_t bw, uint16_t hopSeq, int8_t devOffset, uint8_t* payload, size_t len);
1080 int16_t lrFhssSetSyncWord(uint32_t sync);
1081 int16_t configBleBeacon(uint8_t chan, uint8_t* payload, size_t len);
1082 int16_t getLoRaRxHeaderInfos(uint8_t* info);
1083 int16_t bleBeaconSend(uint8_t chan, uint8_t* payload, size_t len);
1084
1085 int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
1086 int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
1087 int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
1088 int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
1089 int16_t wifiGetNbResults(uint8_t* nbResults);
1090 int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
1091 int16_t wifiResetCumulTimings(void);
1092 int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
1093 int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
1094 int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
1095 int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
1096 int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
1097
1098 int16_t gnssSetConstellationToUse(uint8_t mask);
1099 int16_t gnssReadConstellationToUse(uint8_t* mask);
1100 int16_t gnssSetAlmanacUpdate(uint8_t mask);
1101 int16_t gnssReadAlmanacUpdate(uint8_t* mask);
1102 int16_t gnssReadVersion(uint8_t* fw, uint8_t* almanac);
1103 int16_t gnssReadSupportedConstellations(uint8_t* mask);
1104 int16_t gnssSetMode(uint8_t mode);
1105 int16_t gnssAutonomous(uint32_t gpsTime, uint8_t resMask, uint8_t nbSvMask);
1106 int16_t gnssAssisted(uint32_t gpsTime, uint8_t effort, uint8_t resMask, uint8_t nbSvMask);
1107 int16_t gnssSetAssistancePosition(float lat, float lon);
1108 int16_t gnssReadAssistancePosition(float* lat, float* lon);
1109 int16_t gnssPushSolverMsg(uint8_t* payload, size_t len);
1110 int16_t gnssPushDmMsg(uint8_t* payload, size_t len);
1111 int16_t gnssGetContextStatus(uint8_t* fwVersion, uint32_t* almanacCrc, uint8_t* errCode, uint8_t* almUpdMask, uint8_t* freqSpace);
1112 int16_t gnssGetNbSvDetected(uint8_t* nbSv);
1113 int16_t gnssGetSvDetected(uint8_t* svId, uint8_t* snr, uint16_t* doppler, size_t nbSv);
1114 int16_t gnssGetConsumption(uint32_t* cpu, uint32_t* radio);
1115 int16_t gnssGetResultSize(uint16_t* size);
1116 int16_t gnssReadResults(uint8_t* result, uint16_t size);
1117 int16_t gnssAlmanacFullUpdateHeader(uint16_t date, uint32_t globalCrc);
1118 int16_t gnssAlmanacFullUpdateSV(uint8_t svn, uint8_t* svnAlmanac);
1119 int16_t gnssGetSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
1120
1121 int16_t cryptoSetKey(uint8_t keyId, uint8_t* key);
1122 int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, uint8_t* key);
1123 int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, uint8_t* header, uint8_t* dataIn, size_t len, uint8_t* dataOut);
1124 int16_t cryptoComputeAesCmac(uint8_t keyId, uint8_t* data, size_t len, uint32_t* mic);
1125 int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, uint8_t* data, size_t len, bool* result);
1126 int16_t cryptoAesEncrypt01(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
1127 int16_t cryptoAesEncrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
1128 int16_t cryptoAesDecrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
1129 int16_t cryptoStoreToFlash(void);
1130 int16_t cryptoRestoreFromFlash(void);
1131 int16_t cryptoSetParam(uint8_t id, uint32_t value);
1132 int16_t cryptoGetParam(uint8_t id, uint32_t* value);
1133 int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, uint32_t* data, size_t len);
1134 int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
1135
1136 int16_t bootEraseFlash(void);
1137 int16_t bootWriteFlashEncrypted(uint32_t offset, uint32_t* data, size_t len);
1138 int16_t bootReboot(bool stay);
1139 int16_t bootGetPin(uint8_t* pin);
1140 int16_t bootGetChipEui(uint8_t* eui);
1141 int16_t bootGetJoinEui(uint8_t* eui);
1142
1143 int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, uint8_t* out = NULL, size_t outLen = 0);
1144
1145 #if !RADIOLIB_GODMODE
1146 protected:
1147 #endif
1148 uint8_t chipType;
1149
1150 #if !RADIOLIB_GODMODE
1151 private:
1152 #endif
1153 Module* mod;
1154
1155 // cached LoRa parameters
1156 uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
1157 uint16_t preambleLengthLoRa = 0;
1158 float bandwidthKhz = 0;
1159 bool ldroAuto = true;
1160 size_t implicitLen = 0;
1161 bool invertIQEnabled = false;
1162
1163 // cached GFSK parameters
1164 uint32_t bitRate = 0, frequencyDev = 0;
1165 uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0, node = 0;
1166 uint16_t preambleLengthGFSK = 0;
1167
1168 float dataRateMeasured = 0;
1169
1170 static int16_t SPIparseStatus(uint8_t in);
1171 static int16_t SPIcheckStatus(Module* mod);
1172 bool findChip(uint8_t ver);
1173 int16_t config(uint8_t modem);
1174 int16_t setPacketMode(uint8_t mode, uint8_t len);
1175 int16_t startCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
1176
1177 // common methods to avoid some copy-paste
1178 int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, uint8_t* payload, size_t len);
1179 int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, uint32_t* data, size_t len);
1180 int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
1181 };
1182
1183 #endif
1184
1185 #endif
LR11x0
Definition: LR11x0.h:543
LR11x0::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition: LR11x0.cpp:507
LR11x0::setBitRate
int16_t setBitRate(float br)
Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: LR11x0.cpp:710
LR11x0::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: LR11x0.cpp:979
LR11x0::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:384
LR11x0::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: LR11x0.cpp:593
LR11x0::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: LR11x0.cpp:1280
LR11x0::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets GFSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: LR11x0.cpp:747
LR11x0::reset
int16_t reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: LR11x0.cpp:156
LR11x0::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:380
LR11x0::getTimeOnAir
uint32_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: LR11x0.cpp:1214
LR11x0::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
LR11x0::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: LR11x0.h:560
LR11x0::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition: LR11x0.cpp:1160
LR11x0::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
LR11x0::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: LR11x0.cpp:1009
LR11x0::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: LR11x0.cpp:560
LR11x0::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)
Sets CRC configuration.
Definition: LR11x0.cpp:1103
LR11x0::LR11x0
LR11x0(Module *mod)
Default constructor.
Definition: LR11x0.cpp:11
LR11x0::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleave=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: LR11x0.cpp:673
LR11x0::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: LR11x0.cpp:908
LR11x0::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:946
LR11x0::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: LR11x0.cpp:857
LR11x0::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets GFSK sync word in the form of array of up to 8 bytes.
Definition: LR11x0.cpp:836
LR11x0::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:388
LR11x0::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: LR11x0.cpp:318
LR11x0::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: LR11x0.cpp:336
LR11x0::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:392
LR11x0::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compa...
Definition: LR11x0.cpp:942
LR11x0::begin
int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage)
Initialization method for LoRa modem.
Definition: LR11x0.cpp:16
LR11x0::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
LR11x0::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: LR11x0.cpp:1048
LR11x0::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:376
LR11x0::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.
Definition: LR11x0.cpp:1031
LR11x0::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: LR11x0.cpp:463
LR11x0::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: LR11x0.cpp:455
LR11x0::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
LR11x0::beginGFSK
int16_t beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)
Initialization method for FSK modem.
Definition: LR11x0.cpp:84
LR11x0::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz.
Definition: LR11x0.cpp:616
LR11x0::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: LR11x0.cpp:727
LR11x0::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: LR11x0.cpp:1195
LR11x0::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:396
LR11x0::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: LR11x0.cpp:1177
LR11x0::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: LR11x0.cpp:1190
LR11x0::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:950
LR11x0::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition: LR11x0.cpp:954
LR11x0::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf, bool legacy=false)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: LR11x0.cpp:652
LR11x0::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: LR11x0.cpp:295
LR11x0::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: LR11x0.cpp:310
LR11x0::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: LR11x0.cpp:894
LR11x0::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word.
Definition: LR11x0.cpp:706
LR11x0::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: LR11x0.cpp:876
LR11x0::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: LR11x0.cpp:1147
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:68
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:54
PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
DataRate_t
Common data rate structure.
Definition: PhysicalLayer.h:38