Skip to content
This repository has been archived by the owner on Nov 2, 2021. It is now read-only.

Commit

Permalink
Updated documentation in preparation for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mfeuer committed Mar 9, 2015
1 parent 97922c7 commit d1cc3d3
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 8 deletions.
2 changes: 1 addition & 1 deletion BUILD.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
13 changes: 6 additions & 7 deletions CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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>

Expand All @@ -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
Expand Down Expand Up @@ -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
47 changes: 47 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit d1cc3d3

Please sign in to comment.