Skip to content

Commit

Permalink
added info about config files
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-manuel committed Nov 19, 2023
1 parent 5cf356e commit 6296717
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/docs/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ sidebar_position: 3
See [this page](../general/install#how-to-change-the-default-limits).


## What is the `config.ini` and `config.default.ini`?

The `config.ini` is a file where you can specify your own configuration changes. Like when you want to change default values, e.g. increase the charge and discharge limits. Lookup the `config.default.ini` to see which settings are available. This file is preserved after a version update.

The `config.default.ini` is a file where all possible configuration settings are stored with their default values. Every setting is also well documented in order to understand what the setting does. This file is overwritten after a version update.

* Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini` of the `master` branch, which is the latest stable version.
* Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini` of the `dev` branch, which is the most up to date version containing new fixes and features.


## How to edit `utils.py` or `config.ini`
See [this page](../general/install#how-to-edit-utilspy-or-configini).

Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"version": "0.0.0",
"version": "0.0.1",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down

0 comments on commit 6296717

Please sign in to comment.