bds.h

Go to the documentation of this file.

// vim:set ft=c.doxygen sw=2 sts=2 fenc=utf8:

/*
 * libasterix
 * Copyright [2013-2020] SinoATC <http://www.sinoatc.com>.
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of SinoATC and its suppliers, if any.
 * The intellectual and technical concepts contained herein
 * are proprietary to Aerosys Corporation and its suppliers and may be
 * covered by U.S. and Foreign Patents, patents in process,
 * and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from SinoATC.
 */

#ifndef LIBASTERIX_BDS_H
#define LIBASTERIX_BDS_H

#include <stddef.h>
#include <stdbool.h>
#include "platform.h"

#ifdef __cplusplus
extern "C" {
#endif

#define AST_MAP_BDS_TYPE(msb, lsb) \
  BDS ## msb ## lsb = 0x ## msb ## lsb,

typedef enum _ast_bds_type_t
{
  AST_MAP_BDS_TYPE(0, 0)  
  AST_MAP_BDS_TYPE(1, 0)
  AST_MAP_BDS_TYPE(1, 7)
  AST_MAP_BDS_TYPE(2, 0)
  AST_MAP_BDS_TYPE(3, 0)
  AST_MAP_BDS_TYPE(4, 0)
  AST_MAP_BDS_TYPE(5, 0)
  AST_MAP_BDS_TYPE(6, 0)
  AST_MAP_BDS_TYPE(E, 1)

} ast_bds_type_t;

AST_API const char* ast_bds_type_to_str(const ast_bds_type_t type);

AST_API const char* ast_bds_type_to_str_simple(const ast_bds_type_t type);

#define AST_MAX_BDS 8

typedef struct _ast_bds_t
{
  const unsigned char* data;    
  size_t size;                    

  ast_bds_type_t type;      

  bool valid;                   
} ast_bds_t;

#define AST_BDS_SIZE 7

AST_API ast_bds_t ast_bds_decode(const unsigned char* buffer, const size_t bufsize, const ast_bds_type_t type);

AST_API const char* ast_bds_get_name(const ast_bds_type_t type);

#define AST_BDS_DETAIL_HTML_PREFERED_CHARS 20480

AST_API void ast_bds_get_detail_html(char* detail, const size_t detail_size, const ast_bds_t bds);

AST_API void ast_bds_get_detail_html_dummy(char* detail, const size_t detail_size, const ast_bds_t bds);

typedef enum _ast_bds_uelm_capability_t
{
  AST_BDS_UELM_CAP_NO = 0,
  AST_BDS_UELM_CAP_1S = 1,
  AST_BDS_UELM_CAP_500MS = 2,
  AST_BDS_UELM_CAP_250MS = 3,
  AST_BDS_UELM_CAP_125MS = 4,
  AST_BDS_UELM_CAP_60MS = 5,
  AST_BDS_UELM_CAP_30MS = 6,
  AST_BDS_UELM_CAP_UNASSIGNED = 7,
} ast_bds_uelm_capability_t;

typedef enum _ast_bds_delm_capability_t
{
  AST_BDS_DELM_CAP_NO = 0,
  AST_BDS_DELM_CAP_4SEG_1S = 1,
  AST_BDS_DELM_CAP_8SEG_1S = 2,
  AST_BDS_DELM_CAP_16SEG_1S = 3,
  AST_BDS_DELM_CAP_16SEG_500MS = 4,
  AST_BDS_DELM_CAP_16SEG_250MS = 5,
  AST_BDS_DELM_CAP_16SEG_125MS = 6,
  AST_BDS_DELM_CAP_UNASSIGNED = 7,
} ast_bds_delm_capability_t;

typedef struct _ast_bds_10_t
{
  bool valid;

  bool continuation_flag;

  bool tcas_interface_operational;

  int modes_subnetwork_version;

  bool transponder_enhanced_protocol;

  bool modes_specific_service;

  ast_bds_uelm_capability_t uelm_capability;

  ast_bds_delm_capability_t delm_capability;

  bool acid_capability;

  bool squitter_capability_updated;

  bool sic_capability;

  bool gicb_capability_updated;
} ast_bds_10_t;

AST_API ast_bds_10_t ast_bds_10_decode(const ast_bds_t bds);

AST_API void ast_bds_10_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

typedef struct _ast_bds_20_t
{
  bool valid;

  char aircraft_id[9];

} ast_bds_20_t;

AST_API ast_bds_20_t ast_bds_20_decode(const ast_bds_t bds);

AST_API void ast_bds_20_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

typedef enum _ast_bds_threat_type_t
{
  AST_BDS_THREAT_TYPE_UNKNOWN = 0,
  AST_BDS_THREAT_TYPE_MODES = 1,
  AST_BDS_THREAT_TYPE_MODEAC = 2,
} ast_bds_threat_type_t;

typedef struct _ast_bds_30_t
{
  bool valid;

  //Active Resolution Advisories (ARA)
  bool ra_active;

  //Resolution Advisory Complements (RAC)
  bool ra_complements;

  //Resolution Advisory Terminated Indicator (RAT)
  bool ra_terminated;

  //Multiple Threat Encounter (MTE)
  bool multi_threat;

  //Threat Type Indicator (TTI)
  ast_bds_threat_type_t threat_type;

  //Threat Identity Data (TID)
  unsigned char threat_addr[3];
  int threat_altitude;
  int threat_range;
  int threat_bearing;

} ast_bds_30_t;

AST_API ast_bds_30_t ast_bds_30_decode(const ast_bds_t bds);

AST_API void ast_bds_30_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

typedef enum _ast_bds_target_altitude_source_t
{
  AST_BDS_TARGET_ALTITUDE_SOURCE_UNKNOWN = 0,
  AST_BDS_TARGET_ALTITUDE_SOURCE_AIRCRAFT = 1,
  AST_BDS_TARGET_ALTITUDE_SOURCE_MCP_SELECTED = 2,
  AST_BDS_TARGET_ALTITUDE_SOURCE_FMS_SELECTED = 3,
} ast_bds_target_altitude_source_t;

typedef struct _ast_bds_40_t
{
  bool valid;

  bool mcp_status;
  int  mcp_selected_altitude;

  bool fms_status;
  int  fms_selected_altitude;

  bool bps_status;
  double  bps_barometric_pressure_setting;

  bool mmb_status;
  bool mmb_vnav_mode;
  bool mmb_alt_hold_mode;
  bool mmb_approach_mode;

  bool tas_status;
  ast_bds_target_altitude_source_t tas_target_alt_source;
} ast_bds_40_t;

AST_API ast_bds_40_t ast_bds_40_decode(const ast_bds_t bds);

AST_API void ast_bds_40_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

typedef struct _ast_bds_50_t
{
  bool valid;

  bool rla_status;
  bool rla_left_wing_down;
  double rla_roll_angle;

  bool tta_status;
  bool tta_west;
  double  tta_true_track_angle;

  bool gsd_status;
  double gsd_ground_speed;

  bool tar_status;
  double tar_track_angle_rate;

  bool tas_status;
  int tas_true_airspeed;
} ast_bds_50_t;

AST_API ast_bds_50_t ast_bds_50_decode(const ast_bds_t bds);

AST_API void ast_bds_50_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

typedef struct _ast_bds_60_t
{
  bool valid;

  bool mnh_status;
  bool mnh_west;
  double mnh_magnetic_heading;

  bool ias_status;
  int ias_indicated_airspeed;

  bool mch_status;
  double mch_mach;

  bool bar_status;
  double bar_barometric_altitude_rate;

  bool ivv_status;
  double ivv_intertial_vertical_velocity;
} ast_bds_60_t;

AST_API ast_bds_60_t ast_bds_60_decode(const ast_bds_t bds);

AST_API void ast_bds_60_get_detail_html(char *detail, const size_t detail_size, const ast_bds_t bds);

#ifdef __cplusplus
     }
#endif // extern "C"

#endif //LIBASTERIX_BDS_H