Metadata-Version: 2.1
Name: python-xsense
Version: 0.0.3
Summary: XSense Python Module
Home-page: https://github.com/theosnel/python-xsense
Author: Theo Snelleman
Author-email: <python@theo.snelleman.net>
License: MIT
Keywords: python,xsense
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: requests
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: pycognito
Provides-Extra: async
Requires-Dist: aiohttp ; extra == 'async'

Python-xsense
=============

Python-xsense is a small library to interact with the API of XSense Home
Security. It allows to retrieve the status of various devices and the
basestation.

Example sync usage
------------------

::

   >>> from xsense import XSense
   >>> from xsense.utils import dump_environment
   >>> api = XSense()
   >>> api.init()
   >>> api.login(username, password)
   >>> api.load_all()
   >>> for _, h in api.houses.items():
   >>>     for _, s in h.stations.items():
   >>>         api.get_state(s)
   >>> dump_environment(api)

Example async usage
-------------------

::

   >>> import asyncio
   >>> from xsense import AsyncXSense
   >>> from xsense.utils import dump_environment
   >>>
   >>> async def run(username: str, password: str):
   >>>     api = AsyncXSense()
   >>>     await api.init()
   >>>     await api.login(username, password)
   >>>     for _, h in api.houses.items():
   >>>         for _, s in h.stations.items():
   >>>             await api.get_state(s)
   >>>     dump_environment(api)
   >>>
   >>> asyncio.run(run(username, password))

Development
-----------

This library is in an early development stage and created primarily to
make an integration for home assistant.
