Definition - CANParamDefDoc
The CANParamDefinitionDoc document
is a definition document that contains the properties for a CAN parameter instance.
The CANParamDefinitionDocdocument
is referenced by the CANMessageDefinitionDoc document.
The CANParamDefinitionDoc 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. |
| paramDefDocId | String | No | - | The unique identifier (id) of the ParamDefinitionDoc document that holds the properties for the parameter associated with this CAN parameter. |
| startBit | 64-bit Long | No | - | A 64-bit Long value representing the start bit of the parameter in the parent message instance. |
| bitLength | 64-bit Long | No | - | A 64-bit Long value representing the length of the message in bytes. |
| dataType | Fixed String | No | Signed | A fixed string representing the CAN parameter data type. Valid options are: Signed, Unsigned, Float. |
| byteOrder | Fixed String | No | MSBFirst | A fixed string representing the CAN parameter byte ordering. Valid options are: MSBFirst, MSBLast. |
| type | Fixed String | Fixed | CANParamDefDoc | The fixed value is always set to CANParamDefDoc. |