mijiaAPI 1.3.4__tar.gz → 1.3.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.3.4
+Version: 1.3.5
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e

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

@@ -1,51 +1,51 @@
-# mijiaAPI
-小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
-
-## 安装
-```bash
-poetry install
-```
-或者
-```bash
-pip install mijiaAPI
-```
-
-## 使用
-使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
-
-有三个类分别用于登录和API调用
-
-* `mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表
-  * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息
-  * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
-
-* `mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
-  * `__init__(auth_data: dict)`：初始化
-  * `available -> bool`：传入的`auth_data`是否有效
-  * `get_devices_list() -> list`：获取设备列表
-  * `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
-  * `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
-  * `run_scene(scene_id: str) -> bool`：运行手动场景
-  * `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
-  * `get_devices_prop(data: list) -> list`：获取设备的属性
-  * `set_devices_prop(data: list) -> list`：设置设备的属性
-    * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
-    * 网站上的方法并非全部可用，需要自行测试
-  * `run_action(data: dict) -> dict`：执行设备的action
-    * `data`为一个字典，需要包含`did`, `siid`, `aiid`，获取方法同上
-
-
-* `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
-  * `__init__(api: mijiaAPI, dev_info: dict. did: str = None, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考[demos/dev_info_example](demos/dev_info_example)，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
-  * `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
-  * `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
-  * v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
-  * **欢迎大家把自己编写的设备属性字典分享到Issues中，方便大家使用**
-  * 也可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
-
-## 致谢
-* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
-
-## 声明
-* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除。
-* 本项目作者不对使用本项目产生的任何后果负责，请用户自行承担使用本项目的风险。
+# mijiaAPI
+小米米家设备的api，可以使用代码直接控制米家设备的功能，[Github link](https://github.com/Do1e/mijia-api)，[PyPI link](https://pypi.org/project/mijiaAPI/)。
+
+## 安装
+```bash
+poetry install
+```
+或者
+```bash
+pip install mijiaAPI
+```
+
+## 使用
+使用实例可以参考`demos`文件夹下的示例代码，以下是简单的使用说明
+
+有三个类分别用于登录和API调用
+
+* `mijiaLogin`：登录小米账号，获取控制设备必须的`userId`, `ssecurity`, `deviceId`, `serviceToken`，方法列表
+  * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息
+  * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
+
+* `mijiaAPI`：API的实现，使用`mijiaLogin`登录后返回的信息进行初始化
+  * `__init__(auth_data: dict)`：初始化
+  * `available -> bool`：传入的`auth_data`是否有效
+  * `get_devices_list() -> list`：获取设备列表
+  * `get_homes_list() -> list`：获取家庭列表，家庭字典中包含房间列表
+  * `get_scenes_list(home_id: str) -> list`：获取手动场景列表，在 *米家->添加->手动控制* 中设置
+  * `run_scene(scene_id: str) -> bool`：运行手动场景
+  * `get_consumable_items(home_id: str) -> list`：获取设备的耗材信息
+  * `get_devices_prop(data: list) -> list`：获取设备的属性
+  * `set_devices_prop(data: list) -> list`：设置设备的属性
+    * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
+    * 网站上的方法并非全部可用，需要自行测试
+  * `run_action(data: dict) -> dict`：执行设备的action
+    * `data`为一个字典，需要包含`did`, `siid`, `aiid`，获取方法同上
+
+
+* `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
+  * `__init__(api: mijiaAPI, dev_info: dict. did: str = None, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考[demos/dev_info_example](demos/dev_info_example)，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `set(name: str, did: str, value: Union[bool, int]) -> Union[bool, int]`：设置设备属性
+  * `get(name: str, did: str) -> Union[bool, int]`：获取设备属性
+  * v1.2.0 新增直接通过名称设置/获取属性，需要在初始化时传入`did`，详见[demos/test_devices_v2_light.py](demos/test_devices_v2_light.py)。名称中包含`-`的属性需要替换为`_`。
+  * **欢迎大家把自己编写的设备属性字典分享到Issues中，方便大家使用**
+  * 也可以调用`get_device_info(device_model: str) -> dict`函数从[米家设备列表](https://home.miot-spec.com/)在线获取设备属性字典，详见[demos/test_get_device_info.py](demos/test_get_device_info.py)
+
+## 致谢
+* [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)
+
+## 声明
+* 本项目仅供学习交流使用，不得用于商业用途，如有侵权请联系删除。
+* 本项目作者不对使用本项目产生的任何后果负责，请用户自行承担使用本项目的风险。

{mijiaapi-1.3.4 → mijiaapi-1.3.5}/mijiaAPI/login.py

@@ -1,155 +1,163 @@
-from typing import Tuple
-import hashlib
-import json
-import os
-import random
-import string
-import time
-from urllib import parse
-
-from qrcode import QRCode
-import requests
-
-from .urls import msgURL, loginURL, qrURL
-from .utils import defaultUA
-
-class LoginError(Exception):
-    def __init__(self, code: int, message: str):
-        self.code = code
-        self.message = message
-        super().__init__(f'Error code: {code}, message: {message}')
-
-class mijiaLogin(object):
-    def __init__(self):
-        self.deviceId = ''.join(random.sample(string.digits + string.ascii_letters, 16))
-        self.session = requests.Session()
-        self.session.headers.update({
-            'User-Agent': defaultUA,
-            'Accept': '*/*',
-            'Accept-Encoding': 'gzip, deflate, br, zstd',
-            'Accept-Language': 'zh-CN,zh;q=0.9',
-            'Cookie': f'deviceId={self.deviceId}; sdkVersion=3.4.1'
-        })
-
-    def _get_index(self) -> Tuple[requests.Session, dict]:
-        ret = self.session.get(msgURL)
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get index page, {ret.text}')
-        ret_data = json.loads(ret.text[11:])
-        data = {'deviceId': self.deviceId}
-        data.update({
-            k: v for k, v in ret_data.items() \
-            if k in ['qs', '_sign', 'callback', 'location']
-        })
-        return data
-
-    def login(self, username: str, password: str) -> dict:
-        """login with username and password
-        mijiaLogin.login(username: str, password: str) -> dict
-        -------
-        @param
-        username: str, xiaomi account username(email/phone number/xiaomi id)
-        password: str, xiaomi account password
-        -------
-        @return
-        dict, data for authorization, including userId, ssecurity, deviceId, serviceToken
-        """
-        data = self._get_index()
-        post_data = {
-            'qs': data['qs'],
-            '_sign': data['_sign'],
-            'callback': data['callback'],
-            'sid': 'xiaomiio',
-            '_json': 'true',
-            'user': username,
-            'hash': (hashlib.md5(password.encode()).hexdigest().upper() + '0' * 32)[:32],
-        }
-        ret = self.session.post(loginURL, data=post_data)
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to post login page, {ret.text}')
-        ret_data = json.loads(ret.text[11:])
-        if ret_data['code'] != 0:
-            raise LoginError(ret_data['code'], ret_data['desc'])
-        if 'location' not in ret_data:
-            raise LoginError(-1, 'Failed to get location')
-        auth_data = {
-            'userId': ret_data['userId'],
-            'ssecurity': ret_data['ssecurity'],
-            'deviceId': data['deviceId'],
-        }
-        ret = self.session.get(ret_data['location'])
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
-        cookies = self.session.cookies.get_dict()
-        auth_data['serviceToken'] = cookies['serviceToken']
-        self.auth_data = auth_data
-        return auth_data
-
-    @staticmethod
-    def _print_qr(loginurl: str, box_size: int = 10) -> None:
-        print('Scan the QR code below with Mi Home app')
-        qr = QRCode(border=1, box_size=box_size)
-        qr.add_data(loginurl)
-        qr.make_image().save('qr.png')
-        try:
-            qr.print_ascii(invert=True, tty=True)
-        except OSError:
-            print('Failed to print QR code to terminal, please use the qr.png file in the current directory.')
-
-    def QRlogin(self) -> dict:
-        """login with QR code
-        mijiaLogin.QRlogin() -> dict
-        -------
-        @return
-        dict, data for authorization, including userId, ssecurity, deviceId, serviceToken
-        """
-        data = self._get_index()
-        location = data['location']
-        location_parsed = parse.parse_qs(parse.urlparse(location).query)
-        params = {
-            '_qrsize': 240,
-            'qs': data['qs'],
-            'bizDeviceType': '',
-            'callback': data['callback'],
-            '_json': 'true',
-            'theme': '',
-            'sid': 'xiaomiio',
-            'needTheme': 'false',
-            'showActiveX': 'false',
-            'serviceParam': location_parsed['serviceParam'][0],
-            '_local': 'zh_CN',
-            '_sign': data['_sign'],
-            '_dc': str(int(time.time() * 1000)),
-        }
-        url = qrURL + '?' + parse.urlencode(params)
-        ret = self.session.get(url)
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get QR code URL, {ret.text}')
-        ret_data = json.loads(ret.text[11:])
-        if ret_data['code'] != 0:
-            raise LoginError(ret_data['code'], ret_data['desc'])
-        loginurl = ret_data['loginUrl']
-        self._print_qr(loginurl)
-        try:
-            ret = self.session.get(ret_data['lp'], timeout=60, headers={'Connection': 'keep-alive'})
-        except requests.exceptions.Timeout:
-            raise LoginError(-1, 'Timeout, please try again')
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to wait for login, {ret.text}')
-        ret_data = json.loads(ret.text[11:])
-        if ret_data['code'] != 0:
-            raise LoginError(ret_data['code'], ret_data['desc'])
-        auth_data = {
-            'userId': ret_data['userId'],
-            'ssecurity': ret_data['ssecurity'],
-            'deviceId': data['deviceId'],
-        }
-        ret = self.session.get(ret_data['location'])
-        if ret.status_code != 200:
-            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
-        cookies = self.session.cookies.get_dict()
-        auth_data['serviceToken'] = cookies['serviceToken']
-        self.auth_data = auth_data
-        if os.path.exists('qr.png'):
-            os.remove('qr.png')
-        return auth_data
+from typing import Tuple
+import hashlib
+import json
+import os
+import random
+import string
+import sys
+import time
+from urllib import parse
+
+from qrcode import QRCode
+import requests
+
+from .urls import msgURL, loginURL, qrURL
+from .utils import defaultUA
+
+class LoginError(Exception):
+    def __init__(self, code: int, message: str):
+        self.code = code
+        self.message = message
+        super().__init__(f'Error code: {code}, message: {message}')
+
+class mijiaLogin(object):
+    def __init__(self):
+        self.deviceId = ''.join(random.sample(string.digits + string.ascii_letters, 16))
+        self.session = requests.Session()
+        self.session.headers.update({
+            'User-Agent': defaultUA,
+            'Accept': '*/*',
+            'Accept-Encoding': 'gzip, deflate, br, zstd',
+            'Accept-Language': 'zh-CN,zh;q=0.9',
+            'Cookie': f'deviceId={self.deviceId}; sdkVersion=3.4.1'
+        })
+
+    def _get_index(self) -> Tuple[requests.Session, dict]:
+        ret = self.session.get(msgURL)
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to get index page, {ret.text}')
+        ret_data = json.loads(ret.text[11:])
+        data = {'deviceId': self.deviceId}
+        data.update({
+            k: v for k, v in ret_data.items() \
+            if k in ['qs', '_sign', 'callback', 'location']
+        })
+        return data
+
+    def login(self, username: str, password: str) -> dict:
+        """login with username and password
+        mijiaLogin.login(username: str, password: str) -> dict
+        -------
+        @param
+        username: str, xiaomi account username(email/phone number/xiaomi id)
+        password: str, xiaomi account password
+        -------
+        @return
+        dict, data for authorization, including userId, ssecurity, deviceId, serviceToken
+        """
+        warning_msg = 'WARNING: there is a high probability of verification code with account and password. Please try other login methods'
+        if sys.stdout.isatty():
+            print(f'\033[33;1m{warning_msg}\033[0m')
+        else:
+            print(warning_msg)
+        data = self._get_index()
+        post_data = {
+            'qs': data['qs'],
+            '_sign': data['_sign'],
+            'callback': data['callback'],
+            'sid': 'xiaomiio',
+            '_json': 'true',
+            'user': username,
+            'hash': (hashlib.md5(password.encode()).hexdigest().upper() + '0' * 32)[:32],
+        }
+        ret = self.session.post(loginURL, data=post_data)
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to post login page, {ret.text}')
+        ret_data = json.loads(ret.text[11:])
+        if ret_data['code'] != 0:
+            raise LoginError(ret_data['code'], ret_data['desc'])
+        if 'location' not in ret_data:
+            raise LoginError(-1, 'Failed to get location')
+        if 'notificationUrl' in ret_data:
+            raise LoginError(-1, 'Verification code required, please try other login methods')
+        auth_data = {
+            'userId': ret_data['userId'],
+            'ssecurity': ret_data['ssecurity'],
+            'deviceId': data['deviceId'],
+        }
+        ret = self.session.get(ret_data['location'])
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
+        cookies = self.session.cookies.get_dict()
+        auth_data['serviceToken'] = cookies['serviceToken']
+        self.auth_data = auth_data
+        return auth_data
+
+    @staticmethod
+    def _print_qr(loginurl: str, box_size: int = 10) -> None:
+        print('Scan the QR code below with Mi Home app')
+        qr = QRCode(border=1, box_size=box_size)
+        qr.add_data(loginurl)
+        qr.make_image().save('qr.png')
+        try:
+            qr.print_ascii(invert=True, tty=True)
+        except OSError:
+            print('Failed to print QR code to terminal, please use the qr.png file in the current directory.')
+
+    def QRlogin(self) -> dict:
+        """login with QR code
+        mijiaLogin.QRlogin() -> dict
+        -------
+        @return
+        dict, data for authorization, including userId, ssecurity, deviceId, serviceToken
+        """
+        data = self._get_index()
+        location = data['location']
+        location_parsed = parse.parse_qs(parse.urlparse(location).query)
+        params = {
+            '_qrsize': 240,
+            'qs': data['qs'],
+            'bizDeviceType': '',
+            'callback': data['callback'],
+            '_json': 'true',
+            'theme': '',
+            'sid': 'xiaomiio',
+            'needTheme': 'false',
+            'showActiveX': 'false',
+            'serviceParam': location_parsed['serviceParam'][0],
+            '_local': 'zh_CN',
+            '_sign': data['_sign'],
+            '_dc': str(int(time.time() * 1000)),
+        }
+        url = qrURL + '?' + parse.urlencode(params)
+        ret = self.session.get(url)
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to get QR code URL, {ret.text}')
+        ret_data = json.loads(ret.text[11:])
+        if ret_data['code'] != 0:
+            raise LoginError(ret_data['code'], ret_data['desc'])
+        loginurl = ret_data['loginUrl']
+        self._print_qr(loginurl)
+        try:
+            ret = self.session.get(ret_data['lp'], timeout=60, headers={'Connection': 'keep-alive'})
+        except requests.exceptions.Timeout:
+            raise LoginError(-1, 'Timeout, please try again')
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to wait for login, {ret.text}')
+        ret_data = json.loads(ret.text[11:])
+        if ret_data['code'] != 0:
+            raise LoginError(ret_data['code'], ret_data['desc'])
+        auth_data = {
+            'userId': ret_data['userId'],
+            'ssecurity': ret_data['ssecurity'],
+            'deviceId': data['deviceId'],
+        }
+        ret = self.session.get(ret_data['location'])
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to get location, {ret.text}')
+        cookies = self.session.cookies.get_dict()
+        auth_data['serviceToken'] = cookies['serviceToken']
+        self.auth_data = auth_data
+        if os.path.exists('qr.png'):
+            os.remove('qr.png')
+        return auth_data

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.4"
+version = "1.3.5"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"