与内部 OverKiz API 交互的异步 Python 客户端（例如，由 Somfy TaHoma 使用）。
项目描述
OverKiz API 的 Python 客户端
用于（内部）OverKiz API 的完全异步且易于使用的 API 客户端。您可以使用此客户端与连接到 OverKiz 平台的智能设备进行交互，该平台由 Somfy TaHoma 和 Atlantic Cozytouch 等多家供应商使用。
这个包是为 Home Assistant ha-tahoma集成编写的，但可以被任何与 OverKiz 集线器交互的 Python 项目使用。
Somfy TaHoma 有一个官方 API，可以通过somfy-open-api使用。不幸的是，官方 API 仅支持少数设备类，因此需要此 API 客户端。
支持的集线器
- 大西洋舒适触感
- 布依格弹性体
- 日立嗨云
- Nexity 欧仁妮
- Rexel Energeasy 连接
- 思慕 (LiveIn2)
- 尚飞连接 IO
- Somfy Connexoon RTS
- 尚飞 TaHoma
- 尚飞 TaHoma 开关
- Thermor Cozytouch
安装
pip install pyoverkiz
入门
import asyncio
import time
from pyoverkiz.const import SUPPORTED_SERVERS
from pyoverkiz.client import OverkizClient
USERNAME = ""
PASSWORD = ""
async def main() -> None:
async with OverkizClient(USERNAME, PASSWORD, server=SUPPORTED_SERVERS["somfy_europe"]) as client:
try:
await client.login()
except Exception as exception: # pylint: disable=broad-except
print(exception)
return
devices = await client.get_devices()
for device in devices:
print(f"{device.label} ({device.id}) - {device.controllable_name}")
print(f"{device.widget} - {device.ui_class}")
while True:
events = await client.fetch_events()
print(events)
time.sleep(2)
asyncio.run(main())
发展
安装
-
对于 Linux，使用pyenv-installer安装pyenv
-
对于 MacOS，运行
brew install pyenv -
不要忘记更新您的
.bashrc文件（或类似文件）：export PATH="~/.pyenv/bin:$PATH" eval "$(pyenv init -)" -
安装所需的依赖项
-
安装诗歌：
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
克隆此存储库
-
cd python-overkiz-api -
安装所需的 Python 版本：
pyenv install -
启动项目：
poetry install -
跑
poetry run pre-commit install
PyCharm
作为 IDE，您可以使用PyCharm。
使用 snap，运行snap install pycharm --classic安装它。
对于 MacOS，运行brew cask install pycharm-ce
启动后，不要创建新项目，而是打开现有项目并选择python-overkiz-api文件夹。
转到文件 | 设置 | 项目：nre-tag | 项目口译员。您的口译员必须看起来像<whatever>/python-overkiz-api/.venv/bin/python
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。