CanSignal ¶

class CanSignal(TypedDict, closed=True):
    message_id: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>The ID of the message.</p>"""
    is_big_endian: "bool"
    """<p>Whether the byte ordering of a CAN message is big-endian.</p>"""
    is_signed: "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.</p>"""
    start_bit: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).</p> <p>This value might be different from the value in a DBC file. For little endian signals, <code>startBit</code> is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the <code>startBit</code>.</p>"""
    offset: "capo_iotfleetwise.types.double.double"
    """<p>The offset used to calculate the signal value. Combined with factor, the calculation is <code>value = raw_value * factor + offset</code>.</p>"""
    factor: "capo_iotfleetwise.types.double.double"
    """<p>A multiplier used to decode the CAN message.</p>"""
    length: "capo_iotfleetwise.types.non_negative_integer.nonNegativeInteger"
    """<p>How many bytes of data are in the message.</p>"""
    name: NotRequired["capo_iotfleetwise.types.can_signal_name.CanSignalName"]
    """<p>The name of the signal.</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>"""