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.

secondssinceepoch
Field Type Required Description
id string Yes The unique identifier of the UAV.
latitude double Yes Latitude in decimal degrees.
longitude double Yes Longitude in decimal degrees.
altitude int Yes Altitude of the UAV in meters,meters based on (GPS altitude AMSL.AMSL). Value "-99999999" means unknown.
altitude_accuracylast_update intlong NoYes Accuracy levelTime of the altitude coordinateevent in meters.
accuracyintNoAccuracy level of the latitude and longitude coordinates in meters.
call_signstringNoUAV call-sign.
ground_speedintNoCurrent ground speed of the UAV, specified in meters per second.
courseintNoDirection of travel, specified in degrees counting clockwise relative to the true north.(UTC-0).
status string No TheCurrent current status of the UAV. Allowable values:status: INACTIVE, AIRBORNE, GROUNDED.
last_updatelongYesThe time of the event in seconds since epoch at UTC-0.
turn_ratefloatNoTurn rate in degrees per second.
vertical_rateintNoVertical rate in meters per second. A positive value indicates climbing, a negative value indicates descent.
icao24stringNoUnique ICAO 24-bit address of the transponder in hex string representation.

2. Beacon Model

The Beacon model definesrepresents all detected aircraft in the structure of an aircraft beacon as provided by SafeSky. This is the traffic as returned by SafeSky.vicinity.

operation(Advisories
Field Type Required Description
id string Yes The unique identifier of the beacon.
latitudedoubleYesLatitude in decimal degrees.
longitudedoubleYesLongitude in decimal degrees.
altitudeintYesAltitude of the beacon in meters, based on GPS altitude AMSL.
ground_speed int Yes Current ground speed of the beacon, specified in meters per second.
coursebeacon_type intYesDirection of travel, specified in degrees relative to true north.
statusstring No The current status of the beacon: INACTIVE, AIRBORNE, GROUNDED.
last_updatelongYesThe time of the event in seconds since epoch at UTC-0.
beacon_typestringNoAllowable values: UNKNOWN,Values: GLIDER, PARA_GLIDER, HELICOPTER, UAV, JET, etc.
operation_area GeoJson No When beacon_type is an ADVISORY, this represents the polygonPolygon for the area of operation.
remarksstringNoFree text comment when applicable.only).

Example Payload:

[
    {
        "latitude": 50.70716,
        "longitude": 4.36613,
        "accuracy": 3645,
        "call_sign": "ADVISORY TEST",
        "transponder_type": "ADVISORY",
        "last_update": 1764171645,
        "altitude": 111,
        "remarks": "Inspection powerlines",
        "status": "AIRBORNE",
        "beacon_type": "UAV",
        "id": "my_advisory_id1"
    }
]