From e9a1c41708c8e2c40f398ac1ae5713e28d041698 Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 16:46:45 -0400 Subject: Updated JSON.mkd Added details on the "modem_configuration" command. --- JSON.mkd | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index 069f74b4..bcc0dfd2 100644 --- 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 -- cgit 1.2.3-korg From 029152ad08a7466e83c419bacff2b398e24691c1 Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 16:48:42 -0400 Subject: All caps makes it look like I'm yelling... --- JSON.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index bcc0dfd2..4656ca3a 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -373,7 +373,7 @@ the response will be `true`. { "command_response": "predefined_obd2", "status": true} -### CELLULAR C5 CONFIGURATION +### 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. -- cgit 1.2.3-korg From 9a4e51989710fc718271981dd29c58c167c80758 Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 16:51:15 -0400 Subject: More JSON.mkd --- JSON.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index 4656ca3a..e7bea7f8 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -381,7 +381,7 @@ The ModemConfigurationCommand message provides three sub-messages for particular 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. +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** -- cgit 1.2.3-korg From 0b778b66400f67417672dd1849f5b90daa32d8a6 Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 21:05:55 -0400 Subject: More JSON.mkd --- JSON.mkd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index e7bea7f8..72860cb3 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -368,7 +368,7 @@ 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} @@ -377,7 +377,7 @@ the response will be `true`. 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. +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. -- cgit 1.2.3-korg From f67d16a46ea8c77ab614aff8060b2c7b2e9215ea Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 21:07:15 -0400 Subject: json --- JSON.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index 72860cb3..9e2f60af 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -377,7 +377,7 @@ the response will be `true`. 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. +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. -- cgit 1.2.3-korg From b8ef51cbb818c6fa91c83e0f06b2f6fde9804609 Mon Sep 17 00:00:00 2001 From: mgiannikouris Date: Mon, 14 Sep 2015 21:11:06 -0400 Subject: abs link json --- JSON.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index 9e2f60af..3f13f881 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -377,7 +377,7 @@ the response will be `true`. 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. +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. -- cgit 1.2.3-korg From 85208d33213e1932f3ae160310f751f1e5c064f6 Mon Sep 17 00:00:00 2001 From: Eric Marsman Date: Tue, 15 Sep 2015 10:04:24 -0400 Subject: link to web server project --- JSON.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'JSON.mkd') diff --git a/JSON.mkd b/JSON.mkd index 3f13f881..831ac505 100644 --- a/JSON.mkd +++ b/JSON.mkd @@ -381,7 +381,7 @@ The ModemConfigurationCommand message provides three sub-messages for particular 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. +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** -- cgit 1.2.3-korg