py-unifi-access 1.1.1

Async Python client for the UniFi Access local API with WebSocket event support

py-unifi-access

Async Python client for the UniFi Access local API with WebSocket event support. Designed for Home Assistant Core integrations.

Features

• Async REST client (aiohttp) for doors, lock rules, emergency status
• WebSocket with auto-reconnect and exponential backoff
• Typed Pydantic v2 models for all API responses and 13 WebSocket event types
• Stateless design for Home Assistant's DataUpdateCoordinator pattern

Installation

pip install py-unifi-access

Usage

import aiohttp
from unifi_access_api import UnifiAccessApiClient

async with aiohttp.ClientSession() as session:
    client = UnifiAccessApiClient("192.168.1.1", "your-api-token", session)

    # Authenticate
    await client.authenticate()

    # Get all doors (keyed by ID for quick lookup)
    doors = {d.id: d for d in await client.get_doors()}
    for door in doors.values():
        print(f"{door.name}: {door.door_position_status}")

    # Unlock a specific door by ID
    await client.unlock_door("your-door-id")

    # WebSocket for real-time events
    ws = client.start_websocket({
        "access.data.device.update": lambda msg: print(msg),
    })

Development

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pre-commit install
pytest tests/ --cov

Releases

Merges to main now trigger an automatic release when the version in pyproject.toml changes. The workflow will:

• run CI
• build the package
• publish it to PyPI
• create and push a matching Git tag
• create a GitHub release with generated notes

To make PyPI publishing work, configure a PyPI trusted publisher for this GitHub repository and environment:

• repository: imhotep/py-unifi-access
• workflow file: ci.yml
• environment: pypi