Homebridge with Sonoff

Sonoff

I bought two of those cheap wifi remote controlled switches called Sonoff.
These switches allow you to turn them on and off with an app on your phone.
https://www.itead.cc/sonoff-wifi-wireless-switch.html

Inside these switches are a ESP8266 , which means that we can flash the chip with our own custom firmware.
And with the help of a Raspberry pi we can enable homekit.

Firstly I reflashed the sonoff with my custom firmware, using the Arduino IDE. (Google how to flash ESP8266)
(This disables the use of the official sonoff app)

https://github.com/kim82/sonoff

Remember to change the hostname, if you have multiple sonoff.

#define HOSTNAME        "sonoff_00"

Raspberry Pi – Homebridge

Download and install Raspbian on the Raspberry Pi.
https://www.raspberrypi.org/downloads/raspbian/

When this is done we can install Homebridge, which is the service that sits between your apple devices and the sonoff switch.

The full install guide can be found here:
https://github.com/nfarina/homebridge/wiki/Running-HomeBridge-on-a-Raspberry-Pi

TLDR; (Raspberry Pi 3)

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install git make
sudo apt-get install g++
#install node
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
#install Avahi and other dependencies
sudo apt-get install libavahi-compat-libdnssd-dev

Script2

Next we need to install Script2, which is a homebridge plugin that allows you to run bash-scripts though the homebridge

npm install -g homebridge-script2

Start at bootup

Lastly we need to start Homebridge whenever the Raspberry pi boots up.
And the following method was found here:
https://gist.github.com/johannrichard/0ad0de1feb6adb9eb61a/

We need to create the following two files.

/etc/default/homebridge

# Defaults / Configuration options for homebridge
# The following settings tells homebridge where to find the config.json file and where to persist the data (i.e. pairing and others)
HOMEBRIDGE_OPTS=-U /var/lib/homebridge

/etc/systemd/system/homebridge.service

[Unit]
Description=Node.js HomeKit Server 
After=syslog.target network-online.target

[Service]
Type=simple
User=homebridge

#could be /usr/local/bin/homebridge - check where the homebridge folder exists
EnvironmentFile=/etc/default/homebridge 

ExecStart=/usr/bin/homebridge $HOMEBRIDGE_OPTS
Restart=on-failure
RestartSec=10
KillMode=process

[Install]
WantedBy=multi-user.target

And to enable the newly created service. (first time only)

sudo systemctl daemon-reload
sudo systemctl enable homebridge
sudo systemctl start homebridge

We also need to create a new user and the folder for the config.json file

#create a new user
sudo useradd -M --system homebridge

#creates a new folder
sudo mkdir /var/lib/homebridge

#changes the owner of the folder to new homebridge-user
sudo chown homebridge:homebridge /var/lib/homebridge

Configuration

To configure the script2, we need to create a config.json file in the /var/lib/homebridge folder.

Mine looks like this:

{
    "bridge": {
        "name": "Sonoff",
        "username": "AA:BB:CC:DD:EE:FF", (THIS NEEDS TO BE CHANGED)
        "port": 40500,
        "pin": "XXX-XX-XXX" (THIS NEEDS TO BE CHANGED - WITH NUMBERS)
    },

    "description": "Sonoff Homebridge",

    "accessories": [
                    {
                    "accessory": "Script2",
                    "name": "Bedroom lamp",
                    "on": "curl http://sonoff_00.local/on",
                    "off": "curl http://sonoff_00.local/off",
                    "state": "curl --max-time 1 http://sonoff_00.local",
                    "fileState": "",
                    "on_value": "on"
                    },
                    {
                    "accessory": "Script2",
                    "name": "Living room lamp",
                    "on": "curl http://sonoff_01.local/on",
                    "off": "curl http://sonoff_01.local/off",
                    "state": "curl --max-time 1 http://sonoff_01.local",
                    "fileState": "",
                    "on_value": "on"
                    }
                   ],

    "platforms": []
}

Restart the homebridge service

sudo systemctl restart homebridge

Now you should be able to add the sonoff homebridge to your Home-app on the iphone/ipad, and control the switches.

GIF frame – IOS app

My first idea was to add a ESP8266 to the GIF frame, so that I could control it remotely. But I haven’t had much success when tinkering the it. I can not get it to run a webserver without it freezing up.

But I had a Bluetooth Low Energy (BLE) laying around – Yes, I have a lot a stuff laying around 🙂
I had bought it a while ago, but didn’t really got into code in Cocoa Touch for iOS- also I didn’t want to pay 100$ for the developer subscription – which was needed for you to get the app on the iPhone.

But with the latest release of xcode, you can install your own apps on your iPhone without the subscription! So everything kinda came together for this project 🙂

The BLE device communicates with a serial port, and can talk directly to the Arduino.
I just need some small adjustments to the menu code – adding software serial. (and I included a power on/off option, while I was at it)

Download: GIF frame

And here it is:

GIF frame – software

The software for the animated gif frame, consist of 3 parts.

  1. code for the Arduino, that reads the sd-card and displays it on the ledstrips (main board)
  2. code for the Arduino, that runs the LCD menu (menu)
  3. code on the PC, which converts a GIF into a text file, with the color codes of the GIF.

Arduino sketch

The two Arduinos communicates via the serial ports.
At startup the main board, request the menu for the current settings. (it does this by sending a request_signal)

Serial.write(REQUEST_DATA);       // request for new data    - value is 155

The menu, then sends the settings in the following format

Serial.write(START_SIGNAL);       // 111
Serial.write(loadNext ? 1 : 0);   // next                    - values 0 or 1
Serial.write(menu.mode);          // mode (single/slideshow) - values 0 or 1
Serial.write(menu.repeat);        // slideshow duration      - values 1 to 50
Serial.write(menu.speed);         // speed                   - values 10 to 100
Serial.write(menu.brightness);    // brightness              - values 10 to 60
Serial.write(END_SIGNAL);         // 222

Whenever a change in the menu happens, it will also send this byte array to the main board.
The menu also,saves the changes to EPROM, so that the settings can be restored when power off and on.

Download the sketch + xcode here: GIF frame

PC software

On the PC side, I used this Processing sketch, but I think i really is just Java. Kinda like Arduino sketch is C/C++.
https://github.com/MeULEDs/MeU_Square_GIF_Converter_Teensy

I modified the original code, so I only outputs the color codes, and not the Arduino sketch code.
Here is my version: GIF_Converter.pde

16×16 animated gif frame

I once saw a Kickstarter project, where they made a frame with a animated gif.
So I wanted to try that out.

My main concern, was how a Arduino would read a GIF file, and convert it into a color code that the ledstrip could understand.
Luckily I found this site, which helped me with converting a GIF into a text file containing the colorcodes.

http://www.themeu.net/downloading-animated-gifs-onto-meu/

I customized the code to fit my needs, and coded the Arduino from scratch – actually I coded it twice, as I accidentally delete me sketch during development…
(now I have Carbon Copy Cloner, which backups to my network drive!)

And here is the end result:

animatedGif

Heres a list of the component used for this build – all found and bought through eBay.

  • A square frame (mines from IKEA)
  • RGB LED strip (256 leds)
  • 2 x Arduino
    • One for the running the ledstrip
    • One for the lcd menu system
  • SD card reader (and a SD card)
  • Nokia 5110 lcd
  • Power regulator to turn 12V to 5V and 5V to 3.3V (for the lcd)
  • Laptop 12v power supply.

During developing stage, I used an Arduino Duemilanove I already had. But for the finished product, I made “DIY” Arduino from a guide I found online. On afterthought, maybe I could’ve bought a cheap knockoff online, for less money… but where the fun in that 😉

At first I try using only one Arduino, but I ran out of memory, when I added the code for the lcd. It used a lot of memory to store all the characters.
So instead, I’m using two Arduino. And they are communicating via the serial port.

As a side effect of having two Arduino, is that the menu system is quick and responsive, as it does not need to wait for the ledstrip to be processed.

My next plan is to add a ESP8266, so that I can upload a new image file remotely.
But so far I havn’t had any succes using the ESP8266 as a webserver. I can’t get it to run without it freezing.

More about the software later…

  • The LED strip is glued to a piece of cardboard

Raspberry Pi RF remote

So I have one of these cheap remote controlled outlets, and I just finished my IR remote control project with the Raspberry Pi, so why not try to control these with the Raspberry Pi also?
Remote Control Outlet

How does it work?

The way these outlets work, is you set some dip-switches on the remote, and on the outlets so they match.

RF RemoteRF outlet

Creating RF transmitter / receiver

Source: http://shop.ninjablocks.com/blogs/how-to/7506204-adding-433-to-your-raspberry-pi

I bought my RF transmitter and receiver from eBay a about 1$.
Connecting RF transmitter and receiver to the Raspberry Pi is pretty simple.
Both the reciver and transmitter has a VCC, GND and DATA pins.
And all you do is connect it to the Raspberry Pi GPIO pins.
RF_GPIO

Install RPi_utils

Source: https://github.com/ninjablocks/433Utils/tree/master/RPi_utils

Start by installing RPI_utils

sudo apt-get update

#Installs GIT
sudo apt-get install git
sudo apt-get install git-core

#Installs 433util
git clone git://github.com/ninjablocks/433Utils.git
cd 433Utils/RPi_utils/

#Installs wiringPI
git clone git://git.drogon.net/wiringPi
cd wiringPi
git pull origin
./build

#Builds RPI_util
cd ..
make all

Testing and decoding RF signal

To capture and decode the RF signal from the remote, I ran the program RFSniffer.

sudo ./RFSniffer

When I push the A (on) button on the remote, I get the following code on the screen.

Received 5260625
Received 5260625
Received 5260625
Received 5260625
Received 5260625

To test if the transmitter works you can send the received value with this command.

sudo ./codesend 5260625

If you convert 5260625 to binary, you get 10100000100010101010001.
And looking at the binary value of all the buttons, you start to see a pattern.

Button Decimal value Binary value
A (On) 5260625 10100000100010101010001
A (Off) 5260628 10100000100010101010100
B (On) 5263697 10100000101000101010001
B (Off) 5263700 10100000101000101010100
C (On) 5264465 10100000101010001010001
C (Off) 5264468 10100000101010001010100
D (On) 5264657 10100000101010100010001
D (Off) 5264660 10100000101010100010100

They all starts with 1010000010, and all the ON buttons ends with 0001 and all the OFF buttons ends with 0100.
The 1010000010 matches with the dip-switches; 10 = down and 01 = up.
The middle part, is a value that identifies A,B,C and D.
You can see the pattern here:

Dip switch Button Id On / Off
A = 10 10 00 00 10 + 00 10 10 10 1 + 0001 / 0100
B = 10 10 00 00 10 + 10 00 10 10 1 + 0001 / 0100
C = 10 10 00 00 10 + 10 10 00 10 1 + 0001 / 0100
D = 10 10 00 00 10 + 10 10 10 00 1 + 0001 / 0100

Script

I then created the following bash script.

#!/bin/bash
BTN=$1
STATUS=$2

BTN=$(echo $BTN | tr '[:lower:]' '[:upper:]')
STATUS=$(echo $STATUS | tr '[:lower:]' '[:upper:]')

DIP_SWITCH="DDUUD"  #Change dip switches to match the remote

#hardcoded values
BTN_A="001010101"
BTN_B="100010101"
BTN_C="101000101"
BTN_D="101010001"

DIP_SWITCH=$(echo $DIP_SWITCH | sed 's/D/10/g' | sed 's/U/00/g')

case $BTN in
    A )
        BTN=$BTN_A ;;
    B )
        BTN=$BTN_B ;;
    C )
        BTN=$BTN_C ;;
    D )
        BTN=$BTN_D ;;
    * )
        echo "Please define the button [A-D]";exit;
esac
case $STATUS in
    ON )
        STATUS="0001" ;;
    OFF )
        STATUS="0100" ;;
    * )
        echo "Please define the button state [ON/OFF]";exit;
esac

BIN=$(echo $DIP_SWITCH$BTN$STATUS)
DEC=$((2#$BIN))

#echo $DEC
sudo /home/pi/codesend $DEC

And to emulate a click, I just call

./RFISend.sh A ON

Control via web

Because the codesend uses wiringpi, it is required to call with sudo.
But if you need to call it from a webserver, it creates some problem, because sudo requires a password.

So we need to edit visudo, so it doesn’t require a password.
(it may not be a secure thing to do, but in my case the webserver is not exposed to the internet, and is only for “at home” use)

sudo visudo

Add the following line to the file.
#NOTE: use TAB and not space, except for the last one – after NOPASSWD:

www-data        ALL=(root) NOPASSWD: /home/pi/433Utils/RPi_utils/codesend

Save the file and reboot the Raspberry Pi, and you’re good to go.

Now the local PHP webserver can call the script with:

<?php
  shell_exec("/home/pi/433Utils/RPi_utils/RFISend.sh A ON");
?>

Raspberry Pi IR remote

I wanted to use the Raspberry Pi as a remote control for my TV, so I searched the internet and found a pretty good guide by Alex Bain.
So all credits goes to him!

I then created a TV-guide webapp, where I could click on a channel to switch to that channel on the TV.
It’s webbased but I haven’t exposed it to the internet, so it only works when I’m home 🙂

Images of the final assembly

IMG_0867IMG_0868
IMG_0869IMG_0870
(Ignore the circuit connected with the green and red wire, its a RF tranmitter, which I will post about later)

Video demo

Installing the distro

I had a old spare 1GB SD card laying around, so first thing I did was install Moebius which is a very small Raspberry Pi distro, that fits the 1GB nicely 🙂
I don’t know what class the card is, but I don’t think it really matter, as performance is not a issue here.

To install the image to a SD-card, I followed the guide from RPi Easy SD Card Setup. (I used the program Pi-Writer.)

Creating IR transmitter

I made the electronic from Alex’ schematic, and soldered the components on a stripboard.
I bought my parts from my local electronics store:
2 x IR-LED
2 x LED holder
1 x IR receiver
1 x NPN transistor
1 x 10 kΩ resistor
1 x 2×13 pin connector
1 x stripboard

Installing LIRC

Follow the guide here.

Installing a web server

Just for good measure reboot the Raspberry Pi

sudo reboot

When it’s back up and running, we now install the webserver and PHP

sudo apt-get -y install lighttpd
sudo apt-get -y install php5-common php5-cgi php5

#enable fastcgi module included with lighttpd
sudo lighttpd-enable-mod fastcgi fastcgi-php

#The following restarts the webserver
sudo service lighttpd force-reload

Now we need to setup some permissions for the webserver.

#change the owner of /var/www to www-data (user and group)
sudo chown www-data:www-data /var/www

#gives user and group read/write/execute rights to /var/www
sudo chmod 775 /var/www

#adds the user pi to the group www-data
sudo usermod -a -G www-data pi