diff options
author | mgiannikouris <mgiannikouris@crosschasm.com> | 2015-09-14 16:46:45 -0400 |
---|---|---|
committer | mgiannikouris <mgiannikouris@crosschasm.com> | 2015-09-14 16:46:45 -0400 |
commit | e9a1c41708c8e2c40f398ac1ae5713e28d041698 (patch) | |
tree | 40e421fea34c72d8200bc57722762a99074139e4 | |
parent | 3bb427338bc52b59921504727e77160b72242f3b (diff) |
Updated JSON.mkd
Added details on the "modem_configuration" command.
-rw-r--r-- | JSON.mkd | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -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 |