Skip to content

Commit 8831cf7

Browse files
committed
Update overlay example and tool dependency
Signed-off-by: Erik Jaegervall <[email protected]>
1 parent 8689187 commit 8831cf7

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,13 @@ What to do if you as of today use signals from the OBD file:
228228
* If you really need the signals in this file and cannot replace them, then consider using the overlay file in the
229229
`overlays` directory from VSS 6.0 onwards.
230230

231+
### Update tool dependency
232+
233+
#### Overlay Support
234+
235+
VSS-tools support for overlays have been improved. It is now in many cases not necessary to specify
236+
`type`and `datatype` for items in the overlay if you are changing an existing item.
237+
231238
## Planned Changes VSS 6.0
232239

233240
### OBD Branch removed

docs-gen/content/rule_set/overlay.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,28 @@ Vehicle.Cabin.Door.IsOpen:
9292
```
9393
*File: overlay_2.vspec*
9494

95+
### Node content in Overlays
96+
97+
If you are adding a node you need to specify all attributes required for that node type.
98+
If you are changing an existing node you typically only need to specify name and what is changed,
99+
like in the `Vehicle.Speed` example below.
100+
Vss-tools will then look up the node name and reuse existing definitions.
101+
An exception is if you are changing a node for a particular instance.
102+
In that case you need to give `type`and `datatype`even if they are not changed,
103+
as the lookup mechanism currently cannot extract them from the existing definition.
104+
105+
```YAML
106+
# Type and Datatype not needed
107+
Vehicle.Speed:
108+
unit: m/s
109+
110+
# Type and Datatype not needed as overlay affects a particular instance
111+
Vehicle.Occupant.Row1.DriverSide.HeadPosition.Yaw:
112+
type: sensor
113+
datatype: float
114+
unit: mm
115+
```
116+
95117
### Overlays in the standard catalog
96118
97119
With the feature of overlays, we introduced a new folder in the

vss-tools

Submodule vss-tools updated 105 files

0 commit comments

Comments
 (0)