refactor: Add profile references

davidrapan · Oct 29, 2024 · 7beea13 · 7beea13
1 parent 9989f56
commit 7beea13
Show file tree

Hide file tree

Showing 29 changed files with 165 additions and 105 deletions.
diff --git a/custom_components/solarman/inverter_definitions/afore_BNTxxxKTL-2mppt.yaml b/custom_components/solarman/inverter_definitions/afore_BNTxxxKTL-2mppt.yaml
@@ -1,5 +1,9 @@
 #
-# To use modbus function in Afore BNTxxxKTL inverters, You first need to change protocol from RS485 to MODBUS in inverter menu
+# Afore BNTxxxKTL
+#
+# Reference: ???
+#
+# To use modbus function you first need to change protocol from RS485 to MODBUS in inverter menu
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/afore_hybrid.yaml b/custom_components/solarman/inverter_definitions/afore_hybrid.yaml
@@ -1,5 +1,10 @@
-# Afore Hybrid Single Phase
-# Tested on AF5K-SL
+#
+# Afore | Hybrid Inverter | Three Phase | LV Battery Supported
+#
+# Reference: https://github.com/user-attachments/files/17139137/211208.-.Afore.T6.communication.protocol.V1.0-211109.xlsx
+#
+# Tested with AF5K-SL
+#
 
 default:
   update_interval: 10

diff --git a/custom_components/solarman/inverter_definitions/chint_cps-scetl.yaml b/custom_components/solarman/inverter_definitions/chint_cps-scetl.yaml
@@ -1,9 +1,8 @@
 #
-# CHINT Hybrid inverters | Three Phase | Hybrid Inverter | LV Battery Supported
+# CHINT | Hybrid Inverter | Three Phase | LV Battery Supported
 #
-# Tested directly on CPS SCE4.6~6KTL-120/EU (https://en.chintpower.com/upload/img/2024-01/65b0c042cfa4c.pdf)
-#
-# The source MODBUS document has been provided directly from CHINT support, there doesn't seems to be a public URL for it.
+# Reference: https://github.com/user-attachments/files/17295986/Hybrid.Modbus.Protocol.per.inverter.ibridi.pdf
+# - MODBUS document has been provided directly from CHINT support
 #
 # Registers
 # The 0x1001 - 0x104C = 0x03 function code - Real Time Data:
@@ -14,6 +13,8 @@
 #
 # Note: the inverter seems to reply with inverted endianess on all the 32-bit responses.
 #
+# Tested with CPS SCE4.6~6KTL-120/EU, link: https://en.chintpower.com/upload/img/2024-01/65b0c042cfa4c.pdf
+#
 
 info:
   manufacturer: CHINT

diff --git a/custom_components/solarman/inverter_definitions/deye_2mppt.yaml b/custom_components/solarman/inverter_definitions/deye_2mppt.yaml
@@ -1,19 +1,9 @@
 #
-# First version: 22.02.2023
-# Latest update: 19.08.2024
-# Microinverter SUNX (DEYE/VESDAS ??? - X because i have no dang clue what shares those registers :) )
-# v0.1  Added all the cool registers from Deye_Modbus.-.-.V118.pdf
-# 2x MPPT, 2x inverter
-# 1x Logger, 2x Module
+# Deye | Microinverter | 2 MPPT
 #
+# Reference: https://github.com/user-attachments/files/16597960/Deye.Modbus.protocol.V118.pdf
 #
-## Tested with:
-### SUN-800-G3-EU-230    FW: 2.06
-### SUN-M80-G3-EU-Q0     FW: 2.06
-### SUN-M80-G3-EU-230    FW: 2.32-D1
-########## May work with:
-### SUN-M80G3-EU-230  FW: ?.??
-### SUN-M60G3-EU-Q0   FW: ?.??
+# Tested with SUN-800-G3-EU-230 FW: 2.06, SUN-M80-G3-EU-Q0 FW: 2.06, SUN-M80-G3-EU-230 FW: 2.32-D1, SUN-M80G3-EU-230 and SUN-M60G3-EU-Q0
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/deye_4mppt.yaml b/custom_components/solarman/inverter_definitions/deye_4mppt.yaml
@@ -1,19 +1,9 @@
 #
-# First version: 08.05.2022
-# Latest update: 17.09.2024
-# Microinverter SUN2000G3 (DEYE/VESDAS)
-# v0.1  Added all the cool registers from Deye_Modbus.-.-.V118.pdf
-# 4x MPPT, 4x inverter
-# 1x Logger, 4x Module,
-#
-#
-#
-#
-#
-#
-#
+# Deye | Microinverter | 4 MPPT
 #
+# Reference: https://github.com/user-attachments/files/16597960/Deye.Modbus.protocol.V118.pdf
 #
+# Tested with SUN2000G3
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/deye_hybrid.yaml b/custom_components/solarman/inverter_definitions/deye_hybrid.yaml
@@ -1,3 +1,11 @@
+#
+# Deye | Hybrid Inverter
+#
+# Reference: https://github.com/user-attachments/files/16597960/Deye.Modbus.protocol.V118.pdf
+#
+# Tested
+#
+
 default:
   update_interval: 10
   digits: 6

diff --git a/custom_components/solarman/inverter_definitions/deye_sg01hp3.yaml b/custom_components/solarman/inverter_definitions/deye_sg01hp3.yaml
@@ -1,6 +1,15 @@
 #
 # SUN-5/6/8/10/12/15/20/25K-SG01HP3-EU-AM2 | 5-25kW | Three Phase | 2 MPPT | Hybrid Inverter | HV Battery Supported
 #
+# Reference: https://github.com/user-attachments/files/16597916/MODBUSRTU.V104.3.1.1111_SG01-HP3-AM2.pdf
+#
+# Registers
+# The 0-59 register address is a readable register type, 0x03 function code.
+# The 60-499 register address is a read-write register type 0x10 function code.
+# The 500-2000 register address is a readable register type 0x03 function code.
+#
+# Tested with 25K
+#
 
 info:
   manufacturer: Deye

diff --git a/custom_components/solarman/inverter_definitions/deye_sg04lp3.yaml b/custom_components/solarman/inverter_definitions/deye_sg04lp3.yaml
@@ -1,12 +1,15 @@
 #
 # SUN-5/6/8/10/12K-SG04LP3 | 5-12kW | Three Phase | 2 MPPT | Hybrid Inverter | LV Battery Supported
-# - tested with 12KW and LSW3_15_FFFF_1.0.91R Stick Logger
+#
+# Reference: https://github.com/user-attachments/files/16798469/MODBUS.RTU.V105.1-20231006.pdf
 #
 # Registers
 # The 0-59 register address is a readable register type, 0x03 function code.
 # The 60-499 register address is a read-write register type 0x10 function code.
 # The 500-2000 register address is a readable register type 0x03 function code.
 #
+# Tested with 12KW and LSW3_15_FFFF_1.0.91R Stick Logger
+#
 
 info:
   manufacturer: Deye

diff --git a/custom_components/solarman/inverter_definitions/deye_string.yaml b/custom_components/solarman/inverter_definitions/deye_string.yaml
@@ -1,3 +1,11 @@
+#
+# Deye | String Inverter | 2 MPPT
+#
+# Reference: https://github.com/user-attachments/files/16597960/Deye.Modbus.protocol.V118.pdf
+#
+# Tested with SUN-9K-G03 and LSW3_15_FFFF_1.0.9E
+#
+
 default:
   update_interval: 5
   digits: 6

diff --git a/custom_components/solarman/inverter_definitions/kstar_hybrid.yaml b/custom_components/solarman/inverter_definitions/kstar_hybrid.yaml
@@ -1,11 +1,14 @@
 #
-# KSTAR Hybrid Inverter
-# Modbus information taken from "MODBUS RS485 Communication Protocol V2.5" document provided by KSTAR
+# KSTAR | Hybrid Inverter
 #
-# This inverter exposes its data in the following registers (although not all of them are used by this definition file):
+# Reference: https://github.com/user-attachments/files/17555061/KSTAR.Hybrid.Inverter.Modbus.V2.9.1_2024.07.21.pdf
+# - MODBUS document has been provided directly from KSTAR support
 #
-#  - INPUT_REGISTERS   3000 - 3792 decimal, 0x0BB8 - 0x0ED0 hexadecimal, 0x04 function code
-#  - HOLDING_REGISTERS 3200 - 3246 decimal. 0x0C80 - 0x0CAE  hexadecimal, 0x03 function code
+# Registers
+# INPUT_REGISTERS   3000 - 3792 decimal, 0x0BB8 - 0x0ED0 hexadecimal, 0x04 function code
+# HOLDING_REGISTERS 3200 - 3246 decimal, 0x0C80 - 0x0CAE hexadecimal, 0x03 function code
+#
+# Note: not all of them are used by this definition file
 #
 
 info:

diff --git a/custom_components/solarman/inverter_definitions/megarevo_r-3h.yaml b/custom_components/solarman/inverter_definitions/megarevo_r-3h.yaml
@@ -1,11 +1,13 @@
-# Three-phase Hybrid Inverter Series R6-15KH3 - 6.6~16.5 kW
-# Version: V0.1
+#
+# Megarevo R6-15KH3 | 6.6~16.5kW | Three Phase | Hybrid Inverter
+#
+# Reference: ???
+#
 # Megarevo Inverters using Solarman v5 via Solarman App pcap - Full Register Map Not Complete Yet
 # Expected to Work with most of the Megarevo Inverters (including EG4 8k)
-# Tested with Megarevo R15K3H (3 Phase Hybird) with FW v0.01 and v1.0.13, some fields yet to be validated.
 #
-# First: Aug 5, 2024 by wolfmon
-# Last: Aug 16, 2024 by davidrapan
+# Tested with Megarevo R15K3H (3 Phase Hybird) with FW v0.01 and v1.0.13, some fields yet to be validated - wolfmon
+#
 
 default:
   update_interval: 60

diff --git a/custom_components/solarman/inverter_definitions/pylontech_Force-H.yaml b/custom_components/solarman/inverter_definitions/pylontech_Force-H.yaml
@@ -1,8 +1,10 @@
+#
 # Pylontech Force H2/H3
-# Modbus information retrieved from:
-# https://gist.github.com/nagisa/435bdf783e4b13b8e810106b0852081e
-# Tested Firmware Version: 0.1.0.1
-# cryptocake August 2024
+#
+# Reference: https://gist.github.com/nagisa/435bdf783e4b13b8e810106b0852081e
+# 
+# Tested Firmware Version: 0.1.0.1 - cryptocake August 2024
+#
 
 default:
   update_interval: 10

diff --git a/custom_components/solarman/inverter_definitions/sofar_g3hyd.yaml b/custom_components/solarman/inverter_definitions/sofar_g3hyd.yaml
@@ -1,5 +1,8 @@
 #
 # Sofar G3 also HYD 5-20KTL-3PH
+#
+# Reference: https://github.com/user-attachments/files/17180102/SOFAR-G3.External.Modbus.Protocol-EN-V1.10.20220622.xlsx
+#
 # This works also for rebranded ZCS Azzurro 3-Phase inverters such as the 3PH HYD6000 ZSS, or single phase such as 1PH HY6000 ZSS HP
 # Note that this won't work if your ZCS inverter is connected via Connext, you have to be using a Wi-Fi or Ethernet Kit such as ZSM-WIFI-USB.
 #

diff --git a/custom_components/solarman/inverter_definitions/sofar_hyd-es.yaml b/custom_components/solarman/inverter_definitions/sofar_hyd-es.yaml
@@ -1,5 +1,7 @@
 #
-# Configuration file for Sofar HYD3000/4000/5000/6000-ES inverter family.
+# Sofar HYD3000/4000/5000/6000-ES
+#
+# Reference: https://github.com/user-attachments/files/16641716/SOFARSOLAR.ModBus-RTU.Communication.Protocol.pdf
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/sofar_lsw3.yaml b/custom_components/solarman/inverter_definitions/sofar_lsw3.yaml
@@ -1,3 +1,9 @@
+#
+# Sofar
+#
+# Reference: ???
+#
+
 default:
   update_interval: 5
   digits: 6

diff --git a/custom_components/solarman/inverter_definitions/sofar_tlx-g3.yaml b/custom_components/solarman/inverter_definitions/sofar_tlx-g3.yaml
@@ -1,5 +1,10 @@
+#
 # Sofar 3.3-12KTLX-G3
+#
+# Reference: https://github.com/user-attachments/files/17180102/SOFAR-G3.External.Modbus.Protocol-EN-V1.10.20220622.xlsx
+#
 # Note: no modbus energy meter connected
+#
 
 info:
   manufacturer: Sofar

diff --git a/custom_components/solarman/inverter_definitions/sofar_wifikit.yaml b/custom_components/solarman/inverter_definitions/sofar_wifikit.yaml
@@ -1,8 +1,12 @@
 #
+# Sofar 
+#
+# Reference: https://github.com/user-attachments/files/16641716/SOFARSOLAR.ModBus-RTU.Communication.Protocol.pdf
+#
 # Tested with Solarman ME3000-SP with an embedded
 # "wifikit" logger. Might work for other devices
 # too.
-
+#
 # The ME3000-SP is basically a glorified battery
 # charger - it is not directly connected to any
 # production infrastructure, but can calculate

diff --git a/custom_components/solarman/inverter_definitions/solarman_dtsd422-d3.yaml b/custom_components/solarman/inverter_definitions/solarman_dtsd422-d3.yaml
@@ -1,6 +1,8 @@
 #
 # Solarman Smart Meter DTSD422-D3
 #
+# Reference: ???
+#
 
 default:
   update_interval: 5

diff --git a/custom_components/solarman/inverter_definitions/solis_1p-5g.yaml b/custom_components/solarman/inverter_definitions/solis_1p-5g.yaml
@@ -1,7 +1,10 @@
-# Solis Single Phase Inverter
-# Model: 1P8K-5G (2 MPTT, 8kWh)
-# Modbus information derived by test and comparing to Solis Cloud
-# Gedger V.0.5 July 2024
+#
+# Solis 1P8K-5G | 8kW | 2 MPPT | Single Phase Inverter
+#
+# Reference: ???
+# - Modbus information derived by test and comparing to Solis Cloud
+# 
+# Tested by Gedger in July 2024
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/solis_3p-4g+.yaml b/custom_components/solarman/inverter_definitions/solis_3p-4g+.yaml
@@ -1,8 +1,9 @@
 #
-# Solis 4G Three Phase Inverter
-# Solis-3P(5-10)K-4G
-# refering to https://ginlongsolis.freshdesk.com/support/solutions/articles/36000340158-modbus-communication-for-solis-inverters
-# agirilovich June 2023
+# Solis 3P5~10K-4G | 5~10kW | 4 MPPT | Three Phase Inverter
+#
+# Reference: https://ginlongsolis.freshdesk.com/support/solutions/articles/36000340158-modbus-communication-for-solis-inverters
+#
+# Tested by agirilovich in June 2023
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/solis_3p-4g.yaml b/custom_components/solarman/inverter_definitions/solis_3p-4g.yaml
@@ -1,8 +1,9 @@
 #
-# Solis 4G Three Phase Inverter
-# Solis-3P(5-10)K-4G
-# refering to https://ginlongsolis.freshdesk.com/support/solutions/articles/36000340158-modbus-communication-for-solis-inverters
-# agirilovich June 2023
+# Solis 3P5~10K-4G | 5~10kW | 2 MPPT | Three Phase Inverter
+#
+# Reference: https://ginlongsolis.freshdesk.com/support/solutions/articles/36000340158-modbus-communication-for-solis-inverters
+#
+# Tested by agirilovich in June 2023
 #
 
 default:

diff --git a/custom_components/solarman/inverter_definitions/solis_3p-5g.yaml b/custom_components/solarman/inverter_definitions/solis_3p-5g.yaml
@@ -1,7 +1,10 @@
-# Solis three Phase Hybrid
-# RHI-(5-10)K-HVES-5G
-# Modbus information retrieved from:
-# https://www.scss.tcd.ie/Brian.Coghlan/Elios4you/RS485_MODBUS-Hybrid-BACoghlan-201811228-1854.pdf
+#
+# Solis RHI-3P5~10K-HVES-5G | 5~10kW | 2 MPPT | Three Phase Inverter
+#
+# Reference: https://github.com/user-attachments/files/16650051/RS485_MODBUS-Hybrid-BACoghlan-201811228-1854.pdf
+#
+# Tested by agirilovich in June 2023
+#
 
 default:
   update_interval: 5

diff --git a/custom_components/solarman/inverter_definitions/solis_hybrid.yaml b/custom_components/solarman/inverter_definitions/solis_hybrid.yaml
@@ -1,8 +1,9 @@
 #
-# Solis Single Phase Hybrid
-# RHI-(3-6)K-48ES-5G
-# Modbus information retrieved from:
-# https://www.scss.tcd.ie/Brian.Coghlan/Elios4you/RS485_MODBUS-Hybrid-BACoghlan-201811228-1854.pdf
+# Solis RHI-1P3~6K-48ES-5G | 3~6kW | Single Phase | Hybrid Inverter
+# 
+# Reference: https://github.com/user-attachments/files/16650051/RS485_MODBUS-Hybrid-BACoghlan-201811228-1854.pdf
+#
+# Tested
 #
 
 default:
@@ -24,8 +25,8 @@ requests:
   - start: 43011
     end: 43025
     mb_functioncode: 0x03
-  - start: 43110
-    end: 43150
+  - start: 43100
+    end: 43170
     mb_functioncode: 0x03
 
 parameters:

diff --git a/custom_components/solarman/inverter_definitions/solis_s6-gr1p.yaml b/custom_components/solarman/inverter_definitions/solis_s6-gr1p.yaml
@@ -1,5 +1,8 @@
 #
-# Solis S6-GR1P4.6K Configuration
+# Solis S6-GR1P4.6K
+#
+# Reference: ???
+#
 # NH-Networks 2023
 #
 

diff --git a/custom_components/solarman/inverter_definitions/swatten_sih-th.yaml b/custom_components/solarman/inverter_definitions/swatten_sih-th.yaml
@@ -1,6 +1,10 @@
-# Swatten SiH-5/6/8/10kW-TH
-# Three Phase Hybrid Inverter（HV）- Residential Storage Inverter ~ https://www.swatten.com/show-3-5.html
-# From https://github.com/davidrapan/ha-solarman/discussions/166
+#
+# Swatten SiH-5/6/8/10kW-TH | Three Phase Hybrid Inverter | HV Battery Supported
+#
+# Reference: https://github.com/user-attachments/files/17558047/Swatten.inverter.Modbus.table.xlsx
+#
+# Tested: https://github.com/davidrapan/ha-solarman/discussions/166, link: https://www.swatten.com/show-3-5.html
+#
 
 default:
   update_interval: 10

diff --git a/custom_components/solarman/inverter_definitions/tsun_tsol-ms.yaml b/custom_components/solarman/inverter_definitions/tsun_tsol-ms.yaml
@@ -1,9 +1,10 @@
-# Microinverter TSUN TSOL-MS300~800
-# From https://github.com/davidrapan/ha-solarman/issues/153
-## 2x MPPT, 1x Device
-## 1x Logger, 2x Module
-## First version: 10.09.2024
-## Tested with TSUN TSOL-MS800 (Serial: Y47E...) FW: LSW5BLE_17_02B0_1.08-D1
+#
+# TSUN TSOL-MS300~800 | 2 MPPT | Microinverter
+#
+# Reference: https://github.com/davidrapan/ha-solarman/issues/153
+#
+# Tested with TSUN TSOL-MS800 (Serial: Y47E...) FW: LSW5BLE_17_02B0_1.08-D1
+#
 
 default:
   update_interval: 5