pyimaprotect 1.1.0

Get alarm status and informations from the IMA Protect API.

pyimaprotect - Python IMA Protect Alarm UNOFFICIAL

Get alarms status information from your IMA Protect Alarm.

It only allows to get status, not to change the status.

This work is originally developed for use with Home Assistant and the custom component imaprotect.

• Free software: MIT license

• Documentation: https://pyimaprotect.readthedocs.io.

Features

Parameters

• username: Username used to connect to https://pilotageadistance.imateleassistance.com

• password: Password used to connect to https://pilotageadistance.imateleassistance.com

Properties

• first_name: Firstname used in your contract

• last_name: Lastname used in your contract

• email: Email used in your contract

• offer: Offercurrently defined in your contract. Example: tout-inclus

• contract_number: Reference number of your contract

• alerts_enabled: Indicates whether the alarm is currently triggered (Boolean).

You can add properties using jsonpath, see method add_property

Methods

• get_all_info: return the full JSON from the IMA Protect API “me” endpoint.

• add_property: allow to add a property to your object. This property will be stored the first time the API is called and each time you call get_all_info.

• get_status: return the current status of your IMA Protect Alarm. See next table to understand the values returned.

List of Alarm status values

Alarm Value	State
-1	UNKNOWN
0	OFF
1	PARTIAL
2	ON

Credits

This work is based on the work of lplancke for Jeedom.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

1.0.0 (2021-04-11)

• First release on PyPI.