More JSON.mkd

[apps/agl-service-can-low-level.git] / JSON.mkd

diff --git a/JSON.mkd b/JSON.mkd
index e07d060..72860cb 100644 (file)
--- a/JSON.mkd
+++ b/JSON.mkd
@@ -39,12 +39,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
@@ -271,6 +271,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 +368,30 @@ 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}
 
+### Celluar C5 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 [cellular_c5_config](vi-firmware/docs/advanced/cellular_c5_config.mkd) 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, 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}
\ No newline at end of file