Skip to content

Logo

Documentation pydiagral

Welcome to the documentation for pydiagral, a Python library for interacting with the Diagral API.

About pydiagral

pydiagral is an asynchronous Python interface for the Diagral alarm system. This library allows users to control and monitor their Diagral alarm system through the official API.

[!CAUTION]

Please note that the Diagral alarm system is a security system, and it may be preferable not to connect it to any automation platform for security reasons. In no event shall the developer of pydiagral library be held liable for any issues arising from the use of this pydiagral library. The user installs and uses this integration at their own risk and with full knowledge of the potential implications.

Requirement

To use this library, which leverages the Diagral APIs, you must have a Diagral box (DIAG56AAX). This box connects your Diagral alarm system to the internet, enabling interaction with the alarm system via the API. You can find more information about the Diagral box here.

Key Features

The DiagralAPI class offers the following functionalities:

  • Authentication:

  • Connect to the Diagral API with username and password

  • Manage access tokens and their expiration

  • Create, validate, and delete API keys

  • System Configuration:

  • Retrieve alarm configuration

  • System Information:

  • Obtain system details

  • Retrieve the current system status
  • Manage webhooks

  • Manage anomalies

  • System Interraction:

  • Activate or Desactivate system (partially or globally)
  • Automatism actions

Quick Start

To get started with pydiagral, follow these steps:

  1. Installation:

bash pip install pydiagral

  1. Example

A modular and easy-to-use test script is available example_code.py to help you get started with the library.

Simply create a .env file with the following content:

USERNAME=your_email@example.com
PASSWORD=your_password
SERIAL_ID=your_serial_id
PIN_CODE=your_pin_code
LOG_LEVEL=DEBUG

And run the example_code.py.

TIP

You can customize the actions performed by example_code.py by modifying the parameters in the code, as indicated by the CUSTOMIZE THE TESTS section title.

API Structure

For detailed API documentation, please refer to the following sections:

  • API Reference: Comprehensive documentation of the DiagralAPI class and its methods
  • Data Models: Description of the data structures used
  • Exceptions: List of package exceptions

Contribution

Contributions to pydiagral are welcome! Please check our contribution guidelines for more information on how to participate in the development of this library.

License

pydiagral is distributed under the GPL-v3 License. See the LICENSE file for more details.