@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
178 lines (89 loc) • 3.21 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / MessageLoggerSettings
Interface: MessageLoggerSettings
A message for defining a message logger's settings.
# Properties
## autoRestartAfterStop
**autoRestartAfterStop**: `boolean`
A flag indicating if the logger should auto-restart after stop. Default value is false
***
## canMessageFilter
**canMessageFilter**: [`CanMessageFilterSettings`](CanMessageFilterSettings.md) \| `undefined`
Any filter
***
## colSeparator?
`optional` **colSeparator**: [`Separator`](../enumerations/Separator.md)
The column separator to be used. Default value is a comma (,)
***
## dataBytesConverterLimit?
`optional` **dataBytesConverterLimit**: `number`
Number of data bytes to max write to the log file (1-64). Default value is 8
***
## decimalSeparator?
`optional` **decimalSeparator**: [`DecimalChar`](../enumerations/DecimalChar.md)
The decimal separator to be used. Default value is a dot (.)
***
## fileConflictAction
**fileConflictAction**: [`FileConflictAction`](../enumerations/FileConflictAction.md)
Name conflict action
***
## fileFormat
**fileFormat**: [`LogFileFormat`](../enumerations/LogFileFormat.md)
The file format to be used
***
## fileName
**fileName**: `string`
Name of the file to log messages to
***
## numberOfTimeDecimals?
`optional` **numberOfTimeDecimals**: `number`
Number of time decimals (0-9). Default value is 9
***
## sizeLimit?
`optional` **sizeLimit**: `number`
Max file size in megabytes before writing to a new file
***
## startTriggerSettings
**startTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
Any start triggers
***
## startTriggersOperator
**startTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
The trigger operator to be used between start triggers
***
## stopTriggerSettings
**stopTriggerSettings**: [`TriggerSettings`](TriggerSettings.md)[]
Any stop triggers
***
## stopTriggersOperator
**stopTriggersOperator**: [`TriggerOperator`](../enumerations/TriggerOperator.md)
The trigger operator to be used between stop triggers
***
## timeLimit?
`optional` **timeLimit**: `number`
Max number of seconds between first and last event before writing to a new file
***
## timeReference?
`optional` **timeReference**: [`TimeReference`](../enumerations/TimeReference.md)
Use the specified time reference. Default value is FIRST_TRIGGER
***
## useCalendarTime?
`optional` **useCalendarTime**: `boolean`
Write timestamps in calendar time instead of seconds. Default value is false
***
## useUtcTime?
`optional` **useUtcTime**: `boolean`
Use UTC instead of local time for absolute timestamps. Default value is true
***
## writeDataInHex?
`optional` **writeDataInHex**: `boolean`
Write data in hexadecimal format. Default value is true
***
## writeFileHeader?
`optional` **writeFileHeader**: `boolean`
Write file header. Default value is true
***
## writeIdInHex?
`optional` **writeIdInHex**: `boolean`
Write ID in hexadecimal format. Default value is true