Get alarm status and informations from the IMA Protect API.
Project description
pyimaprotect - Python IMA Protect Alarm UNOFFICIAL
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.
Alarm Value |
State |
---|---|
-1 |
UNKNOWN |
0 |
OFF |
1 |
PARTIAL |
2 |
ON |
Credits
History
1.0.0 (2021-04-11)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyimaprotect-1.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e51a30a5fba72832eb80e0df15148de64d3850932d78b3c591336b81e20577b |
|
MD5 | 02615b3f75f363d001d507bff4a6f56d |
|
BLAKE2b-256 | b54d5c6611fcc05b00ae85c43422fc7d2180a82cb7f8748cd297f7074ab20453 |