ADSB.h

#if !defined(RADIOLIB_ADSB_H)
#define RADIOLIB_ADSB_H
 
#include "../../TypeDef.h"
 
#if !RADIOLIB_EXCLUDE_ADSB
 
#include "../PhysicalLayer/PhysicalLayer.h"
 
#define RADIOLIB_ADSB_CARRIER_FREQUENCY                         (1090.0f)
 
// basic ADS-B frame structure
#define RADIOLIB_ADSB_FRAME_LEN_BYTES                           (14)
#define RADIOLIB_ADSB_FRAME_DF_CA_POS                           (0)
#define RADIOLIB_ADSB_FRAME_ICAO_LEN_BYTES                      (3)
#define RADIOLIB_ADSB_FRAME_ICAO_POS                            (1)
#define RADIOLIB_ADSB_FRAME_MESSAGE_LEN_BYTES                   (7)
#define RADIOLIB_ADSB_FRAME_MESSAGE_POS                         (4)
#define RADIOLIB_ADSB_FRAME_PARITY_INTERROGATOR_LEN_BYTES       (3)
#define RADIOLIB_ADSB_FRAME_PARITY_INTERROGATOR_POS             (11)
 
// length of the ICAO address, including a terminating null
#define RADIOLIB_ADSB_HEX_ID_LEN                                (6 + 1)
 
// length of the callsign, including a terminating null
#define RADIOLIB_ADSB_CALLSIGN_LEN                              (8 + 1)
 
enum class ADSBMessageType {
  AIRCRAFT_ID = 0,
  SURFACE_POS,
  AIRBORNE_POS_ALT_BARO,
  AIRBORNE_VEL,
  AIRBORNE_POS_ALT_GNSS,
  AIRCRAFT_STATUS,
  TARGET_STATE,
  AIRCRAFT_OPS_STATUS,
  RESERVED,
};
 
enum class ADSBAircraftCategory {
  NONE = 0,
  SURFACE_EMERGENCY,
  SURFACE_SERVICE,
  GROUND_OBSTRUCTION,
  GLIDER,
  LIGHTER_THAN_AIR,
  PARACHUTIST,
  ULTRALIGHT_PARAGLIDER,
  UAV,
  SPACE_VEHICLE,
  LIGHT,
  MEDIUM_1,
  MEDIUM_2,
  HIGH_VORTEX,
  HEAVY,
  HIGH_PERFORMANCE,
  ROTORCRAFT,
  RESERVED,
};
 
struct ADSBFrame {
  public:
    uint8_t downlinkFormat;
 
    uint8_t capability;
 
    uint8_t icao[RADIOLIB_ADSB_FRAME_ICAO_LEN_BYTES];
 
    ADSBMessageType messageType;
 
    uint8_t message[RADIOLIB_ADSB_FRAME_MESSAGE_LEN_BYTES];
};
 
class ADSBClient {
  public:
    explicit ADSBClient(PhysicalLayer* phy);
 
    int16_t begin();
 
    int16_t decode(const uint8_t in[RADIOLIB_ADSB_FRAME_LEN_BYTES], ADSBFrame* out);
 
    int16_t parseHexId(const ADSBFrame* in, char id[RADIOLIB_ADSB_HEX_ID_LEN]);
 
    int16_t parseCallsign(const ADSBFrame* in, char callsign[RADIOLIB_ADSB_CALLSIGN_LEN], ADSBAircraftCategory* cat = NULL);
 
    void setReferencePosition(float lat, float lon);
 
    int16_t parseAirbornePosition(const ADSBFrame* in, int* alt, float* lat, float* lon, bool* altGnss = NULL);
  
#if !RADIOLIB_GODMODE
  private:
#endif
    PhysicalLayer* phyLayer;
    
    // reference position
    float refPos[2] = { 0, 0 };
};
 
#endif
 
#endif