Skip to main content

Async Python wrapper to interact with internal Somfy TaHoma API

Project description

Somfy TaHoma

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.

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

USERNAME = ""
PASSWORD = ""

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhoma-0.5.10.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhoma-0.5.10-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file pyhoma-0.5.10.tar.gz.

File metadata

  • Download URL: pyhoma-0.5.10.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.4 Linux/5.4.0-1043-azure

File hashes

Hashes for pyhoma-0.5.10.tar.gz
Algorithm Hash digest
SHA256 0848f65bd289529b3e5689b43bcc394d31cda16a78b478b7dad2b29651d53a23
MD5 49fa64ad870e723b8d0a911dbd3cb4a9
BLAKE2b-256 b49de29383561b31d099c1f2387ea6578719f235b23eacd1f6f1c32bdc1aeb15

See more details on using hashes here.

File details

Details for the file pyhoma-0.5.10-py3-none-any.whl.

File metadata

  • Download URL: pyhoma-0.5.10-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.4 Linux/5.4.0-1043-azure

File hashes

Hashes for pyhoma-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 209c7a58cdc0349b603bfe3e5eb9e712f53b77b0f30e336087d0d3b31d352342
MD5 1fc91ce99319d8cc683169e8e53a37bd
BLAKE2b-256 ccb6be912d89d1a10b68c27defdabd3b7e97b645534c006fb6b250e2236dc99e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page