Skip to main content

Python client library for the Alula security platform API (Cove Smart, Alula Connect+)

Project description

alulapy

Python client library for the Alula security platform API. Works with Cove Smart, Alula Connect+, and other Alula-powered alarm systems.

Features

  • OAuth2 authentication with automatic token refresh
  • Device info — panel name, serial number, online status, firmware
  • Arming state — real-time armed/disarmed/armed-stay/armed-away status
  • Zone sensors — door, window, motion, smoke, water sensor open/closed states
  • Trouble flags — AC failure, low battery, comm failure, tamper, and more
  • Event log — recent arm/disarm/alarm events with filtering
  • Arm/Disarm — via helix.command RPC (requires dealer to enable interactive services)

Installation

pip install -e /path/to/alulapy

Quick Start

import asyncio
import aiohttp
from alulapy import AlulaClient

async def main():
    async with aiohttp.ClientSession() as session:
        client = AlulaClient(session)
        await client.async_login("your_username", "your_pin")

        devices = await client.async_get_devices()
        for device in devices:
            if device.is_panel:
                print(f"{device.name}: {device.arming_state}")
                print(f"  Online: {device.online}, Trouble: {device.any_trouble}")

        zones = await client.async_get_zones()
        for zone in zones:
            status = "OPEN" if zone.is_open else "closed"
            print(f"  Zone {zone.zone_index}: {zone.zone_name}{status}")

asyncio.run(main())

Arm/Disarm

Arm/disarm uses the helix.command RPC method. This requires interactiveEnabled: true on the device, which must be enabled by the alarm dealer (e.g., Cove support).

await client.async_arm_stay(device.id)
await client.async_arm_away(device.id)
await client.async_disarm(device.id)

If you get "Permission Denied" (error code 6), contact your alarm provider and ask them to enable interactive services on your device.

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

alulapy-0.2.0.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

alulapy-0.2.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file alulapy-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for alulapy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b198c0ff4ab25e505f85ad65ded027ff4c68c677db42137f0a382522cb5ad03f
MD5 abc7c7fe7b58910f8d9d4d711a83fb85
BLAKE2b-256 d9fb1da6042e9f2bae1bbc29c2c733db580aa3872ab0562c5be176e5187aa0fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for alulapy-0.2.0.tar.gz:

Publisher: pypi.yaml on JoshuaSeidel/alulapy

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

File details

Details for the file alulapy-0.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for alulapy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36752bc2853f7fdb1443fb5ec081d80abe703913e6f64208e353d0aff007ea92
MD5 0e015a0ff877aab29a2d595be5397895
BLAKE2b-256 ddfcd24a20385940f96148f41556617c5aa84f5b9bb59643416547807fb03d5f

See more details on using hashes here.

Provenance

The following attestation bundles were made for alulapy-0.2.0-py3-none-any.whl:

Publisher: pypi.yaml on JoshuaSeidel/alulapy

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