Skip to content

Sensor

Source code in docs_src/capo_iotfleetwise/types/sensor.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Sensor(TypedDict, closed=True):
    fully_qualified_name: "capo_iotfleetwise.types.string.string"
    """<p>The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be <code>Vehicle.Body.Engine.Battery</code>.</p>"""
    data_type: "capo_iotfleetwise.types.node_data_type.NodeDataType"
    """<p>The specified data type of the sensor. </p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>A brief description of a sensor.</p>"""
    unit: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>The scientific unit of measurement for data collected by the sensor.</p>"""
    allowed_values: NotRequired["capo_iotfleetwise.types.list_of_strings.listOfStrings"]
    """<p>A list of possible values a sensor can take.</p>"""
    min: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible minimum value of the sensor.</p>"""
    max: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible maximum value of the sensor.</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 a sensor if the data type of the actuator is <code>Struct</code> or <code>StructArray</code>. For example, the struct fully qualified name of a sensor might be <code>Vehicle.ADAS.CameraStruct</code>.</p>"""

allowed_values instance-attribute 

allowed_values: NotRequired[listOfStrings]

A list of possible values a sensor can take.

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 sensor.

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 a sensor.

fully_qualified_name instance-attribute 

fully_qualified_name: string

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

max instance-attribute 

max: NotRequired[double]

The specified possible maximum value of the sensor.

min instance-attribute 

min: NotRequired[double]

The specified possible minimum value of the sensor.

struct_fully_qualified_name instance-attribute 

struct_fully_qualified_name: NotRequired[NodePath]

The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

unit instance-attribute 

unit: NotRequired[string]

The scientific unit of measurement for data collected by the sensor.