Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct unit documentation #597

Merged
merged 1 commit into from
May 8, 2023
Merged

Correct unit documentation #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs-gen/content/rule_set/data_entry/data_unit_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,9 @@ ratio | Relation | Relation measured as ratio
percent | Relation | Relation measured in percent
... | ... | ...

VSS tooling use the list specified in [config.yaml](https://github.com/COVESA/vss-tools/blob/master/vspec/config.yaml) to validate that only supported types are used in the signal specification.
[VSS-Tools](https://github.com/COVESA/vss-tools) require that a unit file is available when transforming *.vspec files.
It can be specified by the `-u` parameter, and if not given the tools will search for a file `units.yaml`
in the same directory as the root *.vspec file.

The VSS standard catalog is based on [units.yaml](https://github.com/COVESA/vehicle_signal_specification/blob/master/spec/units.yaml),
i.e. only units from that file can be used.
4 changes: 1 addition & 3 deletions spec/units.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# This file defines units supported in the VSS catalog
# It has precedence over the file defined in https://github.com/COVESA/vss-tools/blob/master/vspec/config.yaml
# This file must be specified with the -u parameter when using vss-tools
# This file defines units supported in the VSS standard catalog
units:
mm:
label: millimeter
Expand Down