Skip to content

Commit fa3b1e5

Browse files
authored
Merge pull request eclipse-leda#73 from SoftwareDefinedVehicle/improve_sdv_intro_tutorial
Add some language improvements and rephrasing to the SDV intro tutorial
2 parents a580f54 + c222bf4 commit fa3b1e5

File tree

1 file changed

+13
-13
lines changed
  • content/en/docs/general-usage/sdv-introduction

1 file changed

+13
-13
lines changed

content/en/docs/general-usage/sdv-introduction/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,17 @@ the Connected Vehicle Systems Alliance (COVESA) for this.
3737
![VSS Tree](vss-tree.png)
3838

3939
VSS essentially defines a [rule set](https://covesa.github.io/vehicle_signal_specification/rule_set/) of how to express the definition of signals in a vehicle.
40-
This definition bases a tree structure where each domain, like body control gets an individual sub-tree.
41-
The authors of VSS further provide a [default tree](https://github.com/COVESA/vehicle_signal_specification/tree/master/spec) of signals to expect in a vehicle.
40+
This definition bases a tree structure where each domain, like body control, gets an individual sub-tree.
41+
The authors of VSS further provide a [default tree](https://github.com/COVESA/vehicle_signal_specification/tree/master/spec) of signals to be expected in a vehicle.
4242
However, it is common practice to tailor the default tree for a specific vehicle model by adding overlays.
4343

4444
VSS allows modeling and structuring of the data from a vehicle but does not define interfaces for the interaction with this data since this depends on the used
4545
communication technology and further circumstances like whether VSS data gets processed inside the vehicle or off-board.
4646

47-
### Eclipse KUKSA.val databroker
48-
4947
For our architecture, we therefore add the [Eclipse Kuksa.val databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker)
5048
from the [Eclipse Kuksa](https://eclipse-kuksa.github.io/kuksa-website/) project.
5149

50+
### Eclipse KUKSA.val databroker
5251
The Eclipse Kuksa.val databroker acts as a vehicle abstraction layer by brokering VSS signals between vehicle applications
5352
and deeply embedded systems in the vehicle. Enabling this abstraction requires a vehicle-specific component to translate between the Kuksa.val databroker and
5453
the underlying transport systems and ECUs.
@@ -68,7 +67,7 @@ Either way, these clients allow the development of vehicle applications and prov
6867

6968
## Vehicle Application Development
7069

71-
When developing an application to interact with the abstraction layer, there are a couple of aspects to cover which are not specific to a single application.
70+
When developing an application to interact with the abstraction layer, there are a couple of aspects to cover, which are not specific to a single application.
7271
Because of that, some projects are evolving around the application development phase.
7372

7473
### Eclipse Autowrx and digital.auto Playground
@@ -77,18 +76,19 @@ A good starting point to figure out what signals are available is the website of
7776

7877
![digital.auto Vehicle API](digitalauto-vehicle-api.png)
7978

80-
In the next step, one can ideate on new applications, start coding, and get fast feedback using the prototyping feature of the playground.
81-
Once one is confident with the initial version, one can continue the development journey with the help of [Eclipse Velocitas](https://eclipse.dev/velocitas/),
79+
In the next step, you can ideate on new applications, start coding, and get fast feedback using the prototyping feature of the playground.
80+
Once you are confident with the initial version, you can continue the development journey with the help of [Eclipse Velocitas](https://eclipse.dev/velocitas/),
8281
which comes with several features making the life of vehicle application developers easier.
8382

8483
![digital.auto Prototyping](digitalauto-prototype.png)
8584

8685
### Eclipse Velocitas
86+
[Eclipse Velocitas™](https://eclipse.dev/velocitas/docs/about/#product) is an open source project providing a development tool chain to create containerized Vehicle Apps, offering a development experience to increase the speed of a development team (velocity).
8787

88-
As a starting point, Eclipse Velocitas provides a [template repository](https://github.com/eclipse-velocitas/vehicle-app-python-template).
89-
To kick-start the development of a new application, one can create an individual repository from this template.
90-
As an alternative, Eclipse Velocitas provides a CLI application with which one can configure the creation of a tailored vehicle application repository.
91-
Either way, the resulting repository containers [skeleton code for the actual application](https://github.com/eclipse-velocitas/vehicle-app-python-template/blob/main/app/src/main.py)
88+
Among other things, Eclipse Velocitas provides a [template repository](https://github.com/eclipse-velocitas/vehicle-app-python-template).
89+
To kick-start the development of a new application, you can create an individual repository from this template.
90+
As an alternative, Eclipse Velocitas provides a CLI application with which you can configure the creation of a tailored vehicle application repository.
91+
Either way, the resulting repository contains [skeleton code for the actual application](https://github.com/eclipse-velocitas/vehicle-app-python-template/blob/main/app/src/main.py)
9292
and comes with pre-defined [GitHub Actions workflows](https://github.com/eclipse-velocitas/vehicle-app-python-template/tree/main/.github) to automate
9393
the testing and releasing of applications as containers.
9494
The repository further contains the Dockerfile for a dev container that setups a development and vehicle environment on the developer machine.
@@ -97,12 +97,12 @@ It is then possible to interact with this container through VSCode.
9797
Another aspect of Eclipse Velocitas is the so-called vehicle model. Here it becomes possible to take a custom vehicle model expressed in
9898
VSS and [generate a tailored SDK](https://github.com/eclipse-velocitas/vehicle-model-generator) with specific domain classes to interact
9999
with a Kuksa.val databroker using the same model.
100-
This way, one can directly develop against the used vehicle model.
100+
This way, we can directly develop against the used vehicle model.
101101

102102
![Velocitas Flow](velocitas-flow.png)
103103

104104
<!-- TODO make this text describing the picture -->
105-
A typical Eclipse Velocitas application development flow then may contain the following steps:
105+
[A typical Eclipse Velocitas application development flow](https://eclipse.dev/velocitas/docs/tutorials/quickstart/) then may contain the following steps:
106106

107107
* create Repository
108108
* build and run Dev Container locally from VSCode

0 commit comments

Comments
 (0)