Metadata-Version: 2.1
Name: pyimaprotect
Version: 2.0.0
Summary: Get alarm status and informations from the IMA Protect API.
Home-page: https://github.com/pcourbin/pyimaprotect
Author: Pierre COURBIN
Author-email: pierre.courbin@gmail.com
License: MIT license
Description: ===========================================================
        pyimaprotect - Python `IMA Protect Alarm`_ *UNOFFICIAL*
        ===========================================================
        
        
        .. image:: https://img.shields.io/pypi/v/pyimaprotect.svg
                :target: https://pypi.python.org/pypi/pyimaprotect
        
        .. image:: https://img.shields.io/pypi/pyversions/pyimaprotect.svg
                :target: https://pypi.python.org/pypi/pyimaprotect
        
        .. image:: https://img.shields.io/travis/pcourbin/pyimaprotect.svg
                :target: https://travis-ci.com/pcourbin/pyimaprotect
        
        .. image:: https://readthedocs.org/projects/pyimaprotect/badge/?version=latest
                :target: https://pyimaprotect.readthedocs.io/en/latest/?version=latest
                :alt: Documentation Status
        
        
        .. image:: https://pyup.io/repos/github/pcourbin/pyimaprotect/shield.svg
             :target: https://pyup.io/repos/github/pcourbin/pyimaprotect/
             :alt: Updates
        
        | 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
        --------
        
        Since the last update of IMAProtect "API" (05/2021), for now, this plugin only allows you to get the status of your alarm.
        
        Parameters
        ==========
        
        - `username`: Username used to connect to https://www.imaprotect.com/
        - `password`: Password used to connect to https://www.imaprotect.com/
        
        Methods
        =======
        
        - `get_status`: return the current status of your IMA Protect Alarm. See next table to understand the values returned.
        
        .. list-table:: List of Alarm status values
           :widths: auto
           :header-rows: 1
        
           * - Alarm Value
             - State
           * - `-1`
             - `UNKNOWN`
           * - `0`
             - `OFF`
           * - `1`
             - `PARTIAL`
           * - `2`
             - `ON`
        
        Credits
        -------
        
        | This work was based on the work of `lplancke`_ for `Jeedom`_.
        | This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _`IMA Protect Alarm`: https://www.imaprotect.com/
        .. _`Home Assistant`: https://www.home-assistant.io/
        .. _`imaprotect`: https://github.com/pcourbin/imaprotect
        .. _`lplancke`: https://github.com/lplancke/jeedom_alarme_IMA
        .. _`Jeedom`: https://www.jeedom.com
        ..
        
        
        =======
        History
        =======
        
        2.0.0 (2021-05-09)
        ------------------
        
        * Update using new IMAProtect "API"
        * No more other info (name, contract, etc.), only alarm status but faster result.
        
        1.0.0 (2021-04-11)
        ------------------
        
        * First release on PyPI.
        
Keywords: pyimaprotect
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.5
