diff --git a/Configuration.md b/Configuration.md new file mode 100644 index 0000000..457cb88 --- /dev/null +++ b/Configuration.md @@ -0,0 +1,33 @@ +BiogasControllerApp has a few configuration options. You can change them by changing the config.ini file in the same folder you can find the main python script and executable. + +There are four different categories of configuration options, order by importance. + +The config is validated before startup and any misconfiguration will not stop the app from starting, as all options are validated on startup and invalid options are ignored and defaults are used for them. If `[Dev] verbose` is set to `True`, then a list of all config errors is printed during startup. + + +# Connection +These options concern themselves with the connection that is established to the microcontroller. +They are: +- `port_override` where you can set a specific COM port (on Windows) or a file-path (on Linux) and defaults to `None` +- `baudrate` The baudrate at which the controller communicates. Has to be an integer and defaults to `19200` +- `filters` The device filter used during comport assignment. If you are using this with another adapter cable than the prolific ones, you will need to update this list, but due to the `USB-Serial Controller` item in the list, it will likely also be found. + +# UI +Since the 3.1.0 update for BiogasControllerApp, this section has quite a few options. +They are: +- `height` the default height of the window when it opens. Has to be an integer and defaults to `600` +- `width` the default width of the window when it opens. Has to be an integer and defaults to `800` +- `theme` Whether to use `Dark` or `Light` mode. Defaults to `Dark` +- `primary_color` The UI's primary color, Material Colors are extracted from that. Defaults to `Green` +- `primary_color` The UI's accent color, Material Colors are extracted from that. Defaults to `Lime` + + +# Dev +These settings should only be interesting to you if you plan to do some changes to BiogasControllerApp or if you have run into an issue. +They are: +- `verbose` Whether to show debug output in the console. Has to be a boolean and defaults to `False` +- `use_test_library` Whether to use the test library. This library will allow you to use BiogasControllerApp as if you are connected to a controller without actually being connected and thus is essentially a simulator. Has to be a boolean and defaults to `False` +- `fail_sim` One out how many (your number + 1) times the connection should fail when simulating (only in effect when `use_test_library` is `True`. Has to be an integer and defaults to `20`. + +# Tariffs +These settings are just for fun and are highly recommended *not* to use. Will make your imports slower. The rates are in percent, so value `50` there is 50% \ No newline at end of file