Debugging a COMx Driver
- Last UpdatedFeb 06, 2024
- 1 minute read
A COMx driver is the board driver typically used for serial communications. COMx driver events are logged in the following file:
syslog.IOServer.<Cluster name>.<IO Server name>.dat
This file is located in the directory specified by the [CtEdit]Logs parameter in the citect.ini file.
The COMx driver can log different combinations of trace levels. This is achieved by setting the following Citect.ini parameters:
|
[COMx] Parameter |
Description |
Allowable Values |
Default Value |
|
DebugLevel |
The trace level used for the log file. |
Any combination of the following, separated by a pipe character (|): ERROR For example, ERROR | TRACE. |
- |
|
DebugCategory |
The categories used for the log. |
The COMx driver supports one category: PROT = protocol level debug |
- |
The log file size and log file rollover process is controlled by the [Debug]SysLogSize and [Debug]SysLogArchive ini parameters.
When the log file reaches a specified size (100000 kilobytes by default), it may be rolled over into a timestamped file when [Debug]SysLogArchive is set to 1, otherwise it will be overwritten.
Note: The more detailed the logging, the larger the amount of log data that will be generated.
This could create a large, cumbersome log file, or cause multiple wraparounds that
write over data. Also when the number of pending messages to process exceeds the value
set by the [Kernel]ErrorBuffers parameter, these messages are no longer logged. Messages not logged can be monitored
in the General Kernel Window under the item "Lost Errors". It is recommended to use
the following DebugLevel and DebugCategory settings:
[COMx]DebugLevel=ERROR|WARN|TRACE
[COMx]DebugCategory=PROT