pyimaprotect

Get alarm status and informations from the IMA Protect API.


Keywords
pyimaprotect
License
MIT
Install
pip install pyimaprotect==3.1.6

Documentation

pyimaprotect - Python IMA Protect Alarm UNOFFICIAL

image

image

image

Documentation Status

Updates

image

pre-commit

Black

Project Maintenance

BuyMeCoffee

Get and set alarm status from your IMA Protect Alarm.
You can get and set the status, get the list of contacts and download your images.

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

Features

Since the last update of IMAProtect "API" (05/2021), this plugin allows you to:

  • get the status of your alarm:
  • set the status of your alarm:
  • get the list and information of your registered contacts:
  • download the images/photos taken with your connected elements:

Parameters

Methods

  • `login()`: open a session with the IMA Protect Alarm website
  • `logout()`: close the session with the IMA Protect Alarm website
  • `status`: property to get or set the status of your IMA Protect Alarm. See the next table to understand the values.
  • `get_contact_list()`: get a JSON with the list and information about your registered contacts.
  • `download_images()`: download the images/photos taken with your connected elements.
List of Alarm status values
Alarm Value State
-1 UNKNOWN
0 OFF
1 PARTIAL
2 ON

Credits

This work was based on the work of lplancke and chris94440 for Jeedom.
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.