livebox:xap_adapter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
livebox:xap_adapter [2011/12/18 18:13] brettlivebox:xap_adapter [2012/03/20 12:13] (current) – [1-Wire] minerva9
Line 5: Line 5:
 <code> <code>
 # xap-livebox --help # xap-livebox --help
- +Livebox Connector for xAP 
-Livebox Connector for xAP v12 +Copyright (C) DBzoo, 2008-2010
-Copyright (C) DBzoo, 2008,2009+
  
 xap-livebox: [options] xap-livebox: [options]
-  -n, --instance NAME    Default Controller 
   -i, --interface IF     Default br0   -i, --interface IF     Default br0
-  -p, --port NUM         Default 3639 
   -s, --serial DEV       Default /dev/ttyS0   -s, --serial DEV       Default /dev/ttyS0
-  -d, --debug            0-9+  -b, --baud RATE        Default 115200 
 +  -d, --debug            0-7
   -h, --help   -h, --help
 # #
Line 26: Line 24:
 The webserver interacts with this daemon by using an internal (127.0.0.1) socket connection on port 79.  This allows each component to be restarted independently of the other.  If the web server fails to communicate with the xap-livebox daemon you will see the message "**?**" being displayed on the webserver.  If this occurs, verify that the xap-livebox process is running. The webserver interacts with this daemon by using an internal (127.0.0.1) socket connection on port 79.  This allows each component to be restarted independently of the other.  If the web server fails to communicate with the xap-livebox daemon you will see the message "**?**" being displayed on the webserver.  If this occurs, verify that the xap-livebox process is running.
  
-===== 1-Wire ===== +===== Inputs and Relays =====
- +
-<code ini> +
-[1-Wire] +
-# Up to 15x 1-wire devices may be supported increasing the number +
-# beyond what you have attached simply presents more xAP endpoints than +
-# you have devices for. +
-devices=1 +
-sensor1.label=Office +
-</code>+
  
-Each sensor can be given a label using the nomenclature "sensor#.label=<your label>" These are best setup using the WEB interface but can be done manually too. The assigned label will be included in the xAP message that is generated when the temperature changes. The 'displaytext' tag will have the format 'displaytext=<label> <temperature>' e.g. displaytext=Inside 21.0 +{{:livebox:config-relays-inputs.jpg|}}
- +
-===== Inputs and Relays =====+
  
 These sections allow us to configure user friendly names that will appear on the webserver interface.  The xAP protocol does not make use of these labels. These sections allow us to configure user friendly names that will appear on the webserver interface.  The xAP protocol does not make use of these labels.
Line 58: Line 45:
  
 The inputs are exposed as four pairs of terminal blocks. Simply short the adjacent terminals together to turn the input on. Looking at the connectors, with the LCD connector on the right, each pair is one input. Numbered (left to right) 2,1,4,3. If your environment is 'noisy' you might need to add an external pullup resistor on the input pin. The inputs are exposed as four pairs of terminal blocks. Simply short the adjacent terminals together to turn the input on. Looking at the connectors, with the LCD connector on the right, each pair is one input. Numbered (left to right) 2,1,4,3. If your environment is 'noisy' you might need to add an external pullup resistor on the input pin.
 +
 +===== 1-Wire =====
 +
 +{{:livebox:1wire-setup.jpg|}}
 +
 +<code ini>
 +# Up to 15x 1-wire devices may be supported increasing the number
 +# beyond what you have attached simply presents more xAP endpoints than
 +# you have devices for.
 +[1wire]
 +sensor1.label=livebox-temp
 +devices=1
 +timeout=0
 +temp_unit=C
 +sensor1.romid=282E2DCB010000A928
 +</code>
 +
 +Each sensor can be given a label using the nomenclature "sensor#.label=<your label>" These are best setup using the WEB interface but can be done manually too. The assigned label will be included in the xAP message that is generated when the temperature changes. The 'displaytext' tag will have the format 'displaytext=<label> <temperature>' e.g. displaytext=Inside 21.0
 +
 +1wire devices can be setup with a calibration (offset) and hysteresis.   This allows you to adjust the reading from each device to allow for variances in their readings.  The hysteresis is used to prevent jitter from the devices triggering an event message.  The offset may be positive or negative.  The hysteresis is a positive value.  Both values are floating point.
  
  • livebox/xap_adapter.1324232010.txt.gz
  • Last modified: 2011/12/18 18:13
  • by brett