Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

implements #93 #94 #102

Merged
merged 26 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
00c099e
feat: #58 & #84 test
Pho3niX90 Oct 30, 2024
cfa0d4a
fix(modbus_controller): log errors and return None in Modbus register…
Pho3niX90 Oct 30, 2024
9683d67
Merge branch 'master' into feature/string_inverters
Pho3niX90 Oct 30, 2024
e6a9231
refactor: improve value check
Pho3niX90 Oct 30, 2024
8d36ae2
refactor: remove dupe
Pho3niX90 Oct 30, 2024
25a7429
refactor: register fix
Pho3niX90 Oct 30, 2024
8e93564
feat: better support for multiple modbus controllers
Pho3niX90 Jan 30, 2025
53e3d9b
feat: better support for multiple modbus controllers
Pho3niX90 Jan 30, 2025
fb6041a
fixes: #15
Pho3niX90 Jan 30, 2025
ec47a2b
fixes: #79
Pho3niX90 Jan 30, 2025
57bc030
bump version
Pho3niX90 Jan 31, 2025
966e8d2
implements #93
Pho3niX90 Feb 4, 2025
b83852d
addition of time of use
Pho3niX90 Feb 4, 2025
1175bc9
addition of time of use
Pho3niX90 Feb 4, 2025
76a21d0
bump version
Pho3niX90 Feb 4, 2025
333b2f6
fix: duplicated sensor ids
Pho3niX90 Feb 5, 2025
73b45ed
Merge branch 'refs/heads/feature/multi_modbus' into feature/more_char…
Pho3niX90 Feb 5, 2025
729bed1
fix: faster startup
Pho3niX90 Feb 6, 2025
70eae96
chore: cleanup
Pho3niX90 Feb 6, 2025
5ecb6f5
chore: cleanup
Pho3niX90 Feb 6, 2025
5040a75
fix: time entity names
Pho3niX90 Feb 6, 2025
b95ae29
fix: sensors AMPERAGE and VOLT displaying as percentage
Pho3niX90 Feb 6, 2025
6890e54
fix: add waveshare values, fixes #74
Pho3niX90 Feb 6, 2025
ce755fb
chore: refactor CONFIG_SCHEMA
Pho3niX90 Feb 6, 2025
7474b53
chore: refactor CONFIG_SCHEMA
Pho3niX90 Feb 6, 2025
bb165b7
.
Pho3niX90 Feb 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions custom_components/solis_modbus/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""The Modbus Integration."""
import asyncio
import logging
import voluptuous as vol
from homeassistant.config_entries import ConfigEntry
Expand Down Expand Up @@ -61,18 +60,13 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
controller = ModbusController(host, port, poll_interval)
hass.data[DOMAIN][CONTROLLER][host] = controller

if not controller.connected():
await controller.connect()

_LOGGER.debug(f'config entry host = {host}, post = {port}')

# Set up the platforms associated with this integration
await hass.config_entries.async_forward_entry_setups(entry, [Platform.SENSOR])
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
await asyncio.sleep(20)
return True


async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
"""Unload a Modbus config entry."""
_LOGGER.debug('init async_unload_entry')
Expand Down
26 changes: 14 additions & 12 deletions custom_components/solis_modbus/config_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@

_LOGGER = logging.getLogger(__name__)

CONFIG_SCHEMA = vol.Schema(
{
vol.Required("host", default="", description="your solis ip"): str,
vol.Required("port", default=502, description="port of your modbus, typically 502 or 8899"): int,
vol.Optional(
"poll_interval",
default=15,
description="poll interval in seconds"
): vol.All(int, vol.Range(min=5)),
vol.Optional("type", default="hybrid", description="type of your modbus connection"): vol.In(["hybrid", "hybrid-waveshare", "string", "grid"]),
}
)

class ModbusConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Modbus configuration flow."""

Expand Down Expand Up @@ -56,18 +69,7 @@ async def _validate_config(self, user_input):

def _get_user_schema(self):
"""Return the schema for the user configuration form."""
return vol.Schema(
{
vol.Required("host", default="", description="your solis ip"): str,
vol.Required("port", default=502, description="port of your modbus, typically 502 or 8899"): int,
vol.Required(
"poll_interval",
default=15,
description="poll interval in seconds"
): vol.All(int, vol.Range(min=5)),
vol.Optional("type", default="hybrid", description="type of your modbus connection"): vol.In(["hybrid"]),
}
)
return CONFIG_SCHEMA

def _get_config(self, config):
"""Ensure 'type' defaults to 'hybrid' if not previously set."""
Expand Down
400 changes: 396 additions & 4 deletions custom_components/solis_modbus/data/hybrid_sensors.py

Large diffs are not rendered by default.

634 changes: 634 additions & 0 deletions custom_components/solis_modbus/data/hybrid_waveshare_sensors.py

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions custom_components/solis_modbus/data/string_sensors.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from homeassistant.components.sensor.const import SensorDeviceClass, SensorStateClass
from homeassistant.const import UnitOfElectricPotential, UnitOfElectricCurrent, UnitOfPower, UnitOfTime, UnitOfEnergy, \
UnitOfReactivePower, UnitOfFrequency, UnitOfTemperature, UnitOfApparentPower, PERCENTAGE
from homeassistant.const import UnitOfPower, UnitOfTime, UnitOfEnergy

# base on RS485_MODBUS Communication Protocol Ver18
string_sensors = [
{
"register_start": 36013,
Expand Down
4 changes: 2 additions & 2 deletions custom_components/solis_modbus/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
"iot_class": "local_polling",
"issue_tracker": "https://github.com/Pho3niX90/solis_modbus/issues",
"quality_scale": "silver",
"requirements": ["pymodbus>=3.6.8"],
"version": "1.5.6"
"requirements": ["pymodbus>=3.7.4"],
"version": "1.6.0"
}
22 changes: 13 additions & 9 deletions custom_components/solis_modbus/modbus_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

_LOGGER = logging.getLogger(__name__)


class ModbusController:
def __init__(self, host, port=502, poll_interval=15):
self.host = host
Expand All @@ -29,9 +28,15 @@ async def connect(self):

if not await self.client.connect():
self.connect_failures += 1
_LOGGER.warning(
f"Failed to connect to Modbus device. Will retry, failures = {self.connect_failures}")
return False # Return False if connection fails
fail_msg = f"Failed to connect to Modbus device. Will retry, failures = {self.connect_failures}"
if self.connect_failures > 50:
_LOGGER.warning(fail_msg)
elif self.connect_failures > 30:
_LOGGER.info(fail_msg)
else:
_LOGGER.debug(fail_msg)
return False

else:
self.connect_failures = 0
return True
Expand All @@ -40,12 +45,11 @@ async def connect(self):
_LOGGER.debug(f"Failed to connect to Modbus device. Will retry. Exception: {str(e)}")
return False # Return False if an exception occurs


async def async_read_input_register(self, register, count=1):
try:
await self.connect()
async with self._lock:
result = await self.client.read_input_registers(register, count, slave=1)
result = await self.client.read_input_registers(address=register, count=count, slave=1)
_LOGGER.debug(f'register value, register = {register}, result = {result.registers}')
return result.registers
except Exception as e:
Expand All @@ -56,7 +60,7 @@ async def async_read_holding_register(self, register: int, count=1):
try:
await self.connect()
async with self._lock:
result = await self.client.read_holding_registers(register, count, slave=1)
result = await self.client.read_holding_registers(address=register, count=count, slave=1)
_LOGGER.debug(f'holding register value, register = {register}, result = {result.registers}')
return result.registers
except Exception as e:
Expand All @@ -67,7 +71,7 @@ async def async_write_holding_register(self, register: int, value):
try:
await self.connect()
async with self._lock:
result = await self.client.write_register(register, value, slave=1)
result = await self.client.write_register(address=register, value=value, slave=1)
return result
except Exception as e:
_LOGGER.debug(f"Failed to write Modbus holding register ({register}): {str(e)}")
Expand All @@ -77,7 +81,7 @@ async def async_write_holding_registers(self, start_register: int, values: list[
try:
await self.connect()
async with self._lock:
result = await self.client.write_registers(start_register, values, slave=1)
result = await self.client.write_registers(address=start_register, values=values, slave=1)
return result
except Exception as e:
_LOGGER.debug(
Expand Down
68 changes: 61 additions & 7 deletions custom_components/solis_modbus/sensor.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, asyn

inverter_type = config_entry.data.get("type", "hybrid")

if inverter_type == "string":
if inverter_type in ["string", "grid"]:
from .data.string_sensors import string_sensors as sensors
from .data.string_sensors import string_sensors_derived as sensors_derived
elif inverter_type == "hybrid-waveshare":
from .data.hybrid_waveshare_sensors import hybrid_waveshare as sensors
from .data.hybrid_waveshare_sensors import hybrid_wavesahre_sensors_derived as sensors_derived
else:
from .data.hybrid_sensors import hybrid_sensors as sensors
from .data.hybrid_sensors import hybrid_sensors_derived as sensors_derived
Expand Down Expand Up @@ -166,6 +169,51 @@ async def clock_drift_test(hass, controller, hours, minutes, seconds):
hass.data[DOMAIN][DRIFT_COUNTER] = 0


def decode_inverter_model(hex_value):
"""
Decodes an inverter model code into its protocol version and description.

:param hex_value: The hexadecimal or decimal inverter model code.
:return: A tuple (protocol_version, model_description)
"""
# Convert hexadecimal string to integer if necessary
if isinstance(hex_value, str):
hex_value = int(hex_value, 16)

# Extract high byte (protocol version) and low byte (inverter model)
protocol_version = (hex_value >> 8) & 0xFF
inverter_model = hex_value & 0xFF

# Inverter model mapping based on provided table
inverter_models = {
0x00: "No definition",
0x10: "1-Phase Grid-Tied Inverter (0.7-8K1P / 7-10K1P)",
0x20: "3-Phase Grid-Tied Inverter (3-20K 3P)",
0x21: "3-Phase Grid-Tied Inverter (25-50K / 50-70K / 80-110K / 90-136K / 125K / 250K)",
0x70: "External EPM Device",
0x30: "1-Phase LV Hybrid Inverter",
0x31: "1-Phase LV AC Coupled Energy Storage Inverter",
0x32: "5-15kWh All-in-One Hybrid",
0x40: "1-Phase HV Hybrid Inverter",
0x50: "3-Phase LV Hybrid Inverter",
0x60: "3-Phase HV Hybrid Inverter (5G)",
0x70: "S6 3-Phase HV Hybrid (5-10kW)",
0x71: "S6 3-Phase HV Hybrid (12-20kW)",
0x72: "S6 3-Phase LV Hybrid (10-15kW)",
0x73: "S6 3-Phase HV Hybrid (50kW)",
0x80: "1-Phase HV Hybrid Inverter (S6)",
0x90: "1-Phase LV Hybrid Inverter (S6)",
0x91: "S6 1-Phase LV AC Coupled Hybrid",
0xA0: "OGI Off-Grid Inverter",
0xA1: "S6 1-Phase LV Off-Grid Hybrid",
}

# Get model description or default to "Unknown Model"
model_description = inverter_models.get(inverter_model, "Unknown Model")

return protocol_version, model_description


class SolisDerivedSensor(RestoreSensor, SensorEntity):
"""Representation of a Modbus derived/calculated sensor."""

Expand Down Expand Up @@ -237,17 +285,23 @@ def update(self):
else:
n_value = 0

# set after
if '35000' in self._register:
protocol_version, model_description = decode_inverter_model(n_value)
self._modbus_controller._sw_version = protocol_version
self._modbus_controller._model = model_description
n_value = model_description + f"(Protocol {protocol_version})"

if isinstance(n_value, Number):
self._attr_available = True
self._attr_native_value = n_value * self._display_multiplier
self._state = n_value * self._display_multiplier
self.schedule_update_ha_state()

# set after
if '36014' in self._register:
self._modbus_controller._sw_version = self._state
if '36013' in self._register:
self._modbus_controller._model = self._state
if isinstance(n_value, str):
self._attr_available = True
self._attr_native_value = n_value
self._state = n_value
self.schedule_update_ha_state()

except ValueError as e:
self._state = None
Expand Down
41 changes: 41 additions & 0 deletions custom_components/solis_modbus/time.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,47 @@ async def async_setup_entry(hass, config_entry: ConfigEntry, async_add_devices):
{"type": "STE", "name": "Solis Time-Charging Charge End (Slot 3)", "register": 43165, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 3)", "register": 43167, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 3)", "register": 43169, "enabled": True},

{"type": "STE", "name": "Solis Time-Charging Charge Start (Slot 4)", "register": 43173, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Charge End (Slot 4)", "register": 43175, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 4)", "register": 43177, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 4)", "register": 43179, "enabled": True},

{"type": "STE", "name": "Solis Time-Charging Charge Start (Slot 5)", "register": 43183, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Charge End (Slot 5)", "register": 43185, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 5)", "register": 43187, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 5)", "register": 43189, "enabled": True},


{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 1)", "register": 43711, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 1)", "register": 43713, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 1)", "register": 43753, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 1)", "register": 43755, "enabled": True},

{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 2)", "register": 43718, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 2)", "register": 43720, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 2)", "register": 43760, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 2)", "register": 43762, "enabled": True},

{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 3)", "register": 43725, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 3)", "register": 43727, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge Start (Slot 3)", "register": 43767, "enabled": True},
{"type": "STE", "name": "Solis Time-Charging Discharge End (Slot 3)", "register": 43769, "enabled": True},

{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 4)", "register": 43732, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 4)", "register": 43734, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge Start (Slot 4)", "register": 43774, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge End (Slot 4)", "register": 43776, "enabled": True},

{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 5)", "register": 43739, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 5)", "register": 43741, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge Start (Slot 5)", "register": 43781, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge End (Slot 5)", "register": 43783, "enabled": True},

{"type": "STE", "name": "Solis Grid Time of Use Charge Start (Slot 6)", "register": 43746, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge End (Slot 6)", "register": 43748, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge Start (Slot 6)", "register": 43788, "enabled": True},
{"type": "STE", "name": "Solis Grid Time of Use Charge Discharge End (Slot 6)", "register": 43790, "enabled": True},
]

for entity_definition in timeent:
Expand Down
8 changes: 3 additions & 5 deletions solis_modbus.iml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@
<module type="WEB_MODULE" version="4">
<component name="FacetManager">
<facet type="Python" name="Python">
<configuration sdkName="Python 3.12" />
<configuration sdkName="Python 3.12 (solis-modbus)" />
</facet>
</component>
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/venv" />
</content>
<content url="file://$MODULE_DIR$" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Python 3.12 interpreter library" level="application" />
<orderEntry type="library" name="Python 3.12 (solis-modbus) interpreter library" level="application" />
</component>
</module>
Loading