mijiaAPI 1.0.0__tar.gz → 1.1.0__tar.gz

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.0.0
+Version: 1.1.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -23,7 +23,7 @@ python setup.py install
 ```
 或者
 ```bash
-pip install NJUlogin
+pip install mijiaAPI
 ```
 
 ## 使用
@@ -44,7 +44,8 @@ pip install NJUlogin
   * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
   * `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)
+    * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
+    * 网站上的方法并非全部可用，需要自行测试
 
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/README.md

@@ -7,7 +7,7 @@ python setup.py install
 ```
 或者
 ```bash
-pip install NJUlogin
+pip install mijiaAPI
 ```
 
 ## 使用
@@ -28,7 +28,8 @@ pip install NJUlogin
   * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
   * `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)
+    * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
+    * 网站上的方法并非全部可用，需要自行测试
 
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/mijiaAPI/__init__.py

@@ -1,5 +1,6 @@
 from .login import mijiaLogin
 from .apis import mijiaAPI
+from .devices import mijiaDevices
 
 from .__version__ import (
     __title__,

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/mijiaAPI/__version__.py

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

mijiaAPI-1.1.0/mijiaAPI/devices.py

@@ -0,0 +1,80 @@
+from typing import Union
+from time import sleep
+from .apis import mijiaAPI
+
+class DevProp(object):
+    def __init__(self, prop_dict: dict):
+        self.name = prop_dict['name']
+        self.desc = prop_dict['description']
+        self.type = prop_dict['type']
+        if self.type not in ['bool', 'int', 'uint', 'float', 'string']:
+            raise ValueError(f'Unsupported type: {self.type}, available types: bool, int, uint, float, string')
+        self.rw = prop_dict['rw']
+        self.unit = prop_dict['unit']
+        self.range = prop_dict['range']
+        self.method = prop_dict['method']
+
+    def __str__(self):
+        return f'{self.name}: {self.desc}\n' \
+               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):
+        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.sleep_time = sleep_time
+
+    def __str__(self):
+        return f'{self.name} ({self.model})\n' \
+               f'Properties:\n' + '\n'.join([str(v) for v in self.prop_list.values()])
+
+    def set(self, name: str, did: str, value: Union[bool, int]) -> Union[bool, int]:
+        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]
+        if 'w' not in prop.rw:
+            raise ValueError(f'Property {name} is read-only')
+        if prop.type == 'bool':
+            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')
+        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')
+        elif prop.type == 'string':
+            if not isinstance(value, str):
+                raise ValueError(f'Invalid value for string: {value}, should be a string')
+        else:
+            raise ValueError(f'Unsupported type: {prop.type}, available types: bool, int, uint, float, string')
+        method = prop.method.copy()
+        method['did'] = did
+        method['value'] = value
+        ret = self.api.set_devices_prop([method])[0]['code'] == 0
+        sleep(self.sleep_time)
+        return ret
+
+    def get(self, name: str, did: str) -> Union[bool, int]:
+        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]
+        if 'r' not in prop.rw:
+            raise ValueError(f'Property {name} is write-only')
+        method = prop.method.copy()
+        method['did'] = did
+        ret = self.api.get_devices_prop([method])[0]['value']
+        sleep(self.sleep_time)
+        return ret

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/mijiaAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mijiaAPI
-Version: 1.0.0
+Version: 1.1.0
 Summary: A Python API for Xiaomi Mijia
 Home-page: https://github.com/Do1e/mijia-api
 Author: Do1e
@@ -23,7 +23,7 @@ python setup.py install
 ```
 或者
 ```bash
-pip install NJUlogin
+pip install mijiaAPI
 ```
 
 ## 使用
@@ -44,7 +44,8 @@ pip install NJUlogin
   * `get_consumable_items(did: str) -> list`：获取设备的耗材信息，`did`为设备id，在设备列表中获取
   * `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)
+    * `data`为一个字典的列表，字典需要包含`did`, `siid`, `piid`，后面两个键可从 *https://home.miot-spec.com/spec/{model}* 中获取，其中`model`为设备的model，在设备列表中获取，如[米家台灯 1S](https://home.miot-spec.com/spec/yeelink.light.lamp4)。
+    * 网站上的方法并非全部可用，需要自行测试
 
 ## 致谢
 * [janzlan/mijia-api](https://gitee.com/janzlan/mijia-api/tree/master)

{mijiaAPI-1.0.0 → mijiaAPI-1.1.0}/mijiaAPI.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.py
 mijiaAPI/__init__.py
 mijiaAPI/__version__.py
 mijiaAPI/apis.py
+mijiaAPI/devices.py
 mijiaAPI/login.py
 mijiaAPI/urls.py
 mijiaAPI/utils.py