Skip to main content

Python library for controlling Saleryd HRV system

Project description

PyPI-Server Monthly Downloads Project generated with PyScaffold

pysaleryd

Python library for controlling Saleryd HRV system

Python library for controlling Saleryd HRV system using the built in websocket server used by Saleryd HRV Homeassistant integration https://github.com/bj00rn/ha-saleryd-ftx

Maintains a reconnecting websocket to the system.

Supported devices

LOKE1/Loke Basic/LS-01 using control system 4.1.5

Usage with asyncio as library

Read data

import asyncio
import aiohttp

from pysaleryd.client import Client

async with aiohttp.ClientSession() as session:
    async with Client(WEBSOCKET_URL, WEBSOCKET_PORT, session) as hrv_client:
        await asyncio.sleep(2) # wait a bit for some data
        print(client.data)

Read data using callback

import asyncio
import aiohttp

from pysaleryd.client import Client

def handle_message(data: dict):
    print(data)

update_interval = 10 # call handle_message every 30 seconds

async with aiohttp.ClientSession() as session:
    async with Client(WEBSOCKET_URL, WEBSOCKET_PORT, session, update_interval) as hrv_client:
        hrv_client.add_handler(handle_message)
        await asyncio.sleep(update_interval +1 ) # wait around a bit for data

Send control command

Command syntax can be found by dissecting websocket messages in the built in web ui

import asyncio
import aiohttp

from pysaleryd.client import Client

async with aiohttp.ClientSession() as session:
    async with Client(WEBSOCKET_URL, WEBSOCKET_PORT, session) as hrv_client:
        await hrv_client.send_command("XX", 1)

Troubleshooting

  • Confirm system is connected and UI is reachable on the local network. Follow steps in the manual.

  • Confirm websocket port by connecting to the UI using a browser and take note of websocket port using debug console in browser. 3001 is probably default

  • The system HRV system can only handle a few connected clients. Shut down any additional clients/browsers sessions and try again.

Disclaimer

Use at own risk.

This project is in no way affiliated with the manufacturer.

All product names, logos, and brands are property of their respective owners. All company, product and service names used are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.

Note

This project has been set up using PyScaffold 4.4. For details and usage information on PyScaffold see https://pyscaffold.org/.

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

pysaleryd-5.0.1.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

pysaleryd-5.0.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file pysaleryd-5.0.1.tar.gz.

File metadata

  • Download URL: pysaleryd-5.0.1.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pysaleryd-5.0.1.tar.gz
Algorithm Hash digest
SHA256 c1f4230632556310488487bfbeabf0926baaff021abf58dd6a44a8037cf9a1dd
MD5 dcbedf60ca1f624f9749dbda6dc7ef39
BLAKE2b-256 54cece7d19c1a035723707032e8a0c9430fd9030e39ee10dbc02e16a4ce18f52

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysaleryd-5.0.1.tar.gz:

Publisher: ci.yml on bj00rn/pysaleryd

Attestations:

File details

Details for the file pysaleryd-5.0.1-py3-none-any.whl.

File metadata

  • Download URL: pysaleryd-5.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pysaleryd-5.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 707dd81a95e157e66f62ac387440206da39f1deb06663f9e626ed936f4e7272e
MD5 98393336119247b792e802ad878dd716
BLAKE2b-256 c4a12d37051648b70556fe5fb484e25a739573f68a4dbc17a2e80a65f1cfac26

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysaleryd-5.0.1-py3-none-any.whl:

Publisher: ci.yml on bj00rn/pysaleryd

Attestations:

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