tinytoolslib 0.6.0__tar.gz → 0.7.2__tar.gz

{tinytoolslib-0.6.0 → tinytoolslib-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinytoolslib
-Version: 0.6.0
+Version: 0.7.2
 Summary: Set of tools for use with tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
 Author-email: Bartek Barszczewski <tinycontrol.software@gmail.com>
 License-Expression: Apache-2.0

{tinytoolslib-0.6.0 → tinytoolslib-0.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinytoolslib"
-version = "0.6.0"
+version = "0.7.2"
 authors = [
     { name="Bartek Barszczewski", email="tinycontrol.software@gmail.com" },
 ]

tinytoolslib-0.7.2/tinytoolslib/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.7.2'

{tinytoolslib-0.6.0 → tinytoolslib-0.7.2}/tinytoolslib/constants.py

@@ -38,3 +38,4 @@ class DeviceFamily(str, Enum):
     PS = "PS"  # Power socket
     DCDC = "DCDC"  # Converter DC/DC
     TCPDU = "tcPDU"
+    EM = "EM"  # Energy Monitor

{tinytoolslib-0.6.0 → tinytoolslib-0.7.2}/tinytoolslib/models.py

@@ -246,6 +246,22 @@ class DeviceModel(ABC):
             f"{self.__class__.__name__} does not support controlling PWMs"
         )
 
+    async def async_set_pwm_duty(self, index, value):
+        """Async set_pwm_duty."""
+        if callable(getattr(self, "_set_pwm_duty", None)):
+            return await self.async_get(self._set_pwm_duty(index, value))
+        raise TinyToolsUnsupported(
+            f"{self.__class__.__name__} does not support controlling PWMs duty"
+        )
+
+    async def async_set_pwm_freq(self, index, value):
+        """Async set_pwm_freq."""
+        if callable(getattr(self, "_set_pwm_freq", None)):
+            return await self.async_get(self._set_pwm_freq(index, value))
+        raise TinyToolsUnsupported(
+            f"{self.__class__.__name__} does not support controlling PWMs frequency"
+        )
+
     async def async_set_var(self, index, value):
         """Async set_var."""
         if callable(getattr(self, "_set_var", None)):
@@ -254,6 +270,14 @@ class DeviceModel(ABC):
             f"{self.__class__.__name__} does not support controlling VARs"
         )
 
+    async def async_set_ds(self, index, value):
+        """Async set_ds."""
+        if callable(getattr(self, "_set_ds", None)):
+            return await self.async_get(self._set_ds(index, value))
+        raise TinyToolsUnsupported(
+            f"{self.__class__.__name__} does not support setting DSs"
+        )
+
     async def async_get_all(self, remove_mapped_keys: bool = False) -> Dict[str, Any]:
         """Async get_all."""
         if callable(getattr(self, "_get_all", None)):
@@ -265,6 +289,22 @@ class DeviceModel(ABC):
             f"{self.__class__.__name__} does not support get_all command"
         )
 
+    async def async_reset_to_defaults(self):
+        """Async reset_to_defaults."""
+        if callable(getattr(self, "_reset_to_defaults", None)):
+            return await self.async_get(self._reset_to_defaults())
+        raise TinyToolsUnsupported(
+            f"{self.__class__.__name__} does not support reset to defaults"
+        )
+
+    async def async_restart(self):
+        """Async restart."""
+        if callable(getattr(self, "_restart", None)):
+            return await self.async_get(self._restart())
+        raise TinyToolsUnsupported(
+            f"{self.__class__.__name__} does not support restart command"
+        )
+
     # endregion
 
 
@@ -470,7 +510,7 @@ class LK_HW_20_PS(DeviceModel):
         """Parse outputs OUT with including negation."""
         # Parser is called post mapping so original keys might be missing already.
         if "out_negation" in data:
-            self._context["out_negation"] = int(data.get("out_negation"))
+            self._context["out_negation"] = bool(int(data.get("out_negation")))
         if "out0" in data:
             out_negation = self._context.get("out_negation")
             number_of_outputs = self.info.extras["number_of_outputs"]
@@ -546,7 +586,7 @@ class LK_HW_20_PS(DeviceModel):
                 index,
                 value,
                 operator.xor(
-                    self._context["out_negation"], self.info.extras["outputs_inverted"]
+                    self._context.get("out_negation", False), self.info.extras["outputs_inverted"]
                 ),
                 False,
             )
@@ -691,6 +731,11 @@ class LK_HW_20(LK_HW_20_PS):
         self.get("/ind.cgi?ds=0")
         return self.get("/board.xml").get("ds_read_id")
 
+    async def async_get_ds_id(self) -> str:
+        """Get ID of detected DS."""
+        await self.async_get("/ind.cgi?ds=0")
+        return await self.async_get("/board.xml").get("ds_read_id")
+
 
 @dataclass
 class LK_HW_25(LK_HW_20):
@@ -1019,7 +1064,7 @@ class LK_HW_30(DeviceModel):
     def _parse_outs(self, data: Dict[str, Any], path: str) -> None:
         """Parse outputs OUT including negation."""
         if "outnn" in data:
-            self._context["out_negation"] = int(data.get("outnn"))
+            self._context["out_negation"] = bool(int(data.get("outnn")))
         if "out0" in data:
             out_negation = self._context.get("out_negation")
             for name in name_list("out", self.info.extras["number_of_outputs"], 0):
@@ -1056,7 +1101,7 @@ class LK_HW_30(DeviceModel):
         so value=1 will actually set 0 and value=0 set 1.
         """
         cmd = set_cmd_helper(
-            self, "/outs.cgi?", "out", index, value, self._context["out_negation"], True
+            self, "/outs.cgi?", "out", index, value, self._context.get("out_negation", False), True
         )
         return cmd
 
@@ -1140,6 +1185,11 @@ class LK_HW_30(DeviceModel):
         self.get("/stm.cgi?dswrite=0")
         return self.get("/json/dsi2c.json").get("ds_read_id")
 
+    async def async_get_ds_id(self) -> str:
+        """Get ID of detected DS."""
+        await self.async_get("/stm.cgi?dswrite=0")
+        return await self.async_get("/json/dsi2c.json").get("ds_read_id")
+
     def _get_all(self) -> List[str]:
         """Prepare list of URLs to fetch data from."""
         urls = ["/json/all.json", "/json/pwmpid.json"]
@@ -1157,14 +1207,14 @@ class LK_HW_30(DeviceModel):
         """Prepare command to restart device."""
         return "/stm.cgi?lk3restart=1"
 
-    def set_analog_input(
+    def _set_analog_input(
         self,
         index: Union[int, List[int]],
         sensor: Union[int, List[int]],
         calibration: Union[int, List[int], None] = None,
         multiplier: Union[float, List[float], None] = None,
-    ) -> Dict[str, Any]:
-        """Set sensor, calibration and multiplier for analog input.
+    ) -> str:
+        """Prepare command for setting sensor, calibration and multiplier for analog input.
 
         Arguments:
             index: 1-6 (analog input index)
@@ -1206,7 +1256,27 @@ class LK_HW_30(DeviceModel):
                 False,
                 "{cmd_param}={index}{value}",
             )
-        return self.get(cmd)
+        return cmd
+
+    def set_analog_input(
+        self,
+        index: Union[int, List[int]],
+        sensor: Union[int, List[int]],
+        calibration: Union[int, List[int], None] = None,
+        multiplier: Union[float, List[float], None] = None,
+    ) -> Dict[str, Any]:
+        """Set sensor, calibration and multiplier for analog input."""
+        return self.get(self._set_analog_input(index, sensor, calibration, multiplier))
+
+    async def async_set_analog_input(
+        self,
+        index: Union[int, List[int]],
+        sensor: Union[int, List[int]],
+        calibration: Union[int, List[int], None] = None,
+        multiplier: Union[float, List[float], None] = None,
+    ) -> Dict[str, Any]:
+        """Set sensor, calibration and multiplier for analog input."""
+        return await self.async_get(self._set_analog_input(index, sensor, calibration, multiplier))
 
 
 @dataclass
@@ -1363,7 +1433,7 @@ class LK_HW_40(DeviceModel):
     def _parse_outs(self, data: Dict[str, Any], path: str) -> None:
         """Parse outputs OUT including negation."""
         if "outNegation" in data:
-            self._context["out_negation"] = data.get("outNegation")
+            self._context["out_negation"] = bool(data.get("outNegation"))
         if "out1" in data:
             out_negation = self._context.get("out_negation")
             for name in name_list("out", self.info.extras["number_of_outputs"]):
@@ -1388,7 +1458,7 @@ class LK_HW_40(DeviceModel):
             "out",
             index,
             value,
-            self._context["out_negation"],
+            self._context.get("out_negation", False),
             True,
         )
         return cmd
@@ -1456,6 +1526,11 @@ class LK_HW_40(DeviceModel):
         self.get("/api/v1/save/?dsReadID=0")
         return self.get("/api/v1/read/status/?dsValues").get("dsReadID")
 
+    async def async_get_ds_id(self) -> str:
+        """Get ID of detected DS."""
+        await self.async_get("/api/v1/save/?dsReadID=0")
+        return await self.async_get("/api/v1/read/status/?dsValues").get("dsReadID")
+
     def _get_all(self) -> List[str]:
         """Prepare list of URLs to fetch data from."""
         return [
@@ -1549,7 +1624,91 @@ class LK_HW_40_mini(LK_HW_40):
         ]
 
 
+@dataclass
+class LK_EM(LK_HW_40):
+    """Device model for LK Energy Monitor.
+
+    It has most of LK4 functions with following differences:
+    - built in 3 phase power/energy meter
+    - 5 outputs instead of 6, 2-4 have PWM mode, 5th has 0-10V mode, no negation
+    - no PWMs
+    - no INPAs
+    - no INPDs
+    - built in energy meter calibration in Power and energy
+    - no Watchdog
+    - no remote control
+    - no serial port
+    - no LTE modem
+    """
+
+    info: ClassVar[Union[DeviceInfo, None]] = DeviceInfo(
+        "LK Energy Monitor",
+        DeviceFamily.EM,
+        "lkem",
+        "https://tinycontrol.pl/en/lkem/downloads/#firmware",
+        fw_update_method=FWUpdateMethod.HTTP,
+        extras={"number_of_outputs": 5},
+    )
+    parsers: ClassVar[List[str]] = []
+
+    @classmethod
+    def check_version(
+        cls, hardware_version: Union[str, None], software_version: str
+    ) -> bool:
+        return hardware_version in ["1.0"] and software_version.endswith("EM")
+
+    # Unset few commands - there are no PWM in LK EM (well OUT have PWM mode)
+    _set_pwm = None
+
+    def _set_pwm_duty(
+        self, index: Union[int, List[int]], value: Union[int, List[int]]
+    ) -> str:
+        """Prepare command for setting PWM duty for OUT2-4 in PWM mode (outModeX=1).
+
+        Arguments:
+            index: 2-4 (single or list)
+            value: 0-100 (single or list)
+        """
+        cmd = set_cmd_helper(self, "/api/v1/save/?", "outDuty", index, value, False, False)
+        return cmd
+
+    def _set_pwm_freq(self, index: Union[int, List[int]], value: Union[int, List[int]]) -> str:
+        """Prepare command for setting PWM freq for OUT2-4 and OUT5.
+
+        Arguments:
+            index: 1-2 (single or list; 1 - OUT2-4, 2 - OUT5)
+            value: 1-1_000_000
+        """
+        cmd = set_cmd_helper(self, "/api/v1/save/?", "outFrequency", index, value, False, False)
+        return cmd
+
+    def _set_out_level(self, value: float) -> str:
+        """Set OUT5 level (indirectly by PWM duty) to value.
+
+        Arguments:
+            value: 0.0-10.0 with 0.1 step
+        """
+        cmd = "/api/v1/save/?outLevel5={:.1f}".format(value)
+        return cmd
+
+    def _get_all(self) -> List[str]:
+        """Prepare list of URLs to fetch data from."""
+        return [
+            "/api/v1/read/set/?generalConfig&outConfig&powerConfig&networkConfig",
+            "/api/v1/read/status/?boardValues&statusValues&timeValues&outValues&dsValues&i2cValues&otherSensorsValues&diffValues&powerValues&mrValues&varValues&meterValues",
+        ]
+
+    def set_out_level(self, value):
+        """Set out level for PWM mode."""
+        return self.get(self._set_out_level(value))
+
+    async def async_set_out_level(self, value):
+        """Async set_out_level."""
+        return await self.async_get(self._set_out_level(value))
+
+
 DEVICE_MODELS = [
+    LK_EM,
     LK_HW_40_mini,
     TCPDU,
     LK_HW_40,

{tinytoolslib-0.6.0 → tinytoolslib-0.7.2}/tinytoolslib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinytoolslib
-Version: 0.6.0
+Version: 0.7.2
 Summary: Set of tools for use with tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
 Author-email: Bartek Barszczewski <tinycontrol.software@gmail.com>
 License-Expression: Apache-2.0

tinytoolslib-0.6.0/tinytoolslib/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.6.0'