Introduction: Simple Home Automation. RaspberryPi + Android

Control relays connected to you RaspberryPi using Android app. Setup multiple RaspberryPi devices around your house. Single device can operate up to 8 relays and all of them are self-discoverable using lightweight network protocol. No complicated setup. Name each relay, give its type (button, switch) and operate it from a dead simple app interface.

For ex. you can connect one of your RaspberryPi to a garage door and furnace blower, and another device to a house ceiling fan and be able to control them using Android app when you are on your home network with a click of a button.

Step 1: Install Android App

Install RaspberryPi Switch Android app from Google Play

When connected to home WiFi, app discovers all available switch-servers on your local network and allows you to control them. Discovery mechanism relies on broadcasting UDP messages, so your network router should not drop packets with broadcast addresses (by default broadcast messages are not dropped by consumer-grade routers unless you configured your network differently)

Step 2: Install Raspbian OS

You can find full instructions on official RaspberryPi website

Quick steps for Mac users to copy image on SD card

1.DownloadRaspberryPi image

2. Identify the disk (not partition) of your SD card. e.g. disk4 (not disk4s1)

diskutil list

3. unmount it

diskutil unmountDisk /dev/disk4

4. Copy image on your SD car (takes a very long time, to speed it up use /dev/rdisk# instead of /dev/disk#)

sudo dd bs=1m if=2012-12-16-wheezy-raspbian.img of=/dev/disk4

Default credentials that come with the image

username: pi
password: raspberry

Step 3: Install Pi4j Library

Pi4J is an API and implementation libraries for Java Applications to access the full I/O capabilities of the Raspberry Pi platform. Full instructions can be found on pi4j webiste or simply run the following command in the RaspberryPi terminal

curl -s get.pi4j.com | sudo bash

Step 4: Connect RaspberryPi to Your Local Home Network

You can connect your RaspberryPi to a home network using:

Quick tip if you are using Edimax WiFi USB adapter:

1. Replace content of the file /etc/network/interfaces (sudo vi /etc/network/interfaces) with

auto lo 

iface lo inet loopback iface eth0 inet dhcp
allow-hotplug wlan0
auto wlan0
iface wlan0 inet dhcp
   wpa-ssid "YOUR-WIFI-NETWORK-NAME-GOES-HERE”
   wpa-psk "YOUR-WIFI-NETWORK-PASSWORD-GOES-HERE"

2. Disable WiFi adapter power safe mode

sudo sh -c "echo 'options 8192cu rtw_power_mgnt=0 rtw_enusbss=0' > /etc/modprobe.d/8192cu.conf"

3. Reboot

Step 5: Install Switch-server

Switch-server is a small java app that runs on your RaspberryPi, controls its GPIOs and makes them discoverable so they can be controlled remotely.

Follow installation instructions on switch-server github page.

You can now connect relays or other gadgets to GIPOs on your raspberry pi, tell switch-server their names and pin numbers they are connected to, and control them via Android app.

You can also run switch-server locally from your laptop if you just want to play with Android App or if you make changes to the server code and want to try it first without installing on the RaspberryPi device.

Tips:

  • To start switch-service on boot add following crontab command (sudo crontab -e): "@reboot java -jar /home/pi/switch-server.jar --config /path/to/config.json"
  • If you installed Raspbian OS, you can place your switch-server jar file under /boot/ partition that is FAT32 and visible on Windows and Mac when you mount SD card. This way you can easily update server jar or config.json files from your laptop without ssh-ing to RaspberryPi.

Comments

author
leomara2 (author)2017-06-22

oh and i am using a NOOB. do i need to chnage my OS on Rpi?

author
sshlyk (author)leomara22017-06-23

Hi. From what I read, NOOBS is OS installer, and it installs Raspbian OS, exactly what you need. In general, app will work with any OS that can run java (assuming you can also install pi4j library). Thx

author
leomara2 (author)2017-06-22

I am making a circuit breaker automation using raspberry pi 3 and a 16 channel 12v octopular relay module.

author
ChrisC718 (author)2017-04-22

I like the architecture of this project. The way it discovers but
keeps separation between the IP comms and the app. I have it running on
an R-pi zero and a modern android. I would like to use an old smart
phone as a dedicated controller but it wont load from playstore. Any
ideas why it is incompatible. Is there an older version that might run
on a gingerbread phone?

author
sshlyk (author)ChrisC7182017-04-22

Hi

I am pretty sure it works on old devices, it is just an artificial restriction. I do not have an old device to verify it though. You could change minSdkVersion version to match your device and build apk locally: https://github.com/sshlyk/switch-android/blob/mast...

Run "./gradlew assembleDebug" and you can find .apk file in build directory.

If it works, create pull request, I'll merge it and publish to app store.

author
ChrisC718 (author)sshlyk2017-04-27

I am having trouble building the app on windows. Do I need a .bat version of gradlew?

author
sshlyk (author)ChrisC7182017-04-27

You are right, for windows you need to use gradlew.bat, I am afraid I just deleted it. Looks like I am using this gradle version

https://services.gradle.org/distributions/gradle-2...

And you can find bat file in the bin folder. I am afraid you are on your own, I have no windows machine to try that.

author
ChrisC718 (author)sshlyk2017-04-23

Thank you for the suggestion
I will work on that.

author
ssm16 (author)2016-01-13

Hi,

Nice project and well written code for both Android & RPI.

I have a few questions:

Have followed the steps described, both Android and RPI are running but the relays do not operate on Android key presses. I have logs enabled on both Android & RPI, the RPI logs show SingleSwitch.java, turnOn() and turnOff() methods are called correctly, but the relays cannot be controlled. Physical pins 13 & 17 are always low.

I have written a simpler java code that does toggle the relays correctly. I have RPI 2 B.

Can you please advice.

Thanks

author
sshlyk (author)ssm162016-01-13

I am going to guess, but you are probably using wrong PIN numbers in the config. Pi4j library I am using has its own PIN number mapping witch is different from raspberry pi mapping. It enumerates them from 0 to 7. Take a look at this http://pi4j.com/usage.html#Pin_Numbering
Find your model and what number pi4j assigns to given gpio

I should probably make it clear in the doc. Feel free to make necessary changes to documentation on github.

author
ssm16 (author)sshlyk2016-01-14

Hi,

I have had a look at the link you mentioned and it seems I have the correct pin numbers. Looking at this link (http://pi4j.com/pins/model-2b-rev1.html) and the switch-config.json file, my allocations are:

"Garage Door">"switchPinNumber": 0>GPIO_0>Pin 11

"House Ceiling Fan">"switchPinNumber": 2>GPIO_2>Pin 13

"Furnace Blower">"switchPinNumber": 3>GPIO_3>Pin 15

These physical allocated pins (11,13,15) work with a simple test version of java code using pi4j enumerations you have described. Actually the test code uses the same code from switch-server>SingleSwitch.java>toPin().

Could you provide further advice.

thanks

author
SauravD13 (author)ssm162016-11-02

Hi ,

Did you get a solution to this problem? Unfortunately, for me the server code and the android program runs fine but GPIO LEDs wont light up. They light up by default in GPIO_2 but dont turn off. Any specific pointers would be valuable.

author
sshlyk (author)SauravD132016-11-02

The default state is ON (HIGH), that's why they light up by default. It is currently hardcoded in the source code, by you can change that to PinState.LOW https://github.com/sshlyk/switch-server/blob/maste...

You still should be able to control the device. Check server-side logs to see if there are incoming requests whey you use the app. If not, make sure both server and client run on the same home local network. Keep in mind, that some public routers drop broadcast packets and client wont be able to discover and send requests.

author
M L G (author)2016-05-13

this is just what Ive been looking for because most other home automations required knowing quite a bit more about arduino etc. which I dont actually have but this seems to be mostly pi related and I have a couple lying around gathering dust, would be sweet to be able to put them to good use. I have the original pi B board, the 2nd model ever released and I have a pi 2 plus would either of these be suitable for this project?

author
sshlyk (author)M L G2016-05-14

I am using pi B and have not tried other models. As long as you can install pi4j library it will work since server is written in java. Server code and android app are opened sourced, feel free to make changes
Thx

author
sshlyk (author)2016-04-14

You need to run it as super user. pi4j need super user access

sudo java -jar /home/pi/switch-server.jar

author
ne3by (author)sshlyk2016-04-15

thank you, it was late night and I forgot that.

but I have exactly the same problem like RaqueebH.

Relays are ON after server start but they don't change state when app command.

author
sshlyk (author)2016-02-18

That's exactly what I need. Seems like service is up and running.
Next, I would verify that pi2 is actually connected to network and it is exactly same network your phone is on. Try on your pi2 shell

ping instructables.com

If it is connected, is it WiFi? Is link reliable. Try moving it closer to your router or connect via ethernet port.

author
kd4hls (author)sshlyk2016-02-18

ok, i need wlan0, not eth0...

mucho thanks

rodger

author
kd4hls (author)2016-02-18

does this work on pi 2 ?, my android won't discover my second server, only the one on pi b.???

thanks

Rodger

author
sshlyk (author)kd4hls2016-02-18

I do not have pi 2, so I can not test it, but it should run, since it is not tight to a specific hardware.
Start service manually and attach the logs. Have you installed pi4j on on pi 2?

Thx

author
kd4hls (author)sshlyk2016-02-18

pi@raspberrypi:/ $ sudo java -jar /home/pi/Switch-server/switch-server.jar --config /home/pi/Switch-server/config2.json
2016-02-18 16:00:53.594 [main] INFO com.alisa.lswitch.server.Main - Starting switch server...
2016-02-18 16:00:54.640 [main] INFO com.alisa.lswitch.server.Main - Found configuration file: /home/pi/Switch-server/config2.json
2016-02-18 16:00:55.108 [main] DEBUG com.alisa.lswitch.server.lib.AppConfig - App config: {password=helloSwitch, port=61235, devices={North gate={switchPinNumber=0, deviceType=button, buttonDelay=2500}, South gate={switchPinNumber=3, deviceType=button, buttonDelay=2500}, Lower gate={switchPinNumber=2, deviceType=button, buttonDelay=2500}}}
2016-02-18 16:00:55.114 [main] DEBUG com.alisa.lswitch.server.io.SingleSwitch - Raspberry switch. PinNumber: 0
2016-02-18 16:00:55.817 [main] DEBUG com.alisa.lswitch.server.DeviceManager - Device ID: 8a35938d-e2df-4006-8114-a2d5ccf76378
2016-02-18 16:00:55.820 [main] DEBUG com.alisa.lswitch.server.io.SingleSwitch - Raspberry switch. PinNumber: 3
2016-02-18 16:00:55.823 [main] DEBUG com.alisa.lswitch.server.DeviceManager - Device ID: 6188657a-e84d-443c-ac2b-a97ef267eda4
2016-02-18 16:00:55.824 [main] DEBUG com.alisa.lswitch.server.io.SingleSwitch - Raspberry switch. PinNumber: 2
2016-02-18 16:00:55.827 [main] DEBUG com.alisa.lswitch.server.DeviceManager - Device ID: f15583b8-7147-4728-8dd7-b12f3ca9324c
2016-02-18 16:00:55.842 [main] DEBUG com.alisa.lswitch.server.NetworkClient - Starting NetworkClient. Port: 61235
2016-02-18 16:00:55.930 [Thread-4] DEBUG com.alisa.lswitch.server.StatusRequestProcessor - StatusRequestProcessor processing incoming status requests
2016-02-18 16:00:55.937 [Thread-5] DEBUG com.alisa.lswitch.server.SwitchRequestProcessor - SwitchRequestProcessor processing incoming switch requests
not sure what logs you want??
thanks

author
RaqueebH (author)2016-02-12

Great article. Seems like as soon I initiate the swich-server, all 4 relays set to "on" mode. And then pressing in app doesn't work.

What am I missing?

Thank you.

author
PravinK13 (author)2016-02-07

server is working properly...but GPIO are not accessable...

author
GANESHY (author)2016-02-02

there is need to add url to apk file or not? plzz help

author
sshlyk (author)GANESHY2016-02-02

Hi. Sorry, Could you clarify the question? Are you looking for compiled apk file because Google play is not available?

author
GANESHY (author)sshlyk2016-02-02

i mean is it need to compose or add url to zip file of android using android studio or it directly works with file from google play..?

author
sshlyk (author)GANESHY2016-02-03

App works straight from google play with the pre built server

author
kd4hls (author)2015-12-01

Verry Kool!, mucho gracias...

How do I write an app for iPad ?

Do you have source for C ?

Thank you

Rodger

author
sshlyk (author)kd4hls2016-01-13

Hi. if you have iOS app, please share it with us

author
sshlyk (author)kd4hls2015-12-01

Communication between app and server is done via simple UDP protocol. iOS app just needs to comply with it. For ex., to discover available services on your network, it broadcasts following UDP status request packet (should broadcast multiple times to increase chances of delivery, switch servers dupe duplicate requests and processed it only once):

[serializer_version|request_type|request_id|device_id|sha1_of_the_request]

serializer_version: (4 bytes) currently there is only one version, so it is always set to 1

request_type: (1 byte) 1 - for status request, 2 - switch request, 3 - status reply

request_id: (16 bytes) random UUID used to dupe duplicate requests

device_id: (16 bytes) switch server id if request designated for specific switch (for ex switch request to push button)

sha1_of_the_request: (16 bytes) sha1 of (uuid + password) (very dumb authorization protocol that has multiple attacks)

Each configured device will reply with the device_id, device_type and device state (on/off).

There are total of 3 requests in this protocol and if your app talks this protocol, you will be able to operate the devices. Take a look at:

https://github.com/sshlyk/switch-server/tree/master/src/main/java/com/alisa/lswitch/client/model

author
kd4hls (author)sshlyk2015-12-01

many thanks, amigo

author
sshlyk (author)2015-12-05

Please, read the instructions. 1) You need to run it as root 2) You need to create config.json file and pass it as argument to the server or default one is used.

author
yb62 (author)2015-12-04

Hello,

I don't know how install switch-server-1.0.jar and i dont know the command "gradlew"

someone can help me please?

thanks

author
sshlyk (author)yb622015-12-04

Just copy the file over to your SD card and then run on Raspberry Pi

java -jar /path/to/you/server/switch-server.jar --config /path/to/config.json



  • To start switch-service on boot add following crontab command (sudo crontab -e): "@reboot java -jar /home/pi/switch-server.jar --config /path/to/config.json"
author
yb62 (author)sshlyk2015-12-04

i have :Error: Unable to access jarfile /path/to/you/server/switch-server.jar

author
sshlyk (author)yb622015-12-04

You need to specify actual path. "/path/to/you/server/switch-server.jar" is just an example.

If you copied your file to "/home/pi/" folder, then the command is

java -jar /home/pi/switch-server.jar


author
yb62 (author)sshlyk2015-12-04

thanks ,it s good now!

author
nitiem (author)2015-11-10

I an a new bee how do you 'connect relays or other gadgets to GIPOs on your raspberry pi, tell switch-server their names and pin numbers they are connected to, and control them via Android app.' can you show hot you actually wire to a garage door opener.

author
sshlyk (author)nitiem2015-11-10

Given relay, locate VCC, ground and IN1. Connect your raspberry pi +5V (or +3V) to VCC, GND (ground) to GND and GPIO1 (for ex) to IN1. Now after you configure and restart switch-server you should be able to control it and you will hear relay's clicking sound. It is ready to be hooked up to your garage.

All garage doors are different, but most of them have 2-3 low voltage wires going in. One of the wires controls the light, and one the motor. I found the one I need just by trying all of them (there are 3 different combinations) you can also trace the wire from your garage button.

Now relay has 3 outputs. One is NC (normally closed) and second one is NO (normally opened). You need NO, so there is no current to your garage when relay is not operated. For relay on the picture, that would be first and second terminal (from top), you can find a drawing there that shows two disconnected lines (NO).

author
millab (author)2015-09-03

I have a small problem, the relay does not stay on long enough to open the door. Is there a way in the json script to hold that open for a second or so?

author
sshlyk (author)millab2015-09-03

You can now specify button delay, just add "buttonDelay" key and time in milliseconds. You will need to download latest server jar (I uploaded new one) or build it yourself.

I would also make sure that relay is not too far from the motor, sometimes there is not enough current when you have long wires.

Screen Shot 2015-09-03 at 9.11.30 PM.png
author
MattTuck (author)sshlyk2015-10-15

Could use a loop to...

author
zootalaws (author)2015-08-07

At around $60 each by the time you have powered it, added wifi and put in an SD card, this is a pretty expensive switch.

A $2.50 ESP8266 or Bluetooth module with small Arduino is a much better solution - smaller, neater and natively works with relays, etc. to achieve the same result.

Sorry - not a believer.

author
sshlyk (author)zootalaws2015-08-07

$21 Raspberry Pi model A
$9 (optional) wifi adapter
$7 relay
$5 power adapter

Total: $42

It is not a competition, just another fun project for RaspberryPi owners.

author
zootalaws (author)sshlyk2015-08-07

$2.50 ESP, $3 USB 5V, $3 relay...

The Pi is a wonderful device, it does some amazing stuff -I have 6 of them, doing such amazing stuff -but acting as a wireless relay is a complete waste of resources.

You're right, it isn't a competition. It's all about using the right tool for the job,

In this case, using a multiprocessing-capable Unix server to turn on a switch isn't. Far better would be to use that Pi to act as the central controller in a network of smart ESP8266 switches.

That would be something that uses the Pi's resources effectively.

author
sshlyk (author)zootalaws2015-08-07

Not sure what is your point. Save 10 bucks?
Agree that RaspberryPi is much more powerful, but have you consideres time it takes to write software for a microcontroller? It is much easier for new people to jump in and make changes to java code than deal with low level microcontroller.
This is not a comercial grade product and not designed to be optimal. It would be more productive if you can give a link for similar project bult around Arduino.

author
zootalaws (author)sshlyk2015-08-07

it's not $10, it's more than $30 -per iteration.

https://www.instructables.com/id/ESP8266-WiFi-relay...

And as a "new people" myself, I have found Arduino and ESP infinitely easier than Java on Pi.

I don't know where you get the idea that programming an ESP requires knowing low-level programming -it uses C++ and the Arduino IDE, or even easier, Lua.

Sounds like you don't actually know what it is you are railing against. Educate yourself before taking me to task -you have been wrong about nearly every single point, so far.

author
sshlyk (author)zootalaws2015-08-07

That's a very nice project. Thank you for sharing. I am glad you prefer Arduino.

author
zootalaws (author)sshlyk2015-08-07

it's not Arduino, it's an ESP8266. Maybe if you read, rather than skimmed, you might learn more?

I don't 'prefer Arduino' - it's about the appropriate tool for the job. In this case, a $2.50 ESP is superior to a $42 Pi.

But, the Pi used as a central controller for a network of such switches, using MQTT or other simple comms protocol, should be easy for a beginner to fathom.

I didn't find it hard and I've never programmed a damned thing.

About This Instructable

32,819views

125favorites

License:

More by sshlyk:Simple home automation. RaspberryPi + Android
Add instructable to: