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 
72 // common status codes
73 
77 #define RADIOLIB_ERR_NONE (0)
78 
83 #define RADIOLIB_ERR_UNKNOWN (-1)
84 
85 // SX127x/RFM9x status codes
86 
91 #define RADIOLIB_ERR_CHIP_NOT_FOUND (-2)
92 
96 #define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED (-3)
97 
101 #define RADIOLIB_ERR_PACKET_TOO_LONG (-4)
102 
106 #define RADIOLIB_ERR_TX_TIMEOUT (-5)
107 
111 #define RADIOLIB_ERR_RX_TIMEOUT (-6)
112 
117 #define RADIOLIB_ERR_CRC_MISMATCH (-7)
118 
122 #define RADIOLIB_ERR_INVALID_BANDWIDTH (-8)
123 
127 #define RADIOLIB_ERR_INVALID_SPREADING_FACTOR (-9)
128 
132 #define RADIOLIB_ERR_INVALID_CODING_RATE (-10)
133 
137 #define RADIOLIB_ERR_INVALID_BIT_RANGE (-11)
138 
142 #define RADIOLIB_ERR_INVALID_FREQUENCY (-12)
143 
147 #define RADIOLIB_ERR_INVALID_OUTPUT_POWER (-13)
148 
153 #define RADIOLIB_PREAMBLE_DETECTED (-14)
154 
158 #define RADIOLIB_CHANNEL_FREE (-15)
159 
163 #define RADIOLIB_ERR_SPI_WRITE_FAILED (-16)
164 
168 #define RADIOLIB_ERR_INVALID_CURRENT_LIMIT (-17)
169 
173 #define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH (-18)
174 
178 #define RADIOLIB_ERR_INVALID_GAIN (-19)
179 
184 #define RADIOLIB_ERR_WRONG_MODEM (-20)
185 
189 #define RADIOLIB_ERR_INVALID_NUM_SAMPLES (-21)
190 
194 #define RADIOLIB_ERR_INVALID_RSSI_OFFSET (-22)
195 
199 #define RADIOLIB_ERR_INVALID_ENCODING (-23)
200 
204 #define RADIOLIB_ERR_LORA_HEADER_DAMAGED (-24)
205 
209 #define RADIOLIB_ERR_UNSUPPORTED (-25)
210 
214 #define RADIOLIB_ERR_INVALID_DIO_PIN (-26)
215 
219 #define RADIOLIB_ERR_INVALID_RSSI_THRESHOLD (-27)
220 
224 #define RADIOLIB_ERR_NULL_POINTER (-28)
225 
226 // RF69-specific status codes
227 
231 #define RADIOLIB_ERR_INVALID_BIT_RATE (-101)
232 
236 #define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION (-102)
237 
241 #define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO (-103)
242 
246 #define RADIOLIB_ERR_INVALID_RX_BANDWIDTH (-104)
247 
251 #define RADIOLIB_ERR_INVALID_SYNC_WORD (-105)
252 
256 #define RADIOLIB_ERR_INVALID_DATA_SHAPING (-106)
257 
261 #define RADIOLIB_ERR_INVALID_MODULATION (-107)
262 
266 #define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE (-108)
267 
268 // APRS status codes
269 
273 #define RADIOLIB_ERR_INVALID_SYMBOL (-201)
274 
278 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY (-202)
279 
283 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY_LENGTH (-203)
284 
288 #define RADIOLIB_ERR_MIC_E_TELEMETRY_STATUS (-204)
289 
290 // RTTY status codes
291 
295 #define RADIOLIB_ERR_INVALID_RTTY_SHIFT (-401)
296 
300 #define RADIOLIB_ERR_UNSUPPORTED_ENCODING (-402)
301 
302 // nRF24-specific status codes
303 
307 #define RADIOLIB_ERR_INVALID_DATA_RATE (-501)
308 
312 #define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH (-502)
313 
317 #define RADIOLIB_ERR_INVALID_PIPE_NUMBER (-503)
318 
322 #define RADIOLIB_ERR_ACK_NOT_RECEIVED (-504)
323 
324 // CC1101-specific status codes
325 
329 #define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS (-601)
330 
331 // SX126x-specific status codes
332 
336 #define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION (-701)
337 
341 #define RADIOLIB_LORA_DETECTED (-702)
342 
346 #define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE (-703)
347 
351 #define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS (-704)
352 
356 #define RADIOLIB_ERR_SPI_CMD_TIMEOUT (-705)
357 
361 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
362 
366 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
367 
374 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
375 
381 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
382 
383 // AX.25-specific status codes
384 
390 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
391 
397 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
398 
404 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
405 
406 // SX128x-specific status codes
407 
411 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
412 
413 // Pager-specific status codes
414 
418 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
419 
423 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
424 
429 #endif