Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Alvarez-Coello <[email protected]>
  • Loading branch information
erikbosch and jdacoello authored Jan 23, 2025
1 parent 8c40e30 commit 451ae24
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions docs-gen/content/rule_set/data_entry/sensor_actuator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,18 @@ weight: 30

# Property Types Overview

Sensors are properties that from a VSS-perspective are read-only. Values of sensors typically change over time.
Reading a sensor shall return the actual value of the related property, e.g. the current speed or the current position of the seat.

Actuators in VSS can be used to represent both the actual value and the desired value of a property.
Some properties like position of a seat or a window in a vehicle cannot change instantly, which means that current and actual value may differ.
## `sensor` type
Sensors are properties that, from a VSS-perspective, are read-only.
The values of a `sensor` property typically change over time and within an ignition cycle (i.e., a driving journey).
Reading a `sensor` shall return the actual value of the related property (e.g., the current speed or the current position of the seat).

## `actuator` type
Similarly, actuators are properties that, from a VSS-perspective, can be read and written.
Actuators in VSS can be used to represent both the actual value (i.e., read) and the desired value of a property (i.e., write).
The value written to a property that involves a slow mechanical action or certain motion might not be immediately reflected in a read operation if the property value is read immediately after a write operation.
Some properties like `Window.Position` or `Seat.Position` are clear examples of things that might not change instantly.
Hence, the written value (i.e., the desired target) and actual value may differ.
Unless otherwise specified it is assumed that APIs implementing access to VSS data shall return actual value for read/subscribe-operations,
and update the desired value for write-operations.

Expand All @@ -19,10 +26,14 @@ If the actuator is read directly after the set request it will still return 0 as
If the seat by some reason is blocked or cannot be moved due to safety reasons it might never reach the wanted position.
It is up to the vehicle to decide how long time it shall try to reach the desired value and what to do if it needs to give up.

Attributes are signals that have a default value, specified by
its ```default``` member.
## `attribute` type
Attributes are properties whose values do not change within an ignition cycle (i.e., a driving journey).
In other words, characteristics that are often static.
For example, the color and model of a car.
The standard Vehicle Signal Specification catalog does not include default values for all attributes.
If a default value has not been specified then the OEM must define a default value matching the actual vehicle.
If a default value has not been specified, then the user of the specification must define the associated value matching the actual vehicle.
For example, the specification might have the attribute `Brand` without a default value associated.
Then, the user of the specification is responsible to assign `Some example brand` as the value for that attribute.
If the standard defines a default value but it does not fit the actual vehicle,
then the OEM must override the standard default value.

Expand Down

0 comments on commit 451ae24

Please sign in to comment.