CANRxMessage

Type: CANRxMessage

Script class for CAN Rx (receive) message slot (obtain via ecu.canRxSetup.getChannel(n).getMessage(x)).

Properties

PropertyDescription
idMaskRaw Get/Set the 'raw' CAN ID mask of the message. For extended IDs, bitwise OR the ID with 0x80000000.
idRaw Get/Set the 'raw' CAN ID of the message. For extended IDs, bitwise OR the ID with 0x80000000.
index Get the index of this message within the list of messages for the channel.
isExtended Get/Set the 'extended' flag of the message. If true, the ID is an extended ID (29 bits), otherwise it is a standard ID (11 bits).
isExtendedMask Get/Set the 'extended mask' flag of the message. If true, the ID mask is an extended mask (29 bits), otherwise it is a standard mask (11 bits).
isUnused Returns true if the message is unused, i.e. any of the received data slot channels are not referenced by any ECU options.
isUsed Returns true if the message is used, i.e. any of the received data slot channels are referenced by any ECU options.
slotCount Get the number of slots in the message, typically 16-bit per channel - see slotSize.
slotSize Get the size of each slot in the message, in bytes. Typically 2 bytes per slot (16-bits).
usedByRevision Get the revision number of the 'used by' state, useful; for lazy evaluation where it may be expensive to traverse the 'used by' list on all unrelated calibration changes.

Methods

MethodDescription
getSlotChannel(index) Get the channel (of type EcuChannel) for the given slot index (0-based). Returns null if no channel is assigned.
getSlotUsedBy(index) Get the list of ECU options that use the given slot index (0-based) in this message. Returns an empty array if no options use the slot.
getUsedBy() Get the list of ECU options that reference any slots within this message. Returns an empty array if no options use the message.