Skip to content
Snippets Groups Projects
Commit 28b6a9e8 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@3199 b32b6428-25c9-4566-ad07-03861ab6144f
parent aceca8dd
Branches
No related tags found
No related merge requests found
xaal.fauxmo
===========
This is a simple implementation of a Fauxmo device for the xAAL protocol. It allows you to control xAAL devices with an Amazon Echo.
The device can be :
- a simple power relay
- a lamp
- a scenario
- anything that support on/off commands
You can group multiple devices under the same name to control them all at once.
Usage
-----
The configuration (`fauxmo.ini`) file looks like this :
.. code:: yaml
[devices]
[[lampe ambiance]]
targets = e19d5ea8-c838-11ea-82a8-9cebe88e1963,
port = 49001
[[luminaires séjour]]
targets = e19d5ea8-c838-11ea-82a8-9cebe88e1963,6265eb30-8c59-11e9-98b1-b827ebe99201,
port = 49003
[[volet salle de bain]]
targets = e4b05165-be5d-46d5-acd0-4da7be1158ed,
port = 49004
Device name are the name that will be used to control the device with the Amazon Echo.
The `targets` field is a list of xAAL device UUIDs that will be controlled.
......@@ -3,10 +3,14 @@ name = "xaal.fauxmo"
version = "0.1"
description = "xAAL to Wemo fake emulations"
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", "wemo", "alexa"]
dependencies = ["xaal.lib", "fauxmo", "nest_asyncio"]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment