diff --git a/_module_8h_source.html b/_module_8h_source.html index 27de0644..084973f6 100644 --- a/_module_8h_source.html +++ b/_module_8h_source.html @@ -388,7 +388,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
Module::pinMode
void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:478
Module::noTone
void noTone(RADIOLIB_PIN_TYPE pin)
Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...
Definition: Module.cpp:539
Module::setRfSwitchState
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:803
-
RADIOLIB_ERR_UNKNOWN
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition: TypeDef.h:109
+
RADIOLIB_ERR_UNKNOWN
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition: TypeDef.h:110
Module::RfSwitchMode_t
Definition: Module.h:42
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index 8636a6d4..bb13dbcc 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -673,7 +673,7 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
SX128x::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
SX128x::setDirectAction
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1279
SX128x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:388
-
RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:26
+
RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:27
Module::RfSwitchMode_t
Definition: Module.h:42
diff --git a/_type_def_8h_source.html b/_type_def_8h_source.html index 20581e6c..7ec9607a 100644 --- a/_type_def_8h_source.html +++ b/_type_def_8h_source.html @@ -89,190 +89,191 @@ $(document).ready(function(){initNavTree('_type_def_8h_source.html',''); initRes
1 #if !defined(_RADIOLIB_TYPES_H)
2 #define _RADIOLIB_TYPES_H
3 
-
4 #include "BuildOpt.h"
+
4 // user build options may override the default
5 #include "BuildOptUser.h"
-
6 
-
16 #define RADIOLIB_SHAPING_NONE (0x00)
-
17 
-
21 #define RADIOLIB_SHAPING_0_3 (0x01)
-
22 
-
26 #define RADIOLIB_SHAPING_0_5 (0x02)
-
27 
-
31 #define RADIOLIB_SHAPING_0_7 (0x03)
-
32 
-
36 #define RADIOLIB_SHAPING_1_0 (0x04)
-
37 
-
51 #define RADIOLIB_ENCODING_NRZ (0x00)
-
52 
-
56 #define RADIOLIB_ENCODING_MANCHESTER (0x01)
-
57 
-
61 #define RADIOLIB_ENCODING_WHITENING (0x02)
-
62 
-
76 #define RADIOLIB_STANDBY_DEFAULT (0x00)
-
77 
-
81 #define RADIOLIB_STANDBY_WARM (0x01)
-
82 
-
86 #define RADIOLIB_STANDBY_COLD (0x02)
-
87 
-
98 // common status codes
-
99 
-
103 #define RADIOLIB_ERR_NONE (0)
-
104 
-
109 #define RADIOLIB_ERR_UNKNOWN (-1)
-
110 
-
111 // SX127x/RFM9x status codes
-
112 
-
117 #define RADIOLIB_ERR_CHIP_NOT_FOUND (-2)
-
118 
-
122 #define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED (-3)
-
123 
-
127 #define RADIOLIB_ERR_PACKET_TOO_LONG (-4)
-
128 
-
132 #define RADIOLIB_ERR_TX_TIMEOUT (-5)
-
133 
-
137 #define RADIOLIB_ERR_RX_TIMEOUT (-6)
-
138 
-
143 #define RADIOLIB_ERR_CRC_MISMATCH (-7)
-
144 
-
148 #define RADIOLIB_ERR_INVALID_BANDWIDTH (-8)
-
149 
-
153 #define RADIOLIB_ERR_INVALID_SPREADING_FACTOR (-9)
-
154 
-
158 #define RADIOLIB_ERR_INVALID_CODING_RATE (-10)
-
159 
-
163 #define RADIOLIB_ERR_INVALID_BIT_RANGE (-11)
-
164 
-
168 #define RADIOLIB_ERR_INVALID_FREQUENCY (-12)
-
169 
-
173 #define RADIOLIB_ERR_INVALID_OUTPUT_POWER (-13)
-
174 
-
179 #define RADIOLIB_PREAMBLE_DETECTED (-14)
-
180 
-
184 #define RADIOLIB_CHANNEL_FREE (-15)
-
185 
-
189 #define RADIOLIB_ERR_SPI_WRITE_FAILED (-16)
-
190 
-
194 #define RADIOLIB_ERR_INVALID_CURRENT_LIMIT (-17)
-
195 
-
199 #define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH (-18)
-
200 
-
204 #define RADIOLIB_ERR_INVALID_GAIN (-19)
-
205 
-
210 #define RADIOLIB_ERR_WRONG_MODEM (-20)
-
211 
-
215 #define RADIOLIB_ERR_INVALID_NUM_SAMPLES (-21)
-
216 
-
220 #define RADIOLIB_ERR_INVALID_RSSI_OFFSET (-22)
-
221 
-
225 #define RADIOLIB_ERR_INVALID_ENCODING (-23)
-
226 
-
230 #define RADIOLIB_ERR_LORA_HEADER_DAMAGED (-24)
-
231 
-
235 #define RADIOLIB_ERR_UNSUPPORTED (-25)
-
236 
-
240 #define RADIOLIB_ERR_INVALID_DIO_PIN (-26)
-
241 
-
245 #define RADIOLIB_ERR_INVALID_RSSI_THRESHOLD (-27)
-
246 
-
250 #define RADIOLIB_ERR_NULL_POINTER (-28)
-
251 
-
252 // RF69-specific status codes
-
253 
-
257 #define RADIOLIB_ERR_INVALID_BIT_RATE (-101)
-
258 
-
262 #define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION (-102)
-
263 
-
267 #define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO (-103)
-
268 
-
272 #define RADIOLIB_ERR_INVALID_RX_BANDWIDTH (-104)
-
273 
-
277 #define RADIOLIB_ERR_INVALID_SYNC_WORD (-105)
-
278 
-
282 #define RADIOLIB_ERR_INVALID_DATA_SHAPING (-106)
-
283 
-
287 #define RADIOLIB_ERR_INVALID_MODULATION (-107)
-
288 
-
292 #define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE (-108)
-
293 
-
294 // APRS status codes
-
295 
-
299 #define RADIOLIB_ERR_INVALID_SYMBOL (-201)
-
300 
-
304 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY (-202)
-
305 
-
309 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY_LENGTH (-203)
-
310 
-
314 #define RADIOLIB_ERR_MIC_E_TELEMETRY_STATUS (-204)
-
315 
-
316 // SSDV status codes
-
317 
-
321 #define RADIOLIB_ERR_INVALID_SSDV_MODE (-301)
-
322 
-
326 #define RADIOLIB_ERR_INVALID_IMAGE_SIZE (-302)
-
327 
-
331 #define RADIOLIB_ERR_INVALID_IMAGE_QUALITY (-303)
-
332 
-
336 #define RADIOLIB_ERR_INVALID_SUBSAMPLING (-304)
-
337 
-
338 // RTTY status codes
-
339 
-
343 #define RADIOLIB_ERR_INVALID_RTTY_SHIFT (-401)
-
344 
-
348 #define RADIOLIB_ERR_UNSUPPORTED_ENCODING (-402)
-
349 
-
350 // nRF24-specific status codes
-
351 
-
355 #define RADIOLIB_ERR_INVALID_DATA_RATE (-501)
-
356 
-
360 #define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH (-502)
-
361 
-
365 #define RADIOLIB_ERR_INVALID_PIPE_NUMBER (-503)
-
366 
-
370 #define RADIOLIB_ERR_ACK_NOT_RECEIVED (-504)
-
371 
-
372 // CC1101-specific status codes
-
373 
-
377 #define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS (-601)
-
378 
-
379 // SX126x-specific status codes
-
380 
-
384 #define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION (-701)
-
385 
-
389 #define RADIOLIB_LORA_DETECTED (-702)
-
390 
-
394 #define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE (-703)
-
395 
-
399 #define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS (-704)
-
400 
-
404 #define RADIOLIB_ERR_SPI_CMD_TIMEOUT (-705)
-
405 
-
409 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
-
410 
-
419 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
-
420 
-
427 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
-
428 
-
434 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
-
435 
-
436 // AX.25-specific status codes
-
437 
-
443 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
-
444 
-
450 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
-
451 
-
457 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
-
458 
-
459 // SX128x-specific status codes
-
460 
-
464 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
-
465 
-
466 // Pager-specific status codes
-
467 
-
471 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
-
472 
-
476 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
-
477 
-
482 #endif
+
6 #include "BuildOpt.h"
+
7 
+
17 #define RADIOLIB_SHAPING_NONE (0x00)
+
18 
+
22 #define RADIOLIB_SHAPING_0_3 (0x01)
+
23 
+
27 #define RADIOLIB_SHAPING_0_5 (0x02)
+
28 
+
32 #define RADIOLIB_SHAPING_0_7 (0x03)
+
33 
+
37 #define RADIOLIB_SHAPING_1_0 (0x04)
+
38 
+
52 #define RADIOLIB_ENCODING_NRZ (0x00)
+
53 
+
57 #define RADIOLIB_ENCODING_MANCHESTER (0x01)
+
58 
+
62 #define RADIOLIB_ENCODING_WHITENING (0x02)
+
63 
+
77 #define RADIOLIB_STANDBY_DEFAULT (0x00)
+
78 
+
82 #define RADIOLIB_STANDBY_WARM (0x01)
+
83 
+
87 #define RADIOLIB_STANDBY_COLD (0x02)
+
88 
+
99 // common status codes
+
100 
+
104 #define RADIOLIB_ERR_NONE (0)
+
105 
+
110 #define RADIOLIB_ERR_UNKNOWN (-1)
+
111 
+
112 // SX127x/RFM9x status codes
+
113 
+
118 #define RADIOLIB_ERR_CHIP_NOT_FOUND (-2)
+
119 
+
123 #define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED (-3)
+
124 
+
128 #define RADIOLIB_ERR_PACKET_TOO_LONG (-4)
+
129 
+
133 #define RADIOLIB_ERR_TX_TIMEOUT (-5)
+
134 
+
138 #define RADIOLIB_ERR_RX_TIMEOUT (-6)
+
139 
+
144 #define RADIOLIB_ERR_CRC_MISMATCH (-7)
+
145 
+
149 #define RADIOLIB_ERR_INVALID_BANDWIDTH (-8)
+
150 
+
154 #define RADIOLIB_ERR_INVALID_SPREADING_FACTOR (-9)
+
155 
+
159 #define RADIOLIB_ERR_INVALID_CODING_RATE (-10)
+
160 
+
164 #define RADIOLIB_ERR_INVALID_BIT_RANGE (-11)
+
165 
+
169 #define RADIOLIB_ERR_INVALID_FREQUENCY (-12)
+
170 
+
174 #define RADIOLIB_ERR_INVALID_OUTPUT_POWER (-13)
+
175 
+
180 #define RADIOLIB_PREAMBLE_DETECTED (-14)
+
181 
+
185 #define RADIOLIB_CHANNEL_FREE (-15)
+
186 
+
190 #define RADIOLIB_ERR_SPI_WRITE_FAILED (-16)
+
191 
+
195 #define RADIOLIB_ERR_INVALID_CURRENT_LIMIT (-17)
+
196 
+
200 #define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH (-18)
+
201 
+
205 #define RADIOLIB_ERR_INVALID_GAIN (-19)
+
206 
+
211 #define RADIOLIB_ERR_WRONG_MODEM (-20)
+
212 
+
216 #define RADIOLIB_ERR_INVALID_NUM_SAMPLES (-21)
+
217 
+
221 #define RADIOLIB_ERR_INVALID_RSSI_OFFSET (-22)
+
222 
+
226 #define RADIOLIB_ERR_INVALID_ENCODING (-23)
+
227 
+
231 #define RADIOLIB_ERR_LORA_HEADER_DAMAGED (-24)
+
232 
+
236 #define RADIOLIB_ERR_UNSUPPORTED (-25)
+
237 
+
241 #define RADIOLIB_ERR_INVALID_DIO_PIN (-26)
+
242 
+
246 #define RADIOLIB_ERR_INVALID_RSSI_THRESHOLD (-27)
+
247 
+
251 #define RADIOLIB_ERR_NULL_POINTER (-28)
+
252 
+
253 // RF69-specific status codes
+
254 
+
258 #define RADIOLIB_ERR_INVALID_BIT_RATE (-101)
+
259 
+
263 #define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION (-102)
+
264 
+
268 #define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO (-103)
+
269 
+
273 #define RADIOLIB_ERR_INVALID_RX_BANDWIDTH (-104)
+
274 
+
278 #define RADIOLIB_ERR_INVALID_SYNC_WORD (-105)
+
279 
+
283 #define RADIOLIB_ERR_INVALID_DATA_SHAPING (-106)
+
284 
+
288 #define RADIOLIB_ERR_INVALID_MODULATION (-107)
+
289 
+
293 #define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE (-108)
+
294 
+
295 // APRS status codes
+
296 
+
300 #define RADIOLIB_ERR_INVALID_SYMBOL (-201)
+
301 
+
305 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY (-202)
+
306 
+
310 #define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY_LENGTH (-203)
+
311 
+
315 #define RADIOLIB_ERR_MIC_E_TELEMETRY_STATUS (-204)
+
316 
+
317 // SSDV status codes
+
318 
+
322 #define RADIOLIB_ERR_INVALID_SSDV_MODE (-301)
+
323 
+
327 #define RADIOLIB_ERR_INVALID_IMAGE_SIZE (-302)
+
328 
+
332 #define RADIOLIB_ERR_INVALID_IMAGE_QUALITY (-303)
+
333 
+
337 #define RADIOLIB_ERR_INVALID_SUBSAMPLING (-304)
+
338 
+
339 // RTTY status codes
+
340 
+
344 #define RADIOLIB_ERR_INVALID_RTTY_SHIFT (-401)
+
345 
+
349 #define RADIOLIB_ERR_UNSUPPORTED_ENCODING (-402)
+
350 
+
351 // nRF24-specific status codes
+
352 
+
356 #define RADIOLIB_ERR_INVALID_DATA_RATE (-501)
+
357 
+
361 #define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH (-502)
+
362 
+
366 #define RADIOLIB_ERR_INVALID_PIPE_NUMBER (-503)
+
367 
+
371 #define RADIOLIB_ERR_ACK_NOT_RECEIVED (-504)
+
372 
+
373 // CC1101-specific status codes
+
374 
+
378 #define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS (-601)
+
379 
+
380 // SX126x-specific status codes
+
381 
+
385 #define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION (-701)
+
386 
+
390 #define RADIOLIB_LORA_DETECTED (-702)
+
391 
+
395 #define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE (-703)
+
396 
+
400 #define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS (-704)
+
401 
+
405 #define RADIOLIB_ERR_SPI_CMD_TIMEOUT (-705)
+
406 
+
410 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
+
411 
+
420 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
+
421 
+
428 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
+
429 
+
435 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
+
436 
+
437 // AX.25-specific status codes
+
438 
+
444 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
+
445 
+
451 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
+
452 
+
458 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
+
459 
+
460 // SX128x-specific status codes
+
461 
+
465 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
+
466 
+
467 // Pager-specific status codes
+
468 
+
472 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
+
473 
+
477 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
+
478 
+
483 #endif