@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
146 lines (73 loc) • 2.27 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / PeriodicTransmissionSettings
Interface: PeriodicTransmissionSettings
A message defining a periodic transmission setup.
# Properties
## channelIdentifier
**channelIdentifier**: `string`
The channel to be used
***
## constantBurstSize
**constantBurstSize**: `number`
Constant burst size that is used if random_burst_size is false
***
## constantIntervalMs
**constantIntervalMs**: `number`
Constant interval in milliseconds that is used if random_interval is false
***
## frame
**frame**: [`WriteFrame`](WriteFrame.md) \| `undefined`
The message frame to be sent out
***
## identifierMax
**identifierMax**: `number`
Random/Scan max identifier
***
## identifierMin
**identifierMin**: `number`
Random/Scan min identifier
***
## numberOfMessages
**numberOfMessages**: `number`
Number of messages to send out, if set to 0 then messages will be sent out continuously until stop is called
***
## randomBurstSize
**randomBurstSize**: `boolean`
Send out with random or constant burst size
***
## randomBurstSizeMax
**randomBurstSizeMax**: `number`
Random max burst size that is used if random_burst_size is true
***
## randomBurstSizeMin
**randomBurstSizeMin**: `number`
Random min burst size that is used if random_burst_size is true
***
## randomDataLength
**randomDataLength**: `boolean`
Randomize the messages' data length
***
## randomIdentifier
**randomIdentifier**: `boolean`
Send out with random identifier, ignored if scan_identifier is set
***
## randomInterval
**randomInterval**: `boolean`
Send out with random or constant interval
***
## randomIntervalMaxMs
**randomIntervalMaxMs**: `number`
Random max interval in milliseconds that is used if random_interval is true
***
## randomIntervalMinMs
**randomIntervalMinMs**: `number`
Random min interval in milliseconds that is used if random_interval is true
***
## randomMessageData
**randomMessageData**: `boolean`
Randomize the messages' data
***
## scanIdentifier
**scanIdentifier**: `boolean`
Send out with identifier set from min to max