From ffef664a6247e1c1ea50f47c19a5baeec5da77e0 Mon Sep 17 00:00:00 2001 From: Erik Jaegervall Date: Thu, 13 Jun 2024 09:49:15 +0200 Subject: [PATCH] Update overlay example and tool dependency Signed-off-by: Erik Jaegervall --- CHANGELOG.md | 7 +++++++ docs-gen/content/rule_set/overlay.md | 22 ++++++++++++++++++++++ vss-tools | 2 +- 3 files changed, 30 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 634c578bf..2122ab6ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -228,6 +228,13 @@ What to do if you as of today use signals from the OBD file: * If you really need the signals in this file and cannot replace them, then consider using the overlay file in the `overlays` directory from VSS 6.0 onwards. +### Update tool dependency + +#### Overlay Support + +VSS-tools support for overlays have been improved. It is now in many cases not necessary to specify +`type`and `datatype` for items in the overlay if you are changing an existing item. + ## Planned Changes VSS 6.0 ### OBD Branch removed diff --git a/docs-gen/content/rule_set/overlay.md b/docs-gen/content/rule_set/overlay.md index de598ea65..ad59ba954 100644 --- a/docs-gen/content/rule_set/overlay.md +++ b/docs-gen/content/rule_set/overlay.md @@ -92,6 +92,28 @@ Vehicle.Cabin.Door.IsOpen: ``` *File: overlay_2.vspec* +### Node content in Overlays + +If you are adding a node you need to specify all attributes required for that node type. +If you are changing an existing node you typically only need to specify name and what is changed, +like in the `Vehicle.Speed` example below. +Vss-tools will then look up the node name and reuse existing definitions. +An exception is if you are changing a node for a particular instance. +In that case you need to give `type`and `datatype`even if they are not changed, +as the lookup mechanism currently cannot extract them from the existing definition. + +```YAML +# Type and Datatype not needed +Vehicle.Speed: + unit: m/s + +# Type and Datatype not needed as overlay affects a particular instance +Vehicle.Occupant.Row1.DriverSide.HeadPosition.Yaw: + type: sensor + datatype: float + unit: mm +``` + ### Overlays in the standard catalog With the feature of overlays, we introduced a new folder in the diff --git a/vss-tools b/vss-tools index e054dbd25..39be8c3dc 160000 --- a/vss-tools +++ b/vss-tools @@ -1 +1 @@ -Subproject commit e054dbd2561ffc104b38d7510b8c8e6605ba9162 +Subproject commit 39be8c3dc3bf60a4ae02756dba7468b2b48b654d