Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kbialek committed Jan 27, 2024
1 parent 79e9e42 commit 750dd72
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 7 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ METRIC_GROUPS = \
settings \
deye_sg01hp3 \
deye_sg01hp3_battery \
deye_sg01hp3_ups
deye_sg01hp3_ups \
deye_sg01hp3_bms
GENERATE_DOCS_TARGETS = $(addprefix generate-docs-, $(METRIC_GROUPS))
$(GENERATE_DOCS_TARGETS): generate-docs-%:
@mkdir -p docs
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ When your inverter turns out to work well with an already exiting metrics group,
| [Deye SUN-5/6/8/10/12K-SG04LP3](https://deye.com/product/sun-5-6-8-10-12k-sg04lp3-5-12kw-three-phase-2-mppt-hybrid-inverter-low-voltage-battery/) | [deye_sg04lp3](docs/metric_group_deye_sg04lp3.md), [deye_sg04lp3_battery](docs/metric_group_deye_sg04lp3_battery.md), [deye_sg04lp3_ups](docs/metric_group_deye_sg04lp3_ups.md), [deye_sg04lp3_timeofuse](docs/metric_group_deye_sg04lp3_timeofuse.md), [settings](docs/metric_group_settings.md) |
| [Deye SUN-5/6K-SG01LP1-US/EU](https://deye.com/product/sun-5-6k-sg01lp1-us-sun-7-6-8k-sg01lp1-us-eu-5-8kw-single-phase-2-mppt-hybrid-inverter-low-voltage-battery/) | [deye_hybrid](docs/metric_group_deye_hybrid.md), [deye_hybrid_battery](docs/metric_group_deye_hybrid_battery.md), [deye_hybrid_timeofuse](docs/metric_group_deye_hybrid_timeofuse.md), [settings](docs/metric_group_settings.md) |
| [Deye SUN-7.6/8K-SG01LP1-US/EU](https://deye.com/product/sun-5-6k-sg01lp1-us-sun-7-6-8k-sg01lp1-us-eu-5-8kw-single-phase-2-mppt-hybrid-inverter-low-voltage-battery/) | [deye_hybrid](docs/metric_group_deye_hybrid.md), [deye_hybrid_battery](docs/metric_group_deye_hybrid_battery.md), [deye_hybrid_timeofuse](docs/metric_group_deye_hybrid_timeofuse.md), [settings](docs/metric_group_settings.md) |
| [Deye SUN-25/30/40/50K-SG01HP3-EU-BM2/3/4](https://deye.com/product/sun-25-30-40-50k-sg01hp3-eu-bm2-3-4-25-50kw-three-phase-2-mppt-hybrid-inverter-low-voltage-battery/) [**(experimental)**](https://github.com/kbialek/deye-inverter-mqtt/issues/110) | [deye_sg01hp3](docs/metric_group_deye_sg01hp3.md), [deye_sg01hp3_battery](docs/metric_group_deye_sg01hp3_battery.md), [deye_sg01hp3_ups](docs/metric_group_deye_sg01hp3_ups.md), [settings](docs/metric_group_settings.md) |
| [Deye SUN-25/30/40/50K-SG01HP3-EU-BM2/3/4](https://deye.com/product/sun-25-30-40-50k-sg01hp3-eu-bm2-3-4-25-50kw-three-phase-2-mppt-hybrid-inverter-low-voltage-battery/) [**(experimental)**](https://github.com/kbialek/deye-inverter-mqtt/issues/110) | [deye_sg01hp3](docs/metric_group_deye_sg01hp3.md), [deye_sg01hp3_battery](docs/metric_group_deye_sg01hp3_battery.md), [deye_sg01hp3_bms](docs/metric_group_deye_sg01hp3_bms.md), [deye_sg01hp3_ups](docs/metric_group_deye_sg01hp3_ups.md), [settings](docs/metric_group_settings.md) |

| Meter model | Metric groups |
| ------------------------------------------------------------------- | ------------------------------------------------- |
Expand Down Expand Up @@ -220,6 +220,7 @@ All configuration options are controlled through environment variables.
* `deye_sg04lp3_timeofuse` - sg04lp3 time-of-use settings
* `deye_sg01hp3` - sg01hp3 inverter
* `deye_sg01hp3_battery` - sg01hp3 battery
* `deye_sg01hp3_bms` - sg01hp3 bms
* `deye_sg01hp3_ups` - sg01hp3 ups
* `igen_dtsd422`- dtsd422 smart meter
* `settings` - inverter settings
Expand Down
15 changes: 10 additions & 5 deletions docs/metric_group_deye_sg01hp3_battery.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
|Daily Battery Discharge|515|`battery/daily_discharge`|kWh|
|Total Battery Charge|516,517|`battery/total_charge`|kWh|
|Total Battery Discharge|518,519|`battery/total_discharge`|kWh|
|Battery Power|590|`battery/power`|W|
|Battery Voltage|587|`battery/voltage`|V|
|Battery SOC|588|`battery/soc`|%|
|Battery Current|591|`battery/current`|A|
|Battery Temperature|586|`battery/temperature`|°C|
|Battery1 Power|590|`battery/1/power`|W|
|Battery1 Voltage|587|`battery/1/voltage`|V|
|Battery1 SOC|588|`battery/1/soc`|%|
|Battery1 Current|591|`battery/1/current`|A|
|Battery1 Temperature|586|`battery/1/temperature`|°C|
|Battery2 SOC|589|`battery/2/soc`|%|
|Battery2 Voltage|593|`battery/2/voltage`|V|
|Battery2 Current|594|`battery/2/current`|A|
|Battery2 Power|595|`battery/2/power`|W|
|Battery2 Temperature|596|`battery/2/temperature`|°C|
22 changes: 22 additions & 0 deletions docs/metric_group_deye_sg01hp3_bms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
|Metric|Modbus address|MQTT topic suffix|Unit|
|---|:-:|---|:-:|
|BMS1 Charging Voltage|210|`bms/1/charging_voltage`|V|
|BMS1 Discharge Voltage|211|`bms/1/discharge_voltage`|V|
|BMS1 Charge Current Limit|212|`bms/1/charge_current_limit`|A|
|BMS1 Discharge Current Limit|213|`bms/1/discharge_current_limit`|A|
|BMS1 SOC|214|`bms/1/soc`|%|
|BMS1 Voltage|215|`bms/1/voltage`|V|
|BMS1 Current|216|`bms/1/current`|A|
|BMS1 Temp|217|`bms/1/temp`|°C|
|BMS1 Charging Max Current|218|`bms/1/charging_max_current`|A|
|BMS1 Discharge Max Current|219|`bms/1/discharge_max_current`|A|
|BMS2 Charging Voltage|241|`bms/2/charging_voltage`|V|
|BMS2 Discharge Voltage|242|`bms/2/discharge_voltage`|V|
|BMS2 Charge Current Limit|243|`bms/2/charge_current_limit`|A|
|BMS2 Discharge Current Limit|244|`bms/2/discharge_current_limit`|A|
|BMS2 SOC|245|`bms/2/soc`|%|
|BMS2 Voltage|246|`bms/2/voltage`|V|
|BMS2 Current|247|`bms/2/current`|A|
|BMS2 Temp|248|`bms/2/temp`|°C|
|BMS2 Charging Max Current|249|`bms/2/charging_max_current`|A|
|BMS2 Discharge Max Current|250|`bms/2/discharge_max_current`|A|

0 comments on commit 750dd72

Please sign in to comment.