Skip to content
Snippets Groups Projects
Commit 2f57f977 authored by jkerdreu's avatar jkerdreu
Browse files

Added some docs


git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3206 b32b6428-25c9-4566-ad07-03861ab6144f
parent a934c79a
No related branches found
No related tags found
No related merge requests found
xaal.monitor
============
This package is a library for monitoring the xAAL devices on the network. It provides a easy way to get the list of devices and their status
(attributes, description, metadata, etc...). It also provides a simple way to subscribe to events.
This package is used by a lot of xAAL programs like: The dashboard, the REST API, the Home Assistant plugin...
Usage
-----
.. code:: python
from xaal.monitor import Monitor
from xaal.schemas import devices
from xaal.lib import Engine
def on_event(ev_type, device):
print("Event type: %s from device %s" % (ev_type, device))
dev = devices.hmi()
eng = Engine()
eng.add_device(dev)
mon = Monitor(dev)
mon.subscribe(on_event)
eng.run()
[project]
name = "xaal.monitor"
version = "0.1"
version = "0.2"
description = "xAAL devices Monitor Lib"
readme = "README.rst"
authors = [ { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" } ]
license = { text = "GPL License"}
classifiers = ['Programming Language :: Python', 'Topic :: Software Development :: Libraries :: Python Modules']
authors = [
{ name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" },
]
license = { text = "GPL License" }
classifiers = [
'Programming Language :: Python',
'Topic :: Software Development :: Libraries :: Python Modules',
]
keywords = ['xaal', 'monitor']
dependencies = ['xaal.lib']
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment