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
Since the last update of IMAProtect “API” (05/2021), this plugin allows you to:
get the status of your alarm:
from pyimaprotect import IMAProtect, STATUS_NUM_TO_TEXT
ima = IMAProtect('myusername','mysuperpassword')
print("# Get Status")
imastatus = ima.status
print("Current Alarm Status: %d (%s)" % (imastatus,STATUS_NUM_TO_TEXT[imastatus]))
set the status of your alarm:
from pyimaprotect import IMAProtect
ima = IMAProtect('myusername','mysuperpassword')
print("# Set Status")
ima.status = 0 # 0 to OFF, 1 to PARTIAL and 2 to On
get the list and information of your registered contacts:
from pyimaprotect import IMAProtect
ima = IMAProtect('myusername','mysuperpassword')
print("# Get Contact List")
contact_list = ima.get_contact_list()
for contact in contact_list:
print(contact)
download the images/photos taken with your connected elements:
from pyimaprotect import IMAProtect
ima = IMAProtect('myusername','mysuperpassword')
print("# Download Images")
ima.download_images() # Download images to 'Images/' folder. One subfolder per camera.
ima.download_images("MyImages/") # Download images to a defined directory 'MyImages/' folder.
Parameters
username: Username used to connect to https://www.imaprotect.com/
password: Password used to connect to https://www.imaprotect.com/
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.
Alarm Value |
State |
|---|---|
-1 |
UNKNOWN |
0 |
OFF |
1 |
PARTIAL |
2 |
ON |