You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58-14Lines changed: 58 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -7,23 +7,11 @@
7
7
8
8
A fully async and easy to use API client for the (internal) OverKiz API. You can use this client to interact with smart devices connected to the OverKiz platform, used by various vendors like Somfy TaHoma and Atlantic Cozytouch.
9
9
10
-
This package is written for the Home Assistant [ha-tahoma](https://github.com/iMicknl/ha-tahoma) integration, but could be used by any Python project interacting with OverKiz hubs.
11
-
12
-
> Somfy TaHoma has an official API, which can be consumed via the [somfy-open-api](https://github.com/tetienne/somfy-open-api). Unfortunately only a few device classes are supported via the official API, thus the need for this API client.
10
+
This package is written for the Home Assistant [Overkiz](https://www.home-assistant.io/integrations/overkiz/) integration, but could be used by any Python project interacting with OverKiz hubs.
13
11
14
12
## Supported hubs
15
13
16
-
- Atlantic Cozytouch
17
-
- Bouygues Flexom
18
-
- Hitachi Hi Kumo
19
-
- Nexity Eugénie
20
-
- Rexel Energeasy Connect
21
-
- Simu (LiveIn2)
22
-
- Somfy Connexoon IO
23
-
- Somfy Connexoon RTS
24
-
- Somfy TaHoma
25
-
- Somfy TaHoma Switch
26
-
- Thermor Cozytouch
14
+
See [pyoverkiz/const.py](./pyoverkiz/const.py)
27
15
28
16
## Installation
29
17
@@ -33,6 +21,62 @@ pip install pyoverkiz
33
21
34
22
## Getting started
35
23
24
+
### API Documentation
25
+
26
+
A subset of the API is [documented and maintened](https://somfy-developer.github.io/Somfy-TaHoma-Developer-Mode) by Somfy.
27
+
28
+
### Local API or Developper mode
29
+
30
+
See https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode#getting-started
31
+
32
+
For the moment, only Tahoma and Conexoon hubs from Somfy Europe can enabled this mode. Not all the devices are returned. You can have more details [here](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode/issues/20).
33
+
34
+
```python
35
+
import asyncio
36
+
import time
37
+
38
+
from aiohttp import ClientSession
39
+
40
+
from pyoverkiz.clients.overkiz import OverkizClient
0 commit comments