Actuator
A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
Note
Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
Contents
- dataType
-
The specified data type of the actuator.
Type: String
Valid Values:
INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN | STRUCT | STRUCT_ARRAYRequired: Yes
- fullyQualifiedName
-
The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be
Vehicle.Front.Left.Door.Lock.Type: String
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: Yes
- allowedValues
-
A list of possible values an actuator can take.
Type: Array of strings
Required: No
- assignedValue
-
This member has been deprecated.
A specified value for the actuator.
Type: String
Required: No
- comment
-
A comment in addition to the description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- deprecationMessage
-
The deprecation message for the node or the branch that was moved or deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- description
-
A brief description of the actuator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- max
-
The specified possible maximum value of an actuator.
Type: Double
Required: No
- min
-
The specified possible minimum value of an actuator.
Type: Double
Required: No
- structFullyQualifiedName
-
The fully qualified name of the struct node for the actuator if the data type of the actuator is
StructorStructArray. For example, the struct fully qualified name of an actuator might beVehicle.Door.LockStruct.Type: String
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
- unit
-
The scientific unit for the actuator.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
