Skip to content

Commit

Permalink
VISSv3.0 documentation update.
Browse files Browse the repository at this point in the history
Signed-off-by: Ulf Bjorkengren <ulfbjn@gmail.com>
  • Loading branch information
UlfBj committed Oct 14, 2024
1 parent 19c33cc commit c298b3f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 5 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Ulf Björkengren - Ford Motor Company
Peter Winzell - Volvo Cars

# COVESA VISS Reference Implementation - VISSR
This project implements the COVESA VISS v2 specification under development at [https://github.com/COVESA/vehicle-information-service-specification](https://github.com/COVESA/vehicle-information-service-specification).
This project provides a reference implementation of the released [COVESA VISSv2.0 specification](https://github.com/COVESA/vehicle-information-service-specification/releases/tag/v2.0) on the v2.0 branch,
and an ongoing development of a reference implementation of the [VISSv3.0 specification](https://github.com/COVESA/vehicle-information-service-specification) on the master branch.

# Tutorial
A tutorial can be found <a href="https://covesa.github.io/vissr/">here</a>.
Expand Down
33 changes: 29 additions & 4 deletions tutorial/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
---
title: "COVESA Vehicle Information Service Specification ver 2 Reference Implementation Tutorial"
title: "COVESA Vehicle Information Service Specification ver 3 Reference Implementation Tutorial"
---
## COVESA Vehicle Information Service Specification ver 2 Reference Implementation Tutorial
## COVESA Vehicle Information Service Specification ver 3 Reference Implementation Tutorial

The COVESA VISSv2 specification is developed at the [COVESA/automotive github](https://github.com/COVESA/vehicle-information-service-specification).
A reference implementation in the form of a server that exposes an interface according to the specification is developed on this repo.
The COVESA VISSv3 specification is under development at the [COVESA VISS Github](https://github.com/COVESA/vehicle-information-service-specification).
A VISSv3.0 reference implementation in the form of a server that exposes an interface according to the specification is developed on the master branch,
while a VISSv2.0 reference implementation is available on the v2.0 branch.

This documentation covers the VISSv3.0 specification.
The new features are listed below.
It is with a few small exceptions backwards compatible with VISSv2.0. The exceptions are listed below.

### VISSv3.0 new features
* Multiple tree support. The server can be configured to manage multiple trees that a client can access.
* Server capabilities documented and client accessible in the Server tree.
* (File transfer.) !!Part of VISSv3.0 spec but not yet implemented!!
* gRPC support. This wa already available on an experimental level in VISSR @v2.0.
* Any further new features added to the VISSv3.0 specification will become implemented.

Also found on this repo are implementations of other components that are needed to realize a communication tech stack that reaches from clients through the server and to the underlying vehicle system interface.

Expand All @@ -20,3 +32,16 @@ These software components (SwCs) can be categorized as follows:
The tutorial describes each SwC category in a separate chapter.
It also contains a few Proof of concept (POC) examples, and information about installing,
building and running Golang based SwCs, a Docker containerization, and about some peripheral components.

### Client deployment options
As is shown in the figure above the VISS interface is well suited to serve clients deployed in different environments:
* Cloud deployment. Typically connected via Internet connectivity.
* Proximity deployment. Typcially in a mobile phone connected via any short range connectivity such as Bluetooth or WiFi.
* In-vehicle deployment. Typically as an app in the infotainment environment.

The payloads handled by the clients at any of these deployments are identical.

The MQTT transport protocol option, with the broker deployed in the cloud,
is well suited for the client cloud deployment as the communication can traverse across subnets.
The thin application layer protocol on top of MQTT that VISS defines makes it possible
to keep the client-server communication, and payload compatibility.

0 comments on commit c298b3f

Please sign in to comment.