Skip to main content

aiopoolside

Asynchronous Python client for Poolside pool controllers.

Speaks the controller's local protocol: an encrypted JSON-RPC transport over websockets using the Noise Protocol Framework (Noise_XX_25519_ChaChaPoly_SHA256), plus the plaintext pre-auth pairing handshake used to enroll a new client.

Installation

pip install aiopoolside

Usage

import aiohttp

from aiopoolside import (
    PoolsideClient,
    async_await_pairing_result,
    async_request_pairing,
    generate_keypair,
)


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        # One-time pairing: the user approves the request on the controller.
        private_key, public_key = generate_keypair()
        ws, result = await async_request_pairing(
            session, "192.168.1.50", 8126, "My Client", public_key
        )
        approved = await async_await_pairing_result(ws)

        client = PoolsideClient(
            session=session,
            host="192.168.1.50",
            port=8126,
            client_private_key=private_key,
            controller_public_key=approved.controller_public_key,
            controller_uuid=approved.controller_uuid,
        )
        await client.async_connect()
        site, controls = await client.async_get_control_layout()
        try:
            for control in controls:
                print(control.name, control.control_type)
        finally:
            await client.async_disconnect()

Development

uv sync
uv run pytest

License

MIT

Metadata

Release files for aiopoolside 0.1.1

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

Source distribution (sdist)

Source distribution for aiopoolside 0.1.1
File Size Uploaded
aiopoolside-0.1.1.tar.gz 20.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiopoolside 0.1.1
File Interpreter ABI Platform
aiopoolside-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 39.3 kB

Release files / aiopoolside-0.1.1.tar.gz

Download URL aiopoolside-0.1.1.tar.gz
Size 20.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a37cf071570056e65cfba009d9494f86ebcd0400f65315f629062e7a7ffa4728
BLAKE2b-256 checksum
How to use checksums
f3a8b0893248fc83b854356c0a3ac9dc79f54b507a4dc03471840b42c1ca7258
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / aiopoolside-0.1.1-py3-none-any.whl

Download URL aiopoolside-0.1.1-py3-none-any.whl
Size 18.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3daf9361099a42f0986bdc4ea1b9a467fe2dc5d12d2099fdec6f3368e1527eb8
BLAKE2b-256 checksum
How to use checksums
9d328af71b58028535e4c6755db6ab5e5bd33b42bea4d293e05a6f6bfd513263
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page