summaryrefslogtreecommitdiffstats
path: root/JSON.mkd
diff options
context:
space:
mode:
authorEric <emarsman@users.noreply.github.com>2015-09-15 10:06:34 -0400
committerEric <emarsman@users.noreply.github.com>2015-09-15 10:06:34 -0400
commitefdc0eb905b57a691badc6e87d9785ee83ce311e (patch)
tree3cf41917fdb6de4e5c3f6198745ccf3336c949a9 /JSON.mkd
parentbe2e20347d928b92b1fdfe674d5d5c31bf60fbfd (diff)
parent85208d33213e1932f3ae160310f751f1e5c064f6 (diff)
Merge pull request #23 from mgiannikouris/crosschasm-c5
added uptime field to VehicleMessage - new support for CrossChasm C5 BT & Cell devices
Diffstat (limited to 'JSON.mkd')
-rw-r--r--JSON.mkd24
1 files changed, 23 insertions, 1 deletions
diff --git a/JSON.mkd b/JSON.mkd
index 069f74b4..831ac505 100644
--- a/JSON.mkd
+++ b/JSON.mkd
@@ -368,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](https://github.com/openxc/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](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} \ No newline at end of file