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.

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

Clarify VSS expectations on read/write #796

Merged
merged 4 commits into from
Jan 29, 2025
Merged

Conversation

erikbosch
Copy link
Collaborator

I ended up in a discussion of what "doing a read" in VSS means. In short, as of today that we say that a read returns actual value. This PR suggests to change the wording somewhat, so that a read unless otherwise specified shall return the actual value.

I.e. it is not forbidden by VSS (project) for implementations to have a read-function that returns the desired value instead, but then that must be clearly specified in the corresponding implementation specification.

This shall not impact VISS/VISSR.

I ended up in a discussion of what "doing a read" in VSS means.
In short, as of today that we say that a read returns actual value.
This PR suggests to change the wording somewhat, so that a read unless otherwise specified
shall return the actual value.

I.e. it is not forbidden by VSS (project) to have a read-function that returns the desired value instead,
but then that must be clearly specified in the corresponding implementation specification.

Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
Copy link
Collaborator

@SebastianSchildt SebastianSchildt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good to me. It is not "strictly" VSS (i.e. a user might doe "whatever" or in a Non-API system this does not even apply), but there where words to this effect before and maybe now it is more clear what the best - or at least common - practice is.

It is also not contradicting what VISS or KUKSA is doing, just to name two "VSS users" I am aware off.

@erikbosch
Copy link
Collaborator Author

MoM:

  • Please review
  • Daniel will review, possibly suggest improvements

Copy link
Contributor

@jdacoello jdacoello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some changes were suggested. Please check them out.

As a side note: VSS specifies the properties (e.g., Speed) and not the actual sensors or actuarors (e.g., speedometer). From that point of view, I agree that it is all about reading and/or writing the associated value of that property. Defining the type as one of sensor, actuator, or attribute is simply a flag that is hopefully considered by whoever implements the interface. We should consider changing the names of this flags at some point to something that is more data-oriented.

docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
docs-gen/content/rule_set/data_entry/sensor_actuator.md Outdated Show resolved Hide resolved
erikbosch and others added 3 commits January 23, 2025 14:07
Co-authored-by: Daniel Alvarez-Coello <8550265+jdacoello@users.noreply.github.com>
Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
@erikbosch
Copy link
Collaborator Author

Failing DCO check is due to accepting changes in UI, will be fixed by squashing when merging

@erikbosch
Copy link
Collaborator Author

MoM: Merge

@erikbosch erikbosch merged commit 42f8cb8 into COVESA:master Jan 29, 2025
4 of 5 checks passed
@erikbosch erikbosch deleted the erik_doc branch January 29, 2025 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants