diff options
author | Magnus Feuer <mfeuer@jaguarlandrover.com> | 2015-03-09 16:44:08 -0700 |
---|---|---|
committer | Magnus Feuer <mfeuer@jaguarlandrover.com> | 2015-03-09 16:44:08 -0700 |
commit | d1cc3d33c53bf5c21cbdfcc7df65bff273b6f5bd (patch) | |
tree | b3a5f00f30f029bbfe4fa1288c68a01446010a7b | |
parent | 97922c7ee40120ee9e846cad6a0a002089a0949d (diff) | |
download | rvi_core-d1cc3d33c53bf5c21cbdfcc7df65bff273b6f5bd.tar.gz |
Updated documentation in preparation for release
-rw-r--r-- | BUILD.md | 2 | ||||
-rw-r--r-- | CONFIGURE.md | 13 | ||||
-rw-r--r-- | RELEASE.md | 47 |
3 files changed, 54 insertions, 8 deletions
@@ -1,4 +1,4 @@ -Copyright (C) 2014, Jaguar Land Rover +Copyright (C) 2014-2015, Jaguar Land Rover This document is licensed under Creative Commons Attribution-ShareAlike 4.0 International. diff --git a/CONFIGURE.md b/CONFIGURE.md index bb0b383..c6d2952 100644 --- a/CONFIGURE.md +++ b/CONFIGURE.md @@ -1,9 +1,9 @@ -Copyright (C) 2014, Jaguar Land Rover +Copyright (C) 2014-2015, Jaguar Land Rover This document is licensed under Creative Commons Attribution-ShareAlike 4.0 International. -**Version 0.2** +**Version 0.3.x** # CONFIGURING AN RVI NODE @@ -269,7 +269,7 @@ The URL of Service Edge is specified through the ```service_edge``` tuple's ```url``` entry, read by the other components in the node to locate it. When a URL is specified for Service Edge, the port that it is to listen to must be synchronzied as well, using the -```exo_http_opts``` tuple. +```exo\_http\_opts``` tuple. An example entry is gven below: @@ -380,7 +380,7 @@ using the address/port specified by ```bert_rpc_server```). Below is an example of where gen_server is used where approrpiate. Please note that ```service_edge always``` need to have its ```url``` -and ```exo_http_pts``` options specified since local services need an +and ```exo_http_opts``` options specified since local services need an HTTP port to send JSON-RPC to. However, gen_server can still be specified in parallel, allowing for gen_server calls to be made between Servie Edge and other RVI components. @@ -441,7 +441,7 @@ of ```servide_edge```. Below is the previous configuration example with such a s { websocket, [ { port, 8818}]}, { url, "http://127.0.0.1:8811" }, { exo_http_opts, [ { port, 8811 } ]} - ]}, + ]},</b> ... </pre> @@ -454,7 +454,7 @@ host). # COMPILING THE RVI SOURCE CODE Before a development release can be built, the source code needs to be compiled. -Please see BUILDING.md for details on this process. +Please see BUILD.md for details on this process. # CREATING A DEVELOPMENT RELEASE @@ -584,4 +584,3 @@ Additional handlers can also be added for different log destinations. See Basho's lager documentation at [github](https://github.com/basho/lager) for details on logging. -## MORE @@ -2,3 +2,50 @@ # v0.1 # Initial demo version. Works with the hvac_demo and its hvac / mobile emulators. + +# v0.2 # +Various improvements + +# v0.3.0 # +* <b>Auto connect static links</b><br> + When data link is lost to a statically configured node (See + CONFIGURE STATIC NODES in [configuration](CONFIGURE.md) document, a + reconnect attempt will be made every five seconds. + +* <b>Intra-component communication speedup</b><br> + Components inside an RVI node can now choose if they want to use + JSON-RPC (compatbility mode) or Erlang Genserver calls to + communicate. + +* <b>List available services</b><br> + Added get\_available\_services, allowing a service to query its RVI node + of which other services are on-line and available for invocation. + + +* <b>New python tutorial code</b> + Created top level ```python``` directory with rvilib.py and three + new apps that can be used as tutorials on how to interface RVI. The + apps are: + + ```rvi_service.py``` registers a service with an RVI node and prints + out information when it is invoked by RVI. + + ```rvi_call.py``` invokes a service in an RVI network. + + + ```rvi_get_services.py``` connects to a local RVI node and prints out + a list of all callable services accessible throughout that node. + + ```rvilib.py``` has been cleaned up and simplified. + + +* <b>Service availability notifications</b><br> + Added real-time notifications from an RVI to its locally connected services + when a new service is added or deleted somewhere in the network. This + allows for the implementation of "vehicle online" indicators and other + real-time sensitive behavior. + +* Big data demo moved to its own repo at https://github.com/PDXostc/rvi_bigdata + +* SOTA demo moved to its own repo at https://github.com/PDXostc/rvi_sota_demo + |