Deprecation Notice

pyhoma is deprecated. Please use pyoverkiz 1.0 which is backwards compatible. See https://github.com/iMicknl/python-overkiz-api.

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.const import SUPPORTED_SERVERS
from pyhoma.client import TahomaClient

USERNAME = ""
PASSWORD = ""

async def main() -> None:
    async with TahomaClient(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())

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

Metadata

Release files for pyhoma 0.7.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyhoma 0.7.4
File	Size	Uploaded
pyhoma-0.7.4.tar.gz	26.8 kB	Dec 21, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for pyhoma 0.7.4
File	Interpreter	ABI	Platform	Reset
pyhoma-0.7.4-py3-none-any.whl 28.0 kB Dec 21, 2021	Python 3	none	any	Details

Total release size: 54.8 kB

Release files / pyhoma-0.7.4.tar.gz

Download URL	pyhoma-0.7.4.tar.gz
Size	26.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`e06bd6d27acbf379a488a5cb1c772c9e5b2832589c0499e37eb91f3f296b9ca5`
BLAKE2b-256 checksum How to use checksums	`27388f131765026ebfa7d183828848b2c8d26072e13739e57df58692ccb69b55`
Upload date	Dec 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.10.1 Linux/5.11.0-1022-azure`

Release files / pyhoma-0.7.4-py3-none-any.whl

Download URL	pyhoma-0.7.4-py3-none-any.whl
Size	28.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`691961989242c26e9983d93fbcfa47b7fadbbe41121d2dc49e5c409eb4330cf1`
BLAKE2b-256 checksum How to use checksums	`0681189585b444353044c0fb73a96fc77fcd821c3cc814babcbafeb64521d609`
Upload date	Dec 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.10.1 Linux/5.11.0-1022-azure`