Readme1st

From ago control wiki
(Difference between revisions)
Jump to: navigation, search
(Device commands and parameters)
(Installation)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Readme First =
+
= Basics =
Describes the basic function and design of agocontrol. Core of the System is the AMQP broker. The broker has two topics ago.events and ago.commands. 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 =
 +
We provide packages for Debian Jessie. You should install at least the agocontrol package. You probably also want to install other components for device support.
  
== Core Modules ==
+
= Configuration =
* qpid / AMQP broker - enterprise messaging system
+
The global configuration is set in the [[System.conf]] file residing in /etc/opt/agocontrol/conf.d/. Here you can specify an installation uuid, the host, username and password for the broker configuration.  Settings for other devices are in device specific conf files located in the same directory.
* agoresolver - service and name resolver for the AMQP based automation control
+
* agoadmin - webinterface for basic control and setup
+
* agocloud - cloud connector - interconnect the local AMQP automation system with the agocontrol.com cloud
+
  
== Plugins ==
+
= Debugging =
* agozwave - control Z-Wave devices
+
The output from the components is logged to syslog. Depending on your syslog configuration it probably ends up in the log /var/log/syslog. You can also take a look at the internal AMQP communication. To watch the messages on the broker use "agodrain":
* agoowfs  - control 1-Wire devices
+
/opt/agocontrol/bin/agodrain
* agologger - logs events of ago.events including command "discover" to Syslog
+
  
 
+
= What next? =
== Message protocol ==
+
Now connect to the ago control administration interface. You can get more information here: [[AgoAdmin]]
 
+
=== 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
+

Latest revision as of 22:44, 26 October 2016

Contents

[edit] 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.

[edit] Installation

We provide packages for Debian Jessie. You should install at least the agocontrol package. You probably also want to install other components for device support.

[edit] Configuration

The global configuration is set in the System.conf file residing in /etc/opt/agocontrol/conf.d/. Here you can specify an installation uuid, the host, username and password for the broker configuration. Settings for other devices are in device specific conf files located in the same directory.

[edit] Debugging

The output from the components is logged to syslog. Depending on your syslog configuration it probably ends up in the log /var/log/syslog. You can also take a look at the internal AMQP communication. To watch the messages on the broker use "agodrain":

/opt/agocontrol/bin/agodrain

[edit] What next?

Now connect to the ago control administration interface. You can get more information here: AgoAdmin

Personal tools