mijiaAPI 1.4.4__tar.gz → 1.5.0__tar.gz

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mijiaAPI
-Version: 1.4.4
+Version: 1.5.0
 Summary: A Python API for Xiaomi Mijia
 License: GPLv3
 Author: Do1e
@@ -53,6 +53,13 @@ pip install .
 poetry install
 ```
 
+### aur
+如果你使用 Arch Linux 或基于 Arch 的发行版，可以通过 AUR 安装：
+
+```bash
+yay -S python-mijia-api
+```
+
 ## 使用
 
 使用实例可以参考 `demos` 文件夹下的示例代码，以下是基本使用说明。
@@ -115,12 +122,12 @@ device_info = get_device_info('yeelink.light.lamp4')  # 米家台灯 1S 的 mode
 
 ### 设备控制封装
 
-`mijiaDevices`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
+`mijiaDevice`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
 
 #### 初始化：
 
 ```python
-mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
+mijiaDevice(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
 ```
 
 * `api`：已初始化的 `mijiaAPI` 对象
@@ -148,7 +155,7 @@ mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: st
 
 ```python
 # 示例：控制台灯
-device = mijiaDevices(api, dev_name='台灯')
+device = mijiaDevice(api, dev_name='台灯')
 device.on = True                 # 打开灯
 device.brightness = 60           # 设置亮度
 current_temp = device.color_temperature  # 获取色温

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/README.md

@@ -29,6 +29,13 @@ pip install .
 poetry install
 ```
 
+### aur
+如果你使用 Arch Linux 或基于 Arch 的发行版，可以通过 AUR 安装：
+
+```bash
+yay -S python-mijia-api
+```
+
 ## 使用
 
 使用实例可以参考 `demos` 文件夹下的示例代码，以下是基本使用说明。
@@ -91,12 +98,12 @@ device_info = get_device_info('yeelink.light.lamp4')  # 米家台灯 1S 的 mode
 
 ### 设备控制封装
 
-`mijiaDevices`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
+`mijiaDevice`：基于 `mijiaAPI` 的高级封装，提供更简便的设备控制方式。
 
 #### 初始化：
 
 ```python
-mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
+mijiaDevice(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: str = None, sleep_time: float = 0.5)
 ```
 
 * `api`：已初始化的 `mijiaAPI` 对象
@@ -124,7 +131,7 @@ mijiaDevices(api: mijiaAPI, dev_info: dict = None, dev_name: str = None, did: st
 
 ```python
 # 示例：控制台灯
-device = mijiaDevices(api, dev_name='台灯')
+device = mijiaDevice(api, dev_name='台灯')
 device.on = True                 # 打开灯
 device.brightness = 60           # 设置亮度
 current_temp = device.color_temperature  # 获取色温

mijiaapi-1.5.0/mijiaAPI/__init__.py

@@ -0,0 +1,3 @@
+from .login import mijiaLogin
+from .apis import mijiaAPI
+from .devices import mijiaDevice, mijiaDevices, get_device_info

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/mijiaAPI/__main__.py

@@ -6,7 +6,7 @@ import sys
 import time
 
 from .apis import mijiaAPI
-from .devices import mijiaDevices, get_device_info
+from .devices import mijiaDevice, get_device_info
 from .login import mijiaLogin
 
 def parse_args(args):
@@ -253,14 +253,14 @@ def run_scene(api: mijiaAPI, scene_id: str, scene_mapping: Optional[dict] = None
 
 def get(args):
     api = init_api(args.auth_path)
-    device = mijiaDevices(api, dev_name=args.dev_name)
+    device = mijiaDevice(api, dev_name=args.dev_name)
     value = device.get(args.prop_name)
     unit = device.prop_list[args.prop_name].unit
     print(f"The {args.prop_name} of {args.dev_name} is {value} {unit if unit else ''}")
 
 def set(args):
     api = init_api(args.auth_path)
-    device = mijiaDevices(api, dev_name=args.dev_name)
+    device = mijiaDevice(api, dev_name=args.dev_name)
     ret = device.set_v2(args.prop_name, args.value)
     unit = device.prop_list[args.prop_name].unit
     if ret:
@@ -307,12 +307,12 @@ def main(args):
             wifispeaker = None
             for device in device_mapping.values():
                 if 'xiaomi.wifispeaker' in device['model']:
-                    wifispeaker = mijiaDevices(api, dev_name=device['name'])
+                    wifispeaker = mijiaDevice(api, dev_name=device['name'])
                     break
             if wifispeaker is None:
                 raise ValueError("No wifispeaker found")
         else:
-            wifispeaker = mijiaDevices(api, dev_name=args.wifispeaker_name)
+            wifispeaker = mijiaDevice(api, dev_name=args.wifispeaker_name)
         wifispeaker.run_action('execute-text-directive', _in=[args.run, args.quiet])
     if hasattr(args, 'func') and args.func is not None:
         if args.func == 'get':

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/mijiaAPI/devices.py

@@ -74,7 +74,7 @@ class DevAction(object):
         return f'  {self.name}: {self.desc}'
 
 
-class mijiaDevices(object):
+class mijiaDevice(object):
     def __init__(
             self,
             api: mijiaAPI,
@@ -376,9 +376,44 @@ class mijiaDevices(object):
         return result['code'] == 0
 
 
+class mijiaDevices(mijiaDevice):
+    def __init__(
+            self,
+            api: mijiaAPI,
+            dev_info: Optional[dict] = None,
+            dev_name: Optional[str] = None,
+            did: Optional[str] = None,
+            sleep_time: Optional[Union[int, float]] = 0.5
+    ):
+        """
+        初始化设备对象。
+
+        如果未提供设备信息，则根据设备名称获取设备信息。如果两者均未提供，则抛出异常。
+        如果同时提供了设备信息和设备名称，则以设备信息为准。
+
+        Args:
+            api (mijiaAPI): 米家API对象。
+            dev_info (dict, optional): 设备信息字典，从get_device_info获取。默认为None。
+            dev_name (str, optional): 设备名称，从get_devices_list获取。默认为None。
+            did (str, optional): 设备ID，如未指定，则需要在调用get/set时指定。默认为None。
+            sleep_time ([int, float], optional): 调用设备属性的间隔时间。默认为0.5秒。
+
+        Raises:
+            RuntimeError: 如果dev_info和dev_name都未提供。
+            ValueError: 如果找不到指定设备或找到多个同名设备。
+
+        Note:
+            - 如果同时提供了dev_info和dev_name，则以dev_info为准。
+            - 如果只提供了dev_name，则根据名称自动获取设备信息。
+            - 如果只提供了dev_info，则直接使用该信息。
+        """
+        super().__init__(api, dev_info, dev_name, did, sleep_time)
+        logger.warning("`mijiaDevices` will be deprecated in future versions, use `mijiaDevice` instead.")
+
+
 def get_device_info(device_model: str, cache_path: Optional[str] = os.path.join(os.path.expanduser("~"), ".config/mijia-api")) -> dict:
     """
-    获取设备信息，用于初始化mijiaDevices对象。
+    获取设备信息，用于初始化mijiaDevice对象。
 
     Args:
         device_model (str): 设备型号，从get_devices_list获取。

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/mijiaAPI/login.py

@@ -74,7 +74,7 @@ class mijiaLogin(object):
         })
         return data
 
-    def _get_account(self, user_id: str) -> dict[str, str]:
+    def _get_account_info(self, user_id: str) -> dict[str, str]:
         """
         获取账户信息。
 
@@ -87,14 +87,13 @@ class mijiaLogin(object):
         Raises:
             LoginError: 获取账户信息失败时抛出。
         """
-        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']
-        }
+        try:
+            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}')
+            data = json.loads(ret.text[11:])['data']
+        except (KeyError, json.JSONDecodeError) as e:
+            data = {}
         return data
 
     @staticmethod
@@ -190,7 +189,7 @@ class mijiaLogin(object):
             'deviceId': data['deviceId'],
             'serviceToken': cookies['serviceToken'],
             'expireTime': self._extract_latest_gmt_datetime(cookies).strftime('%Y-%m-%d %H:%M:%S'),
-            **self._get_account(ret_data['userId'])
+            'account_info': self._get_account_info(ret_data['userId'])
         }
 
         self._save_auth()
@@ -275,7 +274,7 @@ class mijiaLogin(object):
             'deviceId': data['deviceId'],
             'serviceToken': cookies['serviceToken'],
             'expireTime': self._extract_latest_gmt_datetime(cookies).strftime('%Y-%m-%d %H:%M:%S'),
-            **self._get_account(ret_data['userId'])
+            'account_info': self._get_account_info(ret_data['userId'])
         }
 
         self._save_auth()

{mijiaapi-1.4.4 → mijiaapi-1.5.0}/pyproject.toml

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

mijiaapi-1.4.4/mijiaAPI/__init__.py

@@ -1,3 +0,0 @@
-from .login import mijiaLogin
-from .apis import mijiaAPI
-from .devices import mijiaDevices, get_device_info