| Name | xaal.tools JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | xAAL devices tools |
| upload_time | 2024-11-06 22:40:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | GPL License |
| keywords |
xaal
tools
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
xaal.tools
==========
A collection of tools for working with the xAAL bus.
This package contains the following tools:
- xaal-isalive
- xaal-info
- xaal-walker
- xaal-dumper
- xaal-log
- xaal-querydb
- xaal-cleandb
- xaal-send
- xaal-tail
- xaal-pkgrun
- xaal-keygen
- xaal-uuidgen
- xaal-shell
Usage
-----
All tools have a help option (-h) that can be used to get more information about. For example:
.. code:: shell
Usage: xaal-isalive [options]
Options:
-h, --help show this help message and exit
-c disable color
-l Enable logging
-a MCAST_ADDR Multicast address
-p MCAST_PORT Multicast port
-t FILTER_TYPE only show given device type
Details
-------
xaal-isalive
~~~~~~~~~~~~
This tool is used to check if a device is alive on the xAAL bus, by sending a isAlive request to the devices
xaal-info
~~~~~~~~~
This tool is used to get information about a device, by requesting description / attributes / metadata.
xaal-walker
~~~~~~~~~~~
This tool is used to walk the xAAL bus and get information about all devices.
xaal-dumper
~~~~~~~~~~~
This tool is used to dump messages from the xAAL bus.
xaal-log
~~~~~~~~
This tool is used to log attributes changed.
xaal-querydb
~~~~~~~~~~~~
This tool is used to query the metadata database.
xaal-cleandb
~~~~~~~~~~~~
This tool is used to clean the metadata database.
xaal-send
~~~~~~~~~
This tool is used to send a message (request) on the xAAL bus.
xaal-tail
~~~~~~~~~
This tool provide a tail-like event logging.
xaal-pkgrun
~~~~~~~~~~~
This tool is used to run packages (for example a gateway). It will load the package and run it.
Example: xaal-pkgrun owm knx
xaal-keygen
~~~~~~~~~~~
This tool is used to generate a key for the xAAL bus.
xaal-uuidgen
~~~~~~~~~~~~
This tool is used to generate a UUID.
xaal-shell
~~~~~~~~~~
This tool is used to start a ipython interpreter with xAAL tools loaded.
Raw data
{
"_id": null,
"home_page": null,
"name": "xaal.tools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "xaal, tools",
"author": null,
"author_email": "Jerome Kerdreux <Jerome.Kerdreux@imt-atlantique.fr>",
"download_url": "https://files.pythonhosted.org/packages/48/66/728c98de7fd3b33c89ee90a45dbf626384c594e3c04644ffe00def25ba10/xaal_tools-0.6.1.tar.gz",
"platform": null,
"description": "\nxaal.tools\n==========\nA collection of tools for working with the xAAL bus.\n\nThis package contains the following tools:\n - xaal-isalive\n - xaal-info\n - xaal-walker\n - xaal-dumper\n - xaal-log\n - xaal-querydb\n - xaal-cleandb\n - xaal-send\n - xaal-tail\n - xaal-pkgrun\n - xaal-keygen\n - xaal-uuidgen\n - xaal-shell\n\nUsage\n-----\nAll tools have a help option (-h) that can be used to get more information about. For example:\n\n .. code:: shell\n\n Usage: xaal-isalive [options]\n\n Options:\n -h, --help show this help message and exit\n -c disable color\n -l Enable logging\n -a MCAST_ADDR Multicast address\n -p MCAST_PORT Multicast port\n -t FILTER_TYPE only show given device type\n\n\nDetails\n-------\n\nxaal-isalive\n~~~~~~~~~~~~\nThis tool is used to check if a device is alive on the xAAL bus, by sending a isAlive request to the devices\n\nxaal-info\n~~~~~~~~~\nThis tool is used to get information about a device, by requesting description / attributes / metadata.\n\nxaal-walker\n~~~~~~~~~~~\nThis tool is used to walk the xAAL bus and get information about all devices.\n\nxaal-dumper\n~~~~~~~~~~~\nThis tool is used to dump messages from the xAAL bus.\n\nxaal-log\n~~~~~~~~\nThis tool is used to log attributes changed.\n\nxaal-querydb\n~~~~~~~~~~~~\nThis tool is used to query the metadata database.\n\nxaal-cleandb\n~~~~~~~~~~~~\nThis tool is used to clean the metadata database.\n\nxaal-send\n~~~~~~~~~\nThis tool is used to send a message (request) on the xAAL bus.\n\nxaal-tail\n~~~~~~~~~\nThis tool provide a tail-like event logging.\n\nxaal-pkgrun\n~~~~~~~~~~~\nThis tool is used to run packages (for example a gateway). It will load the package and run it.\nExample: xaal-pkgrun owm knx\n\nxaal-keygen\n~~~~~~~~~~~\nThis tool is used to generate a key for the xAAL bus.\n\nxaal-uuidgen\n~~~~~~~~~~~~\nThis tool is used to generate a UUID.\n\nxaal-shell\n~~~~~~~~~~\nThis tool is used to start a ipython interpreter with xAAL tools loaded.\n",
"bugtrack_url": null,
"license": "GPL License",
"summary": "xAAL devices tools",
"version": "0.6.1",
"project_urls": {
"Documentation": "https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/entry/code/Python/branches/0.7/apps/tools/README.rst",
"Homepage": "https://recherche.imt-atlantique.fr/xaal/",
"Source": "https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/tools"
},
"split_keywords": [
"xaal",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac8803734a3817edf12965c08fb3c3cf7b242ce7c5299e3b0a54721488103402",
"md5": "adcb789e2389ce7ff512e583b6db25cf",
"sha256": "d01e44c7126813245e726d8144b2100b95bc737316fde40a328b46620f5fda20"
},
"downloads": -1,
"filename": "xaal.tools-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adcb789e2389ce7ff512e583b6db25cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10508,
"upload_time": "2024-11-06T22:40:35",
"upload_time_iso_8601": "2024-11-06T22:40:35.388096Z",
"url": "https://files.pythonhosted.org/packages/ac/88/03734a3817edf12965c08fb3c3cf7b242ce7c5299e3b0a54721488103402/xaal.tools-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4866728c98de7fd3b33c89ee90a45dbf626384c594e3c04644ffe00def25ba10",
"md5": "4bffb0bc36bb61f39ae6acfa660f0929",
"sha256": "25837966e830d3ae1200b2a29d4863db343f6fe4bac9eb554e4ed8c63d34a6a6"
},
"downloads": -1,
"filename": "xaal_tools-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "4bffb0bc36bb61f39ae6acfa660f0929",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10843,
"upload_time": "2024-11-06T22:40:37",
"upload_time_iso_8601": "2024-11-06T22:40:37.140438Z",
"url": "https://files.pythonhosted.org/packages/48/66/728c98de7fd3b33c89ee90a45dbf626384c594e3c04644ffe00def25ba10/xaal_tools-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 22:40:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xaal.tools"
}
