Difference between revisions of "Install state"

From xPL
Jump to: navigation, search
(Created page with " ::<html> <a title="By Dsmurat (+) [LGPL (http://www.gnu.org/licenses/lgpl.html)], via Wikimedia Commons" href="http://commons.wikimedia.org/wiki/File%3AUnder_construction_ic...")
 
(→‎Install xPL home state device)
 
(22 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
The [http://en.wikipedia.org/wiki/XPL_Protocol xPL] home state device stores the current state of different devices
 +
such as lights, shutters, etc…
 +
This information can be retrieved by clients such as [https://en.wikipedia.org/wiki/Web_2.0 web 2.0] pages
 +
in order to display the proper state of the devices to be controlled.
  
 +
The state update is best controlled with the help of the [[install central|central xPL device]].
  
−
::<html>
+
Before all, make sure you have installed an [[install xpl hub|xPL hub]].
−
<a title="By Dsmurat (+) [LGPL (http://www.gnu.org/licenses/lgpl.html)], via Wikimedia Commons" href="http://commons.wikimedia.org/wiki/File%3AUnder_construction_icon-blue.svg"><img width="512" alt="Under construction icon-blue" src="//upload.wikimedia.org/wikipedia/commons/thumb/d/d5/Under_construction_icon-blue.svg/512px-Under_construction_icon-blue.svg.png"/></a>
+
 
−
</html>
+
= Home state information =
 +
 
 +
The home state information is stored in an [https://en.wikipedia.org/wiki/XML XML] file.
 +
It is categorised in 4 hierarchy levels:
 +
* the ''room''
 +
* the ''kind'', such as <code>lights</code>, <code>shutters</code>, etc…
 +
* the ''object'': an object of the kind given by an identifier, such as <code>table</code> for the lamp above the table
 +
* the ''value'', such as <code>on</code> or <code>off</code>
 +
 
 +
The following example shows a possible content of <code>/home/control/Documents/Controls/state.xml</code>:
 +
<?xml version="1.0" encoding="ISO-8859-1"?>
 +
<state>
 +
  <lounge name="lights" center="off" entry="off" stand="off" table="off" />
 +
  <lounge name="shutters" center="up" east="up" west="up" />
 +
  <lounge name="audio" balance="0" power="on" mute="off" source="CD" surround="stereoSub" volume="50" />
 +
  <lounge name="screen" aspect="43" input="RGB" power="on" />
 +
  <study name="lights" ceiling="off" stand="off" />
 +
  <study name="shutters" window="louvresDown" />
 +
  <study name="audio" balance="0" source="CD" power="off" volume="30" />
 +
</state>
 +
 
 +
The home state information is both updated and queried with the help of [https://en.wikipedia.org/wiki/XPL_Protocol#Protocol xPL messages].
 +
 
 +
= Install xPL home state device =
 +
 
 +
Install <code>XML::Simple</code>:
 +
sudo apt install libxml-simple-perl
 +
 
 +
Download the [http://www.dspc.ch/xPL/Downloads/xpl-homeState.pl xPL home state] script:
 +
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
 +
cd $SCRIPTS_BASE_DIR
 +
wget http://www.dspc.ch/xPL/Downloads/xpl-homeState.pl
 +
chown control:users *.pl
 +
chmod 775 *.pl
 +
 
 +
Create the <code>/home/control/Documents/Controls/state.xml</code> state file based on the preceeding example, but adapted to your needs.
 +
The file doesn't need to be complete: objects will be added by the xPL <code>update</code> or <code>set</code> messages.
 +
 
 +
= Test xPL home state device =
 +
 
 +
Test it on a [[install BeagleBone|BeagleBone]]:
 +
su control
 +
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
 +
$SCRIPTS_BASE_DIR/xpl-homeState.pl -h
 +
$SCRIPTS_BASE_DIR/xpl-homeState.pl -v -n home
 +
 
 +
Open a 2nd terminal window (on any machine with xPL installed) and monitor the xPL protocol:
 +
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
 +
$SCRIPTS_BASE_DIR/xpl-monitor.pl -vf
 +
The monitor will help by showing the responses of the home state device.
 +
 
 +
Open another terminal and query a value:
 +
su control
 +
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
 +
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
 
 +
Modify a value:
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=on command=update
 +
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
 
 +
Modify a value and trigger an action:
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=off command=set
 +
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
Additionally to updating the state file, this command will trigger an <code>act</code> message
 +
which can be used by the [[install central|central xPL device]] to actually turn off the light.
 +
 
 +
Try to modify a value and don't trigger an action:
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=off command=set
 +
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
As the value of the <code>ceiling</code> lamp was already <code>off</code>,
 +
this command will not trigger an <code>act</code> message.
 +
This feature will prevent objects to flicker or temporarily mute when an identical command is sent more than once.
 +
 
 +
= Launch the xPL home state device at startup =
 +
 
 +
The xPL home state device is to be launched after the xPL hub.
 +
 
 +
== Debian with SystemD ==
 +
 
 +
On Debian with [https://wiki.debian.org/systemd systemd] (such as [https://www.raspbian.org/ Raspbian]
 +
or [https://www.ubuntu.com/ Ubuntu]), the scripts can be defined as services.
 +
 
 +
Edit <code>/lib/systemd/system/xpl-homeState.service</code>:
 +
[Unit]
 +
Description=xPL homeState
 +
After=xpl-hub.service
 +
 +
[Service]
 +
Type=simple
 +
User=control
 +
Group=users
 +
ExecStart=/home/control/Documents/Controls/xpl-homeState.pl -n home
 +
Restart=always
 +
 +
[Install]
 +
WantedBy=multi-user.target
 +
 
 +
Activate the service:
 +
su
 +
systemctl enable xpl-homeState.service
 +
service xpl-homeState start
 +
 
 +
Reboot and check:
 +
ps aux | grep -v grep | grep -i xpl
 +
ps ax | grep -i xpl | grep -v grep | sed 's/.*\/Controls\///'
 +
systemctl list-units --type=service --state=running | grep xpl
 +
service xpl-homeState status
 +
 
 +
== Ubuntu with Upstart ==
 +
 
 +
On Ubuntu, the xPL home state device starts-up once <code>xpl-hub_started</code> has been emitted.
 +
 
 +
Edit <code>/etc/init/xpl-homeState.conf</code>:
 +
################################################################################
 +
# xPL home state manager
 +
#
 +
description "xPL home state manager"
 +
version    "1.0"
 +
author      "Francois Corthay"
 +
 +
#-------------------------------------------------------------------------------
 +
# Configuration variables
 +
#
 +
env SCRIPTS_DIR='/home/control/Documents/Controls'
 +
env SCRIPT_NAME='xpl-homeState.pl'
 +
env PARAMETERS='-n home'
 +
 +
#-------------------------------------------------------------------------------
 +
# Start and stop conditions
 +
#
 +
start on xpl-hub_started
 +
stop on shutdown
 +
respawn
 +
setuid control
 +
setgid users
 +
 +
#-------------------------------------------------------------------------------
 +
# Start daemon
 +
#
 +
exec $SCRIPTS_DIR/$SCRIPT_NAME $PARAMETERS
 +
 
 +
Start the device and test it:
 +
su root
 +
service xpl-homeState start
 +
service xpl-homeState status
 +
initctl list | grep xpl
 +
 +
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
 
 +
== Mac OS ==
 +
 
 +
On Mac OS, the xPL home state device starts-up later than the hub.
 +
 
 +
Edit <code>/Library/LaunchDaemons/xpl-homeState.plist</code>:
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 +
<plist version="1.0">
 +
  <dict>
 +
    <key>Label</key>
 +
    <string>xPL home state manager</string>
 +
    <key>OnDemand</key>
 +
    <false/>
 +
    <key>UserName</key>
 +
    <string>control</string>
 +
    <key>ProgramArguments</key>
 +
    <array>
 +
      <string>/Users/control/Documents/Controls/xpl-homeState.pl</string>
 +
      <string>-n</string>
 +
      <string>home</string>
 +
      <string>-w</string>
 +
      <string>25</string>
 +
      <string>-s</string>
 +
      <string>/home/control/Documents/Controls/state.xml</string>
 +
    </array>
 +
  </dict>
 +
</plist>
 +
 
 +
Start the device and test it:
 +
su root
 +
launchctl load /Library/LaunchDaemons/xpl-homeState.plist
 +
 +
SCRIPTS_BASE_DIR=/Users/control/Documents/Controls
 +
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
 +
 
 +
[[Category: all]] [[Category: install]] [[Category: xPL]]

Latest revision as of 20:35, 8 January 2022

The xPL home state device stores the current state of different devices such as lights, shutters, etc… This information can be retrieved by clients such as web 2.0 pages in order to display the proper state of the devices to be controlled.

The state update is best controlled with the help of the central xPL device.

Before all, make sure you have installed an xPL hub.

Home state information

The home state information is stored in an XML file. It is categorised in 4 hierarchy levels:

  • the room
  • the kind, such as lights, shutters, etc…
  • the object: an object of the kind given by an identifier, such as table for the lamp above the table
  • the value, such as on or off

The following example shows a possible content of /home/control/Documents/Controls/state.xml: 

<?xml version="1.0" encoding="ISO-8859-1"?>
<state>
  <lounge name="lights" center="off" entry="off" stand="off" table="off" />
  <lounge name="shutters" center="up" east="up" west="up" />
  <lounge name="audio" balance="0" power="on" mute="off" source="CD" surround="stereoSub" volume="50" />
  <lounge name="screen" aspect="43" input="RGB" power="on" />
  <study name="lights" ceiling="off" stand="off" />
  <study name="shutters" window="louvresDown" />
  <study name="audio" balance="0" source="CD" power="off" volume="30" />
</state>

The home state information is both updated and queried with the help of xPL messages.

Install xPL home state device

Install XML::Simple: 

sudo apt install libxml-simple-perl

Download the xPL home state script: 

SCRIPTS_BASE_DIR=/home/control/Documents/Controls
cd $SCRIPTS_BASE_DIR
wget http://www.dspc.ch/xPL/Downloads/xpl-homeState.pl
chown control:users *.pl
chmod 775 *.pl

Create the /home/control/Documents/Controls/state.xml state file based on the preceeding example, but adapted to your needs. The file doesn't need to be complete: objects will be added by the xPL update or set messages.

Test xPL home state device

Test it on a BeagleBone: 

su control
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
$SCRIPTS_BASE_DIR/xpl-homeState.pl -h
$SCRIPTS_BASE_DIR/xpl-homeState.pl -v -n home

Open a 2nd terminal window (on any machine with xPL installed) and monitor the xPL protocol: 

SCRIPTS_BASE_DIR=/home/control/Documents/Controls
$SCRIPTS_BASE_DIR/xpl-monitor.pl -vf

The monitor will help by showing the responses of the home state device.

Open another terminal and query a value: 

su control
SCRIPTS_BASE_DIR=/home/control/Documents/Controls
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask

Modify a value: 

$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=on command=update
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask

Modify a value and trigger an action: 

$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=off command=set
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask

Additionally to updating the state file, this command will trigger an act message which can be used by the central xPL device to actually turn off the light.

Try to modify a value and don't trigger an action: 

$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling value=off command=set
cat $SCRIPTS_BASE_DIR/state.xml | grep 'study.*lights'
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask

As the value of the ceiling lamp was already off, this command will not trigger an act message. This feature will prevent objects to flicker or temporarily mute when an identical command is sent more than once.

Launch the xPL home state device at startup

The xPL home state device is to be launched after the xPL hub.

Debian with SystemD

On Debian with systemd (such as Raspbian or Ubuntu), the scripts can be defined as services.

Edit /lib/systemd/system/xpl-homeState.service: 

[Unit]
Description=xPL homeState
After=xpl-hub.service

[Service]
Type=simple
User=control
Group=users
ExecStart=/home/control/Documents/Controls/xpl-homeState.pl -n home
Restart=always

[Install]
WantedBy=multi-user.target

Activate the service: 

su
systemctl enable xpl-homeState.service
service xpl-homeState start

Reboot and check: 

ps aux | grep -v grep | grep -i xpl
ps ax | grep -i xpl | grep -v grep | sed 's/.*\/Controls\///'
systemctl list-units --type=service --state=running | grep xpl
service xpl-homeState status

Ubuntu with Upstart

On Ubuntu, the xPL home state device starts-up once xpl-hub_started has been emitted.

Edit /etc/init/xpl-homeState.conf: 

################################################################################
# xPL home state manager
#
description "xPL home state manager"
version     "1.0"
author      "Francois Corthay"

#-------------------------------------------------------------------------------
# Configuration variables
#
env SCRIPTS_DIR='/home/control/Documents/Controls'
env SCRIPT_NAME='xpl-homeState.pl'
env PARAMETERS='-n home'

#-------------------------------------------------------------------------------
# Start and stop conditions
#
start on xpl-hub_started
stop on shutdown
respawn
setuid control
setgid users

#-------------------------------------------------------------------------------
# Start daemon
#
exec $SCRIPTS_DIR/$SCRIPT_NAME $PARAMETERS

Start the device and test it: 

su root
service xpl-homeState start
service xpl-homeState status
initctl list | grep xpl

SCRIPTS_BASE_DIR=/home/control/Documents/Controls
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask

Mac OS

On Mac OS, the xPL home state device starts-up later than the hub.

Edit /Library/LaunchDaemons/xpl-homeState.plist: 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>Label</key>
    <string>xPL home state manager</string>
    <key>OnDemand</key>
    <false/>
    <key>UserName</key>
    <string>control</string>
    <key>ProgramArguments</key>
    <array>
      <string>/Users/control/Documents/Controls/xpl-homeState.pl</string>
      <string>-n</string>
      <string>home</string>
      <string>-w</string>
      <string>25</string>
      <string>-s</string>
      <string>/home/control/Documents/Controls/state.xml</string>
    </array>
  </dict>
</plist>

Start the device and test it: 

su root
launchctl load /Library/LaunchDaemons/xpl-homeState.plist

SCRIPTS_BASE_DIR=/Users/control/Documents/Controls
$SCRIPTS_BASE_DIR/xpl-send.pl -v -c state.basic room=study kind=lights object=ceiling command=ask
Retrieved from "http://www.dspc.ch/xPL/index.php?title=Install_state&oldid=620"