diff options
Diffstat (limited to 'doc/rvi_services.md')
| -rw-r--r-- | doc/rvi_services.md | 40 |
1 files changed, 33 insertions, 7 deletions
diff --git a/doc/rvi_services.md b/doc/rvi_services.md index 74f92ee..11d77da 100644 --- a/doc/rvi_services.md +++ b/doc/rvi_services.md @@ -1,10 +1,14 @@ +<style type="text/css" media="print"> + div.pagebreak + { + page-break-before: always; + } +</style> Copyright (C) 2014, 2015 Jaguar Land Rover This document is licensed under Creative Commons Attribution-ShareAlike 4.0 International. - - Remote Vehicle Interface (RVI) Core Services ============================================ @@ -105,6 +109,7 @@ The parameters are: After receiving a key the device will typically store it in its key store. +<div class="pagebreak"></div> ##### Provision Certificate @@ -154,6 +159,8 @@ The parameters are: After receiving an erase certificate request the device must remove it from its certificate store. +<div class="pagebreak"></div> + ##### Clear Certificates Erase all certificates from the device's certificate store. @@ -207,7 +214,7 @@ reject that certificate as invalid. Services to manage device configuration. -##### Read Congfiguration Variables +##### Read Configuration Variables Retrieve the value of one or more configuration variables from the device. @@ -251,7 +258,9 @@ The parameters are: * variables - An array of dictionaries with variable names and values. * value - The value of the variable. -##### Write Congfiguration Variables +<div class="pagebreak"></div> + +##### Write Configuration Variables Set the value of one or more configuration variable in the device. @@ -305,7 +314,9 @@ Sequence of events: 5. After the server has sent the last chunk it sends `finish` to the client. 6. Once the client receives the `finish` message and has assembled and verified the download it sends `download_complete` to the server with a status indicator. - + +<div class="pagebreak"></div> + #### Notify Inform client of pending file transfer. @@ -353,6 +364,8 @@ The parameters are: match the ID from the `notify` message this message is sent in response to. +<div class="pagebreak"></div> + #### Start Download Initiate the download from the server to the client. @@ -398,6 +411,8 @@ The parameters are: may not arrive in order. * msg - File chunk encoded with base64. +<div class="pagebreak"></div> + #### Finish Transmission Indication by the server to the client that the last chunk has been sent. @@ -441,6 +456,8 @@ The parameters are: match the ID from the `notify` message this message is sent in response to. +<div class="pagebreak"></div> + #### Cancel Download Tell server to cancel the download. @@ -488,7 +505,9 @@ The parameters are: * channels - An array with the data channels to subscribe to. * reporting_interval - The reporting interval in milliseconds [ms]. - + +<div class="pagebreak"></div> + #### Unsubscribe Unsubscribe from one of more data channels. This message is typically implemented @@ -544,6 +563,8 @@ The parameters are: JSON data type. In particular `value` can be a dictionary in itself, as it is with the `location` channel. +<div class="pagebreak"></div> + Currently defined channels: | Channel | Description | Value Data Type | @@ -595,7 +616,8 @@ The parameters are: ```r2_lt``` and ```r2_rt``` are row two (rear) doors.<br> ```trunk``` is the rear trunk.<br> ```hood``` is the rear hood. - + +<div class="pagebreak"></div> #### Start / Stop Engine @@ -640,6 +662,8 @@ The parameters are: ```open``` open the trunk.<br> ```close``` close the trunk. +<div class="pagebreak"></div> + #### Horn Activate the horn. @@ -815,6 +839,8 @@ will be listed. } } +<div class="pagebreak"></div> + The parameters are: * windows - List each window with its current position. |