RaspberryPi Home Automation Using OpenHAB

Home automation using Raspberry Pi 3B and OpenHAB. [Optional] We will be using Google Home (or Google Assistant) to enable voice control.

Step 1: Parts Required

For this project we will be requiring-

HARDWARE-

Raspberry Pi (I used a 3B board)
Google Home Mini [Optional] (You can use assistant too!)
Jumper Wires
Relay Module

SOFTWARE-

OpenHABian Pi [You can use Raspbian OS too]
IFTTT

Step 2: Getting Started With Software Needs

You have two of the following choices-

Flash Raspbian and then install OpenHAB onto it. (Tiresome and not good)
Directly flash OpenHABian onto SD card and run it directly (Damn Easy)

I used the second option and flashed OpenHABian onto a SD-card and put it into RPi. So I will be going to discuss this method. If you want to follow the first one, follow this guide, Manual Installation.

Else follow the steps below:

Download the latest OpenHABian system image.
Flash it onto a SD-card using Etcher.io
After successful flashing, put the SD-card into Rpi and connect an Ethernet to the Rpi. (You may also use WiFi).
Boot up the Rpi. You don't need a screen and/or mouse and keyboard as SSH and Samba are enabled already!
Wait for 30-45 minutes for OpenHAB to finish its initial setup.
After that, go to http://openhabianpi:8080 This will be the address of your Rpi from where you can access it.

That's all for the initial installation part.

Configuring OpenHAB

After OpenHAB finishes its initial setup, go to http://openhabianpi:8080

There navigate to Paper UI.
There, go to Addons>Bindings. Search GPIO in the search bar. Install GPIO binding. Then navigate to MISC tab and install openHAB Cloud Connector.

Step 3: Configuring OpenHAB -Making Items

Now we need to access our Rpi through SSH. I am going to use PuTTY. If you are on MacOS or Linux, you can use terminal.

SSH through PuTTY-

Open PuTTY.
Go to your router's admin page and find out the IP address. It will be named as OpenHABian.
Copy the IP address and paste it in PuTTY and click Open.
Now you need to login -
login as: openhabian
password: openhabian
After logging in, type in the following commands-
$ cd /etc/openhab2
$ ls
Now it will show you all the available directories. We will be using - items (to create different items), rules ( to enable voice commands) and sitemaps ( to create a sitemap for navigation). We will create a sitemap as -home.sitemap. Items file would be - home.items. And rules file would be - home.rules.
$ sudo nano items/home.items
$ password: openhabian
This would open a blank document. We will here, create our items that we will be controlling through Rpi. In my case, I used 4 items. You can use as many as you want.
//Items File
Switch fan "Fan" { gpio="pin:17 activelow:yes initialValue:low" } Switch night_light "Night Lamp" { gpio="pin:27 activelow:yes initialValue:high" } Switch exhaust "Exhaust Fan" { gpio="pin:23 activelow:yes initialValue:high" } Switch light "Light" { gpio="pin:5 activelow:yes initialValue:low" }
String VoiceCommand

Here, I would explain the above with an example- Switch fan "Fan" { gpio="pin:17 activelow:yes initialValue:low" } What happens here is as follows-

Switch - it is a keyword that defines that the item is a switch.
fan (generic - name it anything you want) - it is a user-defined identifier for naming different items that one wants to control.
"Fan" (generic - name it anything you want)- it is the display name that will be displayed in the UI.
<fan_ceiling> (icon name)- It is the name of the icon that will be displayed along with the name.
{ gpio="pin:17 activelow:yes initialValue:low" } - here gpio is the thing that tells OpenHAB that the item is connected through gpio. pin:17 is the pin that you connect the relay to. activelow:yes(or no) - Active low means that when the switch is off there will be no voltage applied to the gpio pin and when the switch is on there will be voltage applied. initialValue:high (or low) - After that is initialValue and what this does is tell openhab what to set the initial value of the item during initialization. This one is set to high because I want the switch to be off during initialization.
String VoiceCommand - it is the item that will be used to control other items using voice commands.
You can create as many items as you want using this syntax-
type item-name "item-display_name" { gpio="pin:pin-no activelow: (yes or low) initialValue: (high or low)
After doing this, press Ctrl+X, then Y and Enter.
$ cd..

Step 4: Creating a Sitemap

Sitemap would be used for navigation and control of the relay switches.

Considering you are continuing after completing above steps, type in terminal
$ sudo nano sitemaps/home.sitemap
This file would be the default sitemap for navigation. The above command will open a blank file. You need to create a sitemap as follows-

sitemap home label="Smart Home"

{

Frame label="My Room"
{

Switch item=fan

Switch item=light

Switch item=exhaust

Switch item=night_light

}

sitemap home label="Smart Home (generic use anything you want)" - this is the title of the homepage. You can use anything you want.
Frame label="My Room (generic use anything you want)" - this will be the sub-section. Its heading can be anything you want.
Switch item=fan - this along with others will define the items you want to see and control from homepage. You have to enter the item-names we created. DO NOT ENTER THE DISPLAY NAME OF THE ITEM.
After this press, CTRL+X, Y and Enter.

Step 5: Creating Rule for VoiceCommand-

For this, you need to create a simple rule. I used reference from this guide. So for voice commands, lets create a basic rule file-

$ sudo nano rules/home.rules

This will create a blank .rules file.

You can access the rules file here.

Well, this is a long code with many files and commands. But you only need to consider the following to create your own set of commands.

if (command.contains("turn on fan") || (command.contains("turn on the fan"))) - here I have listed two options I can say to make the command work. What happens in actual is, when I say the reserved line, OpenHAB recognizes it and checks for the specific rule to do what occurs next.
fan.sendCommand(ON) - When the above condition is true, this function sends a command ON to the item fan. This can be modified according to your choice.

Well, if you have made it to here without any problems, Congrats, because most part of the work is done. Now we need to setup the UI and enable remote access for our OpenHAB.

Step 6: Configuring BasicUI

Now, we need to tell OpenHAB to use the sitemap we create to use it as the default one.

Here's how to do it-

Go to http://openhabianpi:8080
Open Paper UI
Configurations > Services > UI > Configure Basic UI
Here you can select the theme and icon formats, etc. The main thing you need to do is to change the default sitemap to home
Click Save
You can view it by going to http://openhabianpi:8080
Click on Basic UI and voila you would see your own sitemap there

Step 7: Enabling Remote Access

To enable remote access, follow these steps-

Go to http://openhabianpi:8080
Open Paper UI
Configurations > Services > IO > Configure OpenHAB Cloud
Change mode to Notifications and Remote Access, Base URL ->https://myopenhab.org/ and items to expose -> Select all of them
Click Save
Proceed to http://myopenhab.org
Sign Up with email address and password.
For openHAB UUID ->
$ sudo nano /var/lib/openhab2/uuid
Copy and paste this UUID into the UUID column.
For OpenHAB secret->
$ sudo nano /var/lib/openhab2/openhabcloud/secret
Copy and paste it into Secret column and hit Sign Up.
Now after Rpi reboots successfully, you will see the status as online in thehttps://myopenhab.org
Go to items tab
Here you can see all of your items you created. If you don't see anything, you need to toggle all those items at least once.

Step 8: HARDWARE!!!!

Be very careful, as we would be handling 220V and other electric things.

BE CAUTIOUS.

YOU WILL BE DOING THIS AT YOUR OWN RISK.

Connecting the Relay to the Raspberry Pi-

To connect the relay to the Raspberry Pi, connect VCC to 5V on Rpi.

Connect GND on relay to GND of Raspberry Pi
Next connect IN1, IN2,... to the GPIO assigned in the home.items

To check if everything is working, navigate to BasicUI and try turning off and on the different items. You should hear a Clicking sound on each toggle.

You can also download the OpenHAB app from Play Store for easier control of your Automation System.

BE CAUTIOUS and PROCEED AT YOUR OWN RISK!

Now we need to connect the wires of the appliances you want to automate to the relay switches. Turn off Rpi and Main Supply before doing this to be on the safer side.

After connecting wires, make sure there is no live wire left uncovered that may prove to be fatal.

Now turn back on your Rpi and give it time to boot. After booting, you will be able to control appliances from Basic UI or from the mobile app. If you don't want voice automation, you don't need to follow the net steps.

Step 9: Connecting With Google Assistant

For this we will use https://IFTTT.com

Go to IFTTT.com
Create an account if you don't have one
Click on New Applet
Select This and select Google Assistant and select Say a phrase with a text ingredient
In what do you want to say, enter - Turn $ item-name Ex- Turn $ fan
Click create trigger
Select that and select OpenHAB. Link your account
Choose send a commandSelect item as VoiceCommand
Command to send as - Turn {{TextField}} item name. Ex- Turn {{TextField}} fan
Create Action

Give around 10 seconds for it to initialize and then Voila, use google assistant to send the command.

That's it. If you have any doubts or there's any error feel free to comment. I will help you for sure.

If you have any problems or queries, feel free to reach out to me at akshit@akshitagrawal.xyz

Good Luck!