Adding a new device type

From ago control wiki
(Difference between revisions)
Jump to: navigation, search
m (HTLM template for device)
m (HTLM template for device)
Line 19: Line 19:
 
File name: core/rpc/html/templates/devices/computer.in.html<br/>
 
File name: core/rpc/html/templates/devices/computer.in.html<br/>
  
<pre> <div class="four columns grid-item device"  data-bind="attr: {'data-uuid': uuid}"> </pre>
+
<pre> <div class="four columns grid-item device"  data-bind="attr: {'data-uuid': uuid}">  
<pre> <div class="row"></pre>
+
<div class="row">
<pre> <div class="three columns"></pre>
+
<div class="three columns">
<pre> <div class="pretty large primary btn grid-item-icon handle"></pre>
+
<div class="pretty large primary btn grid-item-icon handle">
<pre> <i class="icon-keyboard" data-bind="click: showDetails"></i></pre>
+
<i class="icon-keyboard" data-bind="click: showDetails"></i>
<pre> </div></pre>
+
</div>
<pre> </div></pre>
+
</div>
<pre> <div class="nine columns"></pre>
+
<div class="nine columns">
 
<div class="grid-item-header">
 
<div class="grid-item-header">
 
<h3 data-bind="text: name, if: name"></h3>
 
<h3 data-bind="text: name, if: name"></h3>
Line 54: Line 54:
 
</div>
 
</div>
 
  </div>
 
  </div>
</no_wiki>
+
</pre>
  
 
== debian install script ==
 
== debian install script ==

Revision as of 16:15, 22 January 2014

Contents

Tutorial for adding a new device type

This tutorial will take you through all steps and files needed to add a new device type to aGo control. As an example the "Computer" device type used by Wake-on-LAN (WOL) will be used.

Add to schema - conf/schema.yaml

 computer:
   name: General computer (for WOL)
   description: A computer
   commands: ["on"]


Add to main web script

File name: core/rpc/html/js/app.js Change the following:

var supported_devices = [ "switch", "dimmer", "binarysensor", "dimmerrgb", "multilevelsensor",
"scenario", "drapes", "brightnesssensor", "powermeter", "energysensor", "humiditysensor", "phone",
"pushbutton", "placeholder", "temperaturesensor", "energymeter", "squeezebox", "computer" ];

HTLM template for device

File name: core/rpc/html/templates/devices/computer.in.html

 <div class="four columns grid-item device"  data-bind="attr: {'data-uuid': uuid}"> 
	<div class="row">
		<div class="three columns">
			<div class="pretty large primary btn grid-item-icon handle">
				<i class="icon-keyboard" data-bind="click: showDetails"></i>
			</div>
		</div>
		<div class="nine columns">
			<div class="grid-item-header">
				<h3 data-bind="text: name, if: name"></h3>
				<ko opts="if: room ">
					<p class="room"><i class="icon-location"></i><span data-bind="text: room"></span></p>
				</ko>
                                <p class="info"><i class="icon-info"></i>
                                        <ko opts="if: state() == 0">
                                                <_span data-translateable="true">OFF</_span>
                                        </ko>
                                        <ko opts="if: state() == 255">
                                                <_span data-translateable="true">ON</_span>
                                        </ko>
                                </p>
			</div>
		</div>
	</div>
	<div class="row grid-item-controls">
		<div class="six columns">
		    <ko opts="if: state ">
                <_div data-translateable="true" class="cmd-btn pretty medium default btn btn-full grid-command" data-bind="click: turnOn" data-value="on">ON</_div>
            </ko>
            <ko opts="ifnot: state ">
                <_div data-translateable="true" class="cmd-btn pretty medium primary btn btn-full grid-command" data-bind="click: turnOn" data-value="on">ON</_div>
            </ko>
		</div>
	</div>
 </div>

debian install script

File name: debian/agocontrol-wake_on_lan.install

Update makefile

File name: devices/Makefile

New make file

File name: devices/wake_on_lan/Makefile


Device driver

Main logic

File name: devices/wake_on_lan/agowake_on_lan.py
Finally, a device driver that uses the new device type. This is a plain vanilla task as outlined in Example Device.

    client.addDevice(deviceId, "computer")

Config file

File name: devices/wake_on_lan/wake_on_lan.conf


Service definition

File name: conf/systemd/agowake_on_lan.service

Personal tools