mijiaAPI 1.1.1__tar.gz → 1.2.0__tar.gz

{mijiaapi-1.1.1/mijiaAPI.egg-info → mijiaapi-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.1.1
+Version: 1.2.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -50,9 +50,10 @@ pip install mijiaAPI
 
 
 * `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
-  * `__init__(api: mijiaAPI, dev_info: dict, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考`demos/dev_info_example`，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `__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中，方便大家使用**
 
 ## 致谢

{mijiaapi-1.1.1 → mijiaapi-1.2.0}/README.md

@@ -34,9 +34,10 @@ pip install mijiaAPI
 
 
 * `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
-  * `__init__(api: mijiaAPI, dev_info: dict, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考`demos/dev_info_example`，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `__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中，方便大家使用**
 
 ## 致谢

mijiaapi-1.2.0/demos/test_devices_v2_light.py

@@ -0,0 +1,43 @@
+import json
+import sys
+sys.path.extend(['.', '..'])
+from mijiaAPI import mijiaDevices, mijiaAPI
+
+with open('jsons/auth.json') as f:
+    auth = json.load(f)
+api = mijiaAPI(auth)
+
+with open('demos/dev_info_example/yeelink.light.lamp4.json', encoding='utf-8') as f:
+    dev_info = json.load(f)
+with open('jsons/devices.json') as f:
+    devices = json.load(f)
+    did = devices[0]['did']
+# sleep_time is optional, default is 0.5
+# get after set shuold be delayed for a while, or the result may be incorrect
+device = mijiaDevices(api, dev_info, did=did, sleep_time=2)
+print(device)
+print('---------------------')
+print(device.on)
+device.on = True
+print('---------------------')
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+device.brightness = 60
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.color_temperature = 5000
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+print('---------------------')
+device.mode = 0
+print('---------------------')
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+device.brightness_delta = -10
+print(f"{device.brightness} {device.prop_list['brightness'].unit}")
+print('---------------------')
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_delta = -10
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_adjust_alexa_increase = 1
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")
+device.ct_adjust_alexa_decrease = 2
+print(f"{device.color_temperature} {device.prop_list['color-temperature'].unit}")

{mijiaapi-1.1.1 → mijiaapi-1.2.0}/mijiaAPI/__version__.py

@@ -1,5 +1,5 @@
 __title__ = "mijiaAPI"
-__version__ = "1.1.1"
+__version__ = "1.2.0"
 __description__ = "A Python API for Xiaomi Mijia"
 __url__ = "https://github.com/Do1e/mijia-api"
 __author__ = "Do1e"

{mijiaapi-1.1.1 → mijiaapi-1.2.0}/mijiaAPI/devices.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Optional
 from time import sleep
 from .apis import mijiaAPI
 
@@ -19,16 +19,21 @@ class DevProp(object):
                f'  valuetype: {self.type}, rw: {self.rw}, unit: {self.unit}, range: {self.range}'
 
 class mijiaDevices(object):
-    def __init__(self, api: mijiaAPI, dev_info: dict, sleep_time: float = 0.5):
+    def __init__(self, api: mijiaAPI, dev_info: dict,
+                 did: Optional[str] = None,
+                 sleep_time: Optional[Union[int, float]] = 0.5):
         self.api = api
         self.name = dev_info['name']
         self.model = dev_info['model']
         self.prop_list = {prop['name']: DevProp(prop) for prop in dev_info['properties']}
+        self.prop_list.update({prop['name'].replace('-', '_'): DevProp(prop) for prop in dev_info['properties'] if '-' in prop['name']})
+        self.did = did
         self.sleep_time = sleep_time
 
     def __str__(self):
+        prop_list = [str(v) for k, v in self.prop_list.items() if '_' not in k]
         return f'{self.name} ({self.model})\n' \
-               f'Properties:\n' + '\n'.join([str(v) for v in self.prop_list.values()])
+               f'Properties:\n' + '\n'.join(prop_list)
 
     def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
         if name not in self.prop_list:
@@ -67,7 +72,19 @@ class mijiaDevices(object):
         sleep(self.sleep_time)
         return ret
 
-    def get(self, name: str, did: str) -> Union[bool, int]:
+    def set_v2(self, name: str, value: Union[bool, int], did: Optional[str] = None) -> Union[bool, int]:
+        if did is not None:
+            return self.set(name, did, value)
+        elif self.did is not None:
+            return self.set(name, self.did, value)
+        else:
+            raise ValueError('Please specify the did')
+
+    def get(self, name: str, did: Optional[str] = None) -> Union[bool, int]:
+        if did is None:
+            did = self.did
+        if did is None:
+            raise ValueError('Please specify the did')
         if name not in self.prop_list:
             raise ValueError(f'Unsupported property: {name}, available properties: {list(self.prop_list.keys())}')
         prop = self.prop_list[name]
@@ -78,3 +95,16 @@ class mijiaDevices(object):
         ret = self.api.get_devices_prop([method])[0]['value']
         sleep(self.sleep_time)
         return ret
+
+    def __setattr__(self, name: str, value: Union[bool, int]) -> None:
+        if 'prop_list' in self.__dict__ and name in self.prop_list:
+            if not self.set_v2(name, value):
+                raise RuntimeError(f'Failed to set property: {name}')
+        else:
+            super().__setattr__(name, value)
+
+    def __getattr__(self, name: str) -> Union[bool, int]:
+        if 'prop_list' in self.__dict__ and name in self.prop_list:
+            return self.get(name)
+        else:
+            return super().__getattr__(name)

{mijiaapi-1.1.1 → mijiaapi-1.2.0/mijiaAPI.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.1.1
+Version: 1.2.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -50,9 +50,10 @@ pip install mijiaAPI
 
 
 * `mijiaDevices`：使用`mijiaAPI`和设备属性字典初始化，以便更方便地调用设备属性
-  * `__init__(api: mijiaAPI, dev_info: dict, sleep_time: float = 0.5)`：初始化，`dev_info`为设备属性，参考`demos/dev_info_example`，`sleep_time`为每次调用设备属性的间隔时间（注：设置属性后立刻获取属性会不符合预期，需要延迟一段时间）
+  * `__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中，方便大家使用**
 
 ## 致谢

{mijiaapi-1.1.1 → mijiaapi-1.2.0}/mijiaAPI.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ demos/test_available.py
 demos/test_devices_airconditioner.py
 demos/test_devices_light.py
 demos/test_devices_sensor.py
+demos/test_devices_v2_light.py
 demos/test_login.py
 demos/dev_info_example/miaomiaoce.sensor_ht.t1.json
 demos/dev_info_example/yeelink.light.lamp4.json