@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
142 lines (71 loc) • 1.89 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / SignalDefinition
Interface: SignalDefinition
A message that holds information about a signal.
# Properties
## comment
**comment**: `string`
A comment for the signal.
***
## dataType
**dataType**: [`SignalType`](../enumerations/SignalType.md)
The data type of the signal.
***
## encoding
**encoding**: [`SignalEncoding`](../enumerations/SignalEncoding.md)
The encoding of the signal.
***
## enumValues
**enumValues**: `object`
The enumeration values for the signal, if it is an enumerated type.
### Index Signature
\[`key`: `number`\]: `string`
***
## factor
**factor**: `number`
The scaling factor for the signal.
***
## isMultiplexed
**isMultiplexed**: `boolean`
Whether the signal is multiplexed within a message.
***
## isMultiplexer
**isMultiplexer**: `boolean`
Whether the signal is the multiplexer signal within a message.
***
## length
**length**: `number`
The length of the signal in bits.
***
## maxValue
**maxValue**: `number`
The maximum value of the signal.
***
## minValue
**minValue**: `number`
The minimum value of the signal.
***
## multiplexValue?
`optional` **multiplexValue**: `number`
The multiplex value for the signal, if it is multiplexed.
***
## name
**name**: `string`
The name of the signal.
***
## offset
**offset**: `number`
The offset for the signal.
***
## qualifiedName
**qualifiedName**: `string`
The qualified name of the signal. This includes the database name and the message name as a prefix and it can be used to uniquely identify the signal.
***
## startbit
**startbit**: `number`
The start bit of the signal within the message.
***
## unit
**unit**: `string`
The unit of the signal.