Skip to main content

Model Definition

Model Definition

1. UAV Model

The UAV model defines the structure and attributes of an Unmanned Aerial Vehicle (UAV) as submitted to the /v1/uav endpoint.
This is your UAV telemetry you are submitting to SafeSky.

Field (Req) Type
Required Description id (Yes) string Yes The unique identifier of the UAV. latitude (Yes) double Yes Latitude in decimal degrees. longitude (Yes) double Yes Longitude in decimal degrees. altitude (Yes) int Yes Altitude of the UAV in (meters, based on GPS altitude AMSL.AMSL). Value "-9999"9999 means unknown. altitude_accuracy int No Accuracy level of the altitude coordinate in meters. accuracy int No Accuracy level of the latitude and longitudehorizontal coordinates in meters. call_sign string No UAV call-sign. ground_speed int No Current ground speed of the UAV, specified in meters per second.(m/s). course int No Direction of travel,travel specified in degrees counting(degrees, clockwise relative to thefrom true north.north). status string No The current status of the UAV. Allowable values:Status: INACTIVE, AIRBORNE, GROUNDED. last_update (Yes) long Yes The timeTime of the event in seconds since epoch at (UTC-0.0). turn_rate float No Turn rate in degrees per second. vertical_rate int No Vertical rate in meters per second. A(m/s): positive value indicates= climbing, a negative value indicates= descent. icao24 string No Unique ICAO 24-bit address of the transponder in (hex string representation. See FAQs for more details.string).

2. Beacon Model

The Beacon model defines the structure of an aircraft beacon,beacon as provided by SafeSky, to represent and describe all detected aircraft in the vicinity.
This is the traffic returned by SafeSky.

Field (Req) Type
Required Description id (Yes) string Yes The unique identifier of the beacon. latitude (Yes) double Yes Latitude in decimal degrees. longitude (Yes) double Yes Longitude in decimal degrees. altitude (Yes) int Yes Altitude of the beacon in (meters, based on GPS altitude AMSL. altitude_accuracy int No Accuracy level of the altitude coordinate in meters. accuracy int No Accuracy level of the latitude and longitude coordinates in meters. call_sign string No Beacon call-sign, available only if the pilot has a public profile.AMSL). ground_speed (Yes) int Yes Current ground speed of the beacon, specified in meters per second.(m/s). course (Yes) int Yes Direction of travel,travel specified in degrees counting(degrees, clockwise relative to thefrom true north.north). status string No The current status of the beacon. Allowable values:Status: INACTIVE, AIRBORNE, GROUNDED. last_update (Yes) long Yes The timeTime of the event in seconds since epoch at (UTC-0. turn_rate float No Turn rate in degrees per second. vertical_rate int No Vertical rate in meters per second. A positive value indicates climbing, a negative value indicates descent.0). beacon_type string NoType The type of the beacon. Allowable values: UNKNOWN(e.g., GLIDER, PARA_GLIDER, HAND_GLIDER, HELICOPTER, UAV, PARACHUTE, MOTORPLANE, JET, AIRSHIP, BALLOON, GYROCOPTER, FLEX_WING_TRIKES, PARA_MOTOR, THREE_AXES_LIGHT_PLANE, PAV, MILITARY, STATIC_OBJECT). operation_area GeoJson No When beacon_type is an ADVISORY, this GeoJSON represents the polygonPolygon for the area of operation.operation (Advisories only). remarks string No Free text comment when applicable.

Example

Example

Payload 
[
    {
        "id": "my_advisory_id1",
        "latitude": 58.88228,50.70716,
        "longitude": 5.51642,
    "vertical_rate": 0,
    "accuracy": 0,
    "call_sign": "NOR303",
    "transponder_type": "ADS-B",
    "last_update": 1764171642,4.36613,
        "altitude": 283,111,
        "altitude_accuracy"ground_speed": 0,
        "course": 63,0,
        "ground_speed"last_update": 71,1764171645,
        "turn_rate"beacon_type": 0.06,"UAV",
        "status": "AIRBORNE",
        "beacon_type"remarks": "HELICOPTER",Inspection "id": "478757"
  },
  {
    "latitude": 50.72218,
    "longitude": 4.615,
    "vertical_rate": 0,
    "accuracy": 0,
    "call_sign": "LGL4EW",
    "transponder_type": "ADS-B",
    "last_update": 1764171642,
    "altitude": 6362,
    "altitude_accuracy": 0,
    "course": 108,
    "ground_speed": 168,
    "turn_rate": -0.06,
    "status": "AIRBORNE",
    "beacon_type": "MOTORPLANE",
    "id": "4D00C9"
  },
  {
    "latitude": 50.69378,
    "longitude": 4.39201,
    "vertical_rate": 5,
    "call_sign": "TEST UAV",
    "transponder_type": "ADS-BI",
    "last_update": 1764171644,
    "altitude": 110,
    "course": 250,
    "ground_speed": 10,
    "status": "AIRBORNE",
    "beacon_type": "UAV",
    "id": "my_uav_001_l2TZ"powerlines"
    }
]
Back to top