Definition - CANSignalDefDoc
The CANSignalDefinitionDoc document
is a definition document that contains the properties for a unique CAN Signal instance.
The CANSignalDefinitionDoc 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 | CANSignalDefDoc | Type of the document, resolved from fixed document types. |
| name | String | Yes | - | A free form string representing the name of the signal. |
| startBit | UInt16 | No | - | A ushort value representing the start bit of the signal. |
| length | UInt16 | No | - | A ushort value representing the length of the signal. |
| byteOrder | Byte | No | - | A byte value representing the byte order of the signal. |
| valueType | Fixed String | No | Signed | A fixed type field that describes value type of the signal. Valid Options are: Signed, Unsigned, Float, Double, IEEEFloat, IEEEDouble |
| factor | Double | No | - | A double value representing the factor of the signal. |
| isInteger | Boolean | No | - | A boolean value indicating whether the signal is an integer. |
| offset | Double | No | - | A double value representing the offset of the signal. |
| minimum | Double | No | - | A double value representing the minimum value of the signal. |
| maximum | Double | No | - | A double value representing the maximum value of the signal. |
| unit | String | No | - | A fixed string value representing the unit of the signal. |
| receiver | String[] | No | - | An array of string representing the receivers of the signal. |
| valueTableMap | IReadOnlyDictionary`2 | No | - | An array of key/value pairs that represents the value table map of the signal. |
| comment | String | No | - | A string value representing the comment for the signal. |
| multiplexing | String | No | - | A string value representing the multiplexing information for the signal. |
| initialValue | Double | No | - | A double value representing the initial value of the signal. |