mijiaAPI 1.3.2__tar.gz → 1.3.4__tar.gz

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/PKG-INFO

@@ -1,29 +1,33 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.3.2
+Version: 1.3.4
 Summary: A Python API for Xiaomi Mijia
-Home-page: https://github.com/Do1e/mijia-api
 License: GPLv3
 Author: Do1e
 Author-email: dpj.email@qq.com
-Requires-Python: >=3.12,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pillow (>=11.0.0,<12.0.0)
 Requires-Dist: qrcode (>=8.0,<9.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
+Project-URL: Homepage, https://github.com/Do1e/mijia-api
 Project-URL: Repository, https://github.com/Do1e/mijia-api
 Description-Content-Type: text/markdown
 
 # mijiaAPI
-小米米家设备的api，可以使用代码直接控制米家设备的功能
+小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
 
 ## 安装
 ```bash
-python setup.py install
+poetry install
 ```
 或者
 ```bash

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/README.md

@@ -1,9 +1,9 @@
 # mijiaAPI
-小米米家设备的api，可以使用代码直接控制米家设备的功能
+小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
 
 ## 安装
 ```bash
-python setup.py install
+poetry install
 ```
 或者
 ```bash

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/mijiaAPI/apis.py

@@ -1,169 +1,169 @@
-from typing import Union
-import requests
-import requests.cookies
-
-from .utils import defaultUA, post_data, PostDataError
-
-class mijiaAPI(object):
-    def __init__(self, auth_data: dict):
-        if any(k not in auth_data for k in ['userId', 'deviceId', 'ssecurity', 'serviceToken']):
-            raise Exception('Invalid authorize data')
-        self.userId = auth_data['userId']
-        self.ssecurity = auth_data['ssecurity']
-        self.session = requests.Session()
-        self.session.headers.update({
-            'User-Agent': defaultUA,
-            'x-xiaomi-protocal-flag-cli': 'PROTOCAL-HTTP2',
-            'Cookie': f'PassportDeviceId={auth_data["deviceId"]};'
-                      f'userId={auth_data["userId"]};'
-                      f'serviceToken={auth_data["serviceToken"]};',
-        })
-
-    @staticmethod
-    def _post_process(data: dict) -> Union[list, bool]:
-        if data['code'] != 0:
-            raise Exception(f'Failed to get data, {data["message"]}')
-        return data['result']
-
-    @property
-    def available(self) -> bool:
-        """check if the API is available"""
-        uri = '/home/device_list'
-        data = {"getVirtualModel": False, "getHuamiDevices": 0}
-        try:
-            post_data(self.session, self.ssecurity, uri, data)
-            return True
-        except PostDataError:
-            return False
-
-    def get_devices_list(self) -> list:
-        """get devices list
-        mijiaAPI.get_devices_list() -> list
-        -------
-        @return
-        dict, devices list
-        """
-        uri = '/home/device_list'
-        data = {"getVirtualModel": False, "getHuamiDevices": 0}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def get_homes_list(self) -> list:
-        """get homes list
-        mijiaAPI.get_homes_list() -> list
-        -------
-        @return
-        list, homes list, including rooms
-        """
-        uri = '/v2/homeroom/gethome'
-        data = {"fg": False, "fetch_share": True, "fetch_share_dev": True, "limit": 300, "app_ver": 7}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def get_scenes_list(self, home_id: str) -> list:
-        """get scenes list
-        set it in Mi Home APP -> Add -> Manual controls
-        mijiaAPI.get_scenes_list(home_id: str) -> list
-        -------
-        @param
-        home_id: str, room id, get from get_homes_list
-        -------
-        @return
-        list, scenes list
-        """
-        uri = '/appgateway/miot/appsceneservice/AppSceneService/GetSceneList'
-        data = {"home_id": home_id}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def run_scene(self, scene_id: str) -> bool:
-        """run scene
-        mijiaAPI.run_scene(scene_id: str) -> bool
-        -------
-        @param
-        scene_id: str, scene id, get from get_scenes_list
-        -------
-        @return
-        dict, result
-        """
-        uri = '/appgateway/miot/appsceneservice/AppSceneService/RunScene'
-        data = {"scene_id": scene_id, "trigger_key": "user.click"}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def get_consumable_items(self, home_id: str) -> list:
-        """get consumable items
-        mijiaAPI.get_consumable_items(did: str) -> list
-        -------
-        @param
-        home_id: str, room id, get from get_homes_list
-        -------
-        @return
-        list, consumable items
-        """
-        uri = '/v2/home/standard_consumable_items'
-        data = {"home_id": int(home_id), "owner_id": self.userId}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def get_devices_prop(self, data: list) -> list:
-        """get devices properties
-        mijiaAPI.get_devices_prop(data: list) -> list
-        -------
-        @param
-        data: list of dict
-            dict keys:
-                - did: str, device id, get from get_devices_list
-                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-                - piid: str, property id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-            model yeelink.light.lamp4 as an example:
-            [
-                {"did": "1234567890", "siid": 2, "piid": 2}, # get the brightness
-                {"did": "1234567890", "siid": 2, "piid": 3}, # get the color temperature
-            ]
-        -------
-        @return
-        list, device properties
-        """
-        uri = '/miotspec/prop/get'
-        data = {"params": data}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def set_devices_prop(self, data: list) -> list:
-        """set devices properties
-        mijiaAPI.set_devices_prop(data: list) -> list
-        -------
-        @param
-        data: list of dict
-            dict keys:
-                - did: str, device id, get from get_devices_list
-                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-                - piid: str, property id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-                - value: str, value to set
-            model yeelink.light.lamp4 as an example:
-            [
-                {"did": "1234567890", "siid": 2, "piid": 2, "value": 50} # set the brightness to 50%
-                {"did": "1234567890", "siid": 2, "piid": 3, "value": 2700} # set the color temperature to 2700K
-            ]
-        -------
-        @return
-        dict, result
-        """
-        uri = '/miotspec/prop/set'
-        data = {"params": data}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
-
-    def run_action(self, data: dict) -> dict:
-        """run action
-        mijiaAPI.run_action(data: dict) -> dict
-        @param
-        data: dict
-            dict keys:
-                - did: str, device id, get from get_devices_list
-                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-                - aiid: str, action id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
-                - value: list, value to list
-            model xiaomi.feeder.pi2001 as an example:
-            {"did": "1234567890", "siid": 2, "aiid": 1, "value": [2]}, # Remote feeding (2 servings) of food
-        -------
-        @return
-        dict, result
-        """
-        uri = '/miotspec/action'
-        data = {"params": data}
-        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+from typing import Union
+import requests
+import requests.cookies
+
+from .utils import defaultUA, post_data, PostDataError
+
+class mijiaAPI(object):
+    def __init__(self, auth_data: dict):
+        if any(k not in auth_data for k in ['userId', 'deviceId', 'ssecurity', 'serviceToken']):
+            raise Exception('Invalid authorize data')
+        self.userId = auth_data['userId']
+        self.ssecurity = auth_data['ssecurity']
+        self.session = requests.Session()
+        self.session.headers.update({
+            'User-Agent': defaultUA,
+            'x-xiaomi-protocal-flag-cli': 'PROTOCAL-HTTP2',
+            'Cookie': f'PassportDeviceId={auth_data["deviceId"]};'
+                      f'userId={auth_data["userId"]};'
+                      f'serviceToken={auth_data["serviceToken"]};',
+        })
+
+    @staticmethod
+    def _post_process(data: dict) -> Union[list, bool]:
+        if data['code'] != 0:
+            raise Exception(f'Failed to get data, {data["message"]}')
+        return data['result']
+
+    @property
+    def available(self) -> bool:
+        """check if the API is available"""
+        uri = '/home/device_list'
+        data = {"getVirtualModel": False, "getHuamiDevices": 0}
+        try:
+            post_data(self.session, self.ssecurity, uri, data)
+            return True
+        except PostDataError:
+            return False
+
+    def get_devices_list(self) -> list:
+        """get devices list
+        mijiaAPI.get_devices_list() -> list
+        -------
+        @return
+        dict, devices list
+        """
+        uri = '/home/device_list'
+        data = {"getVirtualModel": False, "getHuamiDevices": 0}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def get_homes_list(self) -> list:
+        """get homes list
+        mijiaAPI.get_homes_list() -> list
+        -------
+        @return
+        list, homes list, including rooms
+        """
+        uri = '/v2/homeroom/gethome'
+        data = {"fg": False, "fetch_share": True, "fetch_share_dev": True, "limit": 300, "app_ver": 7}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def get_scenes_list(self, home_id: str) -> list:
+        """get scenes list
+        set it in Mi Home APP -> Add -> Manual controls
+        mijiaAPI.get_scenes_list(home_id: str) -> list
+        -------
+        @param
+        home_id: str, room id, get from get_homes_list
+        -------
+        @return
+        list, scenes list
+        """
+        uri = '/appgateway/miot/appsceneservice/AppSceneService/GetSceneList'
+        data = {"home_id": home_id}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def run_scene(self, scene_id: str) -> bool:
+        """run scene
+        mijiaAPI.run_scene(scene_id: str) -> bool
+        -------
+        @param
+        scene_id: str, scene id, get from get_scenes_list
+        -------
+        @return
+        dict, result
+        """
+        uri = '/appgateway/miot/appsceneservice/AppSceneService/RunScene'
+        data = {"scene_id": scene_id, "trigger_key": "user.click"}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def get_consumable_items(self, home_id: str) -> list:
+        """get consumable items
+        mijiaAPI.get_consumable_items(did: str) -> list
+        -------
+        @param
+        home_id: str, room id, get from get_homes_list
+        -------
+        @return
+        list, consumable items
+        """
+        uri = '/v2/home/standard_consumable_items'
+        data = {"home_id": int(home_id), "owner_id": self.userId}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def get_devices_prop(self, data: list) -> list:
+        """get devices properties
+        mijiaAPI.get_devices_prop(data: list) -> list
+        -------
+        @param
+        data: list of dict
+            dict keys:
+                - did: str, device id, get from get_devices_list
+                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+                - piid: str, property id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+            model yeelink.light.lamp4 as an example:
+            [
+                {"did": "1234567890", "siid": 2, "piid": 2}, # get the brightness
+                {"did": "1234567890", "siid": 2, "piid": 3}, # get the color temperature
+            ]
+        -------
+        @return
+        list, device properties
+        """
+        uri = '/miotspec/prop/get'
+        data = {"params": data}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def set_devices_prop(self, data: list) -> list:
+        """set devices properties
+        mijiaAPI.set_devices_prop(data: list) -> list
+        -------
+        @param
+        data: list of dict
+            dict keys:
+                - did: str, device id, get from get_devices_list
+                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+                - piid: str, property id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+                - value: str, value to set
+            model yeelink.light.lamp4 as an example:
+            [
+                {"did": "1234567890", "siid": 2, "piid": 2, "value": 50} # set the brightness to 50%
+                {"did": "1234567890", "siid": 2, "piid": 3, "value": 2700} # set the color temperature to 2700K
+            ]
+        -------
+        @return
+        dict, result
+        """
+        uri = '/miotspec/prop/set'
+        data = {"params": data}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))
+
+    def run_action(self, data: dict) -> dict:
+        """run action
+        mijiaAPI.run_action(data: dict) -> dict
+        @param
+        data: dict
+            dict keys:
+                - did: str, device id, get from get_devices_list
+                - siid: str, service id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+                - aiid: str, action id, get from https://home.miot-spec.com/spec/{model}, model from get_devices_list
+                - value: list, value to list
+            model xiaomi.feeder.pi2001 as an example:
+            {"did": "1234567890", "siid": 2, "aiid": 1, "value": [2]}, # Remote feeding (2 servings) of food
+        -------
+        @return
+        dict, result
+        """
+        uri = '/miotspec/action'
+        data = {"params": data}
+        return self._post_process(post_data(self.session, self.ssecurity, uri, data))

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/mijiaAPI/devices.py

@@ -69,21 +69,21 @@ class mijiaDevices(object):
             if not isinstance(value, bool):
                 raise ValueError(f'Invalid value for bool: {value}, should be True or False')
         elif prop.type in ['int', 'uint']:
-            try:
-                value = int(value)
-                if prop.range:
-                    if value < prop.range[0] or value > prop.range[1]:
-                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
-            except ValueError:
-                raise ValueError(f'Invalid value for int: {value}, should be an integer')
+            value = int(value)
+            if prop.range:
+                if value < prop.range[0] or value > prop.range[1]:
+                    raise ValueError(f'Value out of range: {value}, should be in range {prop.range[:2]}')
+                if len(prop.range) >= 3 and prop.range[2] != 1:
+                    if (value - prop.range[0]) % prop.range[2] != 0:
+                        raise ValueError(f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
         elif prop.type == 'float':
-            try:
-                value = float(value)
-                if prop.range:
-                    if value < prop.range[0] or value > prop.range[1]:
-                        raise ValueError(f'Value out of range: {value}, should be in range {prop.range}')
-            except ValueError:
-                raise ValueError(f'Invalid value for float: {value}, should be a float')
+            value = float(value)
+            if prop.range:
+                if value < prop.range[0] or value > prop.range[1]:
+                    raise ValueError(f'Value out of range: {value}, should be in range {prop.range[:2]}')
+                if len(prop.range) >= 3 and isinstance(prop.range[2], int):
+                    if int(value - prop.range[0]) % prop.range[2] != 0:
+                        raise ValueError(f'Invalid value: {value}, should be in range {prop.range[:2]} with step {prop.range[2]}')
         elif prop.type == 'string':
             if not isinstance(value, str):
                 raise ValueError(f'Invalid value for string: {value}, should be a string')
@@ -166,6 +166,8 @@ def get_device_info(device_model: str) -> dict:
     result['actions'] = []
     services = content['props']['spec']['services']
 
+    properties_name = []
+    actions_name = []
     for siid in services:
         if 'properties' in services[siid]:
             for piid in services[siid]['properties']:
@@ -193,11 +195,17 @@ def get_device_info(device_model: str) -> dict:
                     }
                 }
                 if item['range'] is not None:
-                    item['range'] = item['range'][:2]
+                    item['range'] = item['range']
+                if item['name'] in properties_name:
+                    item["name"] = f'{services[siid]['name']}-{item["name"]}'
+                properties_name.append(item['name'])
                 result['properties'].append({k: None if v == 'none' else v for k, v in item.items()})
         if 'actions' in services[siid]:
             for aiid in services[siid]['actions']:
                 act = services[siid]['actions'][aiid]
+                if act['name'] in actions_name:
+                    act['name'] = f'{services[siid]["name"]}-{act["name"]}'
+                actions_name.append(act['name'])
                 result['actions'].append({
                     'name': act['name'],
                     'description': act['description'],

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/mijiaAPI/urls.py

@@ -1,6 +1,6 @@
-sid = 'xiaomiio'
-msgURL = 'https://account.xiaomi.com/pass/serviceLogin?sid=%s&_json=true' % sid
-loginURL = 'https://account.xiaomi.com/pass/serviceLoginAuth2'
-qrURL = 'https://account.xiaomi.com/longPolling/loginUrl'
-apiURL = 'https://api.io.mi.com/app'
-deviceURL = 'https://home.miot-spec.com/spec/'
+sid = 'xiaomiio'
+msgURL = 'https://account.xiaomi.com/pass/serviceLogin?sid=%s&_json=true' % sid
+loginURL = 'https://account.xiaomi.com/pass/serviceLoginAuth2'
+qrURL = 'https://account.xiaomi.com/longPolling/loginUrl'
+apiURL = 'https://api.io.mi.com/app'
+deviceURL = 'https://home.miot-spec.com/spec/'

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/mijiaAPI/utils.py

@@ -1,43 +1,43 @@
-import base64
-from hashlib import sha256
-import hmac
-import random
-import string
-
-import requests
-
-from .urls import apiURL
-
-defaultUA = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Mobile Safari/537.36 Edg/126.0.0.0'
-
-class PostDataError(Exception):
-    def __init__(self, code: int, message: str):
-        self.code = code
-        self.message = message
-        super().__init__(f'Error code: {code}, message: {message}')
-
-def _generate_signed_nonce(secret: str, nonce: str) -> str:
-    sha = sha256()
-    sha.update(base64.b64decode(secret))
-    sha.update(base64.b64decode(nonce))
-    return base64.b64encode(sha.digest()).decode()
-
-
-def _generate_signature(uri: str, signedNonce: str, nonce: str, data: str) -> str:
-    sign = '&'.join([uri, signedNonce, nonce, f'data={data}'])
-    mac = hmac.new(base64.b64decode(signedNonce), digestmod='sha256')
-    mac.update(sign.encode())
-    return base64.b64encode(mac.digest()).decode()
-
-
-def post_data(session: requests.Session, ssecurity: str, uri: str, data: dict) -> dict:
-    data = str(data).replace("'", '"').replace('True', 'true').replace('False', 'false')
-    nonce = ''.join(random.sample(string.digits + string.ascii_letters, 16))
-    signed_nonce = _generate_signed_nonce(ssecurity, nonce)
-    signature = _generate_signature(uri, signed_nonce, nonce, data)
-    post_data = {'_nonce': nonce, 'data': data, 'signature': signature}
-    ret = session.post(apiURL + uri, data=post_data)
-    if ret.status_code != 200:
-        raise PostDataError(ret.status_code, f'Failed to post data, {ret.text}')
-    ret_data = ret.json()
-    return ret_data
+import base64
+from hashlib import sha256
+import hmac
+import random
+import string
+
+import requests
+
+from .urls import apiURL
+
+defaultUA = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Mobile Safari/537.36 Edg/126.0.0.0'
+
+class PostDataError(Exception):
+    def __init__(self, code: int, message: str):
+        self.code = code
+        self.message = message
+        super().__init__(f'Error code: {code}, message: {message}')
+
+def _generate_signed_nonce(secret: str, nonce: str) -> str:
+    sha = sha256()
+    sha.update(base64.b64decode(secret))
+    sha.update(base64.b64decode(nonce))
+    return base64.b64encode(sha.digest()).decode()
+
+
+def _generate_signature(uri: str, signedNonce: str, nonce: str, data: str) -> str:
+    sign = '&'.join([uri, signedNonce, nonce, f'data={data}'])
+    mac = hmac.new(base64.b64decode(signedNonce), digestmod='sha256')
+    mac.update(sign.encode())
+    return base64.b64encode(mac.digest()).decode()
+
+
+def post_data(session: requests.Session, ssecurity: str, uri: str, data: dict) -> dict:
+    data = str(data).replace("'", '"').replace('True', 'true').replace('False', 'false')
+    nonce = ''.join(random.sample(string.digits + string.ascii_letters, 16))
+    signed_nonce = _generate_signed_nonce(ssecurity, nonce)
+    signature = _generate_signature(uri, signed_nonce, nonce, data)
+    post_data = {'_nonce': nonce, 'data': data, 'signature': signature}
+    ret = session.post(apiURL + uri, data=post_data)
+    if ret.status_code != 200:
+        raise PostDataError(ret.status_code, f'Failed to post data, {ret.text}')
+    ret_data = ret.json()
+    return ret_data

{mijiaapi-1.3.2 → mijiaapi-1.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.2"
+version = "1.3.4"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"
@@ -17,9 +17,10 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.12"
+python = ">=3.9,<4.0"
 requests = "^2.32.3"
 qrcode = "^8.0"
+pillow = "^11.0.0"
 
 [tool.poetry-dynamic-versioning]
 enable = false