use strict;
# ———————————————————————–
# SMS module for Misterhouse
# Uses your voipbuster account http://voipbuster.com to send an SMS message to your mobile.
# Originally written by Stuart Grimshaw <stuart@smgsystems.co.uk>
# Changed by Nico Lembrechts for use with voipbuster.com <nicoatyow@gmail.com> http://yow.be
#
# (17/04/2009)
#
# It’s trivially simple to use, just add the .pm file to either your code
# directory, or the Misterhouse lib directory. Until the module is integrated
# into the next release (and until you upgrade to it) you need to add the
# line:
#
#       use voipbuster_SMS_Item;
#
# somewhere in your code.
#
# To create the object use:
#
#       new voipbuster_SMS_Item(<username>, <password>, <from_telephone_number>, <to_telephone_number>);
#
#       $SMS_voipbuster = new voipbuster_SMS_Item(“username”, “password”, “+32161234567″, “+324961234567″);
#
# and to send a message use the line:
#
#       $SMS_voipbuster->send(“Window left open and it is raining now.”);
#
# ———————————————————————–
package voipbuster_SMS_Item;
use LWP::UserAgent;
my $smsurl = “https://myaccount.voipbuster.com/clx/sendsms.php?”;
sub new {
my($class)=shift(@_);
my($self) = {};
$$self{username} = shift(@_);
$$self{password} = shift(@_);
$$self{from} = shift(@_);
$$self{to} = shift(@_);
bless $self, $class;
return $self;
}
sub send {
my($self, $message) = @_;
my $ua = new LWP::UserAgent;
my $req = $smsurl.(“username=$$self{username}&password=$$self{password}&from=$$self{from}&to=$$self{to}&text=$message — “);
my $res = $ua->get($req);
die “Error at $req\n “, $res->status_line, “\n Aborting”
unless $res->is_success;
}
sub set {
my($self, $voip_user, $voip_pass, $voip_from, $voip_to) = @_;
$$self{username}=$voip_user;
$$self{password}=$voip_pass;
$$self{from}=$voip_from;
$$self{to}=$voip_from;
}

This code is doing the actual work.

In the following code I create an Item

use voipbuster_SMS_Item;
# To create the object use:
#
$SMS_Nico = new voipbuster_SMS_Item(“nicoatyow”, “********”, “+32496*********”, “+324**********”);
# and to send a message use the line:
#
#$SMS_Nico->send(“Mum called your home at 13:15″) if $New_Minute;

Once the item is created you can use it in all your misterhouse code files. For example with my rain detector :

if ($state = state_changed $rainsensor){
print_log “Rainsensor is now $state”;
$SMS_Nico->send(“ALARM !! It’s raining and a window left open. “) if ($state eq ON) and state $window_open eq ON;
}

Create a directory on the same level as the misterhouse install directory

root@OpenWrt:/mnt/usb# ls
etc lib lost+found mh usr
mkdir my-mh
cd my-mh

Copy the code dir and data dir

mkdir code
cp -r ../mh/code/proxy code
mkdir data
cp -r ../mh/data/proxy data

Because I am setting up a misterhouse proxy I only copied the proxy sub directories of the data and code directories. I also copied the mh.private.ini config file and some startup scripts and altered them to use the newly created directories.

cp ../mh/bin/mh_proxy.ini mh.private.ini

The mh.private.ini file overrides the main mh.ini configuration file in the misterhouse installation directory and is used to make your personal configuration changes. This is how my file looks like:

code_dir=$Pgm_Root/../my_mh/code/proxy
data_dir=$Pgm_Root/../my_mh/data/proxy
code_select = code_select.txt
code_unselect = code_unselect.txt
sound_program=
server_telnet_port=
server_mhsend_port=
xpl_disable=1
xap_enable_items=1
voice_text=
#only_load=proxy_server.pl
no_log=serial_unmatch
xcmd_file=
sleep_time=100
sleep_count=1
tk=0
title=Proxy MisterHouse
gd=0
x10_errata=1
server_proxy_port=
xap_echo_all=1
http_port = 8080

I also copied the mh_proxy startup script and the mhl script and altered them to reflect my proxy setup

cp ../mh/bin/mhl ../mh/bin/mh_proxy .

This is my mh_proxy script that I use to start misterhouse as a proxy

#!/bin/sh
export mh_parms=/mnt/usb/my_mh/mh.private.ini
./mhl “$@”

And this is the mhl script that actually starts and monitors the misterhouse process

#!/bin/sh
while [ 1 = 1 ]; do
echo
echo Deleting startup file
touch mh.startup
export LANG=C
echo Running mh
perl /mnt/usb/mh/bin/mh “$@”
rc=$?
echo mh rc=$rc
if [ $rc = 1 ]; then
echo mh exited normally
exit
fi
if [ -f mh.startup ]; then
echo mh failed on startup … will not restart
exit
fi
echo mh had an unexpected exit … sleep a bit, then restarting
date >> mh_restart.log
sleep 5
done

Now you can use the mh_proxy script to start misterhouse on your router.
Next you can start enabling or disabling code. Because I enabled the web interface on port 8080 in mh.private.ini you can browse to your router and use the web interface to enable or disable code. Note that you need a reload to activate the changes. You can also go to the data directory and edit the code_select.txt and code_unselect.txt files to list the code files you want to enable or disable. It is important to understand that the code_select.txt file list the code files you want to enable from the “misterhouse install directory”/code/common directory and that code_unselect.txt lists the files you want to disable from your personal code directory. I enabled the following code files from the common code dir

mh_control.pl
xAP_command.pl
xAP_send.pl

My own code dir has the following files

root@OpenWrt:/mnt/usb# ls my_mh/code/proxy/
digitemp.pl k8055-file.pl mh.menu proxy_server.pl triggers.mhp

and my code_unselect.txt looks like this

proxy_server.pl

So this means that all code files (the ones with .pl extension) are running except proxy_server.pl .

The Xap setup

Like you can see in the code_select.txt file I enabled the xAP_command.pl and xAP_send.pl code files you need to also enable them on your main misterhouse box and add the line “xap_enable_items=1″ to your mh.private.ini file on the main misterhouse box. I have only tested this with Generic_Items but if you create a new Item with the same name on both your proxy and the main misterhouse box the state of these Items will be synced. This works very well for me.

Have a look at my 1-wire and K8055 code files for some working examples.

I have compiled the module myself because there was no package available for the openwrt kamikaze 8.09 release, if you need it you can download it here so you don’t need to install the buildroot etc.or you can install the package directly.

opkg install http://blog.export.be/downloads/kmod-k8055d_0.1.2_2.4.35.4-brcm-2.4-1_mipsel.ipk
opkg install kmod-usb-uhci-iv

Like you can see I also installed the kmod-usb-uhci-iv package which was needed for the module to work. If all went well you now a /proc/k8055/0 directory with a file for every input and output. By reading or writing to these files you can read or write values to the board.
Next I wrote some misterhouse code to create misterhouse items for all the IO and the read and write commands to interface the files. Here is my code :
$k8055_out1 = new Generic_Item;
$k8055_out2 = new Generic_Item;
$k8055_out3 = new Generic_Item;
$k8055_out4 = new Generic_Item;
$k8055_out5 = new Generic_Item;
$k8055_out6 = new Generic_Item;
$k8055_out7 = new Generic_Item;
$k8055_out8 = new Generic_Item;
$k8055_in1 = new Generic_Item;
$k8055_in2 = new Generic_Item;
$k8055_in3 = new Generic_Item;
$k8055_in4 = new Generic_Item;
$k8055_in5 = new Generic_Item;
$k8055_out1 -> set_states (‘aan’,'uit’);
$k8055_out2 -> set_states (‘aan’,'uit’);
$k8055_out3 -> set_states (‘aan’,'uit’);
$k8055_out4 -> set_states (‘aan’,'uit’);
$k8055_out5 -> set_states (‘aan’,'uit’);
$k8055_out6 -> set_states (‘aan’,'uit’);
$k8055_out7 -> set_states (‘aan’,'uit’);
$k8055_out8 -> set_states (‘aan’,'uit’);
if ($state = state_changed $k8055_out1){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out1′,1);
}
else {
file_write(‘/proc/k8055/0/out1′,0);
}
}

if ($state = state_changed $k8055_out2){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out2′,1);
}
else {
file_write(‘/proc/k8055/0/out2′,0);
}
}

if ($state = state_changed $k8055_out3){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out3′,1);
}
else {
file_write(‘/proc/k8055/0/out3′,0);
}
}

if ($state = state_changed $k8055_out4){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out4′,1);
}
else {
file_write(‘/proc/k8055/0/out4′,0);
}
}

if ($state = state_changed $k8055_out5){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out5′,1);
}
else {
file_write(‘/proc/k8055/0/out5′,0);
}
}

if ($state = state_changed $k8055_out6){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out6′,1);
}
else {
file_write(‘/proc/k8055/0/out6′,0);
}
}

if ($state = state_changed $k8055_out7){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out7′,1);
}
else {
file_write(‘/proc/k8055/0/out7′,0);
}
}
if ($state = state_changed $k8055_out8){
if ($state eq ‘aan’) {
file_write(‘/proc/k8055/0/out8′,1);
}
else {
file_write(‘/proc/k8055/0/out8′,0);
}
}
my $input;
if ($New_Second){
$input = file_read(‘/proc/k8055/0/in1′);
set $k8055_in1 $input;
$input = file_read(‘/proc/k8055/0/in2′);
set $k8055_in2 $input;
$input = file_read(‘/proc/k8055/0/in3′);
set $k8055_in3 $input;
$input = file_read(‘/proc/k8055/0/in4′);
set $k8055_in4 $input;
$input = file_read(‘/proc/k8055/0/in5′);
set $k8055_in5 $input;
#print_log “Input 1 is now $input1″;
}

Handles for the DA and AD ports are not yet implemented because I don’t use them for the moment.

Update : I just finished doing the same setup on a NSLU2 . I compiled the k8055 module via the buildroot for the ixp4xx harware. The only difference was that I had to use the kmod-usb-ohci_2.6.28.10-1_ixp4xx.ipk module instead of the uhci one. If anyone needs tha packages for the Linux OpenWrt 2.6.28.10 #2  armv5teb GNU/Linux NSLU2 harware let me know.

owserver

I installed the package owserver with the opkg command line tool

opkg -d usb install owserver

When the package was installed i started the owserver.

owserver – u -p 5555

On my desktop running ubuntu I installed owfs

sudo apt-get install owfs

which is the client for the owserver program and will create a filesystem whit all the sensors data.

sudo mkdir /mnt/ow
sudo owfs -s 192.168.1.1:5555 /mnt/ow

Works like a charm for me

drwxr-xr-x 1 root root 8 2009-03-16 21:28 .
drwxr-xr-x 22 root root 4096 2009-02-23 21:16 ..
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.096994010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.585394010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.6A6E94010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.A09B94010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.A77594010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 10.F77094010800
drwxrwxrwx 1 root root 8 2009-03-19 15:59 81.E74C2A000000
drwxr-xr-x 1 root root 8 2009-03-16 21:28 bus.0
drwxr-xr-x 1 root root 8 2009-03-16 21:28 settings
drwxr-xr-x 1 root root 8 2009-03-16 21:28 statistics
drwxr-xr-x 1 root root 30 2009-03-16 21:28 structure
drwxr-xr-x 1 root root 8 2009-03-16 21:28 system
drwxr-xr-x 1 root root 8 2009-03-16 21:28 uncached

Nice if you need to share your 1-wire data over the network but what i want is to have my temperature sensors values available in misterhouse that runs on the router as well.
So let’s go on to the next solution.

digitemp

Digitemp is another command line tool to interface a 1-wire network. To install type

opkg -d usb install digitemp

Let’s do a first test :

root@OpenWrt:~# digitemp_DS2490 -w
DigiTemp v3.5.0 Copyright 1996-2007 by Brian C. Lane
GNU Public License v2.0 – http://www.digitemp.com
Found DS2490 device #1 at 003/004
Turning off all DS2409 Couplers
…….
Devices on the Main LAN
10A09B9401080052 : DS1820/DS18S20/DS1920 Temperature Sensor
105853940108009D : DS1820/DS18S20/DS1920 Temperature Sensor
106A6E9401080076 : DS1820/DS18S20/DS1920 Temperature Sensor
10096994010800BD : DS1820/DS18S20/DS1920 Temperature Sensor
10A77594010800AF : DS1820/DS18S20/DS1920 Temperature Sensor
10F7709401080053 : DS1820/DS18S20/DS1920 Temperature Sensor
81E74C2A000000A5 : Unknown Family Code

That’s good ! Next create a conf file.

digitemp -i

Now you can read a value like this

digitemp_DS2490 -t 2 -q -c /root/.digitemprc
Feb 08 22:09:23 Sensor 2 C: 21.00 F: 69.80

All that we need now is some perl code to read the sensors values and store them in a misterhouse variable. I came up with the following code.

use vars ‘$tempsensor1′;
if ($New_Minute){
$_=`digitemp_DS2490 -t 5 -q -c /root/.digitemprc`;
/\sC:\s(.*)\sF/;
$tempsensor1 = $1;
print_log “Temperatuur is nu $tempsensor1″;
}

This is just some test code but it proofs that it works so I am happy for now.

The first step is to install perl and all the modules misterhouse need . Install following packages with the opkg command

opkg install packagename

perl
perlbase-autoloader
perlbase-base
perlbase-bytes
perlbase-config
perlbase-cwd
perlbase-data
perlbase-db-file
perlbase-errno
perlbase-essential
perlbase-fcntl
perlbase-file
perlbase-filehandle
perlbase-getopt
perlbase-integer
perlbase-io
perlbase-posix
perlbase-re
perlbase-selectsaver
perlbase-socket
perlbase-symbol
perlbase-term
perlbase-text
perlbase-time
perlbase-xsloader
perlbase-sys
perlbase-encode
perlbase-universal
perlbase-net
perlbase-filehandle

Then install misterhouse. Installing misterhouse is nothing more than unpacking the code to your mounted USB media and altering the config file(s). First download the latest stable code tarball and unpack it.

cd /mnt/usb
wget http://prdownloads.sourceforge.net/misterhouse/misterhouse-2.105.tar.gz
tar xzvf misterhouse-2.105.tar.gz .

Now you have a directory /mnt/usb/mh
As a first test you can try to run misterhouse to see if all perl packages  needed are installed and working.

cd /mnt/usb/mh/bin
./mhl

You may see some GD.pm and TK perl module errors in the log but can ignore them for the moment. We will disable these functions later. If you see a line “PM: Saving object states … done” then you are good and know that misterhouse is running. You can even browse to http://192.168.1.1:8080 to see the web interface.
The next step is to create your own code files and to alter the misterhouse configuration file for your needs. This is explained on the misterhouse homepage or in the docs section of your misterhouse install directory .
A first step could be to disable TK and GD code by adding the following lines to your mh.private.ini file

tk=0
gd=0

For my own project I run misterhouse as a proxy. A proxy is a stripped down misterhouse process that can interact with a main full misterhouse install on another server for example. In my next post I will explain how i setup my misterhouse proxy with a Velleman K8055 USB IO board, a 1-wire usb interface and a bluetooth dongle to detect if my mobile phone is nearby.