text.skipToContent text.skipToNavigation



Intruder Alert

Download Project Resources View on Github

The WiFi Intruder Alert provides you with email notifications and reports the exact time and date when someone has entered your monitored area, such as your room. The WiFi Intruder Alert is based on the ESP8266 integrated WiFi and Microcontroller unit. We used the ESP8266 D1 Mini main board, the small footprint measures only 25x35mm, making it ideal for hiding the unit away from the intruder’s view.

titlebild

This project utilises the "G-Mail Email Sender Using ESP8266" project published in the Instructables community, http://www.instructables.com/id/ESP8266-GMail-Sender. A few additional features have been added to enable date and time synchronisation using NTP (Network Time Protocol), and of course; an interface to the XC4444 PIR Motion sensor module.

Before you begin

There's a few readme's before you begin this project:

ESP8266

If you are new to the world of ESP, you might not know that it is not supported by default in the Arduino IDE; you must enable the ESP8266 board management through the File -> Preferences dialog. You can find information for doing so on the Manuals download for the XC3802

xc3802 setup

(Deprecation warning) Gmail setup

This project uses an older method of communicating with gmail. Because this project utilises a connection straight to the gmail server, you need configure your gmail "Sign-in & Security" options to allow "less secure App".

This means that your ESP8266 device will be sending your gmail log in details through your wifi in a some-what less secure manner.

By building this project you are agreeing that you understand the risks of leaking your personal account details..

The correct method to communicate with gmail is to go through something such as IFTTT service; which we have done in our latest WiFi-Datalogger project. We are looking forward to pull requests to change this project to use the IFTTT method and is a good first issue for makers just starting with code and github.

sign in

Bill of Materials

Qty Code Description
1 XC3802 ESP8266 module
1 XC3850 prototyping shield for ESP
1 XC4444 PIR motion sensor
1 RR2766 1W 470 resistor
1 RR0596 0.5W 10k resistor
1 ZD0230 Red LED
1 ZD0232 Green LED
1 SP0601 PCB mounted switch
1 WH3025 Hookup wire
1 HM3230 40 pin female header strip

Circuit & Assembly

We assembled the main components on the small Prototype board, everything fitted neatly on this board, though fitting all the wiring in a small space mostly at the bottom of the board looked like a spaghetti bowl, it all worked well. You are free to choose how you wish to assemble this project, as long as you adhere to the wiring connections detailed below:

schematic

When wiring LED’s remember the long pin is the Anode (+), and the shorter pin is the cathode (-).

diodes

Connecting the PIR Sensor is very easy simply connect the VCC pin to the 3.3v rail, and the GND to the same GND as the ESP8266 board. The PIR Sensor output pin is then connected to pin D5 of the ESP8266 board. We added a 10K ohm pull down resistor to make sure the PIR output signal is low at all times when no active motion is detected.

Activity PIR Out
No Motion LOW
Motion HIGH

PIR sensor

On the Prototype Shield (XC3850) we placed the main components, LED’s, Switch, and resistors. We also cut the 40 pin header to get the 3 pin socket where we will insert the PIR sensor. The wiring was mainly done on the back of the prototype shield, in accordance with the above circuit diagram.

board top

This is the underside of the XC3850

The prototype shield is then inserted on-top of the ESP8266 main board (XC3802), as shown below., Make sure the pins are correctly aligned and match.

underside

Now all you need to do is insert the PIR sensor pins in the allocated 3 pin header on the top of the prototype shield, as shown below.

mount

Source code

First unzip the code file, you see three files, these files are to be located under the same directory in order for the code to compile.

WiFi_Intruder_Alert.ino This is the Arduino IDE source code file
Gsender.h Library definition file, you should change to include your details.
Gsender.cpp Library implementation file, no changes

Modifying the Gsender.h file

From the Arduino IDE open the intruder.ino project. You will notice three tabs on the tiop of the main editor scree, click on the Gsender.h to edit it in the arduino IDE.

There are only three lines which need to be updated in this file, to tell the application your email address and login details, as shown below:

const char* EMAILBASE64_LOGIN = "exampleencodedpassname==";
const char* EMAILBASE64_PASSWORD = "examplefasdfasdf=";
const char* FROM = "yourgmailaddress@gmail.com";

You will notice that the EMAILBASE64_LOGIN and EMAILBASE64_PASSWORD are encoded, that is because you may not want to insert your private login details as plain text, so we use base64encode.org to generate the encoded version of our plain text email login credentials.

Once you have done this insert the encoded string into the above code.

Modifying the intruder.ino file

In the main code file you need to configure your WiFi network SSID and password, as well as the destination email address where the notifications are to be sent to.

#define email "enter your email here"
const char* ssid = "your WiFi SSID here"
const char* password = "your WiFi password here"

Include the "" in the above variables. Now all you need to do is download the code (as you would with any other Arduino development board).

Tips & Tricks

The code has been written in a way that allows you to change the way the code works without too much hard coding. You can change the literal definitions to change the way the WiFi Intruder Alert works, here are some tips;

Code Advice
#define longPRESS This controls the hold time (in mSec) that a user needs to depress the switch before any action is taken. Hence a value of 500 means the user needs to depress the switch for at least 0.5 sec before the unit responds with an action; If the unit is OFF and the user presses the switch for a long_press, the unit will switch ON. If the unit is ON and the user presses the switch for a long_press, the unit will switch OFF.
#define timezone This is set to Sydney time zone by default (GMT + 10). You can change the time zone to your city. Note: If Day Light Savings time applies, then add (or remove) one to your city time zone, e.g. Sydney GMT+10 + 1 = 11
#define arm_delay This is the initial time delay before the WiFi Intruder Alert unit is armed (i.e. starts monitoring for movement). This delay is in mSec (1/1000 Sec), hence is we want a 10 Second delay, we enter 10000. You can change this delay value to suit your application.
#define trigger_interval After a movement there will be a delay before the next trigger can be detected, this is defined by the trigger_interval in minutes. Hence a value of 3 means that there needs to be a delay of at least 3 minutes from when someone triggers the PIR to the next time the PIR detects another trigger.
#define max_no_trigger The maximum number of triggers provides a limit of the number of reported triggers in each email notification. Once the maximum number of triggers is reached an email notification is sent.