Definition - CANMessageDefDoc
The CANMessageDefDoc document
is a definition document that contains the properties for a unique can message definition instance.
The CANMessageDefDoc 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 | - | Regno unique document identifier. |
| type | Fixed String | No | CANMessageDefDoc | Type of the document, resolved from fixed document types. |
| messageId | String | Yes | - | A string value representing the ID of the CAN message. |
| isExtID | Boolean | No | - | A boolean value indicating whether the ID is an extended ID. |
| name | String | Yes | - | A string value representing the name of the CAN message. |
| dLC | UInt16 | No | - | A short value representing the data length code (DLC) of the CAN message. |
| transmitter | String | No | - | A string representing the transmitter of the CAN message. |
| comment | String | No | - | A string representing the comment for the CAN message. |
| paramDefDocIds | String[] | Yes | - | An array of the ParamDefDocIds associated with the CAN message. |