Vehicle-Fault.md

Vehicle Fault

This entity contains a harmonised description of a Vehicle Fault. This entity is primarily associated with the Automotive vertical segment but might also be relevant to Industry, Smart City, Agriculture and related IoT applications.

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
vehicle	Relationship	Reference to the vehicle entity which this fault relates to.	Mandatory
observedAt	DateTime	Indicates the date/time the fault was detected or identified.	Mandatory
eventType	Property	The event type descriptor, a choice from an enumerated list including: collision, emergency, harshAccel, harshDecel, auxBatteryWarn, milWarn.	Mandatory
location	GeoProperty	The geo location where the fault was detected or identified.	Recommended
processingType	Property	Indicates how the fault was dealt with, e.g. systemHandled, or not present if the issue has not been resolved.	Optional
resolvedAt	DateTime	Indicates the date/time at which the issue was solved, or not present if the issue has not been resolved.	Optional
dtCode	Property	DTC or Diagnostic Trouble Codes are codes generated by the vehicle's computer diagnostic system. These may be manufacturer, equipment or vehicle specific.	Optional
faultLog	Property	Free text that records information about the initial fault incident, ongoing updates and fault resolution.	Optional
dateIdentified	DateTime	Indicates the date/time the fault was detected or identified. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with observedAt	Deprecated
dateProcessed	DateTime	Indicates the date/time at which the issue was solved, or not present if the issue has not been resolved. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with resolvedAt	Deprecated

NGSI-LD Context Definition

The following NGSI-LD context definition applies to the Vehicle Fault 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",
        "vehicle": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/vehicle",
        "eventType": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/eventtype",
        "location": "http://uri.etsi.org/ngsi-ld/location",
        "processingType": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/processingtype",
        "resolvedAt": {
            "@type": "DateTime",
            "@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/resolvedat"
        },
        "dtCode": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dtcode",
        "faultLog": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/faultlog",
        "dateIdentified": {
            "@type": "DateTime",
            "@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dateidentified"
        },
        "dateProcessed": {
            "@type": "DateTime",
            "@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dateprocessed"
        }
    }
}

Example of Vehicle Fault Entity

The following is an example instance of the Vehicle Fault 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/Vehicle-Fault-context.jsonld"
    ],
    "id": "urn:ngsi-ld:VehicleFault:4939200a-5ef5-4266-8c91-1f82ad3b543b",
    "type": "VehicleFault",
    "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,
    "vehicle": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:Vehicle:1fa179a6-b507-4857-ad72-eb5513ef05c6"
    },
    "observedAt": {
        "type": "Property",
        "value": "2017-05-04T10:18:16Z"
    },
    "eventType": {
        "type": "Property",
        "value": "emergency"
    },
    "location": {
        "type": "GeoProperty",
        "value": {
            "type": "Point",
            "coordinates": [
                -104.99404,
                39.75621
            ]
        }
    },
    "processingType": {
        "type": "Property",
        "value": "systemHandled"
    },
    "resolvedAt": {
        "type": "Property",
        "value": "2017-05-04T10:18:16Z"
    },
    "dtCode": {
        "type": "Property",
        "value": "EMERG-1234-a"
    },
    "faultLog": {
        "type": "Property",
        "value": "Emergency stop. Fault with engine"
    }
}