Updated JSON.mkd
authormgiannikouris <mgiannikouris@crosschasm.com>
Mon, 14 Sep 2015 20:46:45 +0000 (16:46 -0400)
committermgiannikouris <mgiannikouris@crosschasm.com>
Mon, 14 Sep 2015 20:46:45 +0000 (16:46 -0400)
Added details on the "modem_configuration" command.

JSON.mkd

index 069f74b..bcc0dfd 100644 (file)
--- a/JSON.mkd
+++ b/JSON.mkd
@@ -373,3 +373,25 @@ the response will be `true`.
 
     { "command_response": "predefined_obd2", "status": true}
 
+### CELLULAR 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 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 command 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 carries data to/from the device 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