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.

Sign up for GitHub

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

Move modbus string helper #634

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Move modbus string helper #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de37718
Move string helper into class
WillCodeForCats Jan 29, 2024
d443feb
Merge branch 'main' into modbus-string-helper
WillCodeForCats Apr 2, 2024
fd3865f
Merge branch 'main' into modbus-string-helper
WillCodeForCats Jul 24, 2024
5413afe
Update hub.py
WillCodeForCats Jul 24, 2024
9066392
Format with black
WillCodeForCats Jul 24, 2024
6398d2f
Merge branch 'main' into modbus-string-helper
WillCodeForCats Dec 20, 2024
a119d46
mbstr as static method
WillCodeForCats Dec 20, 2024
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
6 changes: 0 additions & 6 deletions custom_components/solaredge_modbus_multi/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@ def float_to_hex(f):
raise TypeError(e)


def parse_modbus_string(s: str) -> str:
s = s.decode(encoding="utf-8", errors="ignore")
s = s.replace("\x00", "").rstrip()
return str(s)


def update_accum(self, accum_value: int) -> None:
if self.last is None:
self.last = 0
Expand Down
52 changes: 30 additions & 22 deletions custom_components/solaredge_modbus_multi/hub.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
SolarEdgeTimeouts,
SunSpecNotImpl,
)
from .helpers import float_to_hex, parse_modbus_string
from .helpers import float_to_hex

_LOGGER = logging.getLogger(__name__)
pymodbus_version = importlib.metadata.version("pymodbus")
Expand Down Expand Up @@ -102,6 +102,16 @@ class DeviceInvalid(SolarEdgeException):
pass


class SolarEdgeModbusDevice:
"""Base class for SolarEdge modbus devices."""

@staticmethod
def mbstr(s: str) -> str:
s = s.decode(encoding="utf-8", errors="ignore")
s = s.replace("\x00", "").rstrip()
return str(s)


class SolarEdgeModbusMultiHub:
def __init__(
self,
Expand Down Expand Up @@ -743,7 +753,7 @@ def is_connected(self) -> bool:
return self._client.connected


class SolarEdgeInverter:
class SolarEdgeInverter(SolarEdgeModbusDevice):
"""Defines a SolarEdge inverter."""

def __init__(self, device_id: int, hub: SolarEdgeModbusMultiHub) -> None:
Expand Down Expand Up @@ -780,14 +790,14 @@ async def init_device(self) -> None:
("C_SunSpec_Length", decoder.decode_16bit_uint()),
(
"C_Manufacturer",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("C_Model", parse_modbus_string(decoder.decode_string(32))),
("C_Option", parse_modbus_string(decoder.decode_string(16))),
("C_Version", parse_modbus_string(decoder.decode_string(16))),
("C_Model", self.mbstr(decoder.decode_string(32))),
("C_Option", self.mbstr(decoder.decode_string(16))),
("C_Version", self.mbstr(decoder.decode_string(16))),
(
"C_SerialNumber",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("C_Device_address", decoder.decode_16bit_uint()),
]
Expand Down Expand Up @@ -903,9 +913,7 @@ async def read_modbus_data(self) -> None:
inverter_data.registers, byteorder=Endian.BIG
)

self.decoded_common["C_Version"] = parse_modbus_string(
decoder.decode_string(16)
)
self.decoded_common["C_Version"] = self.mbstr(decoder.decode_string(16))

inverter_data = await self.hub.modbus_read_holding_registers(
unit=self.inverter_unit_id, address=40069, rcount=40
Expand Down Expand Up @@ -1017,7 +1025,7 @@ async def read_modbus_data(self) -> None:
("ID", decoder.decode_16bit_uint()),
(
"IDStr",
parse_modbus_string(decoder.decode_string(16)),
self.mbstr(decoder.decode_string(16)),
),
("DCA", decoder.decode_16bit_uint()),
("DCV", decoder.decode_16bit_uint()),
Expand Down Expand Up @@ -1497,7 +1505,7 @@ def mmppt_idstr(self) -> str:
return self.inverter.decoded_model[self.mmppt_key]["IDStr"]


class SolarEdgeMeter:
class SolarEdgeMeter(SolarEdgeModbusDevice):
"""Defines a SolarEdge meter."""

def __init__(
Expand Down Expand Up @@ -1550,14 +1558,14 @@ async def init_device(self) -> None:
("C_SunSpec_Length", decoder.decode_16bit_uint()),
(
"C_Manufacturer",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("C_Model", parse_modbus_string(decoder.decode_string(32))),
("C_Option", parse_modbus_string(decoder.decode_string(16))),
("C_Version", parse_modbus_string(decoder.decode_string(16))),
("C_Model", self.mbstr(decoder.decode_string(32))),
("C_Option", self.mbstr(decoder.decode_string(16))),
("C_Version", self.mbstr(decoder.decode_string(16))),
(
"C_SerialNumber",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("C_Device_address", decoder.decode_16bit_uint()),
]
Expand Down Expand Up @@ -1744,7 +1752,7 @@ def via_device(self, device: str) -> None:
self._via_device = (DOMAIN, device)


class SolarEdgeBattery:
class SolarEdgeBattery(SolarEdgeModbusDevice):
"""Defines a SolarEdge battery."""

def __init__(
Expand Down Expand Up @@ -1780,13 +1788,13 @@ async def init_device(self) -> None:
[
(
"B_Manufacturer",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("B_Model", parse_modbus_string(decoder.decode_string(32))),
("B_Version", parse_modbus_string(decoder.decode_string(32))),
("B_Model", self.mbstr(decoder.decode_string(32))),
("B_Version", self.mbstr(decoder.decode_string(32))),
(
"B_SerialNumber",
parse_modbus_string(decoder.decode_string(32)),
self.mbstr(decoder.decode_string(32)),
),
("B_Device_Address", decoder.decode_16bit_uint()),
("ignore", decoder.skip_bytes(2)),
Expand Down
Loading