Wiki
Clone wikiKerbalSimpit / PluginConfiguration.md
Plugin Configuration
The plugin configuration file is GameData/KerbalSimpit/PluginData/Settings.cfg
.
It contains general plugin configuration, and one or more SerialPort nodes for
serial port configuration.
Plugin settings
Documentation
: This parameter is hard-coded by the plugin, and will revert to the internal default on every run. It's value is a URL for plugin configuration documentation. Congrats, you found it!Verbose
: Required, defaults to false. Set to True to log... quite a bit more info from the plugin. Very useful for debugging.RefreshRate
: Required, defaults to 80ms. A time interval, measured in milliseconds. Data providers that send updates on a regular basis will use this interval for sending them. (internally, the plugin uses a time sliceRefreshRate
milliseconds long, and evenly spaces providers through it)
Serial settings
A SerialPort node defines a serial connection. Each device needs its own SerialPort node to establish a connection with the plugin. All parameters in the SerialPort node are required.
SerialPort
{
PortName = COM1
BaudRate = 115200
}
- PortName: The name of the serial port. On Windows machines, the SerialPort
will be of the form
COMn
. For Linux and MacOS, the full path to the device file is required, for example/dev/ttyUSB0
or/dev/tty.usbmodem1411
. - BaudRate: The serial port baud rate. The device must be using the same rate
in its
Serial.begin()
call.
Updated