Definition - CANBufferDefDoc

The CANBufferDefinitionDoc document is a definition document that contains the properties for a CAN buffer instance.

The CANBufferDefinitionDoc document is referenced by the CANBusDefinitionDoc document and provides a container that hold associated CANMessageDefinitionDoc documents.

The CANBufferDefinitionDoc document does not contain a reference to the ConfigDoc document and therefore can be reused by multiple configurations and data sets.

Field Data Type Required Default Description
id String Yes - A unique identifier that is referenced by all other documents see section Unique Id Generation.
name String No - A free form string value to name the CAN buffer.
mode Fixed String No Unused A fixed string representing the CAN buffer mode type. Valid options are: Unused, Receive, Transmit, Reserved.
receiveMask String No - A free form string value of the receive bit mask applied on this CAN buffer.
dataRate 64-bit Long No - The data rate interval in nanoseconds of this CAN buffer.
canMessageDefDocs Array [CANMessageDefinitionDoc] No - An associated CANMessageDefinitionDoc document.
type Fixed String Fixed CANBufferDefDoc The fixed value is always set to CANBufferDefDoc.