Skip to content

Actuator

Source code in docs_src/capo_iotfleetwise/types/actuator.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class Actuator(TypedDict, closed=True):
    fully_qualified_name: "capo_iotfleetwise.types.string.string"
    """<p>The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be <code>Vehicle.Front.Left.Door.Lock</code>.</p>"""
    data_type: "capo_iotfleetwise.types.node_data_type.NodeDataType"
    """<p>The specified data type of the actuator. </p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>A brief description of the actuator.</p>"""
    unit: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>The scientific unit for the actuator.</p>"""
    allowed_values: NotRequired["capo_iotfleetwise.types.list_of_strings.listOfStrings"]
    """<p>A list of possible values an actuator can take.</p>"""
    min: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible minimum value of an actuator.</p>"""
    max: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible maximum value of an actuator.</p>"""
    assigned_value: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>A specified value for the actuator.</p>"""
    deprecation_message: NotRequired["capo_iotfleetwise.types.message.message"]
    """<p>The deprecation message for the node or the branch that was moved or deleted.</p>"""
    comment: NotRequired["capo_iotfleetwise.types.message.message"]
    """<p>A comment in addition to the description.</p>"""
    struct_fully_qualified_name: NotRequired[
        "capo_iotfleetwise.types.node_path.NodePath"
    ]
    """<p>The fully qualified name of the struct node for the actuator if the data type of the actuator is <code>Struct</code> or <code>StructArray</code>. For example, the struct fully qualified name of an actuator might be <code>Vehicle.Door.LockStruct</code>.</p>"""

allowed_values instance-attribute 

allowed_values: NotRequired[listOfStrings]

A list of possible values an actuator can take.

assigned_value instance-attribute 

assigned_value: NotRequired[string]

A specified value for the actuator.

comment instance-attribute 

comment: NotRequired[message]

A comment in addition to the description.

data_type instance-attribute 

data_type: NodeDataType

The specified data type of the actuator.

deprecation_message instance-attribute 

deprecation_message: NotRequired[message]

The deprecation message for the node or the branch that was moved or deleted.

description instance-attribute 

description: NotRequired[description]

A brief description of the actuator.

fully_qualified_name instance-attribute 

fully_qualified_name: string

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

max instance-attribute 

max: NotRequired[double]

The specified possible maximum value of an actuator.

min instance-attribute 

min: NotRequired[double]

The specified possible minimum value of an actuator.

struct_fully_qualified_name instance-attribute 

struct_fully_qualified_name: NotRequired[NodePath]

The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

unit instance-attribute 

unit: NotRequired[string]

The scientific unit for the actuator.