Copyright 2014, Jérôme Kerdreux, Telecom Bretagne

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.


Contents
========
The archive contains the following software : 
├── apps
│   ├── automata
│   ├── cmdline
│   ├── xAALBrowser
│   └── xaal-webUI
├── devices
│   ├── AirBreizh
│   ├── DummyGtkDevices
│   ├── Influxdb
│   ├── MqttRelay
│   ├── PushingBox
│   ├── SmsFreeMobile
│   ├── spotify
│   ├── WiiBalance
│   ├── xaal-desktopNotification
│   ├── xaal-mpd
│   ├── xaal-sqlalchemy
│   ├── xaal-wol
│   └── yahooWeather
├── gateways
│   ├── GrovePi
│   ├── X10
│   ├── xaal-knx
│   └── xaal-zwave
├── licences
│   ├── gpl.txt
│   └── lgpl.txt
├── README.txt
├── services: xAAL Services (not needed for basic operation)
│   ├── xAALCache
│   ├── xAALMetadata
│   └── xaal-schemasrepository
└── xaal-lib: xAAL Python Library

Installation
============
To install the library, simply use in a bash terminal: 
 $ cd xaal-lib
 $ sudo python setup.py install (or develop)

At this time, there is no setup.py, nor pip support for all devices, gateways
or services. But some of them have ;-)

Tests
=====
- Edit the xAAL/config.py to fix CONF_DIR, and SCHEMA_DIR 
- CONF_DIR: default config file path (Be careful, the directory must exist !!)
- SCHEMA_DIR:  path where you store the schemas. 
- Schemas are mainly used for the xAALBrowser at this time. 

- Start devices/DummyGtkDevices; python ./dummyLamp.py 

- Send command through xAAL to dummyLamp 
  cd apps/cmdline; python send.py e58d7d24-3db3-11e4-97b3-3c77e618c6f7 stop

Note: you can verify the xAAL addr in the configuration file for the dummy lamp

- Now you can try the web interface : 
  - Install cherrypy if needed (apt-get install python-cherrypy3)
  - Start the web-server : cd apps/xAALBrowser; python xAALBrowserIHM.py 
  - Browse http://localhost:8080/devices 
  
  
SUPPORT
=======
You may have found a bug, so please let us know at : 
christophe.lohr@telecom-bretagne.eu


Copyright and License:
=====================
See license directory


TODO
==== 
- Fix the ifdown / ifup error. Right now, on an ifdown the xAAL API raise 
  an socket.error.
- Fix WiiBalance Bluetooth connection.
- Fix in xAALBrowser: 
    * Default methods forms/buttons to add parameters inputs like dimmer
      for instance.
    * Avoid reload the entire page /devices 
    * Try comet vs Sse method because push data from server seems to be 
      slow with Sse method
- Cmdline.py: add parameters to use methods with parameters

--
The xAAL Team.