Readme1st

From ago control wiki
(Difference between revisions)
Jump to: navigation, search
m (Readme First)
(Readme First)
Line 1: Line 1:
= Readme First =
+
= Basics =
Describes the basic function and design of agocontrol. Core of the System is the AMQP broker. The components communicate over a topic queue "agocontrol". The resolver is the brain of the system and knows everything about the system. The resolver stores information like devices and rooms which he got from agoadmin or plugins.  
+
ago control uses AMQP as underlying communication protocol. It uses the Apache QPID broker to pass messages. The components communicate over a topic queue "agocontrol". The [[Resolver]] component tracks device announcement events to build an inventory. It also enriches the inventory with devicename and room information and provides the device schema. This can be used by user interfaces as it defines the supported commands for each device type.
 
+
= Installation =
== Core Modules ==
+
We provide packages for Debian Wheezy and Fedora 17. You should install at least the agocontrol and the agocontrol-admin package. You probably also want to install other components for device support.
* qpid / AMQP broker - enterprise messaging system
+
= Configuration =
* agoresolver - service and name resolver for the AMQP based automation control
+
The global configuration is set in the [[config.ini]] file residing in /etc/opt/agocontrol. Here you can specify an installation uuid, the host, username and password for the broker configuration and settings for device interfaces like the USB com port to use for the Z-Wave interface device.
* agoadmin - webinterface for basic control and setup
+
= Startup =
* agocloud - cloud connector - interconnect the local AMQP automation system with the agocontrol.com cloud
+
The packages contain systemd service definitions. You can use systemctl to start ago control components, e.g.:
 
+
systemctl start agoresolver.service
== Plugins ==
+
systemctl start agoadmin.service
* agozwave - control Z-Wave devices
+
= Debugging =
* agoowfs  - control 1-Wire devices
+
The output from the components is logged to syslog. To watch the messages on the broker use "agodrain.py":
* agologger - logs events of ago.events including command "discover" to Syslog
+
 
+
 
+
== Message protocol ==
+
 
+
=== agoresolver commands ===
+
* inventory - listing inventory (devices, rooms)
+
* setroomname - set room name of given uiid and name
+
* setdeviceroom - set the room for device with given uuid's
+
* setdevicename - set the device name of given uuid and name
+
 
+
=== Device commands and parameters ===
+
'''YAML Shema'''
+
/etc/opt/agocontrol/schema.yaml
+
 
+
'''Commands'''
+
* on - switch device on
+
* off - switch device off
+
* setlevel - set level on device - example a dimmer value
+
 
+
'''Parameters'''
+
* level - level from 0 to 255
+
 
+
== Debugging ==
+
* look in /var/log/syslog
+
tail -f /var/log/syslog
+
 
+
* see whats going on in ago.events
+
 
  python /opt/agocontrol/bin/agodrain.py
 
  python /opt/agocontrol/bin/agodrain.py

Revision as of 14:00, 6 December 2012

Contents

Basics

ago control uses AMQP as underlying communication protocol. It uses the Apache QPID broker to pass messages. The components communicate over a topic queue "agocontrol". The Resolver component tracks device announcement events to build an inventory. It also enriches the inventory with devicename and room information and provides the device schema. This can be used by user interfaces as it defines the supported commands for each device type.

Installation

We provide packages for Debian Wheezy and Fedora 17. You should install at least the agocontrol and the agocontrol-admin package. You probably also want to install other components for device support.

Configuration

The global configuration is set in the config.ini file residing in /etc/opt/agocontrol. Here you can specify an installation uuid, the host, username and password for the broker configuration and settings for device interfaces like the USB com port to use for the Z-Wave interface device.

Startup

The packages contain systemd service definitions. You can use systemctl to start ago control components, e.g.:

systemctl start agoresolver.service
systemctl start agoadmin.service

Debugging

The output from the components is logged to syslog. To watch the messages on the broker use "agodrain.py":

python /opt/agocontrol/bin/agodrain.py
Personal tools