zwave-alarm-client

Async Python client (aiohttp) for the REST API of the Z-Wave Alarm service. Used by the Home Assistant integration; contains no Home Assistant code.

import aiohttp
from zwave_alarm_client import async_get_panel_state, async_stream_events, InvalidAuth, CannotConnect

async with aiohttp.ClientSession() as session:
    panel = await async_get_panel_state(session, "192.168.1.50", 3000, None)

    async for event in async_stream_events(session, "192.168.1.50", 3000, None):
        ...  # first event is a full `snapshot`, then `panel.changed`, `sensor.changed`, ...

Every call takes (session, host, port, token, ...); token is optional: pass None (no Authorization header is sent, so only host and port are needed); a non-empty value is sent as a bearer token. A cookie session from async_login also works with None. Pass secure=True for https/wss.

Coverage

Response shapes are available as TypedDicts in zwave_alarm_client.models.

Errors

All derive from ZwaveAlarmError: CannotConnect (unreachable, timeout, 5xx; ServiceUnavailable for 503), InvalidAuth (401), Forbidden (403), NotFound (404), BadRequest (400, message names the field), Conflict (409; CommandRejected for a lost arm/disarm race, ZoneNotEmpty, ZoneInUse, CodeInUse), AccountLocked (423), TooManyRequests (429, .retry_after).

Development

python -m venv .venv && . .venv/bin/activate
pip install -e '.[test]'
pytest

Commits follow Conventional Commits: fix releases a patch, feat a minor, BREAKING CHANGE/! a major. Releases are tagged and published to PyPI from main.