pylocal-akuvox 0.1.0

Async Python library for the Akuvox local HTTP API

pylocal-akuvox

Async Python library for the Akuvox local HTTP API.

pylocal-akuvox provides a single AkuvoxDevice object for communicating with Akuvox intercoms and access controllers on the LAN. It supports user/PIN management, relay control, schedule management, and log retrieval over the device's local HTTP API.

Features

• Async-only — designed for asyncio event loops and Home Assistant
• Single runtime dependency — only aiohttp
• Full device management — users, PINs, relays, schedules, and logs
• Multiple auth modes — None, Allowlist, Basic, and Digest
• SSL support — including self-signed certificate handling
• Comprehensive error handling — typed exception hierarchy

Installation

pip install pylocal-akuvox

Quick Start

import asyncio
from pylocal_akuvox import AkuvoxDevice

async def main():
    async with AkuvoxDevice("192.168.1.100") as device:
        info = await device.get_info()
        print(f"{info.model} — FW {info.firmware_version}")

asyncio.run(main())

Manage Users and PINs

import asyncio
from pylocal_akuvox import AkuvoxDevice

async def main():
    async with AkuvoxDevice("192.168.1.100") as device:
        await device.add_user(
            name="Alice",
            user_id="2001",
            web_relay="0",
            schedule_relay="1001-1;",
            lift_floor_num="0",
            private_pin="1234",
        )

        users = await device.list_users()
        for user in users:
            print(f"{user.name} (ID: {user.user_id})")

asyncio.run(main())

Trigger a Door Relay

import asyncio
from pylocal_akuvox import AkuvoxDevice

async def main():
    async with AkuvoxDevice("192.168.1.100") as device:
        await device.trigger_relay(num=1, delay=5)

asyncio.run(main())

Authentication

import asyncio
from pylocal_akuvox import AkuvoxDevice, AuthConfig, AuthMethod

async def main():
    # Basic Auth
    auth = AuthConfig(method=AuthMethod.BASIC, username="admin", password="secret")
    async with AkuvoxDevice("192.168.1.100", auth=auth) as device:
        info = await device.get_info()

asyncio.run(main())

Documentation

Full documentation is available at pylocal-akuvox.readthedocs.io.

Contributing

This project uses uv for dependency management.

# Clone and install
git clone https://github.com/tykeal/pylocal-akuvox.git
cd pylocal-akuvox
uv sync --group dev

# Run tests
uv run pytest tests/ -x -q

# Run linting
uv run ruff check src/ tests/

# Build docs locally
uv run --extra docs sphinx-build -b html docs docs/_build/html

License

Apache-2.0 — see LICENSE for details.