From ab7cbb961b9e02e9f166fb40b420b6ff7da2f1da Mon Sep 17 00:00:00 2001 From: Thomas Basler Date: Fri, 30 Sep 2022 18:46:22 +0200 Subject: [PATCH] Added MQTT Topic documentation --- README.md | 2 ++ docs/MQTT_Topics.md | 66 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 docs/MQTT_Topics.md diff --git a/README.md b/README.md index b235f02..e58ad38 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,8 @@ You'll find the firmware file (after a successfull build process) under `.pio/bu After the successful upload, the OpenDTU immediately restarts into the new firmware. +## MQTT Topic Documentation +A documentation of all available MQTT Topics can be found here: [MQTT Documentation](docs/MQTT_Topics.md) ## Available cases * [https://www.thingiverse.com/thing:5435911](https://www.thingiverse.com/thing:5435911) diff --git a/docs/MQTT_Topics.md b/docs/MQTT_Topics.md new file mode 100644 index 0000000..138c819 --- /dev/null +++ b/docs/MQTT_Topics.md @@ -0,0 +1,66 @@ +# MQTT Topics + +The base topic, as configured in the web GUI is prepended to all follwing topics. + +## General topics + +| Topic | R / W | Description | Value / Unit | +| --------------------------------------- | ----- | ---------------------------------------------------- | -------------------------- | +| dtu/ip | R | IP address of OpenDTU | IP address | +| dtu/rssi | R | WiFi network quality | db value | +| dtu/status | R | Indicates whether OpenDTU network is reachable | online / offline | +| dtu/uptime | R | Time in seconds since startup | seconds | + +## Inverter specific topics + +serial will be replaced with the serial number of the inverter. + +| Topic | R / W | Description | Value / Unit | +| --------------------------------------- | ----- | ---------------------------------------------------- | -------------------------- | +| [serial]/name | R | Name of the inverter as configured in web GUI | | +| [serial]/device/bootloaderversion | R | Bootloader version of the inverter | | +| [serial]/device/fwbuildversion | R | Firmware version of the inverter | | +| [serial]/device/fwbuilddatetime | R | Build date / time of inverter firmware | | +| [serial]/device/hwpartnumber | R | Hardware part number of the inverter | | +| [serial]/device/hwversion | R | Hardware version of the inverter | | + +### AC channel / global specific topics + +| Topic | R / W | Description | Value / Unit | +| --------------------------------------- | ----- | ---------------------------------------------------- | -------------------------- | +| [serial]/0/current | R | AC current in ampere | Ampere (A) | +| [serial]/0/efficiency | R | Ratio AC Power over DC Power in percent | % | +| [serial]/0/frequency | R | AC frequency in hertz | Hertz (Hz) | +| [serial]/0/power | R | AC active power in watts | Watt (W) | +| [serial]/0/powerdc | R | DC power in watts | Watt (W) | +| [serial]/0/powerfactor | R | Power factor in percent | % | +| [serial]/0/reactivepower | R | AC reactive power in VAr | VAr | +| [serial]/0/temperature | R | Temperature of inverter in degree celsius | Degree Celsius (°C) | +| [serial]/0/voltage | R | AC voltage in volt | Volt (V) | +| [serial]/0/yieldday | R | Energy converted to AC per day in watt hours | Watt hours (Wh) | +| [serial]/0/yieldtotal | R | Energy converted to AC since reset watt hours | Watt hours (Wh) | + +### DC input channel topics + +[1-4] represents the different inputs. The amount depends on the inverter model. + +| Topic | R / W | Description | Value / Unit | +| --------------------------------------- | ----- | ---------------------------------------------------- | -------------------------- | +| [serial]/[1-4]/current | R | DC current of specific input in ampere | Ampere (A) | +| [serial]/[1-4]/irradiation | R | Ratio DC Power over set maximum power (in web GUI) | % | +| [serial]/[1-4]/power | R | DC power of specific input in watt | Watt (W) | +| [serial]/[1-4]/voltage | R | DC voltage of specific input in volt | Volt (V) | +| [serial]/[1-4]/yieldday | R | Energy converted to AC per day on specific input | Watt hours (Wh) | +| [serial]/[1-4]/yieldtotal | R | Energy converted to AC since reset on specific input | Watt hours (Wh) | + +### Inverter limit specific topics + +cmd topics are used to set values. Settings topics are updated from values set in the inverter. + +| Topic | R / W | Description | Value / Unit | +| ----------------------------------------- | ----- | ---------------------------------------------------- | -------------------------- | +| [serial]/settings/limit | R | Current applied production limit of the inverter | % of total possible output | +| [serial]/cmd/limit_persistent_relative | W | Set the inverter limit as a percentage of total production capability. The value will survive the night without power | % | +| [serial]/cmd/limit_persistent_absolute | W | Set the inverter limit as a absolute value. The value will survive the night without power | Watt (W) | +| [serial]/cmd/limit_nonpersistent_relative | W | Set the inverter limit as a percentage of total production capability. The value will reset to the last persistent value at night without power | % | +| [serial]/cmd/limit_nonpersistent_absolute | W | Set the inverter limit as a absolute value. The value will reset to the last persistent value at night without power | Watt (W) | \ No newline at end of file