pysensorlinx

An async Python library for the SensorLinx API. It provides full control of HBX HVAC controllers (such as the ECO-0600) — reading sensor data, getting and setting device parameters, and managing heat-pump staging, tank temperatures, backup settings, and more.

Features

• Async — built on aiohttp for non-blocking I/O
• Login & session management — authenticate, auto-refresh tokens, and close sessions
• Buildings & devices — list buildings and enumerate devices per building
• Get & set parameters — read and write every ECO-0600 configuration parameter
• Temperature objects — Temperature and TemperatureDelta classes with automatic °F ↔ °C conversion
• Read sensor data — retrieve live temperature sensor readings and stage runtimes
• Exception hierarchy — typed exceptions for login failures and invalid parameters

Installation

pip install pysensorlinx

Development install

git clone https://github.com/sslivins/pysensorlinx.git
cd pysensorlinx
python -m venv .venv

# Windows
.venv\Scripts\activate

# macOS / Linux
source .venv/bin/activate

pip install -e .[tests]

Quick start

import asyncio
from pysensorlinx import Sensorlinx, SensorlinxDevice

async def main():
    api = Sensorlinx()
    try:
        await api.login("your_username", "your_password")

        # List buildings
        buildings = await api.get_buildings()
        building_id = buildings[0]["_id"]

        # List devices in the first building
        devices = await api.get_devices(building_id)
        device_id = devices[0]["syncCode"]

        # Create a device helper
        device = SensorlinxDevice(api, building_id, device_id)

        # Read parameters
        mode = await device.get_hvac_mode_priority()        # "heat", "cool", or "auto"
        temps = await device.get_temperatures()              # dict of sensor readings
        max_temp = await device.get_hot_tank_max_temp()      # Temperature(150.00, 'F')

        # Write parameters
        await device.set_hvac_mode_priority("auto")
        await device.set_hot_tank_max_temp(160)              # accepts int (°F) or Temperature
    finally:
        await api.close()

asyncio.run(main())

Temperature & TemperatureDelta

The library returns temperature values as Temperature or TemperatureDelta objects that handle unit conversion automatically. The API stores all values in °F.

from pysensorlinx import Temperature, TemperatureDelta

# Absolute temperatures  (°F = °C × 9/5 + 32)
t = Temperature(212, "F")
print(t.to_celsius())     # 100.0
print(t.as_celsius())     # Temperature(100.00, 'C')
print(t)                  # 212.00°F

# Temperature differentials  (ΔF = ΔC × 9/5, no +32 offset)
d = TemperatureDelta(9, "F")
print(d.to_celsius())     # 5.0
print(d.as_celsius())     # TemperatureDelta(5.00, 'C')
print(d)                  # 9.00Δ°F

Temperature methods

TemperatureDelta has the same methods (returns TemperatureDelta for as_*).

Some getters return 'off' when the feature is disabled:

shutdown = await device.get_warm_weather_shutdown()  # Temperature(75.00, 'F') or 'off'

API reference

Sensorlinx

The low-level API client. Manages authentication and HTTP requests.

SensorlinxDevice

A high-level wrapper around a single device. All methods are async.

Getters

Weather conditions

The description and weatherId fields in weather and forecast data come from OpenWeatherMap. Use weatherId for programmatic checks — it is more reliable than parsing the description string.

Setters

All setters accept the value as the first argument. Temperature setters accept int (°F), Temperature, or 'off' where applicable.

Exceptions

Testing

pip install -e .[tests]
pytest

License

MIT