Show more command data

.gitignore

@@ -3,4 +3,4 @@ venv/
 __pycache__/
 dist/
 **/*.egg-info/
-test.py
+test*

README.md

@@ -1,12 +1,24 @@
 **This python package is unofficial and is not related in any way to Haier. It was developed by reversed engineered requests and can stop working at anytime!**
 
 # pyhOn
+[![PyPI - Status](https://img.shields.io/pypi/status/pyhOn)](https://pypi.org/project/pyhOn)
+[![PyPI](https://img.shields.io/pypi/v/pyhOn?color=blue)](https://pypi.org/project/pyhOn)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyhOn)](https://www.python.org/)
+[![PyPI - License](https://img.shields.io/pypi/l/pyhOn)](https://github.com/Andre0512/pyhOn/blob/main/LICENSE)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyhOn)](https://pypistats.org/packages/pyhon)  
 Control your Haier appliances with python!
+The idea behind this library is, to make the use of all available commands as simple as possible.
+
+## Installation
+```bash
+pip install pyhOn
+```
+
 ### Quick overview
-To see the available options of the appliances from your Haier Account, use the commandline-tool `pyhOn`
+To get an idea of what is possible, use the commandline-tool `pyhOn`. This command requests all available options of connected appliances from the hOn api of your Haier Account.
 ```commandline
 $ pyhOn --user example@mail.com --password pass123
-========== Waschmaschine ==========
+========== WM - Waschmaschine ==========
 commands:
   pauseProgram: pauseProgram command
   resumeProgram: resumeProgram command
@@ -37,7 +49,39 @@ asyncio.run(devices_example())
 ### Execute a command
 ```python
 async with HonConnection(USER, PASSWORD) as hon:
-    washing_machine = hon[0]
+    washing_machine = hon.devices[0]
     pause_command = washing_machine.commands["pauseProgram"]
     await pause_command.send()
 ```
+
+### Set command parameter
+Use `device.settings` to get all variable parameters.  
+Use `device.parmeters` to get also fixed parameters. 
+```python
+async with HonConnection(USER, PASSWORD) as hon:
+    washing_machine = hon.devices[0]
+    start_command = washing_machine.commands["startProgram"]
+    for name, setting in start_command.settings:
+        print("Setting", name)
+        print("Current value", setting.value)
+        if setting.typology == "enum":
+            print("Available values", setting.values)
+            setting.value = setting.values[0]
+        elif setting.typology == "range":
+            print("Min value", setting.min)
+            print("Max value", setting.max)
+            print("Step value", setting.step)
+            setting.value = setting.min + setting.step
+```
+
+## Tested devices
+- Haier Washing Machine HW90
+
+_Unfortunately I don't have any more Haier appliances..._
+
+## Usage example
+This library is used for the custom [HomeAssistant Integration "Haier hOn"](https://github.com/Andre0512/hOn).
+
+## Contribution
+Any kind of contribution is welcome!
+

pyhon/__main__.py

@@ -24,7 +24,7 @@ def get_arguments():
     return vars(parser.parse_args())
 
 
-# yaml.dump() would be done the same, but needs an additional import...
+# yaml.dump() would be done the same, but needs an additional dependency...
 def pretty_print(data, key="", intend=0, is_list=False):
     if type(data) is list:
         if key:
@@ -47,6 +47,18 @@ def pretty_print(data, key="", intend=0, is_list=False):
         print(f"{'  ' * intend}{'- ' if is_list else ''}{key}{': ' if key else ''}{data}")
 
 
+def create_command(commands):
+    result = {}
+    for name, command in commands.items():
+        result[name] = {}
+        for parameter, data in command.parameters.items():
+            if data.typology == "enum":
+                result[name][parameter] = data.values
+            if data.typology == "range":
+                result[name][parameter] = {"min": data.min, "max": data.max, "step": data.step}
+    return result
+
+
 async def main():
     args = get_arguments()
     if not (user := args["user"]):
@@ -55,7 +67,7 @@ async def main():
         password = getpass("Password for hOn account: ")
     async with HonConnection(user, password) as hon:
         for device in hon.devices:
-            print("=" * 10, device.nick_name, "=" * 10)
+            print("=" * 10, device.appliance_type_name, "-", device.nick_name, "=" * 10)
             pretty_print({"commands": device.commands})
             pretty_print({"data": device.data})
 

pyhon/api.py

@@ -84,7 +84,7 @@ class HonConnection:
                 return {}
             return result
 
-    async def load_attributes(self, device: HonDevice):
+    async def load_attributes(self, device: HonDevice, loop=False):
         params = {
             "macAddress": device.mac_address,
             "applianceType": device.appliance_type_name,
@@ -92,6 +92,10 @@ class HonConnection:
         }
         url = f"{const.API_URL}/commands/v1/context"
         async with self._session.get(url, params=params, headers=await self._headers) as response:
+            if response.status >= 400 and not loop:
+                _LOGGER.error("%s - Error %s - %s", url, response.status, await response.text)
+                await self.setup()
+                return await self.load_attributes(device, loop=True)
             return (await response.json()).get("payload", {})
 
     async def load_statistics(self, device: HonDevice):

pyhon/appliances/wm.py

@@ -0,0 +1,8 @@
+class Appliance:
+    def __init__(self, data):
+        self._data = data
+
+    def get(self):
+        if self._data["lastConnEvent.category"] == "DISCONNECTED":
+            self._data["machMode"] = "0"
+        return self._data

pyhon/commands.py

@@ -31,18 +31,15 @@ class HonCommand:
 
     @property
     def parameters(self):
-        result = {key: parameter.value for key, parameter in self._parameters.items()}
+        return self._parameters
-        if self._multi:
-            result |= {"program": self._category}
-        return result
 
     @property
     def ancillary_parameters(self):
         return {key: parameter.value for key, parameter in self._ancillary_parameters.items()}
 
     async def send(self):
-        return await self._connector.send_command(self._device, self._name, self.parameters,
+        parameters = {name: parameter.value for name, parameter in self._parameters}
-                                                  self.ancillary_parameters)
+        return await self._connector.send_command(self._device, self._name, parameters, self.ancillary_parameters)
 
     def get_programs(self):
         return self._multi
@@ -69,5 +66,6 @@ class HonCommand:
 
     @property
     def settings(self):
+        """Parameters with typology enum and range"""
         return {s: self._parameters[s] for s in self.setting_keys}
 

pyhon/device.py

@@ -1,9 +1,14 @@
+import importlib
+from pprint import pprint
+
 from pyhon.commands import HonCommand
 
 
 class HonDevice:
     def __init__(self, connector, appliance):
         self._appliance = appliance
+        for values in self._appliance.pop("attributes"):
+            self._appliance[values["parName"]] = values["parValue"]
         self._connector = connector
         self._appliance_model = {}
 
@@ -123,6 +128,10 @@ class HonDevice:
     def statistics(self):
         return self._statistics
 
+    @property
+    def appliance(self):
+        return self._appliance
+
     async def load_commands(self):
         raw = await self._connector.load_commands(self)
         self._appliance_model = raw.pop("applianceModel")
@@ -153,13 +162,15 @@ class HonDevice:
         result = {}
         for name, command in self._commands.items():
             for key, parameter in command.parameters.items():
-                result[f"{name}.{key}"] = parameter
+                result[f"{name}.{key}"] = parameter.value
         return result
 
     async def load_attributes(self):
         data = await self._connector.load_attributes(self)
         for name, values in data.get("shadow").get("parameters").items():
             self._attributes[name] = values["parNewVal"]
+        for name, value in data.get("lastConnEvent").items():
+            self._attributes[f"lastConnEvent.{name}"] = value
 
     async def load_statistics(self):
         self._statistics = await self._connector.load_statistics(self)
@@ -169,4 +180,9 @@ class HonDevice:
 
     @property
     def data(self):
-        return self.attributes | self.parameters | self._appliance | self._statistics
+        result = self.attributes | self.parameters | self.appliance | self._statistics
+        try:
+            extra = importlib.import_module(f'appliances.{self.appliance_type_name.lower()}')
+            return result | extra.Appliance(result).get()
+        except ModuleNotFoundError:
+            return result

pyhon/parameter.py

@@ -14,6 +14,18 @@ class HonParameter:
     def value(self):
         return self._value if self._value is not None else "0"
 
+    @property
+    def category(self):
+        return self._category
+
+    @property
+    def typology(self):
+        return self._typology
+
+    @property
+    def mandatory(self):
+        return self._mandatory
+
 
 class HonParameterFixed(HonParameter):
     def __init__(self, key, attributes):
@@ -64,7 +76,7 @@ class HonParameterRange(HonParameter):
     @value.setter
     def value(self, value):
         if self._min <= value <= self._max and not value % self._step:
-            self._value = self._value
+            self._value = value
         else:
             raise ValueError(f"Allowed: min {self._min} max {self._max} step {self._step}")
 
@@ -90,7 +102,7 @@ class HonParameterEnum(HonParameter):
     @value.setter
     def value(self, value):
         if value in self.values:
-            self._value = self._value
+            self._value = value
         else:
             raise ValueError(f"Allowed values {self._value}")
 
@@ -101,6 +113,7 @@ class HonParameterProgram(HonParameterEnum):
         self._command = command
         self._value = command._category
         self._values = command._multi
+        self._typology = "enum"
 
     @property
     def value(self):
@@ -111,4 +124,4 @@ class HonParameterProgram(HonParameterEnum):
         if value in self.values:
             self._command.set_program(value)
         else:
-            raise ValueError(f"Allowed values {self._value}")
+            raise ValueError(f"Allowed values {self._values}")

setup.py

@@ -7,18 +7,31 @@ with open("README.md", "r") as f:
 
 setup(
     name="pyhOn",
-    version="0.2.0",
+    version="0.2.6",
     author="Andre Basche",
     description="Control hOn devices with python",
     long_description=long_description,
     long_description_content_type='text/markdown',
-    url="https://github.com/Andre0512/pyh0n",
+    project_urls={
+        "GitHub": "https://github.com/Andre0512/pyhOn",
+        "PyPI": "https://pypi.org/project/pyhOn",
+    },
     license="MIT",
     platforms="any",
     packages=find_packages(),
     include_package_data=True,
     python_requires=">=3.10",
     install_requires=["aiohttp"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ],
     entry_points={
         'console_scripts': [
             'pyhOn = pyhon.__main__:start',