RadioLib
Universal wireless communication library for Arduino
TypeDef.h
1 #if !defined(_RADIOLIB_TYPES_H)
2 #define _RADIOLIB_TYPES_H
3 
4 #include "BuildOpt.h"
5 
15 #define RADIOLIB_SHAPING_NONE (0x00)
16 
20 #define RADIOLIB_SHAPING_0_3 (0x01)
21 
25 #define RADIOLIB_SHAPING_0_5 (0x02)
26 
30 #define RADIOLIB_SHAPING_0_7 (0x03)
31 
35 #define RADIOLIB_SHAPING_1_0 (0x04)
36 
50 #define RADIOLIB_ENCODING_NRZ (0x00)
51 
55 #define RADIOLIB_ENCODING_MANCHESTER (0x01)
56 
60 #define RADIOLIB_ENCODING_WHITENING (0x02)
61 
75 #define RADIOLIB_STANDBY_DEFAULT (0x00)
76 
80 #define RADIOLIB_STANDBY_WARM (0x01)
81 
85 #define RADIOLIB_STANDBY_COLD (0x02)
86 
97 // common status codes
98 
102 #define RADIOLIB_ERR_NONE (0)
103 
108 #define RADIOLIB_ERR_UNKNOWN (-1)
109 
110 // SX127x/RFM9x status codes
111 
116 #define RADIOLIB_ERR_CHIP_NOT_FOUND (-2)
117 
121 #define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED (-3)
122 
126 #define RADIOLIB_ERR_PACKET_TOO_LONG (-4)
127 
131 #define RADIOLIB_ERR_TX_TIMEOUT (-5)
132 
136 #define RADIOLIB_ERR_RX_TIMEOUT (-6)
137 
142 #define RADIOLIB_ERR_CRC_MISMATCH (-7)
143 
147 #define RADIOLIB_ERR_INVALID_BANDWIDTH (-8)
148 
152 #define RADIOLIB_ERR_INVALID_SPREADING_FACTOR (-9)
153 
157 #define RADIOLIB_ERR_INVALID_CODING_RATE (-10)
158 
162 #define RADIOLIB_ERR_INVALID_BIT_RANGE (-11)
163 
167 #define RADIOLIB_ERR_INVALID_FREQUENCY (-12)
168 
172 #define RADIOLIB_ERR_INVALID_OUTPUT_POWER (-13)
173 
178 #define RADIOLIB_PREAMBLE_DETECTED (-14)
179 
183 #define RADIOLIB_CHANNEL_FREE (-15)
184 
188 #define RADIOLIB_ERR_SPI_WRITE_FAILED (-16)
189 
193 #define RADIOLIB_ERR_INVALID_CURRENT_LIMIT (-17)
194 
198 #define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH (-18)
199 
203 #define RADIOLIB_ERR_INVALID_GAIN (-19)
204 
209 #define RADIOLIB_ERR_WRONG_MODEM (-20)
210 
214 #define RADIOLIB_ERR_INVALID_NUM_SAMPLES (-21)
215 
219 #define RADIOLIB_ERR_INVALID_RSSI_OFFSET (-22)
220 
224 #define RADIOLIB_ERR_INVALID_ENCODING (-23)
225 
229 #define RADIOLIB_ERR_LORA_HEADER_DAMAGED (-24)
230 
234 #define RADIOLIB_ERR_UNSUPPORTED (-25)
235 
239 #define RADIOLIB_ERR_INVALID_DIO_PIN (-26)
240 
244 #define RADIOLIB_ERR_INVALID_RSSI_THRESHOLD (-27)
245 
249 #define RADIOLIB_ERR_NULL_POINTER (-28)
250 
251 // RF69-specific status codes
252 
256 #define RADIOLIB_ERR_INVALID_BIT_RATE (-101)
257 
261 #define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION (-102)
262 
266 #define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO (-103)
267 
271 #define RADIOLIB_ERR_INVALID_RX_BANDWIDTH (-104)
272 
276 #define RADIOLIB_ERR_INVALID_SYNC_WORD (-105)
277 
281 #define RADIOLIB_ERR_INVALID_DATA_SHAPING (-106)
282 
286 #define RADIOLIB_ERR_INVALID_MODULATION (-107)
287 
291 #define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE (-108)
292 
293 // APRS status codes
294 
298 #define RADIOLIB_ERR_INVALID_SYMBOL (-201)
299 
303 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY (-202)
304 
308 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY_LENGTH (-203)
309 
313 #define RADIOLIB_ERR_MIC_E_TELEMETRY_STATUS (-204)
314 
315 // RTTY status codes
316 
320 #define RADIOLIB_ERR_INVALID_RTTY_SHIFT (-401)
321 
325 #define RADIOLIB_ERR_UNSUPPORTED_ENCODING (-402)
326 
327 // nRF24-specific status codes
328 
332 #define RADIOLIB_ERR_INVALID_DATA_RATE (-501)
333 
337 #define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH (-502)
338 
342 #define RADIOLIB_ERR_INVALID_PIPE_NUMBER (-503)
343 
347 #define RADIOLIB_ERR_ACK_NOT_RECEIVED (-504)
348 
349 // CC1101-specific status codes
350 
354 #define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS (-601)
355 
356 // SX126x-specific status codes
357 
361 #define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION (-701)
362 
366 #define RADIOLIB_LORA_DETECTED (-702)
367 
371 #define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE (-703)
372 
376 #define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS (-704)
377 
381 #define RADIOLIB_ERR_SPI_CMD_TIMEOUT (-705)
382 
386 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
387 
391 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
392 
399 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
400 
406 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
407 
408 // AX.25-specific status codes
409 
415 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
416 
422 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
423 
429 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
430 
431 // SX128x-specific status codes
432 
436 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
437 
438 // Pager-specific status codes
439 
443 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
444 
448 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
449 
454 #endif