TypeDef.h

#if !defined(_RADIOLIB_TYPES_H)
#define _RADIOLIB_TYPES_H
 
// user build options may override the default
#include "BuildOptUser.h"
#include "BuildOpt.h"


#define RADIOLIB_SHAPING_NONE                                   (0x00)

#define RADIOLIB_SHAPING_0_3                                    (0x01)

#define RADIOLIB_SHAPING_0_5                                    (0x02)

#define RADIOLIB_SHAPING_0_7                                    (0x03)

#define RADIOLIB_SHAPING_1_0                                    (0x04)



#define RADIOLIB_ENCODING_NRZ                                   (0x00)

#define RADIOLIB_ENCODING_MANCHESTER                            (0x01)

#define RADIOLIB_ENCODING_WHITENING                             (0x02)

#define RADIOLIB_ENCODING_MANCHESTER_INV                        (0x03)



#define RADIOLIB_STANDBY_DEFAULT                                (0x00)

#define RADIOLIB_STANDBY_WARM                                   (0x01)

#define RADIOLIB_STANDBY_COLD                                   (0x02)


 
// common status codes

#define RADIOLIB_ERR_NONE                                      (0)

#define RADIOLIB_ERR_UNKNOWN                                   (-1)
 
// SX127x/RFM9x status codes

#define RADIOLIB_ERR_CHIP_NOT_FOUND                            (-2)

#define RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED                  (-3)

#define RADIOLIB_ERR_PACKET_TOO_LONG                           (-4)

#define RADIOLIB_ERR_TX_TIMEOUT                                (-5)

#define RADIOLIB_ERR_RX_TIMEOUT                                (-6)

#define RADIOLIB_ERR_CRC_MISMATCH                              (-7)

#define RADIOLIB_ERR_INVALID_BANDWIDTH                         (-8)

#define RADIOLIB_ERR_INVALID_SPREADING_FACTOR                  (-9)

#define RADIOLIB_ERR_INVALID_CODING_RATE                       (-10)

#define RADIOLIB_ERR_INVALID_BIT_RANGE                         (-11)

#define RADIOLIB_ERR_INVALID_FREQUENCY                         (-12)

#define RADIOLIB_ERR_INVALID_OUTPUT_POWER                      (-13)

#define RADIOLIB_CHANNEL_FREE                                  (-15)

#define RADIOLIB_ERR_SPI_WRITE_FAILED                          (-16)

#define RADIOLIB_ERR_INVALID_CURRENT_LIMIT                     (-17)

#define RADIOLIB_ERR_INVALID_PREAMBLE_LENGTH                   (-18)

#define RADIOLIB_ERR_INVALID_GAIN                              (-19)

#define RADIOLIB_ERR_WRONG_MODEM                               (-20)

#define RADIOLIB_ERR_INVALID_NUM_SAMPLES                       (-21)

#define RADIOLIB_ERR_INVALID_RSSI_OFFSET                       (-22)

#define RADIOLIB_ERR_INVALID_ENCODING                          (-23)

#define RADIOLIB_ERR_LORA_HEADER_DAMAGED                       (-24)

#define RADIOLIB_ERR_UNSUPPORTED                               (-25)

#define RADIOLIB_ERR_INVALID_DIO_PIN                           (-26)

#define RADIOLIB_ERR_INVALID_RSSI_THRESHOLD                    (-27)

#define RADIOLIB_ERR_NULL_POINTER                              (-28)

#define RADIOLIB_ERR_INVALID_IRQ                               (-29)

#define RADIOLIB_ERR_PACKET_TOO_SHORT                          (-30)
 
// RF69-specific status codes

#define RADIOLIB_ERR_INVALID_BIT_RATE                          (-101)

#define RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION               (-102)

#define RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO                 (-103)

#define RADIOLIB_ERR_INVALID_RX_BANDWIDTH                      (-104)

#define RADIOLIB_ERR_INVALID_SYNC_WORD                         (-105)

#define RADIOLIB_ERR_INVALID_DATA_SHAPING                      (-106)

#define RADIOLIB_ERR_INVALID_MODULATION                        (-107)

#define RADIOLIB_ERR_INVALID_OOK_RSSI_PEAK_TYPE                (-108)

#define RADIOLIB_ERR_INVALID_BIT_RATE_TOLERANCE_VALUE          (-109)
 
// APRS status codes

#define RADIOLIB_ERR_INVALID_SYMBOL                            (-201)

#define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY                   (-202)

#define RADIOLIB_ERR_INVALID_MIC_E_TELEMETRY_LENGTH            (-203)

#define RADIOLIB_ERR_MIC_E_TELEMETRY_STATUS                    (-204)
 
// SSDV status codes

#define RADIOLIB_ERR_INVALID_SSDV_MODE                         (-301)

#define RADIOLIB_ERR_INVALID_IMAGE_SIZE                        (-302)

#define RADIOLIB_ERR_INVALID_IMAGE_QUALITY                     (-303)

#define RADIOLIB_ERR_INVALID_SUBSAMPLING                       (-304)
 
// RTTY status codes

#define RADIOLIB_ERR_INVALID_RTTY_SHIFT                        (-401)

#define RADIOLIB_ERR_UNSUPPORTED_ENCODING                      (-402)
 
// nRF24-specific status codes

#define RADIOLIB_ERR_INVALID_DATA_RATE                         (-501)

#define RADIOLIB_ERR_INVALID_ADDRESS_WIDTH                     (-502)

#define RADIOLIB_ERR_INVALID_PIPE_NUMBER                       (-503)

#define RADIOLIB_ERR_ACK_NOT_RECEIVED                          (-504)
 
// CC1101-specific status codes

#define RADIOLIB_ERR_INVALID_NUM_BROAD_ADDRS                   (-601)
 
// SX126x-specific status codes

#define RADIOLIB_ERR_INVALID_CRC_CONFIGURATION                 (-701)

#define RADIOLIB_LORA_DETECTED                                 (-702)

#define RADIOLIB_ERR_INVALID_TCXO_VOLTAGE                      (-703)

#define RADIOLIB_ERR_INVALID_MODULATION_PARAMETERS             (-704)

#define RADIOLIB_ERR_SPI_CMD_TIMEOUT                           (-705)

#define RADIOLIB_ERR_SPI_CMD_INVALID                           (-706)

#define RADIOLIB_ERR_SPI_CMD_FAILED                            (-707)

#define RADIOLIB_ERR_INVALID_SLEEP_PERIOD                      (-708)

#define RADIOLIB_ERR_INVALID_RX_PERIOD                         (-709)

#define RADIOLIB_ERR_INVALID_NTC_PARAMETERS                    (-710)
 
// AX.25-specific status codes

#define RADIOLIB_ERR_INVALID_CALLSIGN                          (-801)

#define RADIOLIB_ERR_INVALID_NUM_REPEATERS                     (-802)

#define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN                 (-803)
 
// SX128x-specific status codes

#define RADIOLIB_ERR_RANGING_TIMEOUT                           (-901)
 
// Pager-specific status codes

#define RADIOLIB_ERR_INVALID_PAYLOAD                            (-1001)

#define RADIOLIB_ERR_ADDRESS_NOT_FOUND                          (-1002)

#define RADIOLIB_ERR_INVALID_FUNCTION                           (-1003)
 
// LoRaWAN-specific status codes

#define RADIOLIB_ERR_NETWORK_NOT_JOINED                         (-1101)

#define RADIOLIB_ERR_DOWNLINK_MALFORMED                         (-1102)

#define RADIOLIB_ERR_INVALID_REVISION                           (-1103)

#define RADIOLIB_ERR_INVALID_PORT                               (-1104)

#define RADIOLIB_ERR_NO_RX_WINDOW                               (-1105)

#define RADIOLIB_ERR_NO_CHANNEL_AVAILABLE                       (-1106)

#define RADIOLIB_ERR_INVALID_CID                                (-1107)

#define RADIOLIB_ERR_UPLINK_UNAVAILABLE                         (-1108)

#define RADIOLIB_ERR_COMMAND_QUEUE_FULL                         (-1109)

#define RADIOLIB_ERR_COMMAND_QUEUE_ITEM_NOT_FOUND               (-1110)

#define RADIOLIB_ERR_JOIN_NONCE_INVALID                         (-1111)

#define RADIOLIB_ERR_MIC_MISMATCH                               (-1112)

#define RADIOLIB_ERR_MULTICAST_FCNT_INVALID                     (-1113)

#define RADIOLIB_ERR_DWELL_TIME_EXCEEDED                        (-1114)

#define RADIOLIB_ERR_CHECKSUM_MISMATCH                          (-1115)

#define RADIOLIB_ERR_NO_JOIN_ACCEPT                             (-1116)

#define RADIOLIB_LORAWAN_SESSION_RESTORED                       (-1117)

#define RADIOLIB_LORAWAN_NEW_SESSION                            (-1118)

#define RADIOLIB_ERR_NONCES_DISCARDED                           (-1119)

#define RADIOLIB_ERR_SESSION_DISCARDED                          (-1120)

#define RADIOLIB_ERR_INVALID_MODE                               (-1121)

#define RADIOLIB_ERR_INVALID_MULTICAST_GROUP                    (-1122)

#define RADIOLIB_ERR_INVALID_SUBBAND                            (-1123)

#define RADIOLIB_ERR_MAC_ANSWERS_PENDING                        (-1124)
 
// LR11x0-specific status codes

#define RADIOLIB_ERR_INVALID_WIFI_TYPE                          (-1200)

#define RADIOLIB_ERR_GNSS_SUBFRAME_NOT_AVAILABLE                (-1201)

#define RADIOLIB_ERR_UNSUPPORTED_FIRMWARE                       (-1202)

#define RADIOLIB_ERR_GNSS_DEMOD_OFFSET                          (-1210)
#define RADIOLIB_ERR_GNSS_DEMOD(X)                              (RADIOLIB_ERR_GNSS_DEMOD_OFFSET + (X))
#define RADIOLIB_GET_GNSS_DEMOD_ERROR(X)                        ((X) - RADIOLIB_ERR_GNSS_DEMOD_OFFSET)

#define RADIOLIB_ERR_GNSS_SOLVER_OFFSET                         (-1230)
#define RADIOLIB_ERR_GNSS_SOLVER(X)                             (RADIOLIB_ERR_GNSS_SOLVER_OFFSET - (X))
#define RADIOLIB_GET_GNSS_SOLVER_ERROR(X)                       (-((X) - RADIOLIB_ERR_GNSS_SOLVER_OFFSET))
 
// LR2021-specific status codes
#define RADIOLIB_ERR_FRONTEND_CALIBRATION_FAILED                (-1300)

#define RADIOLIB_ERR_INVALID_SIDE_DETECT                        (-1301)
 
// ADS-B-specific status codes
#define RADIOLIB_ERR_ADSB_INVALID_MSG_TYPE                      (-1400)

#define RADIOLIB_ERR_ADSB_INVALID_CATEGORY                      (-1401)
 
// SSDVClient-specific error codes
#define RADIOLIB_ERR_SSDV_CALLSIGN_TOO_LONG                     (-1500)

#define RADIOLIB_ERR_SSDV_CALLSIGN_INVALID                      (-1501)

#define RADIOLIB_ERR_SSDV_NO_IMAGE                              (-1502)

#define RADIOLIB_ERR_SSDV_INVALID_QUALITY                       (-1503)

#define RADIOLIB_ERR_SSDV_ENCODE_FAILED                         (-1504)

#define RADIOLIB_ERR_SSDV_NOT_INITIALIZED                       (-1505)

#define RADIOLIB_ERR_SSDV_NO_PACKET_BUFFER                      (-1506)

#define RADIOLIB_ERR_SSDV_ALL_SENT                              (-1507)

#define RADIOLIB_ERR_SSDV_JPEG_TRUNCATED                        (-1508)

#define RADIOLIB_ERR_SSDV_INTERNAL_MISMATCH                     (-1509)

#define RADIOLIB_ERR_SSDV_INVALID_PACKET                        (-1510)

#define RADIOLIB_ERR_SSDV_DECODE_FAILED                         (-1511)

#define RADIOLIB_ERR_SSDV_BUFFER_TOO_SMALL                      (-1512)

#define RADIOLIB_ERR_SSDV_NO_JPEG                               (-1513)

#define RADIOLIB_ERR_SSDV_BUFFER_IN_USE                         (-1514)

#define RADIOLIB_ERR_HAL_OFFSET                                 (-10000)
#define RADIOLIB_ERR_HAL(X)                                     (RADIOLIB_ERR_HAL_OFFSET + (X))
#define RADIOLIB_GET_HAL_ERROR(X)                               ((X) - RADIOLIB_ERR_HAL_OFFSET)



typedef unsigned long RadioLibTime_t;

typedef uint32_t RadioLibIrqFlags_t;

 
// unit prefix macros
#define RADIOLIB_UNIT_KILO(X)             ((uint32_t)(X) * (uint32_t)1000)
#define RADIOLIB_UNIT_KILO_FLT(X)         ((uint32_t)((float)(X) * 1000.0f))
#define RADIOLIB_UNIT_MEGA(X)             ((uint32_t)(X) * (uint32_t)1000000)
#define RADIOLIB_UNIT_MEGA_FLT(X)         ((uint32_t)((float)(X) * 1000000.0f))

enum RadioLibTCXOVoltage_t {
  VoltageNone = -1,
  Voltage1V6,
  Voltage1V7,
  Voltage1V8,
  Voltage2V2,
  Voltage2V4,
  Voltage2V7,
  Voltage3V0,
  Voltage3V3,
};
 
#endif