Skip to content

Commit 824f3d5

Browse files
mikehallermikehaller
authored
Merge pull request #76 from eclipse-leda/copilot/update-vss-release-to-6-0
Update VSS documentation generation to COVESA VSS 6.0 with auto-detection
2 parents fa3b1e5 + aee6600 commit 824f3d5

2,231 files changed

Lines changed: 139307 additions & 78008 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎vss/build-vss-docs.sh‎

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,46 @@
1313
# ********************************************************************************/
1414
#
1515
# Setup:
16-
# sudo apt-get install python3.10
16+
# sudo apt-get install python3
1717
# sudo apt-get update
1818
# sudo apt-get install pip
19-
# pip install vss-tools
20-
# git clone https://github.com/COVESA/vss-tools.git
19+
# pip install vss-tools mako anytree
2120

22-
# git clone --recurse-submodules https://github.com/COVESA/vehicle_signal_specification
23-
# pushd vehicle_signal_specification
24-
# git checkout --detach
25-
# git for-each-ref refs/remotes/origin --format='../%(refname:lstrip=3) %(refname:lstrip=3)'|grep -v ' HEAD$' |xargs -n 2 git worktree add
26-
# popd
21+
# Auto-detect the latest COVESA VSS release from GitHub
22+
GITHUB_API_URL="https://api.github.com/repos/COVESA/vehicle_signal_specification/releases/latest"
23+
DEFAULT_VSS_VERSION="6.0"
2724

28-
./vspecjson2markdown.py -I release/3.1/spec -i VehicleSignalSpecification.vspec -u release/3.1/spec/units.yaml -o output
25+
echo "Detecting latest VSS release..."
26+
LATEST_TAG=$(curl -s "${GITHUB_API_URL}" | python3 -c "import sys, json; print(json.load(sys.stdin)['tag_name'])" 2>/dev/null || echo "")
27+
28+
if [ -z "${LATEST_TAG}" ]; then
29+
echo "Could not auto-detect latest version, using default: v${DEFAULT_VSS_VERSION}"
30+
LATEST_TAG="v${DEFAULT_VSS_VERSION}"
31+
fi
32+
33+
VSS_VERSION="${LATEST_TAG#v}"
34+
echo "Using VSS version: ${VSS_VERSION} (tag: ${LATEST_TAG})"
35+
36+
# Download and extract the VSS specification if not already present
37+
VSS_DIR="/tmp/vehicle_signal_specification-${VSS_VERSION}"
38+
if [ ! -d "${VSS_DIR}" ]; then
39+
echo "Downloading VSS ${VSS_VERSION}..."
40+
DOWNLOAD_URL="https://github.com/COVESA/vehicle_signal_specification/archive/refs/tags/${LATEST_TAG}.zip"
41+
curl -L "${DOWNLOAD_URL}" -o "/tmp/vss_${VSS_VERSION}.zip"
42+
unzip -q "/tmp/vss_${VSS_VERSION}.zip" -d /tmp/
43+
fi
44+
45+
SPEC_DIR="${VSS_DIR}/spec"
46+
echo "Using spec directory: ${SPEC_DIR}"
47+
48+
# Clean up old output before regenerating
49+
echo "Cleaning output directory..."
50+
rm -rf output
51+
52+
./vspecjson2markdown.py \
53+
-I "${SPEC_DIR}" \
54+
-i "${SPEC_DIR}/VehicleSignalSpecification.vspec" \
55+
-u "${SPEC_DIR}/units.yaml" \
56+
-q "${SPEC_DIR}/quantities.yaml" \
57+
-o output
2958

‎vss/output/Vehicle/ADAS/ABS/IsEnabled/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IsEnabled
33

4-
date: 2023-06-05T12:39:01.888437
4+
date: 2026-03-08T08:02:56.149129
55
no_list: true
66
---
77

‎vss/output/Vehicle/ADAS/ABS/IsEngaged/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IsEngaged
33

4-
date: 2023-06-05T12:39:01.946299
4+
date: 2026-03-08T08:02:56.169382
55
no_list: true
66
---
77

‎vss/output/Vehicle/ADAS/ABS/IsError/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IsError
33

4-
date: 2023-06-05T12:39:01.922369
4+
date: 2026-03-08T08:02:56.159163
55
no_list: true
66
---
77

‎vss/output/Vehicle/ADAS/ABS/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: ABS
33

4-
date: 2023-06-05T12:39:01.868024
4+
date: 2026-03-08T08:02:56.139068
55
no_list: true
66
---
77

‎vss/output/Vehicle/ADAS/ActiveAutonomyLevel/_index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: ActiveAutonomyLevel
33

4-
date: 2023-06-05T12:39:01.369199
4+
date: 2026-03-08T08:02:55.531773
55
no_list: true
66
---
77

88

99
| | |
1010
|---|---|
1111
| Full qualified VSS Path: | `Vehicle.ADAS.ActiveAutonomyLevel` |
12-
| Description: | Indicates the currently active level of autonomy according to SAE J3016 taxonomy. |
13-
| Comment: | Follows https://www.sae.org/news/2019/01/sae-updates-j3016-automated-driving-graphic taxonomy. For SAE levels 3 and 4 the system is required to alert the driver before it will disengage. Level 4 systems are required to reach a safe state even if a driver does not take over. Only level 5 systems are required to not rely on a driver at all. While level 2 systems require the driver to be monitoring the system at all times, many level 2 systems, often termed "level 2.5" systems, do warn the driver shortly before reaching their operational limits, therefore we also support the DISENGAGING state for SAE_2. |
12+
| Description: | Indicates the currently active level of driving automation according to the SAE J3016 (Taxonomy and Definitions for Terms Related to Driving Automation Systems for On-Road Motor Vehicles). |
13+
| Comment: | Complies with https://www.sae.org/standards/content/j3016_202104/ and https://www.sae.org/blog/sae-j3016-update. Level 5 and 4 ADS (Automated driving system) disengage, if appropriate, only after it achieves a minimal risk condition or a driver is performing the DDT. Level 3 ADS disengages either an appropriate time after issuing a request to intervene or immediately upon user request. Level 2 DAS (Driving automation system) disengages immediately upon driver request. However, since many Level 2 DAS, often termed "Level 2.5", warn the driver shortly before reaching their operational limits, the VSS also supports the DISENGAGING state for SAE_2. Nevertheless, it should be noted that the SAE J3016 states that it is incorrect to describe driving automation features using fractional levels. |
1414

1515
## Navigation
1616

@@ -56,7 +56,7 @@ sdv.databroker.v1 > set Vehicle.ADAS.ActiveAutonomyLevel Foo
5656
|---|---|---|
5757
| Path | `Vehicle.ADAS.ActiveAutonomyLevel` | [VSS: Addressing nodes](https://covesa.github.io/vehicle_signal_specification/rule_set/basics/) |
5858
| Data type | `string` | [VSS: Datatypes](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_types/) |
59-
| Allowed values | `['SAE_0', 'SAE_1', 'SAE_2_DISENGAGING', 'SAE_2', 'SAE_3_DISENGAGING', 'SAE_3', 'SAE_4_DISENGAGING', 'SAE_4', 'SAE_5']` | [VSS: Specifying allowed values](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/allowed/) |
59+
| Allowed values | `['SAE_0', 'SAE_1', 'SAE_2_DISENGAGING', 'SAE_2', 'SAE_3_DISENGAGING', 'SAE_3', 'SAE_4_DISENGAGING', 'SAE_4', 'SAE_5_DISENGAGING', 'SAE_5']` | [VSS: Specifying allowed values](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/allowed/) |
6060

6161

6262

‎vss/output/Vehicle/ADAS/CruiseControl/AdaptiveDistanceSet/_index.md‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
title: AdaptiveDistanceSet
3+
4+
date: 2026-03-08T08:02:55.612772
5+
no_list: true
6+
---
7+
8+
9+
| | |
10+
|---|---|
11+
| Full qualified VSS Path: | `Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet` |
12+
| Description: | Distance in meters to keep from lead vehicle |
13+
14+
## Navigation
15+
16+
```mermaid
17+
flowchart LR
18+
19+
20+
21+
Vehicle-->ADAS
22+
23+
ADAS-->CruiseControl
24+
25+
CruiseControl-->AdaptiveDistanceSet
26+
27+
```
28+
29+
## Eclipse Leda: Usage Example
30+
31+
In [Eclipse Kuksa.VAL Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) CLI:
32+
33+
34+
35+
```bash
36+
$ databroker-cli
37+
sdv.databroker.v1 > connect
38+
[connect] OK
39+
sdv.databroker.v1 > get Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet
40+
[get] OK
41+
Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet: ( NotAvailable )
42+
sdv.databroker.v1 > set Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet 0
43+
[set] OK
44+
```
45+
46+
## Digital Auto: Playground
47+
48+
[playground.digital.auto](http://digital.auto) provides an in-browser, rapid prototyping environment utilizing the COVESA APIs for connected vehicles.
49+
50+
| Vehicle Model | Direct link to Vehicle Signal |
51+
|---|---|
52+
| ACME Car (EV) v0.1 | [Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet](https://digitalauto.netlify.app/model/STLWzk1WyqVVLbfymb4f/cvi/list/Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet/) |
53+
54+
## Data Type & Unit
55+
56+
| | | |
57+
|---|---|---|
58+
| Path | `Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet` | [VSS: Addressing nodes](https://covesa.github.io/vehicle_signal_specification/rule_set/basics/) |
59+
| Data type | `float` | [VSS: Datatypes](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_types/) |
60+
| Unit | `m` | [VSS: Units](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_unit_types/) |
61+
| Label | meter | |
62+
| Description | Length measured in meters | [VSS: Sensors & Actuators](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/sensor_actuator/) |
63+
| Domain | length | [](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_unit_types/) |
64+
| Minimum value | `0.0` | [VSS: Sensors & Actuators](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/sensor_actuator/) |
65+
66+
67+
68+
69+
70+
71+
72+
73+
74+
75+
**Note:** The `float` datatype is a *floating point number* which technically allows values between -3.4e ^ -38 and 3.4e ^ 38
76+
77+
78+
79+
80+
## Signal Information
81+
82+
The vehicle signal `Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet` is an **Actuator**.
83+
84+
85+
86+
87+
88+
The vehicle signal `Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet` is a **Signal**.
89+
90+
91+
92+
## UUID
93+
94+
Each vehicle signal is identified by a [Universally Unique Identifier (UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier))
95+
96+
The UUID for `Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet` is `72b605a1903750219d50732b4c92084c`
97+
98+
99+
## Feedback
100+
101+
Do you think this Vehicle Signal specification needs enhancement? Do you want to discuss with experts? Try the following ressources to get in touch with the VSS community:
102+
103+
| | |
104+
|---|---|
105+
| Enhancement request | [Create COVESA GitHub Issue](https://github.com/COVESA/vehicle_signal_specification/issues/new?body=Please+describe+your+feedback&title=Signal+feedback+Vehicle.ADAS.CruiseControl.AdaptiveDistanceSet) |
106+
| Join COVESA | [www.covesa.global](https://www.covesa.global/join?src=sidebar) |
107+
| Discuss VSS on Slack | [w3cauto.slack.com](http://w3cauto.slack.com/) |
108+
| VSS Data Experts on Google Groups | [covesa.global data-expert-group](https://groups.google.com/a/covesa.global/g/data-expert-group) |
109+
110+
## About VSS
111+
112+
The [Vehicle Signal Specification](https://covesa.github.io/vehicle_signal_specification/) (VSS)
113+
is an initiative by COVESA to define a syntax and a catalog for vehicle signals.
114+
The source code and releases can be found in the [VSS github repository](https://github.com/COVESA/vehicle_signal_specification).
115+
116+
## Supported datatypes
117+
118+
The following is a list of VSS supported built-in datatypes:
119+
120+
Name | Type | Min | Max
121+
:----------|:---------------------------|:-----|:---
122+
uint8 | unsigned 8-bit integer | 0 | 255
123+
int8 | signed 8-bit integer | -128 | 127
124+
uint16 | unsigned 16-bit integer | 0 | 65535
125+
int16 | signed 16-bit integer | -32768 | 32767
126+
uint32 | unsigned 32-bit integer | 0 | 4294967295
127+
int32 | signed 32-bit integer | -2147483648 | 2147483647
128+
uint64 | unsigned 64-bit integer | 0 | 2^64 - 1
129+
int64 | signed 64-bit integer | -2^63 | 2^63 - 1
130+
boolean | boolean value | 0/false | 1/true
131+
float | floating point number | -3.4e -38 | 3.4e 38
132+
double | double precision floating point number | -1.7e -300 | 1.7e 300
133+
string | character string | n/a | n/a
134+
135+
> Min, max and default values defined in a Vehicle Signal Specification must be in the supported range of the data type.

‎vss/output/Vehicle/ADAS/CruiseControl/AdaptiveIntervalSet/_index.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: AdaptiveIntervalSet
3+
4+
date: 2026-03-08T08:02:55.622912
5+
no_list: true
6+
---
7+
8+
9+
| | |
10+
|---|---|
11+
| Full qualified VSS Path: | `Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet` |
12+
| Description: | Follow distance setting, commonly 1-5 with 1 being closest. |
13+
14+
## Navigation
15+
16+
```mermaid
17+
flowchart LR
18+
19+
20+
21+
Vehicle-->ADAS
22+
23+
ADAS-->CruiseControl
24+
25+
CruiseControl-->AdaptiveIntervalSet
26+
27+
```
28+
29+
## Eclipse Leda: Usage Example
30+
31+
In [Eclipse Kuksa.VAL Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) CLI:
32+
33+
34+
35+
```bash
36+
$ databroker-cli
37+
sdv.databroker.v1 > connect
38+
[connect] OK
39+
sdv.databroker.v1 > get Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet
40+
[get] OK
41+
Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet: ( NotAvailable )
42+
sdv.databroker.v1 > set Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet 0
43+
[set] OK
44+
```
45+
46+
## Digital Auto: Playground
47+
48+
[playground.digital.auto](http://digital.auto) provides an in-browser, rapid prototyping environment utilizing the COVESA APIs for connected vehicles.
49+
50+
| Vehicle Model | Direct link to Vehicle Signal |
51+
|---|---|
52+
| ACME Car (EV) v0.1 | [Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet](https://digitalauto.netlify.app/model/STLWzk1WyqVVLbfymb4f/cvi/list/Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet/) |
53+
54+
## Data Type & Unit
55+
56+
| | | |
57+
|---|---|---|
58+
| Path | `Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet` | [VSS: Addressing nodes](https://covesa.github.io/vehicle_signal_specification/rule_set/basics/) |
59+
| Data type | `uint8` | [VSS: Datatypes](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_types/) |
60+
61+
**Note:** The `uint8` datatype is an *unsigned 8-bit integer* which technically allows values between 0 and 255 (inclusive).
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
72+
73+
74+
75+
## Signal Information
76+
77+
The vehicle signal `Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet` is an **Actuator**.
78+
79+
80+
81+
82+
83+
The vehicle signal `Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet` is a **Signal**.
84+
85+
86+
87+
## UUID
88+
89+
Each vehicle signal is identified by a [Universally Unique Identifier (UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier))
90+
91+
The UUID for `Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet` is `abce234cbded57f4bfea3d859a5fb269`
92+
93+
94+
## Feedback
95+
96+
Do you think this Vehicle Signal specification needs enhancement? Do you want to discuss with experts? Try the following ressources to get in touch with the VSS community:
97+
98+
| | |
99+
|---|---|
100+
| Enhancement request | [Create COVESA GitHub Issue](https://github.com/COVESA/vehicle_signal_specification/issues/new?body=Please+describe+your+feedback&title=Signal+feedback+Vehicle.ADAS.CruiseControl.AdaptiveIntervalSet) |
101+
| Join COVESA | [www.covesa.global](https://www.covesa.global/join?src=sidebar) |
102+
| Discuss VSS on Slack | [w3cauto.slack.com](http://w3cauto.slack.com/) |
103+
| VSS Data Experts on Google Groups | [covesa.global data-expert-group](https://groups.google.com/a/covesa.global/g/data-expert-group) |
104+
105+
## About VSS
106+
107+
The [Vehicle Signal Specification](https://covesa.github.io/vehicle_signal_specification/) (VSS)
108+
is an initiative by COVESA to define a syntax and a catalog for vehicle signals.
109+
The source code and releases can be found in the [VSS github repository](https://github.com/COVESA/vehicle_signal_specification).
110+
111+
## Supported datatypes
112+
113+
The following is a list of VSS supported built-in datatypes:
114+
115+
Name | Type | Min | Max
116+
:----------|:---------------------------|:-----|:---
117+
uint8 | unsigned 8-bit integer | 0 | 255
118+
int8 | signed 8-bit integer | -128 | 127
119+
uint16 | unsigned 16-bit integer | 0 | 65535
120+
int16 | signed 16-bit integer | -32768 | 32767
121+
uint32 | unsigned 32-bit integer | 0 | 4294967295
122+
int32 | signed 32-bit integer | -2147483648 | 2147483647
123+
uint64 | unsigned 64-bit integer | 0 | 2^64 - 1
124+
int64 | signed 64-bit integer | -2^63 | 2^63 - 1
125+
boolean | boolean value | 0/false | 1/true
126+
float | floating point number | -3.4e -38 | 3.4e 38
127+
double | double precision floating point number | -1.7e -300 | 1.7e 300
128+
string | character string | n/a | n/a
129+
130+
> Min, max and default values defined in a Vehicle Signal Specification must be in the supported range of the data type.

‎vss/output/Vehicle/ADAS/CruiseControl/IsActive/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IsActive
33

4-
date: 2023-06-05T12:39:01.523300
4+
date: 2026-03-08T08:02:55.572146
55
no_list: true
66
---
77

0 commit comments

Comments
 (0)