Skip to content

Commit

Permalink
Update sensor_actuator.md
Browse files Browse the repository at this point in the history
Add k/v pairs

identifier
featureOfInterest and property
elementType and definition
  • Loading branch information
alanmapleburl-au authored Nov 8, 2023
1 parent a238ec2 commit 97ca0f4
Showing 1 changed file with 32 additions and 10 deletions.
42 changes: 32 additions & 10 deletions docs-gen/content/rule_set/data_entry/sensor_actuator.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,64 @@ entry example is given below:
```YAML
Speed:
type: sensor
identifier: Vehicle.Speed
elementType: SignalDefinition
featureOfInterest: Vehicle
property: Speed
description: The vehicle speed.
definition: The rate of change in the vehicle position per unit of time
comment: For engine speed see Vehicle.Powertrain.CombustionEngine.Engine.Speed.
datatype: float
unit: km/h
min: 0
max: 300
```
**```Drivetrain.Transmission.Speed```**
**```Speed```**
Defines the dot-notated name of the data entry. Please note that
all parental branches included in the name must be defined as well.

**```type```**
Defines the type of the node. This can be `branch`,
`sensor`, `actuator` or `attribute`.
Defines the type of the node.

**```datatype```**
The string value of the type specifies the scalar type of the data entry
value. See [data type](/vehicle_signal_specification/rule_set/data_entry/data_types/) chapter for a list of available types.
**```identifier```** *[optional]*
A set of characters that uniquely identifies the signal. This is generally the branch and the property.

**```elementType```** *[optional]*
A type that classifies the attribute in regards to the Vehicle Signal domain
- ```SignalDefinition```: The entry defines a property of a feature of interest.

**```featureOfInterest```** *[optional]*
The identifier of the physical object whose properties can be observed and possibly manipulated by signals of this type

**```property```** *[optional]*
The identifier of the property being reported by signals of this type

**```description```**
Describes the meaning and content of the signal.
The `description`shall together with other mandatory members like `datatype` and `unit` provide sufficient information
to understand what the signal contains and how signal values shall be constructed or interpreted.
Recommended to start with a capital letter and end with a dot (`.`).


**```definition```*** *[optional]*
A formal specification that includes the necessary and sufficient conditions for distinguishing this signal definition from anything else. It is similar to a dictionary definition, and the conditions put forth can translate to formal axioms in an ontology and can be used for inferencing and automation.

**```comment ```** *[optional]* `since version 3.0`
A comment can be used to provide additional informal information on a signal.
This could include background information on the rationale for the signal design,
references to related signals, standards and similar.
Recommended to start with a capital letter and end with a dot (`.`).

**```datatype```**
The string value of the type specifies the scalar type of the data entry
value. See [data type](/vehicle_signal_specification/rule_set/data_entry/data_types/) chapter for a list of available types.

**```unit```** *[optional]*
The unit of measurement that the data entry has. See [Data Unit Types](/vehicle_signal_specification/rule_set/data_entry/data_unit_types/)
chapter for a list of available unit types. This
cannot be specified if ```allowed``` is defined as the signal type.

**```min```** *[optional]*
The minimum value, within the interval of the given ```type```, that the
data entry can be assigned.
Expand All @@ -58,7 +84,3 @@ data entry can be assigned.
If omitted, the maximum value will be the "Max" value for the given type.
Cannot be specified if ```allowed``` is defined for the same data entry.

**```unit```** *[optional]*
The unit of measurement that the data entry has. See [Data Unit Types](/vehicle_signal_specification/rule_set/data_entry/data_unit_types/)
chapter for a list of available unit types. This
cannot be specified if ```allowed``` is defined as the signal type.

0 comments on commit 97ca0f4

Please sign in to comment.