-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| ### VehicleFault | ||
|
|
||
| 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 and Agriculture related IoT applications. | ||
|
|
||
| <VehicleFault><Generic Attributes> | ||
|
|
||
| | Attribute Name | Attribute Type | Description | Mandatory/Optional | May be Null | | ||
| |----------------|----------------|-------------------------------------------------------------------------------|--------------------|-------------| | ||
| | id | Text | Unique id of this instance of this entity. | M | N | | ||
| | type | Text | Must be equal to "**VehicleFault**". | M | N | | ||
| | dateCreated | DateTime | Entity creation timestamp. | M | N | | ||
| | dateModified | DateTime | Timestamp of the last modification of the entity. | M | Y | | ||
| | source | Text | A sequence of characters giving the source of the entity data as a URL. | M | Y | | ||
| | dataProvider | Text | A sequence of characters identifying the originator of the harmonised entity. | M | Y | | ||
|
|
||
| <VehicleFault><Entity Specific Attributes> | ||
|
|
||
| | Attribute Name | Attribute Type | Description | Mandatory/Optional | May be Null | | ||
| |----------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|-------------| | ||
| | refVehicle | Array of Reference | A JSON encode sequence of characters referencing the Id of the vehicle in which this fault occurred. | M | N | | ||
| | dateDetected | DateTime | An ISO8601 sequence of characters indicating the date and time the fault was detected. | M | N | | ||
| | eventType | Text | The event type descriptor, a choice from an enumerated list including: <br/><br/>**collision, emergency, harshAccel, harshDecel, auxBatteryWarn, milWarn**. | M | N | | ||
| | location | geo:json | The geo location where the fault was detected. | M | Y | | ||
| | processingType | Text | Indicates how the fault was dealt with, e.g. **systemHandled,** or not present if the issue has not been resolved. | O | Y | | ||
| | dateProcessed | DateTime | The ISO8601 sequence of characters indicating the data and time at which the issue was solved, or not present if the issue has not been resolved. | O | Y | | ||
| | dtCode | Text | DTC or Diagnostic Trouble Codes are codes generated by the vehicle's computer diagnostic system. These may be manufacturer, equipment or vehicle specific. | O | Y | | ||
| | faultLog | Text | Free text that records information about the initial fault incident, ongoing updates and fault resolution. | O | Y | | ||
|
|
||
| #### VehicleFault JSON | ||
|
|
||
| The JSON code can be downloaded from: | ||
|
|
||
| <https://gist.github.com/GSMADeveloper/2e40b95654493bc44cabe360e9c3f82d> | ||
| ```json | ||
| { | ||
| "id": "4939200a-5ef5-4266-8c91-1f82ad3b543b", | ||
| "type": "VehicleFault", | ||
| "dateCreated": { | ||
| "value": "2016-08-08T10:18:16Z", | ||
| "type": "DateTime" | ||
| }, | ||
| "dateModified": { | ||
| "value": "2016-08-08T10:18:16Z", | ||
| "type": "DateTime" | ||
| }, | ||
| "source": { | ||
| "value": "http://www.example.com", | ||
| "type": "URL" | ||
| }, | ||
| "dataProvider": { | ||
| "value": "OperatorA", | ||
| "type": "Text" | ||
| }, | ||
| "refVehicle": [ | ||
| "e64a2ecb-a8ae-4f51-ab66-2e9729c02d22" | ||
| ], | ||
| "dateDetected": { | ||
| "value": "2016-08-20T10:18:16Z", | ||
| "type": "DateTime" | ||
| }, | ||
| "eventType": { | ||
| "value": "emergency", | ||
| "type": "Text" | ||
| }, | ||
| "location": { | ||
| "value": { | ||
| "type": "Point", | ||
| "coordinates": [ | ||
| -104.99404, | ||
| 39.75621 | ||
| ] | ||
| }, | ||
| "type": "geo:json" | ||
| }, | ||
| "processingType": { | ||
| "value": "systemHandled", | ||
| "type": "Text" | ||
| }, | ||
| "dateProcessed": { | ||
| "value": "2016-08-21T10:18:16Z", | ||
| "type": "DateTime" | ||
| }, | ||
| "dtCode": { | ||
| "value": "EMERG-1234-a", | ||
| "type": "Text" | ||
| }, | ||
| "faultLog": { | ||
| "value": "Emergency stop. Fault with engine", | ||
| "type": "Text" | ||
| } | ||
| } | ||
| ``` |