Updated macro names

This commit is contained in:
jgromes 2021-11-14 11:36:06 +01:00
parent 10ec10d233
commit 70d86f7eb6
2 changed files with 115 additions and 364 deletions

View file

@ -13,9 +13,6 @@ SerialModule KEYWORD1
# modules # modules
CC1101 KEYWORD1 CC1101 KEYWORD1
ESP8266 KEYWORD1
HC05 KEYWORD1
JDY08 KEYWORD1
LLCC68 KEYWORD1 LLCC68 KEYWORD1
nRF24 KEYWORD1 nRF24 KEYWORD1
RF69 KEYWORD1 RF69 KEYWORD1
@ -42,12 +39,8 @@ SX1279 KEYWORD1
SX1280 KEYWORD1 SX1280 KEYWORD1
SX1281 KEYWORD1 SX1281 KEYWORD1
SX1282 KEYWORD1 SX1282 KEYWORD1
XBee KEYWORD1
XBeeSerial KEYWORD1
# protocols # protocols
MQTTClient KEYWORD1
HTTPClient KEYWORD1
RTTYClient KEYWORD1 RTTYClient KEYWORD1
MorseClient KEYWORD1 MorseClient KEYWORD1
PagerClient KEYWORD1 PagerClient KEYWORD1
@ -177,17 +170,6 @@ startReceiveDutyCycleAuto KEYWORD2
setRegulatorLDO KEYWORD2 setRegulatorLDO KEYWORD2
setRegulatorDCDC KEYWORD2 setRegulatorDCDC KEYWORD2
getCurrentLimit KEYWORD2 getCurrentLimit KEYWORD2
# ESP8266
join KEYWORD2
reset KEYWORD2
# XBee
setDestinationAddress KEYWORD2
setPanId KEYWORD2
getPacketSource KEYWORD2
getPacketData KEYWORD2
# nRF24 # nRF24
setIrqAction KEYWORD2 setIrqAction KEYWORD2
setAddressWidth KEYWORD2 setAddressWidth KEYWORD2
@ -197,19 +179,6 @@ disablePipe KEYWORD2
getStatus KEYWORD2 getStatus KEYWORD2
setAutoAck KEYWORD2 setAutoAck KEYWORD2
# HTTP
get KEYWORD2
post KEYWORD2
# MQTT
connect KEYWORD2
disconnect KEYWORD2
publish KEYWORD2
subscribe KEYWORD2
unsubscribe KEYWORD2
ping KEYWORD2
check KEYWORD2
# RTTY # RTTY
idle KEYWORD2 idle KEYWORD2
byteArr KEYWORD2 byteArr KEYWORD2
@ -217,17 +186,6 @@ byteArr KEYWORD2
# Morse # Morse
startSignal KEYWORD2 startSignal KEYWORD2
# TransportLayer
openTransportConnection KEYWORD2
closeTransportConnection KEYWORD2
send KEYWORD2
receive KEYWORD2
getNumBytes KEYWORD2
# SIM800
sendSMS KEYWORD2
shutdown KEYWORD2
# AX.25 # AX.25
setRepeaters KEYWORD2 setRepeaters KEYWORD2
setRecvSequence KEYWORD2 setRecvSequence KEYWORD2
@ -273,88 +231,65 @@ RADIOLIB_ENCODING_NRZ LITERAL1
RADIOLIB_ENCODING_MANCHESTER LITERAL1 RADIOLIB_ENCODING_MANCHESTER LITERAL1
RADIOLIB_ENCODING_WHITENING LITERAL1 RADIOLIB_ENCODING_WHITENING LITERAL1
ERR_NONE LITERAL1 RADIOLIB_ERR_NONE LITERAL1
ERR_UNKNOWN LITERAL1 RADIOLIB_ERR_UNKNOWN LITERAL1
ERR_CHIP_NOT_FOUND LITERAL1 RADIOLIB_ERR_CHIP_NOT_FOUND LITERAL1
ERR_MEMORY_ALLOCATION_FAILED LITERAL1 RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED LITERAL1
ERR_PACKET_TOO_LONG LITERAL1 RADIOLIB_ERR_PACKET_TOO_LONG LITERAL1
ERR_TX_TIMEOUT LITERAL1 RADIOLIB_ERR_TX_TIMEOUT LITERAL1
ERR_RX_TIMEOUT LITERAL1 RADIOLIB_ERR_RX_TIMEOUT LITERAL1
ERR_CRC_MISMATCH LITERAL1 RADIOLIB_ERR_CRC_MISMATCH LITERAL1
ERR_INVALID_BANDWIDTH LITERAL1 RADIOLIB_ERR_INVALID_BANDWIDTH LITERAL1
ERR_INVALID_SPREADING_FACTOR LITERAL1 RADIOLIB_ERR_INVALID_SPREADING_FACTOR LITERAL1
ERR_INVALID_CODING_RATE LITERAL1 RADIOLIB_ERR_INVALID_CODING_RATE LITERAL1
ERR_INVALID_BIT_RANGE LITERAL1 RADIOLIB_ERR_INVALID_BIT_RANGE LITERAL1
ERR_INVALID_FREQUENCY LITERAL1 RADIOLIB_ERR_INVALID_FREQUENCY LITERAL1
ERR_INVALID_OUTPUT_POWER LITERAL1 RADIOLIB_ERR_INVALID_OUTPUT_POWER LITERAL1
PREAMBLE_DETECTED LITERAL1 RADIOLIB_PREAMBLE_DETECTED LITERAL1
CHANNEL_FREE LITERAL1 RADIOLIB_CHANNEL_FREE LITERAL1
ERR_SPI_WRITE_FAILED LITERAL1 RADIOLIB_ERR_SPI_WRITE_FAILED LITERAL1
ERR_INVALID_CURRENT_LIMIT LITERAL1 RADIOLIB_ERR_INVALID_CURRENT_LIMIT LITERAL1
ERR_INVALID_PREAMBLE_LENGTH LITERAL1 RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH LITERAL1
ERR_INVALID_GAIN LITERAL1 RADIOLIB_ERR_INVALID_GAIN LITERAL1
ERR_WRONG_MODEM LITERAL1 RADIOLIB_ERR_WRONG_MODEM LITERAL1
ERR_INVALID_NUM_SAMPLES LITERAL1 RADIOLIB_ERR_INVALID_NUM_SAMPLES LITERAL1
ERR_INVALID_RSSI_OFFSET LITERAL1 RADIOLIB_ERR_INVALID_RSSI_OFFSET LITERAL1
ERR_INVALID_ENCODING LITERAL1 RADIOLIB_ERR_INVALID_ENCODING LITERAL1
ERR_INVALID_BIT_RATE LITERAL1 RADIOLIB_ERR_INVALID_BIT_RATE LITERAL1
ERR_INVALID_FREQUENCY_DEVIATION LITERAL1 RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION LITERAL1
ERR_INVALID_BIT_RATE_BW_RATIO LITERAL1 RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO LITERAL1
ERR_INVALID_RX_BANDWIDTH LITERAL1 RADIOLIB_ERR_INVALID_RX_BANDWIDTH LITERAL1
ERR_INVALID_SYNC_WORD LITERAL1 RADIOLIB_ERR_INVALID_SYNC_WORD LITERAL1
ERR_INVALID_DATA_SHAPING LITERAL1 RADIOLIB_ERR_INVALID_DATA_SHAPING LITERAL1
ERR_INVALID_MODULATION LITERAL1 RADIOLIB_ERR_INVALID_MODULATION LITERAL1
ERR_AT_FAILED LITERAL1 RADIOLIB_ASCII LITERAL1
ERR_URL_MALFORMED LITERAL1 RADIOLIB_ASCII_EXTENDED LITERAL1
ERR_RESPONSE_MALFORMED_AT LITERAL1 RADIOLIB_ITA2 LITERAL1
ERR_RESPONSE_MALFORMED LITERAL1 RADIOLIB_ERR_INVALID_RTTY_SHIFT LITERAL1
ERR_MQTT_CONN_VERSION_REJECTED LITERAL1 RADIOLIB_ERR_UNSUPPORTED_ENCODING LITERAL1
ERR_MQTT_CONN_ID_REJECTED LITERAL1
ERR_MQTT_CONN_SERVER_UNAVAILABLE LITERAL1
ERR_MQTT_CONN_BAD_USERNAME_PASSWORD LITERAL1
ERR_MQTT_CONN_NOT_AUTHORIZED LITERAL1
ERR_MQTT_UNEXPECTED_PACKET_ID LITERAL1
ERR_MQTT_NO_NEW_PACKET_AVAILABLE LITERAL1
MQTT_SUBS_SUCCESS_QOS_0 LITERAL1
MQTT_SUBS_SUCCESS_QOS_1 LITERAL1
MQTT_SUBS_SUCCESS_QOS_2 LITERAL1
ERR_MQTT_SUBS_FAILED LITERAL1
ERR_CMD_MODE_FAILED LITERAL1 RADIOLIB_ERR_INVALID_DATA_RATE LITERAL1
ERR_FRAME_MALFORMED LITERAL1 RADIOLIB_ERR_INVALID_ADDRESS_WIDTH LITERAL1
ERR_FRAME_INCORRECT_CHECKSUM LITERAL1 RADIOLIB_ERR_INVALID_PIPE_NUMBER LITERAL1
ERR_FRAME_UNEXPECTED_ID LITERAL1 RADIOLIB_ERR_ACK_NOT_RECEIVED LITERAL1
ERR_FRAME_NO_RESPONSE LITERAL1
ASCII LITERAL1 RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS LITERAL1
ASCII_EXTENDED LITERAL1
ITA2 LITERAL1
BCD LITERAL1
ERR_INVALID_RTTY_SHIFT LITERAL1
ERR_UNSUPPORTED_ENCODING LITERAL1
ERR_INVALID_DATA_RATE LITERAL1 RADIOLIB_ERR_INVALID_CRC_CONFIGURATION LITERAL1
ERR_INVALID_ADDRESS_WIDTH LITERAL1 RADIOLIB_LORA_DETECTED LITERAL1
ERR_INVALID_PIPE_NUMBER LITERAL1 RADIOLIB_ERR_INVALID_TCXO_VOLTAGE LITERAL1
ERR_ACK_NOT_RECEIVED LITERAL1 RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS LITERAL1
RADIOLIB_ERR_SPI_CMD_TIMEOUT LITERAL1
RADIOLIB_ERR_SPI_CMD_INVALID LITERAL1
RADIOLIB_ERR_SPI_CMD_FAILED LITERAL1
RADIOLIB_ERR_INVALID_SLEEP_PERIOD LITERAL1
RADIOLIB_ERR_INVALID_RX_PERIOD LITERAL1
ERR_INVALID_NUM_BROAD_ADDRS LITERAL1 RADIOLIB_ERR_INVALID_CALLSIGN LITERAL1
RADIOLIB_ERR_INVALID_NUM_REPEATERS LITERAL1
RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN LITERAL1
ERR_INVALID_CRC_CONFIGURATION LITERAL1 RADIOLIB_ERR_RANGING_TIMEOUT LITERAL1
LORA_DETECTED LITERAL1
ERR_INVALID_TCXO_VOLTAGE LITERAL1
ERR_INVALID_MODULATION_PARAMETERS LITERAL1
ERR_SPI_CMD_TIMEOUT LITERAL1
ERR_SPI_CMD_INVALID LITERAL1
ERR_SPI_CMD_FAILED LITERAL1
ERR_INVALID_SLEEP_PERIOD LITERAL1
ERR_INVALID_RX_PERIOD LITERAL1
ERR_INVALID_CALLSIGN LITERAL1
ERR_INVALID_NUM_REPEATERS LITERAL1
ERR_INVALID_REPEATER_CALLSIGN LITERAL1
ERR_RANGING_TIMEOUT LITERAL1

View file

@ -3,86 +3,6 @@
#include "BuildOpt.h" #include "BuildOpt.h"
/*!
\defgroup shield_config Shield Configuration
\{
*/
/*!
\brief Use SPI interface.
*/
#define RADIOLIB_USE_SPI 0x00
/*!
\brief Use UART interface.
*/
#define RADIOLIB_USE_UART 0x01
/*!
\}
*/
/*!
\defgroup uart_config UART Configuration
\{
*/
/*!
\brief Use 1 bit stop.
*/
#define RADIOLIB_UART_STOPBIT_1 0x01
/*!
\brief Use 1.5 bit stop.
*/
#define RADIOLIB_UART_STOPBIT_1_5 0x02
/*!
\brief Use 2 bit stop.
*/
#define RADIOLIB_UART_STOPBIT_2 0x03
/*!
\brief No parity.
*/
#define RADIOLIB_UART_PARITY_NONE 0x00
/*!
\brief Odd parity.
*/
#define RADIOLIB_UART_PARITY_ODD 0x01
/*!
\brief Even parity.
*/
#define RADIOLIB_UART_PARITY_EVEN 0x02
/*!
\brief No flow control.
*/
#define RADIOLIB_UART_FLOW_NONE 0x00
/*!
\brief RTS only.
*/
#define RADIOLIB_UART_FLOW_RTS 0x01
/*!
\brief CTS only.
*/
#define RADIOLIB_UART_FLOW_CTS 0x02
/*!
\brief Both RTS and CTS.
*/
#define RADIOLIB_UART_FLOW_BOTH 0x03
/*!
\}
*/
/*! /*!
\defgroup config_shaping Data shaping filter values aliases. \defgroup config_shaping Data shaping filter values aliases.
@ -92,27 +12,27 @@
/*! /*!
\brief No shaping. \brief No shaping.
*/ */
#define RADIOLIB_SHAPING_NONE 0x00 #define RADIOLIB_SHAPING_NONE (0x00)
/*! /*!
\brief Gaussin shaping filter, BT = 0.3 \brief Gaussin shaping filter, BT = 0.3
*/ */
#define RADIOLIB_SHAPING_0_3 0x01 #define RADIOLIB_SHAPING_0_3 (0x01)
/*! /*!
\brief Gaussin shaping filter, BT = 0.5 \brief Gaussin shaping filter, BT = 0.5
*/ */
#define RADIOLIB_SHAPING_0_5 0x02 #define RADIOLIB_SHAPING_0_5 (0x02)
/*! /*!
\brief Gaussin shaping filter, BT = 0.7 \brief Gaussin shaping filter, BT = 0.7
*/ */
#define RADIOLIB_SHAPING_0_7 0x03 #define RADIOLIB_SHAPING_0_7 (0x03)
/*! /*!
\brief Gaussin shaping filter, BT = 1.0 \brief Gaussin shaping filter, BT = 1.0
*/ */
#define RADIOLIB_SHAPING_1_0 0x04 #define RADIOLIB_SHAPING_1_0 (0x04)
/*! /*!
\} \}
@ -127,17 +47,17 @@
/*! /*!
\brief Non-return to zero - no encoding. \brief Non-return to zero - no encoding.
*/ */
#define RADIOLIB_ENCODING_NRZ 0x00 #define RADIOLIB_ENCODING_NRZ (0x00)
/*! /*!
\brief Manchester encoding. \brief Manchester encoding.
*/ */
#define RADIOLIB_ENCODING_MANCHESTER 0x01 #define RADIOLIB_ENCODING_MANCHESTER (0x01)
/*! /*!
\brief Whitening. \brief Whitening.
*/ */
#define RADIOLIB_ENCODING_WHITENING 0x02 #define RADIOLIB_ENCODING_WHITENING (0x02)
/*! /*!
\} \}
@ -154,13 +74,13 @@
/*! /*!
\brief No error, method executed successfully. \brief No error, method executed successfully.
*/ */
#define ERR_NONE 0 #define RADIOLIB_ERR_NONE (0)
/*! /*!
\brief There was an unexpected, unknown error. If you see this, something went incredibly wrong. \brief There was an unexpected, unknown error. If you see this, something went incredibly wrong.
Your Arduino may be possessed, contact your local exorcist to resolve this error. Your Arduino may be possessed, contact your local exorcist to resolve this error.
*/ */
#define ERR_UNKNOWN -1 #define RADIOLIB_ERR_UNKNOWN (-1)
// SX127x/RFM9x status codes // SX127x/RFM9x status codes
@ -168,344 +88,240 @@
\brief Radio chip was not found during initialization. This can be caused by specifying wrong chip type in the constructor \brief Radio chip was not found during initialization. This can be caused by specifying wrong chip type in the constructor
(i.e. calling SX1272 constructor for SX1278 chip) or by a fault in your wiring (incorrect slave select pin). (i.e. calling SX1272 constructor for SX1278 chip) or by a fault in your wiring (incorrect slave select pin).
*/ */
#define ERR_CHIP_NOT_FOUND -2 #define RADIOLIB_ERR_CHIP_NOT_FOUND (-2)
/*! /*!
\brief Failed to allocate memory for temporary buffer. This can be cause by not enough RAM or by passing invalid pointer. \brief Failed to allocate memory for temporary buffer. This can be cause by not enough RAM or by passing invalid pointer.
*/ */
#define ERR_MEMORY_ALLOCATION_FAILED -3 #define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED (-3)
/*! /*!
\brief Packet supplied to transmission method was longer than limit. \brief Packet supplied to transmission method was longer than limit.
*/ */
#define ERR_PACKET_TOO_LONG -4 #define RADIOLIB_ERR_PACKET_TOO_LONG (-4)
/*! /*!
\brief Timed out waiting for transmission finish. \brief Timed out waiting for transmission finish.
*/ */
#define ERR_TX_TIMEOUT -5 #define RADIOLIB_ERR_TX_TIMEOUT (-5)
/*! /*!
\brief Timed out waiting for incoming transmission. \brief Timed out waiting for incoming transmission.
*/ */
#define ERR_RX_TIMEOUT -6 #define RADIOLIB_ERR_RX_TIMEOUT (-6)
/*! /*!
\brief The calculated and expected CRCs of received packet do not match. \brief The calculated and expected CRCs of received packet do not match.
This means that the packet was damaged during transmission and should be sent again. This means that the packet was damaged during transmission and should be sent again.
*/ */
#define ERR_CRC_MISMATCH -7 #define RADIOLIB_ERR_CRC_MISMATCH (-7)
/*! /*!
\brief The supplied bandwidth value is invalid for this module. \brief The supplied bandwidth value is invalid for this module.
*/ */
#define ERR_INVALID_BANDWIDTH -8 #define RADIOLIB_ERR_INVALID_BANDWIDTH (-8)
/*! /*!
\brief The supplied spreading factor value is invalid for this module. \brief The supplied spreading factor value is invalid for this module.
*/ */
#define ERR_INVALID_SPREADING_FACTOR -9 #define RADIOLIB_ERR_INVALID_SPREADING_FACTOR (-9)
/*! /*!
\brief The supplied coding rate value is invalid for this module. \brief The supplied coding rate value is invalid for this module.
*/ */
#define ERR_INVALID_CODING_RATE -10 #define RADIOLIB_ERR_INVALID_CODING_RATE (-10)
/*! /*!
\brief Internal only. \brief Internal only.
*/ */
#define ERR_INVALID_BIT_RANGE -11 #define RADIOLIB_ERR_INVALID_BIT_RANGE (-11)
/*! /*!
\brief The supplied frequency value is invalid for this module. \brief The supplied frequency value is invalid for this module.
*/ */
#define ERR_INVALID_FREQUENCY -12 #define RADIOLIB_ERR_INVALID_FREQUENCY (-12)
/*! /*!
\brief The supplied output power value is invalid for this module. \brief The supplied output power value is invalid for this module.
*/ */
#define ERR_INVALID_OUTPUT_POWER -13 #define RADIOLIB_ERR_INVALID_OUTPUT_POWER (-13)
/*! /*!
\brief LoRa preamble was detected during channel activity detection. \brief LoRa preamble was detected during channel activity detection.
This means that there is some LoRa device currently transmitting in your channel. This means that there is some LoRa device currently transmitting in your channel.
*/ */
#define PREAMBLE_DETECTED -14 #define RADIOLIB_PREAMBLE_DETECTED (-14)
/*! /*!
\brief No LoRa preambles were detected during channel activity detection. Your channel is free. \brief No LoRa preambles were detected during channel activity detection. Your channel is free.
*/ */
#define CHANNEL_FREE -15 #define RADIOLIB_CHANNEL_FREE (-15)
/*! /*!
\brief Real value in SPI register does not match the expected one. This can be caused by faulty SPI wiring. \brief Real value in SPI register does not match the expected one. This can be caused by faulty SPI wiring.
*/ */
#define ERR_SPI_WRITE_FAILED -16 #define RADIOLIB_ERR_SPI_WRITE_FAILED (-16)
/*! /*!
\brief The supplied current limit value is invalid. \brief The supplied current limit value is invalid.
*/ */
#define ERR_INVALID_CURRENT_LIMIT -17 #define RADIOLIB_ERR_INVALID_CURRENT_LIMIT (-17)
/*! /*!
\brief The supplied preamble length is invalid. \brief The supplied preamble length is invalid.
*/ */
#define ERR_INVALID_PREAMBLE_LENGTH -18 #define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH (-18)
/*! /*!
\brief The supplied gain value is invalid. \brief The supplied gain value is invalid.
*/ */
#define ERR_INVALID_GAIN -19 #define RADIOLIB_ERR_INVALID_GAIN (-19)
/*! /*!
\brief User tried to execute modem-exclusive method on a wrong modem. \brief User tried to execute modem-exclusive method on a wrong modem.
For example, this can happen when you try to change LoRa configuration when FSK modem is active. For example, this can happen when you try to change LoRa configuration when FSK modem is active.
*/ */
#define ERR_WRONG_MODEM -20 #define RADIOLIB_ERR_WRONG_MODEM (-20)
/*! /*!
\brief The supplied number of RSSI samples is invalid. \brief The supplied number of RSSI samples is invalid.
*/ */
#define ERR_INVALID_NUM_SAMPLES -21 #define RADIOLIB_ERR_INVALID_NUM_SAMPLES (-21)
/*! /*!
\brief The supplied RSSI offset is invalid. \brief The supplied RSSI offset is invalid.
*/ */
#define ERR_INVALID_RSSI_OFFSET -22 #define RADIOLIB_ERR_INVALID_RSSI_OFFSET (-22)
/*! /*!
\brief The supplied encoding is invalid. \brief The supplied encoding is invalid.
*/ */
#define ERR_INVALID_ENCODING -23 #define RADIOLIB_ERR_INVALID_ENCODING (-23)
/*! /*!
\brief LoRa packet header has been damaged. \brief LoRa packet header has been damaged.
*/ */
#define ERR_LORA_HEADER_DAMAGED -24 #define RADIOLIB_ERR_LORA_HEADER_DAMAGED (-24)
// RF69-specific status codes // RF69-specific status codes
/*! /*!
\brief The supplied bit rate value is invalid. \brief The supplied bit rate value is invalid.
*/ */
#define ERR_INVALID_BIT_RATE -101 #define RADIOLIB_ERR_INVALID_BIT_RATE (-101)
/*! /*!
\brief The supplied frequency deviation value is invalid. \brief The supplied frequency deviation value is invalid.
*/ */
#define ERR_INVALID_FREQUENCY_DEVIATION -102 #define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION (-102)
/*! /*!
\brief The supplied bit rate to bandwidth ratio is invalid. See the module datasheet for more information. \brief The supplied bit rate to bandwidth ratio is invalid. See the module datasheet for more information.
*/ */
#define ERR_INVALID_BIT_RATE_BW_RATIO -103 #define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO (-103)
/*! /*!
\brief The supplied receiver bandwidth value is invalid. \brief The supplied receiver bandwidth value is invalid.
*/ */
#define ERR_INVALID_RX_BANDWIDTH -104 #define RADIOLIB_ERR_INVALID_RX_BANDWIDTH (-104)
/*! /*!
\brief The supplied FSK sync word is invalid. \brief The supplied FSK sync word is invalid.
*/ */
#define ERR_INVALID_SYNC_WORD -105 #define RADIOLIB_ERR_INVALID_SYNC_WORD (-105)
/*! /*!
\brief The supplied FSK data shaping option is invalid. \brief The supplied FSK data shaping option is invalid.
*/ */
#define ERR_INVALID_DATA_SHAPING -106 #define RADIOLIB_ERR_INVALID_DATA_SHAPING (-106)
/*! /*!
\brief The current modulation is invalid for the requested operation. \brief The current modulation is invalid for the requested operation.
*/ */
#define ERR_INVALID_MODULATION -107 #define RADIOLIB_ERR_INVALID_MODULATION (-107)
/*! /*!
\brief Supplied Peak type is invalid. \brief Supplied Peak type is invalid.
*/ */
#define ERR_INVALID_OOK_RSSI_PEAK_TYPE -108 #define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE (-108)
// ESP8266 status codes
/*!
\brief AT command failed to execute, or timed out.
*/
#define ERR_AT_FAILED -201
/*!
\brief Supplied URL is malformed or invalid.
*/
#define ERR_URL_MALFORMED -202
/*!
\brief AT command response was malformed.
*/
#define ERR_RESPONSE_MALFORMED_AT -203
/*!
\brief Data response was malformed.
*/
#define ERR_RESPONSE_MALFORMED -204
/*!
\brief MQTT broker rejected connection due to version mismatch.
*/
#define ERR_MQTT_CONN_VERSION_REJECTED -205
/*!
\brief MQTT broker rejected connection due to unknown ID.
*/
#define ERR_MQTT_CONN_ID_REJECTED -206
/*!
\brief Failed to establish connection with MQTT broker.
*/
#define ERR_MQTT_CONN_SERVER_UNAVAILABLE -207
/*!
\brief Supplied username/password combination is incorrect.
*/
#define ERR_MQTT_CONN_BAD_USERNAME_PASSWORD -208
/*!
\brief Unauthorized connection to MQTT broker.
*/
#define ERR_MQTT_CONN_NOT_AUTHORIZED -208
/*!
\brief Received packet ID does not match the expected ID.
*/
#define ERR_MQTT_UNEXPECTED_PACKET_ID -209
/*!
\brief No new packet was received since the last check.
*/
#define ERR_MQTT_NO_NEW_PACKET_AVAILABLE -210
/*!
\brief Successfully subscribed to MQTT topic with QoS 0.
*/
#define MQTT_SUBS_SUCCESS_QOS_0 0x00
/*!
\brief Successfully subscribed to MQTT topic with QoS 1.
*/
#define MQTT_SUBS_SUCCESS_QOS_1 0x01
/*!
\brief Successfully subscribed to MQTT topic with QoS 2.
*/
#define MQTT_SUBS_SUCCESS_QOS_2 0x02
/*!
\brief Failed to subscribe to MQTT topic.
*/
#define ERR_MQTT_SUBS_FAILED 0x80
// XBee status codes
/*!
\brief Failed to enter command mode.
*/
#define ERR_CMD_MODE_FAILED -301
/*!
\brief Received ZigBee frame is malformed.
*/
#define ERR_FRAME_MALFORMED -302
/*!
\brief Received ZigBee frame checksum does not match the calculated.
*/
#define ERR_FRAME_INCORRECT_CHECKSUM -303
/*!
\brief Received ZigBee frame with unexpected ID.
*/
#define ERR_FRAME_UNEXPECTED_ID -304
/*!
\brief Timed out waiting for response to ZigBee frame.
*/
#define ERR_FRAME_NO_RESPONSE -305
// RTTY status codes // RTTY status codes
/*! /*!
\brief Supplied RTTY frequency shift is invalid for this module. \brief Supplied RTTY frequency shift is invalid for this module.
*/ */
#define ERR_INVALID_RTTY_SHIFT -401 #define RADIOLIB_ERR_INVALID_RTTY_SHIFT (-401)
/*! /*!
\brief Supplied RTTY encoding is invalid. \brief Supplied RTTY encoding is invalid.
*/ */
#define ERR_UNSUPPORTED_ENCODING -402 #define RADIOLIB_ERR_UNSUPPORTED_ENCODING (-402)
// nRF24-specific status codes // nRF24-specific status codes
/*! /*!
\brief Supplied data rate is invalid. \brief Supplied data rate is invalid.
*/ */
#define ERR_INVALID_DATA_RATE -501 #define RADIOLIB_ERR_INVALID_DATA_RATE (-501)
/*! /*!
\brief Supplied address width is invalid. \brief Supplied address width is invalid.
*/ */
#define ERR_INVALID_ADDRESS_WIDTH -502 #define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH (-502)
/*! /*!
\brief Supplied data pipe number is invalid. \brief Supplied data pipe number is invalid.
*/ */
#define ERR_INVALID_PIPE_NUMBER -503 #define RADIOLIB_ERR_INVALID_PIPE_NUMBER (-503)
/*! /*!
\brief ACK packet from destination module was not received within 15 retries. \brief ACK packet from destination module was not received within 15 retries.
*/ */
#define ERR_ACK_NOT_RECEIVED -504 #define RADIOLIB_ERR_ACK_NOT_RECEIVED (-504)
// CC1101-specific status codes // CC1101-specific status codes
/*! /*!
\brief Supplied number of broadcast addresses is invalid. \brief Supplied number of broadcast addresses is invalid.
*/ */
#define ERR_INVALID_NUM_BROAD_ADDRS -601 #define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS (-601)
// SX126x-specific status codes // SX126x-specific status codes
/*! /*!
\brief Supplied CRC configuration is invalid. \brief Supplied CRC configuration is invalid.
*/ */
#define ERR_INVALID_CRC_CONFIGURATION -701 #define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION (-701)
/*! /*!
\brief Detected LoRa transmission while scanning channel. \brief Detected LoRa transmission while scanning channel.
*/ */
#define LORA_DETECTED -702 #define RADIOLIB_LORA_DETECTED (-702)
/*! /*!
\brief Supplied TCXO reference voltage is invalid. \brief Supplied TCXO reference voltage is invalid.
*/ */
#define ERR_INVALID_TCXO_VOLTAGE -703 #define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE (-703)
/*! /*!
\brief Bit rate / bandwidth / frequency deviation ratio is invalid. See SX126x datasheet for details. \brief Bit rate / bandwidth / frequency deviation ratio is invalid. See SX126x datasheet for details.
*/ */
#define ERR_INVALID_MODULATION_PARAMETERS -704 #define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS (-704)
/*! /*!
\brief SX126x timed out while waiting for complete SPI command. \brief SX126x timed out while waiting for complete SPI command.
*/ */
#define ERR_SPI_CMD_TIMEOUT -705 #define RADIOLIB_ERR_SPI_CMD_TIMEOUT (-705)
/*! /*!
\brief SX126x received invalid SPI command. \brief SX126x received invalid SPI command.
*/ */
#define ERR_SPI_CMD_INVALID -706 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
/*! /*!
\brief SX126x failed to execute SPI command. \brief SX126x failed to execute SPI command.
*/ */
#define ERR_SPI_CMD_FAILED -707 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
/*! /*!
\brief The supplied sleep period is invalid. \brief The supplied sleep period is invalid.
@ -513,14 +329,14 @@
The specified sleep period is shorter than the time necessary to sleep and wake the hardware The specified sleep period is shorter than the time necessary to sleep and wake the hardware
including TCXO delay, or longer than the maximum possible including TCXO delay, or longer than the maximum possible
*/ */
#define ERR_INVALID_SLEEP_PERIOD -708 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
/*! /*!
\brief The supplied Rx period is invalid. \brief The supplied Rx period is invalid.
The specified Rx period is shorter or longer than the hardware can handle. The specified Rx period is shorter or longer than the hardware can handle.
*/ */
#define ERR_INVALID_RX_PERIOD -709 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
// AX.25-specific status codes // AX.25-specific status codes
@ -529,28 +345,28 @@
The specified callsign is longer than 6 ASCII characters. The specified callsign is longer than 6 ASCII characters.
*/ */
#define ERR_INVALID_CALLSIGN -801 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
/*! /*!
\brief The provided repeater configuration is invalid. \brief The provided repeater configuration is invalid.
The specified number of repeaters does not match number of repeater IDs or their callsigns. The specified number of repeaters does not match number of repeater IDs or their callsigns.
*/ */
#define ERR_INVALID_NUM_REPEATERS -802 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
/*! /*!
\brief One of the provided repeater callsigns is invalid. \brief One of the provided repeater callsigns is invalid.
The specified callsign is longer than 6 ASCII characters. The specified callsign is longer than 6 ASCII characters.
*/ */
#define ERR_INVALID_REPEATER_CALLSIGN -803 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
// SX128x-specific status codes // SX128x-specific status codes
/*! /*!
\brief Timed out waiting for ranging exchange finish. \brief Timed out waiting for ranging exchange finish.
*/ */
#define ERR_RANGING_TIMEOUT -901 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
/*! /*!
\} \}