ObdSignal ¶

class ObdSignal(TypedDict, closed=True):
    pid_response_length: "capo_iotfleetwise.types.positive_integer.positiveInteger"
    """<p>The length of the requested data.</p>"""
    service_mode: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>The mode of operation (diagnostic service) in a message.</p>"""
    pid: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>The diagnostic code used to request data from a vehicle for this signal.</p>"""
    scaling: "capo_iotfleetwise.types.double.double"
    """<p>A multiplier used to decode the message.</p>"""
    offset: "capo_iotfleetwise.types.double.double"
    """<p>The offset used to calculate the signal value. Combined with scaling, the calculation is <code>value = raw_value * scaling + offset</code>.</p>"""
    start_byte: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>Indicates the beginning of the message.</p>"""
    byte_length: "capo_iotfleetwise.types.obd_byte_length.ObdByteLength"
    """<p>The length of a message.</p>"""
    bit_right_shift: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>The number of positions to shift bits in the message.</p>"""
    bit_mask_length: NotRequired[
        "capo_iotfleetwise.types.obd_bitmask_length.ObdBitmaskLength"
    ]
    """<p>The number of bits to mask in a message.</p>"""
    is_signed: NotRequired["bool"]
    """<p>Determines whether the message is signed (<code>true</code>) or not (<code>false</code>). If it's signed, the message can represent both positive and negative numbers. The <code>isSigned</code> parameter only applies to the <code>INTEGER</code> raw signal type, and it doesn't affect the <code>FLOATING_POINT</code> raw signal type. The default value is <code>false</code>.</p>"""
    signal_value_type: NotRequired[
        "capo_iotfleetwise.types.signal_value_type.SignalValueType"
    ]
    """<p>The value type of the signal. The default value is <code>INTEGER</code>.</p>"""