pyhoma 0.5.14

Async Python wrapper to interact with internal Somfy TaHoma API, or other OverKiz API's.

Somfy TaHoma / OverKiz

An updated and async version of the original tahoma-api by @philklei. The aim of this wrapper is to offer an easy to consume Python wrapper for the internal API's used by tahomalink.com, or other vendors which use the OverKiz platform.

Somfy TaHoma has an official API, which can be consumed via the Somfy-open-api. Unfortunately only a few device classes are supported via the official API, thus the need for this wrapper.

This package is written for the Home Assistant ha-tahoma integration, but could be used by any Python project interacting with Somfy TaHoma devices.

Installation

pip install pyhoma

Getting started

import asyncio
import time

from pyhoma.client import TahomaClient

SUPPORTED_ENDPOINTS = {
    "Cozytouch": "https://ha110-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "eedomus": "https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "Hi Kumo": "https://ha117-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "Rexel Energeasy Connect": "https://ha112-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "Somfy Connexoon IO": "https://tahomalink.com/enduser-mobile-web/enduserAPI/",
    "Somfy Connexoon RTS": "https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "Somfy TaHoma": "https://tahomalink.com/enduser-mobile-web/enduserAPI/",
    "Somfy (Australia)": "https://ha201-1.overkiz.com/enduser-mobile-web/enduserAPI/",
    "Somfy (Europe)": "https://tahomalink.com/enduser-mobile-web/enduserAPI/",
    "Somfy (North America)": "https://ha401-1.overkiz.com/enduser-mobile-web/enduserAPI/",
}

USERNAME = ""
PASSWORD = ""

async def main() -> None:
    async with TahomaClient(USERNAME, PASSWORD, api_url=SUPPORTED_ENDPOINTS["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())

Development

Installation

• For Linux, install pyenv using pyenv-installer

• For MacOS, run brew install pyenv

• Don't forget to update your .bashrc file (or similar):

  export PATH="~/.pyenv/bin:$PATH"
  eval "$(pyenv init -)"
  

• Install the required dependencies

• Install poetry: curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

• Clone this repository

• cd python-tahoma-api

• Install the required Python version: pyenv install

• Init the project: poetry install

• Run poetry run pre-commit install

PyCharm

As IDE you can use PyCharm.

Using snap, run snap install pycharm --classic to install it.

For MacOS, run brew cask install pycharm-ce

Once launched, don't create a new project, but open an existing one and select the python-tahoma-api folder.

Go to File | Settings | Project: nre-tag | Project Interpreter. Your interpreter must look like <whatever>/python-tahoma-api/.venv/bin/python