add JKBMS and MQTT battery web ui settings docs

docs/firmware/configuration/battery_settings.md

@@ -0,0 +1,27 @@
+# Battery Settings
+
+## Screenshot
+
+![Battery Settings](../../assets/images/screenshots/battery_settings.png)
+
+## Settings / Parameters
+
+### General Interface Settings
+
+#### Verbose Logging :material-toggle-switch:{title="Switch"}
+
+Enable to log more information regarding the battery interface on the (serial)
+console. The actual verbosity and type of messages vary among the different
+data providers.
+
+#### Data Provider :material-form-dropdown:{title="Dropdown"}
+
+Select the data provider applicable to your setup. The settings for each
+battery data provider are different.
+
+### Provider Settings
+
+There are no additional settings for the Pylontech, Pytes, and Victron
+SmartShunt interfaces. Refer to the respective subpage for more information
+about the [MQTT](battery_settings_mqtt.md) or [JK
+BMS](battery_settings_jkbms.md) provider settings.

docs/firmware/configuration/battery_settings_jkbms.md

@@ -0,0 +1,19 @@
+# JK BMS Battery Provider
+
+## Screenshot
+
+![JK BMS Battery Settings](../../assets/images/screenshots/battery_settings_jkbms.png)
+
+## Settings / Parameters
+
+### JK BMS Settings
+
+#### Interface Type :material-form-dropdown:{title="Dropdown"}
+
+Set this according to your hardware setup. Refer to the [JK BMS hardware
+documentation](../../hardware/jkbms/index.md) to learn which value to choose.
+
+#### Polling Interval :material-form-textbox:{title="Textbox"}
+
+As the JK BMS does not broadcast values unsolicited, it is polled at this
+interval.

docs/firmware/configuration/battery_settings_mqtt.md

@@ -0,0 +1,36 @@
+# MQTT Battery Provider
+
+## Screenshot
+
+![MQTT Battery Settings](../../assets/images/screenshots/battery_settings_mqtt.png)
+
+## Settings / Parameters
+
+### SoC Settings
+
+#### SoC Value Topic :material-form-textbox:{title="Textbox"}
+
+MQTT topic to which the battery SoC value is published on your broker.
+
+#### JSON Path :material-form-textbox:{title="Textbox"}
+
+If the payload of the topic is not a numeric value but a serialized JSON
+object, this path expressions tells which value to extract from the JSON
+object.
+
+### Voltage Settings
+
+#### Voltage Value Topic :material-form-textbox:{title="Textbox"}
+
+MQTT topic to which the battery voltage value is published on your broker.
+
+#### JSON Path :material-form-textbox:{title="Textbox"}
+
+If the payload of the topic is not a numeric value but a serialized JSON
+object, this path expressions tells which value to extract from the JSON
+object.
+
+#### Unit :material-form-dropdown:{title="Dropdown"}
+
+Allows to set the actual unit of the numeric voltage payload, often Volt (V)
+or Millivolt (mV).

docs/hardware/battery.md

@@ -21,3 +21,7 @@ The MQTT battery provider is the most generic interface. Use it if your battery
 publishes state of charge and/or voltage information to the MQTT broker. This option does
 not require to separately connect OpenDTU-OnBattery to your battery (managemen
 system), i.e., no setup of hardware is required to use this interface.
+
+Refer to the [MQTT battery settings
+documentation](../firmware/configuration/battery_settings_mqtt.md) for
+configuration options.

docs/hardware/jkbms/index.md

@@ -10,3 +10,7 @@ These models are supported:
 
 1. [JK-B* Models](models_b.md)
 2. [JK-PB* Models](models_pb.md) (new style Inverter-BMS)
+
+Refer to the [JK BMS battery settings
+documentation](../../firmware/configuration/battery_settings_jkbms.md) for
+configuration options (all models).

mkdocs.yml

@@ -144,6 +144,10 @@ nav:
         - firmware/configuration/security_settings.md
         - firmware/configuration/dtu_settings.md
         - firmware/configuration/device_settings.md
+        - Battery:
+          - firmware/configuration/battery_settings.md
+          - firmware/configuration/battery_settings_jkbms.md
+          - firmware/configuration/battery_settings_mqtt.md
         - firmware/configuration/config_settings.md
         - firmware/configuration/firmware_upgrade.md
         - firmware/configuration/device_reboot.md