Heyu

Linux Heyu Support for X10 Commander

Thanks to Brandt D for creating this awesome shell script for Linux, Mac OSX, and Unix to allow Heyu to act as an X10 Commander Server. This was all written and tested on 'Debian Squeeze' on a Sheevaplug. Another user Dony71 created instructions for using on 'OpenWRT' based platforms as well.

Requirements

X10 Commander application for your mobile device (iPhone, iPad, iPod, Android)
Heyu Software (http://www.heyu.org/) (Most likely have to download source and compile, but might also be available as a package)
xinetd (if not installed do 'apt-get install xinetd' or something similar depending on the package manager)
bash, date, grep, awk, sed, tr, and echo (Make sure these are all in the path of the user running the x10cmdr.sh script)
X10 Commander Heyu Shell Script (Bash) (thanks to brandtd)
X10 Commander Heyu Shell Script (OpenWRT) (thanks to dony71)

Instructions

Decide on a port you want to use, and check if it is available.

root@haplug:~# cat /etc/services | grep 3003
root@haplug:~# grep -r 3003 /etc/xinetd.d/*

The above should return no results if it is available.

Edit /etc/services:

root@haplug:~# vi /etc/services

add the following line:

x10cmdr 3003/tcp # X10 Commander

save with :wq! or ZZ (if using the vi editor)

Create the following file:

root@haplug:~# vi /etc/xinetd.d/x10cmdr

containing:

# default: on
# description: X10 Commander Socket Server
service x10cmdr
{
   port             = 3003
   socket_type      = stream
   wait             = no
   user             = root
   groups           = yes
   server           = /usr/local/bin/x10cmdr.sh
   log_on_success += USERID
   log_on_failure += USERID
   disable        = no
}

Note: if you have a special heyu user it is preferred over the root user but it must have execute permission on heyu. Also, if you are using different port, or plan on a different script location, please edit the above file.

save with :wq! or ZZ (if using the vi editor)

Restart the xinetd service:

root@haplug:~# /etc/init.d/xinetd restart
Stopping internet superserver: xinetd.
Starting internet superserver: xinetd.

Using INETD rather than XINETD

If you prefer to use INETD instead of XINETD the instuctions are slightly different. Assuming you saved "x10cmdr.sh" into folder "/usr/local/bin"
so full path is:
/usr/local/bin/x10cmdr.sh
and you have edited it to suite your needs
and you have set permissions:

sudo chmod 755 /usr/local/bin/x10cmdr.sh

type:

sudo update-inetd --add "x10cmdr\t\t\tstream\ttcp\tnowait\tmark:mark\t/usr/local/bin/x10cmdr.sh"

You should not need to restart inetd.

Install the script:

In the path defined in the xinetd service file you created above:

root@haplug:/usr/local/bin# tar xvf x10cmdr-linux.tar

Change the owner of the script to match the owner defined in the xinetd service file above:

root@haplug:/usr/local/bin# chown root x10cmdr.sh

Note: The owner of the xinetd file, the script, and heyu should all be the same to avoid any potential problems.

Edit the script:

There are a few variables at the beginning of the script you must set. These include, the path to Heyu, the password which must match the password configured on your mobile device, the house codes you would like available to your mobile device, the path to store the log file, sorting A-Z set to 1 or 0 for sorting by housecode, and what type of transmissions heyu should send 0 for powerline or 1 for RF:

HEYU=/usr/local/bin/heyu
PASS=password123             # Password must match mobile device password setting
HC=abc                       # Housecodes you want to use
LOG=/tmp/x10c.log      # Change to /dev/null if you don't want logs.
SORTAZ=0                     # If 0, will sort by house code.
XMIT=0                       # If 1, will transmit CM17A commands.

Heyu Notes:

The Heyu state engine must be running. Please add "START_ENGINE AUTO" to your Heyu config file and restart Heyu.
The user defined to run the script in the xinetd service file must have r/w permissions to the TTY device defined in your Heyu config file: TTY /dev/ttyUSB0

Troubleshooting

First let's make sure the Heyu end of things is setup correctly.

Open up three terminals.
run 'heyu monitor" or tail -f /var/log/heyu/heyu.log.ttyUSB0" in the first terminal

In a second terminal tail the x10cmdr.sh log:

"tail -f /tmp/x10c.log"

In a third terminal run the script on the command line:

root@haplug:/usr/local/bin# ./x10cmdr.sh
1000 X10Commander Server

Now if you type in "PASSWORD~somepassword" it will set $CLIENT to ANDROID. If you type in "password~somepassword" it will set $CLIENT to IPHONE.

Anything else will set $CLIENT to MOBILE....

Then press the ENTER key.

PASSWORD~somepassword
VER~2.9.1 (1.0)

Now if you are emulating an ANDROID client then type "LIST" if your are emulating an IPHONE then type "list"
press the ENTER key:

LIST
Device~Living Room Lights~C1~0
Device~Recliner Lamp~C2~0
Device~Corner Lamp~C3~0
Device~Kitchen Dining Light~C4~0
Device~Entry Light~C5~0
Device~Upstairs Hall Light~C6~0
Device~Dining Light~C7~0
Device~Kitchen Light~C8~0
Device~China Light~C9~0
Device~Downstairs Hall Light~C10~0
Device~Laundry Light~C11~0
Device~Kitchen Sink Light~C12~0
UPDATE~Living Room Lights~C1~0
UPDATE~Recliner Lamp~C2~0
UPDATE~Corner Lamp~C3~100
UPDATE~Kitchen Dining Light~C4~0
UPDATE~Entry Light~C5~0
UPDATE~Upstairs Hall Light~C6~0
UPDATE~Dining Light~C7~0
UPDATE~Kitchen Light~C8~100
UPDATE~China Light~C9~0
UPDATE~Downstairs Hall Light~C10~100
UPDATE~Laundry Light~C11~0
UPDATE~Kitchen Sink Light~C12~0
ENDLIST

The "Device~...." populates the scroll wheel list on the client (the 0 means a PLC device, a 1 would mean RF)
the "UPDATE~.." sends the dimlevels (the 100 on the end of C10 means dimlevel is 100 for example)
"ENDLIST" tells the client to re-draw the gui.

Now type something like this:
DEVICE~sendplc~"C11 ON"

you should see the following and that device should turn on:

MSG~HEYU ON C11
UPDATE~Laundry Light~C11~100
ENDLIST

hit the enter/return key to disconnect.

Secondly, make sure the client works. If you can down load Melloware's X10 Commander Server for Windows, and try it with that.

If all the above work perfectly, then I would look at XINETD and the ports, usernames, perms, etc...

Bugs, Comments, Feature Request, Enhancements

To submit a bug or ask questions or anything at all please use these two outlets:

Forums: http://forum.melloware.com

Tickets: https://www.assembla.com/spaces/melloware/tickets

Melloware Inc