Changes and updates

docs/docs/faq/index.md

@@ -16,8 +16,7 @@ The `config.ini` is a file where you can specify your own configuration changes.
 
 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.
+Click [here](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini) to see the `config.default.ini`.
 
 ## How to edit `utils.py` or `config.ini`
 

docs/docs/general/install.md

@@ -72,7 +72,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
 
 [![dbus-serialbattery install](https://img.youtube.com/vi/Juht6XGLcu0/0.jpg)](https://www.youtube.com/watch?v=Juht6XGLcu0)
 
-### Install automatically with USB/SD card
+### Install or update automatically with USB/SD card
 
 > It might be, that this doesn't work on older CerboGX devices. In this case use SSH option instead.
 
@@ -87,7 +87,7 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
 1. Reboot the GX (in the Remote Console go to `Settings` → `General` → `Reboot?`).
 
 
-### Install over SSH
+### Install or update over SSH
 
 > Require [root access](https://www.victronenergy.com/live/ccgx:root_access#root_access)
 
@@ -103,56 +103,54 @@ In [VRM](https://vrm.victronenergy.com/) look under the device list for your ins
 
 1. You can now choose which version you want to install:
 
-   1. [latest release](#latest-release)
-      Stable version, tested for over a week.
+   1. [Latest release](#latest-release)
+      Stable version, tested for more then a week.
 
-   1. [beta release](#beta-release)
-      Beta version, tested for over 72 hours.
+   1. [Beta release](#beta-release)
+      Beta version, no errors after 72 h runtime, long time testing needed.
 
-   1. [dev build](#dev-build)
-      Development/Nightly version, tested for a few hours.
+   1. [Nightly build](#nightly-build)
+      Nightly version, newest features and fixes, bugs possible.
 
-   1. [specific version](#specific-versiontroubleshooting-option)
+   1. [Specific version](#specific-versiontroubleshooting-option)
 
-   1. [local tar file](#local-tar-file)
+   1. [Local tar file](#local-tar-file)
 
 #### Latest release
 
-Stable version, tested for over a week.
+Stable version, tested for more then a week.
 
-Run the [install script](#install-over-ssh) and select `1` or `2`.
+Run the [install script](#install-or-update-over-ssh) and select `1` or `2`.
 
 💡 Reboot the system after the installation finished with `reboot`.
 
 #### Beta release
 
-Beta version, tested for over 72 hours.
+Beta version, no errors after 72 h runtime, long time testing needed.
 
-Run the [install script](#install-over-ssh) and select `3` or `4`.
+Run the [install script](#install-or-update-over-ssh) and select `3` or `4`.
 
 💡 Reboot the system after the installation finished with `reboot`.
 
-#### Dev build
+#### Nightly build
 
-Development/Nightly version, tested for a few hours. Issues might arise. Please keep your system monitored.
+Nightly version, newest features and fixes, bugs possible. Please keep your system monitored.
 
 > Not recommended in production environment, unless you know what you do. Testers are very welcome!
 
-Run the [install script](#install-over-ssh) and select `5` or `6`.
-
-💡 Reboot the system after the installation finished with `reboot`.
+Run the [install script](#install-or-update-over-ssh) and select `5` or `6`.
 
 💡 Reboot the system after the installation finished with `reboot`.
 
 #### Specific version/troubleshooting option
 
-Run the [install script](#install-over-ssh) and select `7`. Go to [releases](https://github.com/Louisvdw/dbus-serialbattery/releases) or [releases](https://github.com/mr-manuel/venus-os_dbus-serialbattery/releases) and copy the link to the `venus-data.tar.gz` version you like to install. Paste the link with a right click and press enter.
+Run the [install script](#install-or-update-over-ssh) and select `7`. Go to [releases](https://github.com/Louisvdw/dbus-serialbattery/releases) or [releases](https://github.com/mr-manuel/venus-os_dbus-serialbattery/releases) and copy the link to the `venus-data.tar.gz` version you like to install. Paste the link with a right click and press enter.
 
 💡 Reboot the system after the installation finished with `reboot`.
 
 #### Local tar file
 
-Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/uploading it. Run the [install script](#install-over-ssh) and select `8`.
+Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/uploading it. Run the [install script](#install-or-update-over-ssh) and select `8`.
 
 💡 Reboot the system after the installation finished with `reboot`.
 

docs/docs/general/supported-bms.md

@@ -64,18 +64,18 @@ You can view the current [BMS requests](https://github.com/Louisvdw/dbus-serialb
 There are two possibilities to add a new BMS.
 
 ### Add by opening a pull request
-Fork the repository and use the [`battery_template.py`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/etc/dbus-serialbattery/bms/battery_template.py) as template to add a new battery. As soon as the BMS works you can open a pull request (PR) to merge it. Please use the `dev` branch for adding your BMS/feature and opening the PR.
+Fork the repository and use the [`battery_template.py`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/bms/battery_template.py) as template to add a new battery. As soon as the BMS works you can open a pull request (PR) to merge it.
 
 Here is a short checklist that should help you:
 
-  - [ ] Add your battery class and battery class import in alphabetical order in the [`etc/dbus-serialbattery/dbus-serialbattery.py`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/etc/dbus-serialbattery/dbus-serialbattery.py)
-  - [ ] Add your BMS to the [BMS feature comparison](../general/features#bms-feature-comparison) page by editing [`docs/docs/general/features.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/docs/docs/general/features.md)
-  - [ ] Add your BMS to the [Supported BMS](../general/supported-bms) page by editing [`docs/docs/general/supported-bms.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/docs/docs/general/supported-bms.md)
+  - [ ] Add your battery class and battery class import in alphabetical order in the [`etc/dbus-serialbattery/dbus-serialbattery.py`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/dbus-serialbattery.py)
+  - [ ] Add your BMS to the [BMS feature comparison](../general/features#bms-feature-comparison) page by editing [`docs/docs/general/features.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/docs/docs/general/features.md)
+  - [ ] Add your BMS to the [Supported BMS](../general/supported-bms) page by editing [`docs/docs/general/supported-bms.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/docs/docs/general/supported-bms.md)
   - [ ] Do not import wildcards `*`
   - [ ] If available populate `self.max_battery_charge_current` and `self.max_battery_discharge_current` with values read from the BMS
   - [ ] If available populate `self.unique_identifier` with a unique value to distinguish the BMS in a multiple battery setup
-  - [ ] If your BMS don't run with the default settings add installation notes to the [How to install, update, disable, enable and uninstall](../general/install#bms-specific-settings) [`docs/docs/general/install.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/docs/docs/general/install.md)
-  - [ ] If your BMS needs custom settings that the user should be able to change, add it below the `; --------- BMS specific settings ---------` section in the [`etc/dbus-serialbattery/config.default.ini`](https://github.com/Louisvdw/dbus-serialbattery/blob/dev/etc/dbus-serialbattery/config.default.ini)
+  - [ ] If your BMS don't run with the default settings add installation notes to the [How to install, update, disable, enable and uninstall](../general/install#bms-specific-settings) [`docs/docs/general/install.md`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/docs/docs/general/install.md)
+  - [ ] If your BMS needs custom settings that the user should be able to change, add it below the `; --------- BMS specific settings ---------` section in the [`etc/dbus-serialbattery/config.default.ini`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini)
   - [ ] Make sure the GitHub Actions run fine in your repository. In order to make the GitHub Actions run please select in your repository settings under `Actions` -> `General` -> `Actions permissions` the option `Allow all actions and reusable workflows`. Check also in your repository settings under `Actions` -> `General` -> `Workflow permissions` if `Read and write permissions` are selected. After this changes you have to make a new commit, if you don't see any Actions run. This will check your code for Flake8 and Black Lint errors. [Here](https://py-vscode.readthedocs.io/en/latest/files/linting.html) is a short instruction on how to set up Flake8 and Black Lint checks in VS Code. This will save you a lot of time.