Skip to main content

Python client library for the Alula alarm panel API

Project description

Alula for Home Assistant

A Home Assistant custom integration for Alula security alarm panels (Connect+, Helix, etc.).

Features

  • Alarm control panel entity with arm away, arm home, arm night, and disarm
  • Binary sensor entities for each zone (doors, motion, glass break, smoke, CO)
  • Near-instant state updates via WebSocket push events
  • PIN code support for disarming

Installation

HACS (recommended)

  1. Open HACS in your Home Assistant instance
  2. Go to Integrations > three-dot menu > Custom repositories
  3. Add pschorf/ha-alula as an Integration
  4. Click Install
  5. Restart Home Assistant

Manual

Copy the custom_components/alula directory into your Home Assistant custom_components/ folder and restart.

Setup

After installation, go to Settings > Devices & Services > Add Integration > Alula and enter:

  • Email -- your Alula account email
  • Password -- your Alula account password
  • Panel ID -- leave blank unless you have multiple panels on one account

pyalula

The integration is powered by pyalula, a standalone async Python client for the Alula API. It can also be used independently:

from pyalula import AlulaClient

async with AlulaClient() as client:
    await client.login("user@example.com", "password")
    panel = await client.get_panel_status()
    print(panel.arm_state)
    await client.arm("away")

Development

pip install -e ".[dev]"

# Library smoke test (requires real credentials):
ALULA_USER=you@example.com ALULA_PASS=secret python -m pyalula.smoke_test

# With debug logging:
DEBUG=1 ALULA_USER=you@example.com ALULA_PASS=secret python -m pyalula.smoke_test

Disclaimer

This project is not affiliated with or endorsed by Alula. It uses the same API as the official Alula mobile app. Use at your own risk.

License

MIT

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

pyalula-0.1.1.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyalula-0.1.1-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file pyalula-0.1.1.tar.gz.

File metadata

  • Download URL: pyalula-0.1.1.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyalula-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e29092f5a179264d8552cee5182013b66ef3597da9c4f45e2c56a17412e02cf6
MD5 7526d25bd73a74662e6436df9e28d9ff
BLAKE2b-256 17c24fd9ec8d7ff9e6be9e144c6dedc7ea57ac8d76f295ecbe4a228009568a51

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyalula-0.1.1.tar.gz:

Publisher: publish.yml on pschorf/ha-alula

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyalula-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyalula-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyalula-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e4287e26eb1109c32bc8e49a1abec9eb7749b79b1f57dc664b7e6a303650a83
MD5 b87d2867d9780747056910a3b8a85a30
BLAKE2b-256 39e3ef48589fabb8bb0e94690e69391281b77c530248bd48df4163c75eca7da1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyalula-0.1.1-py3-none-any.whl:

Publisher: publish.yml on pschorf/ha-alula

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page