Skip to main content

An API client for Roth's TouchlineSL control system.

Project description

A Python Library for Roth's TouchlineSL System

Roth TouchlineSL is a control system for underfloor heating, cooling and radiator control. They have a public API which is documented on their website.

This project provides a Python client for interacting with the API, and controlling heating systems. It does not have complete coverage of the API, and currently provides the facility to:

  • Authenticate with a https://roth-touchlinesl.com account
  • List modules associated with an account
  • Get details of individual zones
  • Get details of global heating schedules
  • Set a constant target temperature for a zone
  • Assign a zone to a specific global schedule

The library was designed primarily to support the development of a Home Assistant integration.

Design

Roth's API design makes operations on individual zones or schedules quite difficult. Only one endpoint is provided for fetching the configuration of zones, and it's the same endpoint that returns data for all zones attached to a module.

As a result, this client implements some basic caching. Each time the modules endpoint is queried, the result is cached for 30 seconds. Any POST requests made (setting temperatures, assigning zones to schedules) will invalidate the cache, and all GET methods have a refresh argument that can be used to force a refresh of the underlying data.

Installation

The package can be installed from PyPi as usual:

pip install pytouchlinesl

Example Usage

import asyncio
import os

from pytouchlinesl import TouchlineSL

async def touchlinesl_example():
    tsl = TouchlineSL(
        username=os.getenv("TOUCHLINESL_LOGIN"),
        password=os.getenv("TOUCHLINESL_PASSWORD"),
    )

    # Fetch a list of modules associated with the account
    modules = await tsl.modules()
    module = await tsl.module(module_id=modules[0].id)

    # Fetch a zone by name, set a constant target temperature of 17.0
    utility = await module.zone_by_name("Utility Room")
    await utility.set_temperature(17.0)

    # Fetch a zone by ID, assign it to a global schedule named "Living Spaces"
    kitchen = await module.zone(2411)
    living_spaces = await module.schedule_by_name("Living Spaces")
    await kitchen.set_schedule(living_spaces.id)

if __name__ == "__main__":
    asyncio.set_event_loop(asyncio.new_event_loop())
    asyncio.run(touchlinesl_example())

Contributing / Hacking

Contributions in either code or documentation are welcome. The set of features is limited at the moment, but I'm happy to expand as the need arises.

The project does not have many dependencies; just asyncio and pytest/pytest-asyncio for testing.

Dependencies are managed using uv. You can get started like so:

# Clone the repository
git clone https://github.com/jnsgruk/pytouchlinesl
cd pytouchlinesl

# Run the tests
uv run pytest
# Lint the code
uv run ruff check --fix
# Format the code
uv run ruff format

If you'd rather use standard Python tooling, you can do so:

# Clone the repository
git clone https://github.com/jnsgruk/pytouchlinesl
cd pytouchlinesl

# Create a virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install dev/project dependencies
pip install -e '.[dev]'

# Run the tests
pytest -s
# Lint the code
ruff check --fix
# Format the code
ruff format

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

pytouchlinesl-0.1.4.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

pytouchlinesl-0.1.4-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file pytouchlinesl-0.1.4.tar.gz.

File metadata

  • Download URL: pytouchlinesl-0.1.4.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pytouchlinesl-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ba4ef0ee2c04bc20ff1d383537385e9e7f09f763ca64cb6cf419258ce0ce33da
MD5 72184be565a44fb626d7dee5b06e3878
BLAKE2b-256 aedd377e8c8f410bb08f4393a387b6be26b1abbb6d1f4eebbf6d5fec3531df93

See more details on using hashes here.

File details

Details for the file pytouchlinesl-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pytouchlinesl-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 307d8c6191071135fdc5fee8b2fc1cd373e7e67bc023eb56a0ab448c785b379a
MD5 d76bb2f14fea3f00b77bb6e711b21e95
BLAKE2b-256 8f0dbd5c7c7420fe86afec35f5f8f9acdf76d4c803814263cc4e3039429bd39c

See more details on using hashes here.

Supported by

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