}
}
-## Single Valued
+## Simple Vehicle Message
-There may not be a 1:1 relationship between input and output signals - i.e. raw
+There may not be a 1:1 relationship between input and output signals - i.e.
engine timing CAN signals may be summarized in an "engine performance" metric on
the abstract side of the interface.
{"name": "steering_wheel_angle", "value": 45}
-## Evented
+## Evented Simple Vehicle Message
The expected format of an event message is:
This format is good for something like a button event, where there are two
discrete pieces of information in the measurement.
-## Raw CAN Message format
+## CAN Message
-The format for a raw CAN message:
+The format for a plain CAN message:
{"bus": 1, "id": 1234, "data": "0x12345678"}
{ "command": "diagnostic_request",
"action": "add",
- "request": {
+ "diagnostic_request": {
"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"pid": 5,
"payload": "0x1234",
{ "command": "diagnostic_request",
"action": "add",
- "request": {
+ "diagnostic_request": {
"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"pid": 5
}
{ "command": "diagnostic_request",
"action": "add",
- "request": {
+ "diagnostic_request": {
"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"pid": 5,
"frequency": 1
{ "command": "diagnostic_request",
"action": "cancel",
- "request": {
+ "diagnostic_request": {
"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"pid": 5
}
**bus** - the numerical identifier of the CAN bus where this request should be
sent, most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
-**id** - the CAN arbitration ID for the request.
+**message_id** - the CAN message ID for the request.
**mode** - the OBD-II mode of the request - 0x1 through 0xff (1 through 9 are the
standardized modes and 0x22 is a common proprietary mode).
**name** - (optional, defaults to nothing) A human readable, string name for
this request. If provided, the response will have a `name` field (much like a
- normal translated message) with this value in place of `bus`, `id`, `mode` and
+ simple vehicle message) with this value in place of `bus`, `id`, `mode` and
`pid`.
**multiple_responses** - (optional, false by default) if true, request will stay
active for a full 100ms, even after receiving a diagnostic response message.
- This is useful for requests to the functional broadcast arbitration ID
+ This is useful for requests to the functional broadcast message ID
(`0x7df`) when you need to get responses from multiple modules. It's possible
to set this to `true` for non-broadcast requests, but in practice you won't
see any additional responses after the first and it will just take up memory
### Responses
-The response to a successful request:
+Requests to add or cancel a diagnostic request are first acknowledged by the VI,
+before any responses to the request are returned. The response uses the standard
+command response format:
+
+ { "command_response": "diagnostic_request", "status": true}
+
+**status** - true if the request was successfully created or cancelled.
+
+When a node on the network response to the request and the result is published
+by the VI, the result looks like:
{"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"pid": 5,
"success": true,
echo:
{"bus": 1,
- "id": 1234,
+ "message_id": 1234,
"mode": 1,
"success": false,
"negative_response_code": 17}
**bus** - the numerical identifier of the CAN bus where this response was
received.
-**id** - the CAN arbitration ID for this response.
+**message_id** - the CAN message ID for this response.
**mode** - the OBD-II mode of the original diagnostic request.
The response to a simple PID request would look like this:
- {"success": true, "bus": 1, "id": 1234, "mode": 1, "pid": 5, "payload": "0x2"}
+ {"success": true, "bus": 1, "message_id": 1234, "mode": 1, "pid": 5, "payload": "0x2"}
## Commands
In addition to the `diagnostic_request` command described earlier, there are
other possible values for the `command` field.
+All commands immediately return a `command_response`, e.g.:
+
+ { "command_response": "version", "message": "v6.0-dev (default)", "status": true}
+
+**command_response** - an echo of the command this is a ACKing.
+
+**status** - true if the command was understood and performed succesfully.
+
+**message** - (optional) a string message from the VI, e.g. to return a version
+ descriptor or error message.
+
### Version Query
The `version` command triggers the VI to inject a firmware version identifier
**Response**
- { "command_response": "version", "message": "v6.0-dev (default)"}
+ { "command_response": "version", "message": "v6.0-dev (default)", "status": true}
### Device ID Query
The `device_id` command triggers the VI to inject a unique device ID (e.g. the
MAC address of an included Bluetooth module) into into the outgoing data stream.
+If no device ID is available, the response message will be "Unknown".
+
**Request**
{ "command": "device_id"}
**Response**
- { "command_response": "device_id", "message": "0012345678"}
+ { "command_response": "device_id", "message": "0012345678", "status": true}
### Passthrough CAN Mode
Code Review / apps / agl-service-can-low-level.git / blobdiff