mijiaAPI 1.3.8__tar.gz → 1.3.9__tar.gz

{mijiaapi-1.3.8 → mijiaapi-1.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.3.8
+Version: 1.3.9
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e
@@ -43,25 +43,6 @@ pip install mijiaAPI
 * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息。**注意，目前这一方法大概率遇到手机验证码，请尽可能使用`QRlogin`。**
 * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
 
-**手动登录方法**
-
-可以使用浏览器，手动获取`userId`, `ssecurity`, `deviceId`, `serviceToken`。当然我还是更推荐大家使用扫码登录，但大家也可以根据下述步骤了解如何获取这些信息。
-
-打开浏览器访问 https://account.xiaomi.com/pass/serviceLogin?sid=xiaomiio&_json=true ，会得到下述信息，复制location中的url到新的界面打开：
-
-```text
-&&&START&&&{"serviceParam":"{\"checkSafePhone\":false,\"checkSafeAddress\":false,\"lsrp_score\":0.0}","qs":"%3Fsid%3Dxiaomiio%26_json%3Dtrue","code":70016,"description":"登录验证失败","securityStatus":0,"_sign":"0psXfr43eNI0IX6q9Suk3qWbRqU=","sid":"xiaomiio","result":"error","captchaUrl":null,"callback":"https://sts.api.io.mi.com/sts","location":"https://account.xiaomi.com/fe/service/login?_json=true&sid=xiaomiio&qs=%253Fsid%253Dxiaomiio%2526_json%253Dtrue&callback=.........","pwd":0,"child":0,"desc":"登录验证失败"}
-```
-
-打开后会进入小米的登录界面（如果直接显示了`ok`，是因为保存了之前的cookie，建议使用无痕窗口重新开始上述步骤），此时需要先按下 `F12` 打开开发者工具，切换到`Network`选项卡，之后可以输入账号密码或者扫码登录。完成后页面会显示一个`ok`。
-
-此时在网络选项卡中按下`Ctrl+F`，搜索上述所需的`userId`, `ssecurity`, `deviceId`, `serviceToken`即可。
-
-或者筛选请求：
-1. `https://sts.api.io.mi.com/sts`，其中的`set-cookie`中包含`userId`和`serviceToken`（`=`到`;`前止）。
-2. `https://account.xiaomi.com/pass/serviceLoginAuth2/end`，其中的`extension-pragma`中包含`ssecurity`（`:"`到`"`前止）。
-3. `https://account.xiaomi.com/identity/authStart`，其中的`cookie`中包含`deviceId`（`=`到`;`前止）。
-
 
 ### API
 
@@ -82,6 +63,8 @@ pip install mijiaAPI
 
 ### 针对设备的封装
 
+最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_device_wifispeaker.py](demos/test_device_wifispeaker.py)
+
 `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]`：设置设备属性

{mijiaapi-1.3.8 → mijiaapi-1.3.9}/README.md

@@ -19,25 +19,6 @@ pip install mijiaAPI
 * `login(username: str, password: str) -> dict`：账号密码登录，返回上述信息。**注意，目前这一方法大概率遇到手机验证码，请尽可能使用`QRlogin`。**
 * `QRlogin() -> dict`：扫描二维码登录，返回上述信息（会在支持tty的终端打印二维码，若打印识别可查看当前文件夹下的`qr.png`）
 
-**手动登录方法**
-
-可以使用浏览器，手动获取`userId`, `ssecurity`, `deviceId`, `serviceToken`。当然我还是更推荐大家使用扫码登录，但大家也可以根据下述步骤了解如何获取这些信息。
-
-打开浏览器访问 https://account.xiaomi.com/pass/serviceLogin?sid=xiaomiio&_json=true ，会得到下述信息，复制location中的url到新的界面打开：
-
-```text
-&&&START&&&{"serviceParam":"{\"checkSafePhone\":false,\"checkSafeAddress\":false,\"lsrp_score\":0.0}","qs":"%3Fsid%3Dxiaomiio%26_json%3Dtrue","code":70016,"description":"登录验证失败","securityStatus":0,"_sign":"0psXfr43eNI0IX6q9Suk3qWbRqU=","sid":"xiaomiio","result":"error","captchaUrl":null,"callback":"https://sts.api.io.mi.com/sts","location":"https://account.xiaomi.com/fe/service/login?_json=true&sid=xiaomiio&qs=%253Fsid%253Dxiaomiio%2526_json%253Dtrue&callback=.........","pwd":0,"child":0,"desc":"登录验证失败"}
-```
-
-打开后会进入小米的登录界面（如果直接显示了`ok`，是因为保存了之前的cookie，建议使用无痕窗口重新开始上述步骤），此时需要先按下 `F12` 打开开发者工具，切换到`Network`选项卡，之后可以输入账号密码或者扫码登录。完成后页面会显示一个`ok`。
-
-此时在网络选项卡中按下`Ctrl+F`，搜索上述所需的`userId`, `ssecurity`, `deviceId`, `serviceToken`即可。
-
-或者筛选请求：
-1. `https://sts.api.io.mi.com/sts`，其中的`set-cookie`中包含`userId`和`serviceToken`（`=`到`;`前止）。
-2. `https://account.xiaomi.com/pass/serviceLoginAuth2/end`，其中的`extension-pragma`中包含`ssecurity`（`:"`到`"`前止）。
-3. `https://account.xiaomi.com/identity/authStart`，其中的`cookie`中包含`deviceId`（`=`到`;`前止）。
-
 
 ### API
 
@@ -58,6 +39,8 @@ pip install mijiaAPI
 
 ### 针对设备的封装
 
+最简单的使用方法是直接使用自然语言调用小爱音箱，参见[demos/test_device_wifispeaker.py](demos/test_device_wifispeaker.py)
+
 `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]`：设置设备属性

{mijiaapi-1.3.8 → mijiaapi-1.3.9}/mijiaAPI/login.py

@@ -1,164 +1,201 @@
-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.auth_data = None
-
-        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) -> dict[str, str]:
-        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
+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, accountURL
+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, save_auth=True, save_path='jsons/auth.json'):
+        self.auth_data = None
+        self.save_auth = save_auth
+        self.save_path = save_path
+
+        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) -> dict[str, str]:
+        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 _get_account(self, user_id: str) -> dict[str, str]:
+        ret = self.session.get(accountURL + str(user_id))
+        if ret.status_code != 200:
+            raise LoginError(ret.status_code, f'Failed to get account page, {ret.text}')
+        ret_data = json.loads(ret.text[11:])['data']
+        data = {
+            k: v for k, v in ret_data.items()
+            if k in ['account', 'gender', 'nickName', 'icon']
+        }
+        return data
+
+    def _save_auth(self) -> None:
+        if self.save_auth and self.auth_data is not None:
+            if not os.path.isabs(self.save_path):
+                self.save_path = os.path.abspath(self.save_path)
+            with open(self.save_path, 'w') as f:
+                json.dump(self.auth_data, f, indent=2)
+            print(f'Auth data saved to [{self.save_path}]')
+        else:
+            print('Auth data not saved')
+
+    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
+        self.auth_data.update(self._get_account(auth_data['userId']))
+
+        if self.save_auth:
+            self._save_auth()
+        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:
+            qr.print_ascii(invert=True, tty=False)
+            print('If the QR code can not be scanned, please change the font of the terminal, such as "Maple Mono", "Fira Code", etc.')
+            print('Or just 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
+        self.auth_data.update(self._get_account(auth_data['userId']))
+
+        if self.save_auth:
+            self._save_auth()
+        return auth_data
+
+    def __del__(self):
+        if os.path.exists('qr.png'):
+            os.remove('qr.png')

{mijiaapi-1.3.8 → mijiaapi-1.3.9}/mijiaAPI/urls.py

@@ -1,6 +1,7 @@
-sid = 'xiaomiio'
-msgURL = f'https://account.xiaomi.com/pass/serviceLogin?sid={sid}&_json=true'
-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 = f'https://account.xiaomi.com/pass/serviceLogin?sid={sid}&_json=true'
+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/'
+accountURL = 'https://account.xiaomi.com/pass2/profile/home?bizFlag=&userId='

{mijiaapi-1.3.8 → mijiaapi-1.3.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mijiaAPI"
-version = "1.3.8"
+version = "1.3.9"
 description = "A Python API for Xiaomi Mijia"
 readme = "README.md"
 requires-python = ">=3.9,<4.0"
@@ -12,7 +12,7 @@ dependencies = [
 
 [tool.poetry]
 name = "mijiaAPI"
-version = "1.3.8"
+version = "1.3.9"
 description = "A Python API for Xiaomi Mijia"
 authors = ["Do1e <dpj.email@qq.com>"]
 license = "GPLv3"