X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=JSON.mkd;h=d320aad08e9a7dae4dc03586d0c913d83f57b6af;hb=94c09b2abeff3f344d688dd7e6aea0db34f50c59;hp=e07d06003220989247cf61a464874250d0d20c49;hpb=9682309b7d7450235bea95841f7442e6712db379;p=apps%2Flow-level-can-service.git diff --git a/JSON.mkd b/JSON.mkd index e07d060..d320aad 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -2,21 +2,16 @@ Each JSON message published by a VI is delimited with a `\0 ` character. -## Extra Values +## Table of Contents +1. [Vehicle Messages](#vehicle-messages) +2. [CAN Message](#can-message) +3. [Diagnostic Message](#diagnostic-message) +4. [Commands](#commands) +5. [Extra Values](#extra-values) -Any of the following JSON objects may optionally include an `extras` -field. The value may be any valid JSON object or array. The client libraries -will do their best to parse this information into a generic format and pass it -to your application. For example: +## Vehicle Messages - {"name": "steering_wheel_angle", - "value": 45, - "extras": { - "calibrated": false - } - } - -## Simple Vehicle Message +### Simple Vehicle Message 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 @@ -26,7 +21,7 @@ The expected format of a single valued message is: {"name": "steering_wheel_angle", "value": 45} -## Evented Simple Vehicle Message +### Evented Simple Vehicle Message The expected format of an event message is: @@ -39,12 +34,12 @@ discrete pieces of information in the measurement. The format for a plain CAN message: - {"bus": 1, "message_id": 1234, "data": "0x12345678"} + {"bus": 1, "id": 1234, "data": "0x12345678"} **bus** - the numerical identifier of the CAN bus where this message originated, most likely 1 or 2 (for a vehicle interface with 2 CAN controllers). -**message_id** - the CAN message ID +**id** - the CAN message ID **data** - up to 8 bytes of data from the CAN message's payload, represented as a hexidecimal number in a string. Many JSON parser cannot handle 64-bit @@ -57,7 +52,7 @@ The format for a plain CAN message: of `standard` or `extended`. If the `id` is greater than `0x7ff`, the extended frame format will be selected automatically. -## Diagnostic Messages +## Diagnostic Message ### Requests @@ -271,6 +266,8 @@ response into the outgoing data stream. 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"} @@ -366,8 +363,73 @@ the "Signals Defined from Diagnostic Messages" section below. **Response** -f the predefined requests were enabled or disabled successfully, the `status` in +If the predefined requests were enabled or disabled successfully, the `status` in the response will be `true`. { "command_response": "predefined_obd2", "status": true} +### C5 Cellular Configuration + +The ModemConfigurationCommand message allows users to change certain aspects of modem operation on-the-fly (at runtime). The modem configuration settings are stored in flash memory and are untouched by the bootloader during a software update (assuming the correct cellular_c5 linker file is used during compilation of vi-firmware). Thus, new modem settings persistent across power cycles. + +The ModemConfigurationCommand message provides three sub-messages for particular groups of modem settings. These are NetworkOperatorSettings, NetworkDataSettings, and ServerConnectSettings. These configuration messages are described in great detail within the [c5_cellular_config](https://github.com/openxc/vi-firmware/docs/advanced/c5_cell_config.html) documentation. + +Currently, only the ServerConnectSettings sub-message is supported in the vi-firmware's command interpreter. All other settings are currently compile-time only. + +The ServerConnectSettings part of ModemConfigurationCommand allows the user to set the host server name and port that the device will use when opening a TCP socket to upload data. This destination must be running an HTTP server similar to [OpenXCWebServer](https://github.com/openxc/openxc-azure-webserver), which defines a set of supported HTTP transactions where the body is comprised of data in the familiar OpenXC Message Format. + +**Request** + + { "command": "modem_configuration", + "server": { + "host": "www.myhost.com", + "port": 10000 + } + } + +**Response** + + { "command_response": "modem_configuration", "status": true} + +## C5 SD Card Status + +In order to check the status of the SD card, the following command is available: + + { "command": "sd_mount_status"} + +Command response if the SD card is mounted correctly: + + { "command_response": "sd_mount_status", "status": true} + +If the SD card is full, not enabled, or connected as a MSD, the device will respond with: + + { "command_response": "sd_mount_status", "status": false} + +For more info see [c5_msd](https://github.com/openxc/vi-firmware/docs/advanced/msd.html). + +## C5 RTC Configuration + +To set the current time of the RTC, the following + + { "command": "rtc_configuration", "unix_time": "1448551563"} + +The response is + + { "command_response": "rtc_configuration", "status": true} + +For more info see [c5_rtc](https://github.com/openxc/vi-firmware/docs/advanced/rtc.html). + +## Extra Values + +Any of the following JSON objects may optionally include an `extras` +field. The value may be any valid JSON object or array. The client libraries +will do their best to parse this information into a generic format and pass it +to your application. For example: + + {"name": "steering_wheel_angle", + "value": 45, + "extras": { + "calibrated": false + } + } +