Important features for driver

[Dexter9532]

Draft to add the remaining of the most important functions for the driver.

[mirzak]

Did a review of just the two first commits, will leave it at that for now.

Regarding your commit messages,

feat(hz): Add getter to read Hertz 

I would write something along the lines of:

feat: Add Hz property

[mirzak]

This should be 0x000F

[mirzak]

Please put these changes in a separate commit as they are not related to adding Hz property.

[mirzak]

Testing this once is enough, and there is no need to repeat it for every property.

[mirzak]

The original was intended, i.e printing out the full address with zeroes. Also this change is not related to adding Hz property.

[mirzak]

This is a very common structure, could be worth simplifying to something like:

diff --git a/src/em511/em511.py b/src/em511/em511.py
index 4da7c7e..dbdaf99 100644
--- a/src/em511/em511.py
+++ b/src/em511/em511.py
@@ -121,6 +121,11 @@ class Em511:
         msg = f"Unexpected register count: {len(regs)}."
         raise ValueError(msg)
 
+    def _read_register(self, address: int, count: int, scale: int, decimals: int) -> Decimal:^M
+        regs = self._read_input_registers(address, count)^M
+        value = Decimal(self._unpack(regs, address)) / scale^M
+        return round(value, decimals)^M
+^M
     @property
     def V(self) -> Decimal:
         """Voltage (V).
@@ -132,9 +137,9 @@ class Em511:
             ValueError: If input is at max value or above.
             ModbusException: If failed to read input register.
         """
-        regs = self._read_input_registers(self.EM511_REGISTER_V, self.INT32_REG_COUNT)
-        value = Decimal(self._unpack(regs, self.EM511_REGISTER_V)) / self.SCALE_10
-        return round(value, 1)
+        return self._read_register(^M
+            address=self.EM511_REGISTER_V, count=self.INT32_REG_COUNT, scale=self.SCALE_10, decimals=1^M
+        )^M
 
     @property
     def A(self) -> Decimal:

---

Another alternative,

diff --git a/src/em511/em511.py b/src/em511/em511.py
index 4da7c7e..424a27c 100644
--- a/src/em511/em511.py
+++ b/src/em511/em511.py
@@ -1,12 +1,22 @@
 # ruff: noqa: N802
 """Driver class for EM511."""
 
+from dataclasses import dataclass^M
 from decimal import Decimal
+from typing import Dict^M
 
 from pymodbus.client import ModbusSerialClient
 from pymodbus.exceptions import ModbusException
 
 
+@dataclass(frozen=True)^M
+class RegisterSpec:^M
+    address: int^M
+    count: int^M
+    scale: int^M
+    decimals: int^M
+^M
+^M
 class Em511:
     """Driver for Carlo Gavazzi EM511 series energy meters.
 
@@ -26,13 +36,10 @@ class Em511:
     INPUT_MAX_VALUE_32 = 0x7FFFFFFF
     INPUT_MAX_VALUE_16 = 0x7FFF
 
-    EM511_REGISTER_V = 0x0000
-    EM511_REGISTER_A = 0x0002
-    EM511_REGISTER_PASSWORD = 0x1000
-
-    SCALE_10 = 10
-    SCALE_100 = 100
-    SCALE_1000 = 1000
+    _register_specs: Dict = {^M
+        "V": RegisterSpec(address=0x0000, count=INT32_REG_COUNT, scale=10, decimals=1),^M
+        "A": RegisterSpec(address=0x0002, count=INT32_REG_COUNT, scale=10, decimals=1),^M
+    }^M
 
     def __init__(self, device_address: int, client: ModbusSerialClient) -> None:
         """Initialize an Em511 driver instance with an existing Modbus client.
@@ -121,6 +128,12 @@ class Em511:
         msg = f"Unexpected register count: {len(regs)}."
         raise ValueError(msg)
 
+    def _read_register(self, register_name: str) -> Decimal:^M
+        spec = self._register_specs[register_name]^M
+        regs = self._read_input_registers(spec.address, spec.count)^M
+        value = Decimal(self._unpack(regs, spec.address)) / spec.scale^M
+        return round(value, spec.decimals)^M
+^M
     @property
     def V(self) -> Decimal:
         """Voltage (V).
@@ -131,10 +144,9 @@ class Em511:
         Raises:
             ValueError: If input is at max value or above.
             ModbusException: If failed to read input register.
+            KeyError: If register name is invalid.^M
         """
-        regs = self._read_input_registers(self.EM511_REGISTER_V, self.INT32_REG_COUNT)
-        value = Decimal(self._unpack(regs, self.EM511_REGISTER_V)) / self.SCALE_10
-        return round(value, 1)
+        return self._read_register("V")^M
 
     @property
     def A(self) -> Decimal:

[mirzak]

This one is interesting (fun exercise to figure out how it works :)):

diff --git a/src/em511/em511.py b/src/em511/em511.py
index 4da7c7e..9493832 100644
--- a/src/em511/em511.py
+++ b/src/em511/em511.py
@@ -1,12 +1,37 @@
 # ruff: noqa: N802
 """Driver class for EM511."""
 
+from dataclasses import dataclass^M
 from decimal import Decimal
+from typing import Dict^M
 
 from pymodbus.client import ModbusSerialClient
 from pymodbus.exceptions import ModbusException
 
 
+def register_properties(cls):^M
+    """Class decorator that auto-generates @property accessors for registers."""^M
+    for name in cls._register_specs:^M
+^M
+        def prop(self, _name=name):  # default arg binds current name^M
+            """Auto-generated register reader."""^M
+            return self._read_register(_name)^M
+^M
+        prop.__name__ = name^M
+        prop.__doc__ = f"{name} measurement."^M
+        setattr(cls, name, property(prop))^M
+    return cls^M
+^M
+^M
+@dataclass(frozen=True)^M
+class RegisterSpec:^M
+    address: int^M
+    count: int^M
+    scale: int^M
+    decimals: int^M
+^M
+^M
+@register_properties^M
 class Em511:
     """Driver for Carlo Gavazzi EM511 series energy meters.
 
@@ -26,13 +51,10 @@ class Em511:
     INPUT_MAX_VALUE_32 = 0x7FFFFFFF
     INPUT_MAX_VALUE_16 = 0x7FFF
 
-    EM511_REGISTER_V = 0x0000
-    EM511_REGISTER_A = 0x0002
-    EM511_REGISTER_PASSWORD = 0x1000
-
-    SCALE_10 = 10
-    SCALE_100 = 100
-    SCALE_1000 = 1000
+    _register_specs: Dict = {^M
+        "V": RegisterSpec(address=0x0000, count=INT32_REG_COUNT, scale=10, decimals=1),^M
+        "A": RegisterSpec(address=0x0002, count=INT32_REG_COUNT, scale=1000, decimals=1),^M
+    }^M
 
     def __init__(self, device_address: int, client: ModbusSerialClient) -> None:
         """Initialize an Em511 driver instance with an existing Modbus client.
@@ -121,70 +143,8 @@ class Em511:
         msg = f"Unexpected register count: {len(regs)}."
         raise ValueError(msg)
 
-    @property
-    def V(self) -> Decimal:
-        """Voltage (V).
-
-        Returns:
-            Decimal: Current voltage value.
-
-        Raises:
-            ValueError: If input is at max value or above.
-            ModbusException: If failed to read input register.
-        """
-        regs = self._read_input_registers(self.EM511_REGISTER_V, self.INT32_REG_COUNT)
-        value = Decimal(self._unpack(regs, self.EM511_REGISTER_V)) / self.SCALE_10
-        return round(value, 1)
-
-    @property
-    def A(self) -> Decimal:
-        """Current (A).
-
-        Returns:
-            Decimal: Current ampere value.
-
-        Raises:
-            ValueError: If input is at max value or above.
-            ModbusException: If failed to read input register.
-        """
-        regs = self._read_input_registers(self.EM511_REGISTER_A, self.INT32_REG_COUNT)
-        value = Decimal(self._unpack(regs, self.EM511_REGISTER_A)) / self.SCALE_1000
-        return round(value, 3)
-
-    @property
-    def password(self) -> int:
-        """Password.
-
-        Returns:
-            int: Current password value.
-
-        Raises:
-            ValueError: If input is at max value or above.
-            ValueError: If password is out of range.
-            ModbusException: If failed to read input register.
-        """
-        regs = self._read_input_registers(self.EM511_REGISTER_PASSWORD, self.INT16_REG_COUNT)
-        value = self._unpack(regs, self.EM511_REGISTER_PASSWORD)
-        if not (self.PASSWORD_MIN_VALUE <= value <= self.PASSWORD_MAX_VALUE):
-            msg = f"Invalid password value: {value}. Must be between 0 and 9999."
-            raise ValueError(msg)
-        return value
-
-    @password.setter
-    def password(self, value: int) -> None:
-        """Password.
-
-        Min value: 0 (no password).
-        Max value: 9999.
-
-        Args:
-            value (int): Set Password.
-
-        Raises:
-            ModbusException: If failed to write to single register.
-            ValueError: If password value is out of range.
-        """
-        if not (self.PASSWORD_MIN_VALUE <= value <= self.PASSWORD_MAX_VALUE):
-            msg = f"Invalid password value: {value}. Must be between 0 and 9999."
-            raise ValueError(msg)
-        self._write_register(self.EM511_REGISTER_PASSWORD, value)
+    def _read_register(self, register_name: str) -> Decimal:^M
+        spec = self._register_specs[register_name]^M
+        regs = self._read_input_registers(spec.address, spec.count)^M
+        value = Decimal(self._unpack(regs, spec.address)) / spec.scale^M
+        return round(value, spec.decimals)^M

[mirzak]

Superseded by #43