Envelope
Message Summary
message Envelope
The envelope includes fundamental information about the individual sender (the vehicle) but not to a level that owner of the vehicle can be identified or different messages can be identified that originate from a single vehicle.
Include: sdii.v3.3.1.proto
Properties
| Field | Type | Label | Description | |
|---|---|---|---|---|
version | string | required | A textual value describing the version of interface specification in use. For example: “3.3.2” | |
submitter | string | required | The name of the company that submits the data (e.g. an OEM name or a System Vendor name). It is not an individual vehicle identifier. The same company may use different values for the submitter text value for different purposes (e.g. production group, pre-development group). The submitter value is based on submitter-receiver agreement and may also be combined to enable distinguishment between different submitter environments (e.g. “OEM-HeadUnit”, “OEM-Cloud”, …) | |
vehicleMetaData | VehicleMetaData | optional | Contains data referring to the vehicle that are not changing in usual driving conditions. | |
transientVehicleID | int64 | optional | DEPRECATED The Transient Vehicle ID is a numeric and optional value. If the transient vehicle ID value is submitted then each submission during the drive cycle of a single vehicle shall receive the same transient vehicle ID value. This allows stitching together multiple smaller path submissions of a vehicle during a drive. A different drive of the same vehicle (e.g. on the next day) should receive a new transient vehicle ID. Within all submissions of a “Submitter” the ID space shall remain unique. This attribute is deprecated and replaced by transientVehicleUUID of data type string. | |
vehicleProfileID | int64 | optional | DEPRECATED The Vehicle Profile ID is a numeric and optional value that is unique for a vehicle. If the vehicle Profile ID value is submitted then each submission including the profile ID is identifiable with the vehicle. This allows stitching together multiple single submissions of a vehicle during over a multitude of drives. The vehicle profile ID should be provided to events as e.g. fuel events where the fuel profile for a single vehicle should be analyzed and provided back to the single vehicle through a different interface. This attribute is deprecated and replaced by persistentVehicleUUID with the data type string. | |
transientEventID | int64 | optional | Allows the vehicle to send in an optional identifier of the reported sensor data if it has it available. The Event ID may be used to a future referencing of the current Sensor Data Message. | |
persistentDriverUUID | string | optional | The Persistent Driver UUID is a string and an optional value that is unique for a driver in a vehicle. If the Persistent Driver UUID value is submitted then each submission including that ID identifies the driver who is assigned that ID. This allows stitching together multiple single submissions for a driver over a multitude of drives. The Persistent Driver UUID should be provided for events e.g. fuel events where the fuel profile for a single driver could be analyzed and provided back to the vehicle through a different interface. | |
persistentVehicleUUID | string | optional | The Persistent Vehicle UUID is a string and an optional value that is unique for a vehicle. If the Persistent Vehicle UUID value is submitted then each submission including that ID identifies the vehicle. This allows stitching together multiple single submissions for a vehicle over a multitude of drives. The Persistent Vehicle UUID should be provided for events e.g. fuel events where the fuel profile for a single vehicle could be analyzed and provided back to the vehicle through a different interface. | |
transientVehicleUUID | string | optional | The Transient Vehicle UUID is a string and an optional value. If the transient vehicle UUID value is submitted then each submission during the drive cycle of a single vehicle shall receive the same transient vehicle UUID value. This allows stitching together multiple smaller path submissions of a vehicle during a drive. A different drive of the same vehicle (e.g. on the next day) should receive a new transient vehicle UUID. Within all submissions of a “Submitter” the ID space shall remain unique. | |
submissionConfigurationUUIDArray | string | repeated | Using the Submission Configuration UUID, the system can group individual submissions of sensor data. One or more Submission Configurtion UUIDs can be sent along with the pertinent sensor data in a single message. | |
mapProvider | string | optional | The name of the provider of the map installed in the vehicle. This information is important in case, map matched information (linkID, map matched position). If provided, all three attributes Map Provider, Map Version, and Map Standard must be set. | |
mapVersion | string | optional | The version of the installed map used for providing information with map matched data. | |
mapStandard | MapStandardEnum | optional | The standard format of the map installed in the vehicle. If provided, all three attributes Map Provider, Map Version, and Map Standard must be set. | |
transientEventUUID | string | optional | The Transient Vehicle UUID is a string and an optional value. If the transient event UUID value is submitted, then each submission shall have a unique UUID value. | |
vehicleHeadUnitVersion | string | optional | The supplier based version of the vehicle Head Unit. It may contain a part for the hardware version, and a part for the software version. | |
