Skip to content

Commit 18a8bb5

Browse files
tscholandtscholand
committed
[modbus.sungrow] Added some more registers, minor fixes
Fixes #17486 Signed-off-by: Tim <[email protected]>
1 parent 4fc8f75 commit 18a8bb5

File tree

11 files changed

+979
-113
lines changed

11 files changed

+979
-113
lines changed

‎bundles/org.openhab.binding.modbus.sungrow/README.md

+9-19
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,18 @@
11
# Modbus Sungrow Binding
22

33
This binding integrates the sungrow inverters into openHAB.
4-
It is based on the Sungrow specification "Communication Protocol of Residential Hybrid Inverter V1.0.23", which can be found here: https://github.com/bohdan-s/SunGather/issues/36.
4+
It is based on the Sungrow specification "Communication Protocol of Residential Hybrid Inverter V1.1.15", which can be found here: https://github.com/Gnarfoz/Sungrow-Inverter/blob/main/Modbus%20Information/TI_20240924_Communication%20Protocol%20of%20Residential%20Hybrid%20Inverter-V1.1.5.pdf.
55

66
## Supported Inverters
77

88
As defined within the spec mentioned above the following inverters are supported, but not all are tested yet:
99

10-
- SH3K6
11-
- SH4K6
12-
- SH5K-20
13-
- SH5K-V13
14-
- SH3K6-30
15-
- SH4K6-30
16-
- SH5K-30
17-
- SH3.0RS
18-
- SH3.6RS
19-
- SH4.0RS
20-
- SH5.0RS
21-
- SH6.0RS
22-
- SH5.0RT
23-
- SH6.0RT
24-
- SH8.0RT
25-
- SH10RT
10+
- SH3.0-6.0RS
11+
- SH8.0-10RS
12+
- SH5.0-10RT
13+
- SH5-25T
14+
15+
Some values might not work for your inverter...
2616

2717
## Supported Things
2818

@@ -35,9 +25,9 @@ The binding supports only one thing:
3525
The data from the inverter is read via Modbus. So you need to configure a Modbus Serial Slave `serial` or Modbus TCP Slave `tcp` as bridge first.
3626
If you are using a Modbus TCP Slave and the WiNet-S Communication Module please ensure:
3727

38-
- that you have the correct IP-Address of your WiNet-S Device
28+
- that you have the correct IP address of your WiNet-S device
3929
- that Modbus is enabled within the Communication Module
40-
- that you've the correct port number
30+
- that you have the correct port number
4131
- that the white list is disabled or your openHAB instance IP is listed
4232

4333
Enabling modbus and whitelist setting can be done in WiNet-S Web-UI as shown below:

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/ConversionConstants.java

+30-1
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,43 @@ final class ConversionConstants {
2929
private ConversionConstants() {
3030
}
3131

32+
/**
33+
* Multiplicand for 0.001.
34+
*/
35+
static final BigDecimal DIV_BY_THOUSAND = new BigDecimal(BigInteger.ONE, 3);
36+
37+
/**
38+
* Multiplicand for 0.01.
39+
*/
40+
static final BigDecimal DIV_BY_HUNDRED = new BigDecimal(BigInteger.ONE, 2);
41+
3242
/**
3343
* Multiplicand for 0.1.
3444
*/
3545
static final BigDecimal DIV_BY_TEN = new BigDecimal(BigInteger.ONE, 1);
3646

47+
/**
48+
* Multiplicand for 1.
49+
*/
50+
static final BigDecimal ONE = BigDecimal.ONE;
51+
/**
52+
* Multiplicand for 10.
53+
*/
54+
static final BigDecimal MULTI_BY_TEN = new BigDecimal(BigInteger.ONE, -1);
55+
56+
/**
57+
* Multiplicand for 100.
58+
*/
59+
static final BigDecimal MULTI_BY_HUNDRED = new BigDecimal(BigInteger.ONE, -2);
60+
61+
/**
62+
* Multiplicand for 1.000.
63+
*/
64+
static final BigDecimal MULTI_BY_THOUSAND = new BigDecimal(BigInteger.ONE, -3);
65+
3766
/**
3867
* Value conversion from Celsius to Kelvin.
3968
*/
4069
static final Function<BigDecimal, BigDecimal> CELSIUS_TO_KELVIN = (BigDecimal celsius) -> celsius
41-
.add(new BigDecimal(273.15f));
70+
.add(new BigDecimal("273.15"));
4271
}

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/SungrowInverterRegisters.java

+168-83
Large diffs are not rendered by default.

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/mapper/ToStringMapper.java

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
* Copyright (c) 2010-2025 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.modbus.sungrow.internal.mapper;
14+
15+
import java.math.BigDecimal;
16+
17+
import org.eclipse.jdt.annotation.NonNullByDefault;
18+
19+
/**
20+
* Defines methods for mapping a given value (from the registers) to a corresponding String.
21+
*
22+
* @author Tim Scholand - Initial contribution
23+
*/
24+
@NonNullByDefault
25+
public interface ToStringMapper {
26+
27+
/**
28+
* Maps from the given {@link BigDecimal} to the {@link String} label.
29+
*
30+
* @param value the value from the register
31+
* @return the corresponding String value
32+
*/
33+
String map(BigDecimal value);
34+
}

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/mapper/impl/DeviceTypeMapper.java

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
/*
2+
* Copyright (c) 2010-2025 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.modbus.sungrow.internal.mapper.impl;
14+
15+
import java.math.BigDecimal;
16+
17+
import org.eclipse.jdt.annotation.NonNullByDefault;
18+
import org.openhab.binding.modbus.sungrow.internal.mapper.ToStringMapper;
19+
20+
/**
21+
* This mapper implements {@link ToStringMapper} and maps the hex codes of the sungrow modbus register to the human
22+
* readable device names.
23+
*
24+
* @author Tim Scholand - Initial contribution
25+
*/
26+
@NonNullByDefault
27+
public class DeviceTypeMapper implements ToStringMapper {
28+
29+
private static final DeviceTypeMapper INSTANCE = new DeviceTypeMapper();
30+
31+
/**
32+
* @return a singleton instance of the mapper
33+
*/
34+
public static DeviceTypeMapper instance() {
35+
return INSTANCE;
36+
}
37+
38+
private DeviceTypeMapper() {
39+
// use instance()
40+
}
41+
42+
@Override
43+
public String map(BigDecimal value) {
44+
String hex = String.format("0x%03X", value.intValue());
45+
return switch (hex) {
46+
case "0xD17" -> "SH3.0RS";
47+
case "0xD0D" -> "SH3.6RS";
48+
case "0xD18" -> "SH4.0RS";
49+
case "0xD0F" -> "SH5.0RS";
50+
case "0xD10" -> "SH6.0RS";
51+
case "0xD1A" -> "SH8.0RS";
52+
case "0xD1B" -> "SH10RS";
53+
case "0xE00" -> "SH5.0RT";
54+
case "0xE01" -> "SH6.0RT";
55+
case "0xE02" -> "SH8.0RT";
56+
case "0xE03" -> "SH10RT";
57+
case "0xE10" -> "SH5.0RT-20";
58+
case "0xE11" -> "SH6.0RT-20";
59+
case "0xE12" -> "SH8.0RT-20";
60+
case "0xE13" -> "SH10RT-20";
61+
case "0xE0C" -> "SH5.0RT-V112";
62+
case "0xE0D" -> "SH6.0RT-V112";
63+
case "0xE0E" -> "SH8.0RT-V112";
64+
case "0xE0F" -> "SH10RT-V112";
65+
case "0xE08" -> "SH5.0RT-V122";
66+
case "0xE09" -> "SH6.0RT-V122";
67+
case "0xE0A" -> "SH8.0RT-V122";
68+
case "0xE0B" -> "SH10RT-V122";
69+
case "0xE20" -> "SH5T-V11";
70+
case "0xE21" -> "SH6T-V11";
71+
case "0xE22" -> "SH8T-V11";
72+
case "0xE23" -> "SH10T-V11";
73+
case "0xE24" -> "SH12T-V11";
74+
case "0xE25" -> "SH15T-V11";
75+
case "0xE26" -> "SH20T-V11";
76+
case "0xE28" -> "SH25T-V11";
77+
default -> "UNKNOWN: " + hex;
78+
};
79+
}
80+
}

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/mapper/impl/DrmStateMapper.java

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*
2+
* Copyright (c) 2010-2025 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.modbus.sungrow.internal.mapper.impl;
14+
15+
import java.math.BigDecimal;
16+
17+
import org.eclipse.jdt.annotation.NonNullByDefault;
18+
import org.openhab.binding.modbus.sungrow.internal.mapper.ToStringMapper;
19+
20+
/**
21+
* This mapper implements {@link ToStringMapper} and maps the integer codes of the sungrow modbus register to the human
22+
* readable DRM states.
23+
*
24+
* @author Tim Scholand - Initial contribution
25+
*/
26+
@NonNullByDefault
27+
public class DrmStateMapper implements ToStringMapper {
28+
29+
private static final DrmStateMapper INSTANCE = new DrmStateMapper();
30+
31+
/**
32+
* @return a singleton instance of the mapper
33+
*/
34+
public static DrmStateMapper instance() {
35+
return INSTANCE;
36+
}
37+
38+
private DrmStateMapper() {
39+
// use instance()
40+
}
41+
42+
@Override
43+
public String map(BigDecimal value) {
44+
return switch (value.intValue()) {
45+
// not sure, if the mapping is correct
46+
case 1 -> "DRM0";
47+
case 2 -> "DRM1";
48+
case 3 -> "DRM2";
49+
case 4 -> "DRM3";
50+
case 5 -> "DRM4";
51+
case 6 -> "DRM5";
52+
case 7 -> "DRM6";
53+
case 8 -> "DRM7";
54+
case 9 -> "DRM8";
55+
default -> "INVALID: " + value.toPlainString();
56+
};
57+
}
58+
}

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/mapper/impl/OutputTypeMapper.java

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/*
2+
* Copyright (c) 2010-2025 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.modbus.sungrow.internal.mapper.impl;
14+
15+
import java.math.BigDecimal;
16+
17+
import org.eclipse.jdt.annotation.NonNullByDefault;
18+
import org.openhab.binding.modbus.sungrow.internal.mapper.ToStringMapper;
19+
20+
/**
21+
* This mapper implements {@link ToStringMapper} and maps the integer codes of the sungrow modbus register to the human
22+
* readable output types.
23+
*
24+
* @author Tim Scholand - Initial contribution
25+
*/
26+
@NonNullByDefault
27+
public class OutputTypeMapper implements ToStringMapper {
28+
29+
private static final OutputTypeMapper INSTANCE = new OutputTypeMapper();
30+
31+
/**
32+
* @return a singleton instance of the mapper
33+
*/
34+
public static OutputTypeMapper instance() {
35+
return INSTANCE;
36+
}
37+
38+
private OutputTypeMapper() {
39+
// use instance()
40+
}
41+
42+
@Override
43+
public String map(BigDecimal value) {
44+
return switch (value.intValue()) {
45+
case 0 -> "SINGLE";
46+
case 1 -> "3P4L";
47+
case 2 -> "3P3L";
48+
default -> "UNKNOWN: " + value.toPlainString();
49+
};
50+
}
51+
}

‎bundles/org.openhab.binding.modbus.sungrow/src/main/java/org/openhab/binding/modbus/sungrow/internal/mapper/impl/RunningStateMapper.java

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
/*
2+
* Copyright (c) 2010-2025 Contributors to the openHAB project
3+
*
4+
* See the NOTICE file(s) distributed with this work for additional
5+
* information.
6+
*
7+
* This program and the accompanying materials are made available under the
8+
* terms of the Eclipse Public License 2.0 which is available at
9+
* http://www.eclipse.org/legal/epl-2.0
10+
*
11+
* SPDX-License-Identifier: EPL-2.0
12+
*/
13+
package org.openhab.binding.modbus.sungrow.internal.mapper.impl;
14+
15+
import java.math.BigDecimal;
16+
17+
import org.eclipse.jdt.annotation.NonNullByDefault;
18+
import org.openhab.binding.modbus.sungrow.internal.mapper.ToStringMapper;
19+
20+
/**
21+
* This mapper implements {@link ToStringMapper} and maps the hex codes of the sungrow modbus register to the human
22+
* readable running states.
23+
*
24+
* @author Tim Scholand - Initial contribution
25+
*/
26+
@NonNullByDefault
27+
public class RunningStateMapper implements ToStringMapper {
28+
29+
private static final RunningStateMapper INSTANCE = new RunningStateMapper();
30+
31+
/**
32+
* @return a singleton instance of the mapper
33+
*/
34+
public static RunningStateMapper instance() {
35+
return INSTANCE;
36+
}
37+
38+
private RunningStateMapper() {
39+
// use instance()
40+
}
41+
42+
@Override
43+
public String map(BigDecimal value) {
44+
String hex = String.format("0x%04X", value.intValue());
45+
return switch (hex) {
46+
case "0x0000", "0x0040" -> "RUNNING";
47+
case "0x0041" -> "OFF_GRID_CHARGE";
48+
case "0x0200" -> "UPDATE_FAILED";
49+
case "0x0400" -> "MAINTAIN_MODE";
50+
case "0x0800" -> "FORCED_MODE";
51+
case "0x1000" -> "OFF_GRID_MODE";
52+
case "0x1111" -> "UNINITIALIZED";
53+
case "0x1200", "0x0010" -> "INITIAL_STANDBY";
54+
case "0x1300", "0x0002" -> "SHUTDOWN";
55+
case "0x1400", "0x0008" -> "STANDBY";
56+
case "0x1500", "0x0004" -> "EMERGENCY_STOP";
57+
case "0x1600", "0x0020" -> "STARTUP";
58+
case "0x1700" -> "AFCI_SELF_TEST_SHUTDOWN";
59+
case "0x1800" -> "INTELLIGENT_STATION_BUILDING_STATUS";
60+
case "0x1900" -> "SAFE_MODE";
61+
case "0x2000" -> "OPEN_LOOP";
62+
case "0x2501" -> "RESTARTING";
63+
case "0x4000" -> "RUNNING_EXTERNAL_EMS_MODE";
64+
case "0x4001" -> "EMERGENCY_CHARGING_OPERATION";
65+
case "0x5500", "0x0100" -> "FAULT";
66+
case "0x8000", "0x0001" -> "STOP";
67+
case "0x8100" -> "DERATING_RUNNING";
68+
case "0x8200" -> "DISPATCH_RUNNING";
69+
case "0x9100" -> "WARN_RUN";
70+
default -> "UNKNOWN: " + hex;
71+
};
72+
}
73+
}

0 commit comments

Comments
 (0)