UAV-UTM-Flight-Message-Agent.md

UAV UTM Flight Message Agent

This entity contains a harmonised description of a generic UAV UTM Flight Message Agent that is designed to subscribe to the Global UTM Association protocol message according to a specific UAV entity. This entity supports the functionality of a service provider to confirm the validity of UTM Flight Message generated by UTM Flight Message Entity. The service provider can include their own Flight Control Policy to the original UTM Flight Message and forward this to a UAVTMS entity.

Attribute Name	Attribute Type	Description	Constraint
id	@id	Provides a unique identifier for an instance of the entity either in the form of a URI (i.e. either a publicly accessible URL or a URN).	Mandatory
type	@type	Defines the type of the entity.	Mandatory
createdAt	TemporalProperty	Indicates the date/ time that the instance of the entity was created in ISO 8601 format. The value of this will be set by the server when the entity was created.	Mandatory
modifiedAt	TemporalProperty	Indicates the date/ time when the entity was last modified in ISO 8601 format. The value of this will be set by the server when the entity was modified, if the entity has not been modified it may have a null value.	Optional
source	Property	Specifies the URL to the source of this data (either organisation or where relevant more specific source)	Recommended
dataProvider	Property	Specifies the URL to information about the provider of this information	Recommended
entityVersion	Property	The entity specification version as a number. A version number of 2.0 or later denotes the entity is represented using NGSI-LD	Recommended
uav	Relationship	Reference to the UAV entity to which this UAVUTMFlightMessageAgent relates.	Mandatory
observedAt	DateTime	Indicates the date/time of the UAVUTMFlightMessageAgent record.	Mandatory
originatedByUAV	Property	A logical indicator of source of the message. True indicates it is the UAV itself, false indicates that it is a different source, a listening station software application or a different UAV.	Mandatory
originator	Relationship	Refers to a third party UAV instance or other entity (e.g. listening station) that reported the information in the case the message was not directly originated by the UAV.	Recommended
flightMessage	Property	A flight message describing the current flight status encoded as a Global UTM Message encoded as a JSON object. https://bitbucket.org/global_utm/flight-declaration-protocol	Mandatory
validationResult	Property	A logical indicator of validation of the message. True indicates it is the validation is confirmed, false indicates that the validation confirmation fails.	Mandatory
flightControlPolicy	Property	Indicates the flight control policy generated by the service provider. This data could be included as a text value or referenced by a URI (URL/URN) to a policy defined in JSON or XML format.	Recommended
dateObserved	DateTime	Indicates the date/time the observation was recorded. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with observedAt	Deprecated

NGSI-LD Context Definition

The following NGSI-LD context definition applies to the UAV UTM Flight Message Agent entity

Download context definition.

{
    "@context": {
        "source": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/source",
        "dataProvider": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dataprovider",
        "entityVersion": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/entityversion",
        "uav": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/uav",
        "originatedByUAV": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/originatedbyuav",
        "originator": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/originator",
        "flightMessage": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/flightmessage",
        "validationResult": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/validationresult",
        "flightControlPolicy": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/flightcontrolpolicy",
        "dateObserved": {
            "@type": "DateTime",
            "@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dateobserved"
        }
    }
}

Example of UAV UTM Flight Message Agent Entity

The following is an example instance of the UAV UTM Flight Message Agent entity

Download example entity definition.

{
    "@context": [
        "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/coreContext/ngsi-ld-core-context.json",
        "https://raw.githubusercontent.com/GSMADeveloper/NGSI-LD-Entities/master/examples/UAV-UTM-Flight-Message-Agent-context.jsonld"
    ],
    "id": "urn:ngsi-ld:UAVUTMFlightMessageAgent:cba823cc-5930-11e8-b8fe-d7c79082c9c7",
    "type": "UAVUTMFlightMessageAgent",
    "createdAt": "2017-01-01T01:20:00Z",
    "modifiedAt": "2017-05-04T12:30:00Z",
    "source": "https://source.example.com",
    "dataProvider": "https://provider.example.com",
    "entityVersion": 2.0,
    "uav": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:UAV:23821045-33d4-46ec-b777-98f461bf4856"
    },
    "observedAt": {
        "type": "Property",
        "value": "2016-08-23T10:18:16Z"
    },
    "originatedByUAV": {
        "type": "Property",
        "value": false
    },
    "originator": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:UAV:29935bbe-5922-11e8-9742-93bfb84686ec"
    },
    "flightMessage": {
        "type": "Property",
        "value": {
            "flightId": "3ce68ac8-5932-11e8-9a8d-ef74eb0fb0a2",
            "sequenceNumber": 0,
            "flightDeclaration": {},
            "version": "1.0.0"
        }
    },
    "validationResult": {
        "type": "Property",
        "value": true
    },
    "flightControlPolicy": {
        "type": "Property",
        "value": "https://www.example.com/fight-policy"
    }
}