![\"Hack](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/HLK-PM03-ESP8266.jpg?resize=1200%2C800&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nPrerequisites<\/h2>\n\n\n\n
Before continuing with this project, we recommend taking a look at the following resources:<\/p>\n\n\n\n
- Getting Started with ESP8266 WiFi Transceiver (Review)<\/a><\/li>
- Power ESP8266 with Mains Voltage using Hi-Link HLK-PM03<\/a> <\/li>
- What is MQTT and How It Works<\/a><\/li>
- You need to have installed in your Raspberry Pi: Node-RED<\/a>, Node-RED Dashboard<\/a>, and Mosquitto MQTT broker<\/a><\/li>
- ESP8266 GPIOs and Pinout Reference<\/a><\/li><\/ul>\n\n\n\n
Parts Required:<\/h2>\n\n\n\n
Here\u2019s a list of the parts needed for this project:<\/p>\n\n\n\n
- PIR Motion Sensor 220V<\/a> (or 110V PIR Motion Sensor<\/a>)<\/li>
- ESP8266-01<\/a> – read Best ESP8266 Wi-Fi Development Boards<\/a><\/li>
- ESP8266-01 Serial Adapter<\/a> (to upload code to the ESP8266)<\/li>
- Hi-Link HLK-PM03<\/a> (to convert mains voltage to DC 3.3V)<\/li>
- Small protoboard<\/a><\/li>
- Fuse Slow Blow (200mA)<\/li>
- 47 uF electrolytic capacitor<\/a><\/li>
- Raspberry Pi<\/a> (to host Node-RED and MQTT broker) – read Best Raspberry Pi Kits<\/a><\/li><\/ul>\n\n\n\n
You can use the preceding links or go directly to MakerAdvisor.com\/tools<\/a> to find all the parts for your projects at the best price!<\/p>
![](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/10\/header-200.png?w=1200&quality=100&strip=all&ssl=1\")
<\/a><\/p>\n\n\n\nProject Overview<\/h2>\n\n\n\n
This project is divided into three parts:<\/p>\n\n\n\n
- Building the circuit<\/li>
- Writing and uploading the ESP8266 code<\/li>
- Creating the Node-RED flow<\/li><\/ol>\n\n\n\n
The following image shows a high-level overview of the project we\u2019ll build.<\/p>\n\n\n\n
![\"ESP8266](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/project-overview-pir-esp8266-hlk-pm03.png?resize=750%2C423&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nMotion Sensor<\/h3>\n\n\n\n
We\u2019ll hack a commercial motion sensor that has enough space to put an ESP-01 and the HLK-PM03 AC\/DC converter module inside. We bought our motion sensor for $5 in a local store. <\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/DSC04162.jpgpir-motion-sensor.jpg?resize=750%2C500&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nWhen the PIR sensor detects motion, there’s power coming out from the red hot wire that can turn on a lamp or a device. Your motion sensor should have a similar wiring diagram on the lid or printed in the instructions manual. <\/p>\n\n\n\n
![\"pir-motion-sensor-wiring\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/pir-motion-sensor-wiring.jpg?resize=750%2C500&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nIn our project, the motion sensor output load is the HLK-PM03 AC\/DC<\/a> converter module that will power the ESP8266.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/12\/hlk-pm03.jpg?resize=750%2C421&quality=100&strip=all&ssl=1\")
Hi-Link HLK-PM03<\/figcaption><\/figure><\/div>\n\n\n\n Related: <\/strong>Power ESP8266 with AC voltage using HLK-PM03 Converter<\/a><\/p>\n\n\n\n
The HLK-PM03 module AC\/DC converter supplies 3.3V from either 110VAC or 220VAC. This makes it perfect to power the ESP8266 from mains voltage.<\/p>\n\n\n\n
In summary, when motion is detected there is power reaching the ESP8266. The ESP8266 can execute tasks for as long as the motion sensor is triggered.<\/p>\n\n\n\n
You may need to adjust the time duration that the sensor stays on, so your ESP8266 has enough time to execute its tasks. The sensor should have a knob to adjust the time (and another to adjust luminosity).<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/motion-sensor-lux-timer-trigger.jpg?resize=750%2C500&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nIn our example, whenever the ESP8266 powers up, it runs a sketch that sends information to Node-RED via MQTT to log the date and time that motion was detected.
<\/p>\n\n\n\nInstead of sending information to Node-RED, you can execute other tasks, such as:<\/p>\n\n\n\n
- Log data to a Google Spreadsheet<\/a>;<\/li>
- Send an email warning that motion was detected;<\/li>
- Send notifications to your smartphone.<\/li><\/ul>\n\n\n\n
These tasks can be easily done using IFTTT.
<\/p>\n\n\n\n1. Building the Circuit<\/h2>\n\n\n\n
The following schematic diagram shows the circuit for this project.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/esp8266-pir-arduino-ide-mqtt-hlk-pm03-circuit.png?resize=1024%2C548&quality=100&strip=all&ssl=1\")
<\/a><\/figure><\/div>\n\n\n\nRemove your PIR motion sensor lid. Inside, it should have three wires: phase in<\/strong>, neutral<\/strong>, and phase out<\/strong>. Follow these steps:<\/p>\n\n\n\n
- Wire phase in<\/strong> (brown) and neutral <\/strong>(blue) to the motion sensor<\/li>
- Wire neutral <\/strong>(blue) and phase out<\/strong> (red) to the HLK-PM03 input<\/li><\/ul>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/motion-sensor-wiring.jpg?resize=750%2C500&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nIt’s recommended to add a slow blow fuse right before the HKL-PM03 converter and a capacitor to the output. <\/p>\n\n\n\n
Note: <\/strong> if you’re using an ESP8266 that is always powered on with the HLK-PM03, we recommend using this protection circuit<\/a>.<\/p>\n\n\n\n
The HLK-PM03 outputs 3.3V and GND. These are connected to the ESP8266 VCC and GND pin to power it.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/HLK-PM03-ESP8266-circuit.jpg?resize=750%2C456&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nWe’ve built the HLK-PM03 and ESP8266 circuit on a small protoboard to save space. We’ve also added some header pins to place the ESP8266-01. This way you can plug and unplug the board every time you need to upload new code.<\/p>\n\n\n\n
Recommended reading:<\/strong> ESP8266 GPIOs and Pinout refence guide<\/a><\/p>\n\n\n\n
2. Writing and Uploading the ESP8266 Code<\/h2>\n\n\n\n
We\u2019ll program the ESP8266 using the Arduino IDE. In order to upload code to your ESP8266, you need to install the ESP8266 add-on first, if you haven’t already (Install the ESP8266 Board in Arduino IDE<\/a>).<\/p>\n\n\n\n
You\u2019ll also need to install the PubSubClient<\/a> library to create an MQTT client with the ESP8266. The PubSubClient library provides a client for doing simple publish\/subscribe messaging with a server that supports MQTT (basically allows your ESP8266 to talk with Node-RED).<\/p>\n\n\n\n
- Click here to download the PubSubClient library<\/a>. You should have a .zip<\/em> folder in your Downloads folder<\/li>
- Unzip the .zip<\/em> folder and you should get pubsubclient-master<\/strong> folder<\/li>
- Rename your folder from
pubsubclient-master<\/del><\/strong> to pubsubclient<\/strong><\/li>- Move the pubsubclient <\/strong>folder to your Arduino IDE installation libraries <\/strong>folder <\/li><\/ul>\n\n\n\n
Then, copy the following code to your Arduino IDE, but don’t upload it yet. You need to make a few modifications to make it work for you. <\/p>\n\n\n\n
You need to edit the code with your own SSID, password and MQTT Broker IP Address (Raspberry Pi IP Address).<\/strong><\/p>\n\n\n\n
\/*********\n Rui Santos\n Complete project details at https:\/\/randomnerdtutorials.com \n*********\/\n\n#include <ESP8266WiFi.h>\n#include <PubSubClient.h>\n\n\/\/ Replace with your SSID, password and MQTT broker IP address\nconst char* ssid = "REPLACE_WITH_YOUR_SSID";\nconst char* password = "REPLACE_WITH_YOUR_PASSWORD";\nconst char* mqtt_server = "REPLACE_WITH_YOUR_MQTT_BROKER_IP";\n\/\/For example\n\/\/const char* mqtt_server = "192.168.1.144";\n\nWiFiClient espClient;\nPubSubClient client(espClient);\n\nvoid setup_wifi() {\n\n delay(10);\n \/\/ We start by connecting to a WiFi network\n Serial.println();\n Serial.print("Connecting to ");\n Serial.println(ssid);\n\n WiFi.begin(ssid, password);\n\n while (WiFi.status() != WL_CONNECTED) {\n delay(500);\n Serial.print(".");\n }\n\n randomSeed(micros());\n\n Serial.println("");\n Serial.println("WiFi connected");\n Serial.println("IP address: ");\n Serial.println(WiFi.localIP());\n}\n\nvoid reconnect() {\n \/\/ Loop until we're reconnected\n while (!client.connected()) {\n Serial.print("Attempting MQTT connection...");\n \/\/ Create a random client ID\n String clientId = "ESP8266Client-";\n clientId += String(random(0xffff), HEX);\n \/\/ Attempt to connect\n if (client.connect(clientId.c_str())) {\n Serial.println("connected");\n } else {\n Serial.print("failed, rc=");\n Serial.print(client.state());\n Serial.println(" try again in 5 seconds");\n \/\/ Wait 5 seconds before retrying\n delay(5000);\n }\n }\n}\n\nvoid setup() {\n pinMode(BUILTIN_LED, OUTPUT); \/\/ Initialize the BUILTIN_LED pin as an output\n digitalWrite(BUILTIN_LED, HIGH);\n Serial.begin(115200);\n setup_wifi();\n client.setServer(mqtt_server, 1883);\n while (!client.connected()) {\n reconnect();\n }\n Serial.print("Motion Detected");\n \/\/ Publish MQTT message\n String mqttMessage = "Motion Detected"; \n client.publish("esp\/pir", mqttMessage.c_str());\n}\n\nvoid loop() {\n client.loop();\n}\n<\/code><\/pre>\n\tView raw code<\/a><\/p>\n\n\n\n
Include your network credentials<\/h3>\n\n\n\n
You need to include your network credentials in the following lines.<\/p>\n\n\n\n
const char* ssid = \"REPLACE_WITH_YOUR_SSID\";\nconst char* password = \"REPLACE_WITH_YOUR_PASSWORD\";<\/code><\/pre>\n\n\n\nInclude your MQTT broker IP address<\/h3>\n\n\n\n
You also need to include your MQTT broker IP address. <\/p>\n\n\n\n
const char* mqtt_server = \"REPLACE_WITH_YOUR_MQTT_BROKER_IP\"; <\/code><\/pre>\n\n\n\nTo find your MQTT broker IP address, it should be configured first. We’re using Mosquitto broker hosted on a Raspberry Pi. Follow the next resources if you haven’t done that yet:<\/p>\n\n\n\n
- How to Install Mosquitto Broker on Raspberry Pi<\/a><\/li>
- Testing Mosquitto Broker and Client on Raspbbery Pi<\/a><\/li><\/ul>\n\n\n\n
How the code works<\/h3>\n\n\n\n
The code is very simple. It simply publishes a message on a topic. For testing purposes, we’re also turning the on-board LED on every time the ESP8266 is powered. This is done on the setup()<\/span> because it will only be executed once (when motion is detected and while the ESP8266 is powered).<\/p>\n\n\n\n
void setup() {\n pinMode(BUILTIN_LED, OUTPUT); \/\/ BUILTIN_LED pin as an output\n digitalWrite(BUILTIN_LED, HIGH);\n Serial.begin(115200);\n setup_wifi();\n client.setServer(mqtt_server, 1883);\n while (!client.connected()) {\n reconnect();\n }\n Serial.print(\"Motion Detected\");\n \/\/ Publish MQTT message\n String mqttMessage = \"Motion Detected\"; \n client.publish(\"esp\/pir\", mqttMessage.c_str());\n}<\/code><\/pre>\n\n\n\nUploading the code<\/h3>\n\n\n\n
After modifying the code with your network credentials, you can upload it to your board. To upload the code to the ESP8266-01 you need a serial adapter<\/a> or an FTDI programmer<\/a>.<\/p>\n\n\n\n
3. Creating the Node-RED Flow<\/h2>\n\n\n\n
Before creating the flow, you need to have installed in your Raspberry Pi:<\/p>\n\n\n\n
- Node-RED<\/a><\/li>
- Node-RED Dashboard<\/a><\/li>
- Mosquitto Broker<\/a><\/li><\/ul>\n\n\n\n
Importing the Node-RED flow<\/h3>\n\n\n\n
To import the provided Node-RED flow, go to the GitHub repository<\/a> or click the figure below to see the raw file, and copy the code provided.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/node-red-flow-github.png?resize=750%2C64&quality=100&strip=all&ssl=1\")
<\/a><\/figure><\/div>\n\n\n\nNext, in the Node-RED window, at the top right corner, select the menu, and go to Import <\/strong> > Clipboard<\/strong>.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/11\/import-nodes.png?resize=523%2C291&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nThen, paste the code provided and click Import<\/strong>.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/09\/node-red-import-flow.png?resize=501%2C336&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nHere\u2019s the imported flow. It receives the ESP8266 MQTT messages and logs the time whenever motion is detected. <\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/Node-RED-flow-ESP8266-HLK-PIR-f-1.png?resize=722%2C323&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nWe’ve also added two buttons to clear and refresh the log. <\/p>\n\n\n\n
Node-RED Dashboard<\/h2>\n\n\n\n
After making all the necessary changes, click the Deploy<\/strong> button to save all the changes.<\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/06\/11_deploy_button.png?resize=138%2C40&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nNow, your Node-RED application is ready. To access Node-RED Dashboard and see how your application looks, access any browser in your local network and type:<\/p>\n\n\n\n
http:\/\/Your_RPi_IP_address:1880<\/strong>\/ui<\/pre>\n\n\n\n
Demonstration<\/h2>\n\n\n\n
Now, you can test your project. Whenever motion is detected, the ESP8266 powers up and sends a message via MQTT to Node-RED.<\/p>\n\n\n\n
If you go to your Node-RED Dashboard you can see all the logs of when motion was detected. Your application should look as in the following figure. <\/p>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/02\/node-red-log_f.png?resize=655%2C607&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nThe dashboard shows the last time motion was detected and all previous logs. You also have the option to refresh the log, and clear the log. Please note that clearing the log is irreversible. <\/p>\n\n\n\n
Wrapping Up<\/h2>\n\n\n\n
This project showed how you can hack a commercial motion sensor with an ESP8266 to make it smarter. You can easily power the ESP8266 with the HLK-PM03 from mains voltage and make a compact circuit that can fit in the motion sensor. <\/p>\n\n\n\n
Whenever motion is detected the ESP8266 is powered and executes a task. In this case, it publishes an MQTT message to log the time motion was detected, but you can easily write code to execute any other task.<\/p>\n\n\n\n
We hope you’ve found this project useful. If you liked this project, you may also be interested in one the following resources:<\/p>\n\n\n\n
- Power ESP8266 with Mains Voltage using Hi-Link HLK-PM03 Converter<\/a><\/li>
- MicroPython \u2013 Getting Started with MQTT on ESP32\/ESP8266<\/a><\/li>
- ESP8266 Multisensor Shield with Node-RED<\/a><\/li>
- [eBook] Home Automation using ESP8266<\/strong><\/a><\/li><\/ul>\n","protected":false},"excerpt":{"rendered":"
In this project we\u2019ll modify a commercial motion sensor (powered with mains voltage) with an ESP8266 to log data whenever motion is detected. The data will be sent to Node-RED using MQTT communication protocol. <\/p>\n
- MicroPython \u2013 Getting Started with MQTT on ESP32\/ESP8266<\/a><\/li>
- Node-RED Dashboard<\/a><\/li>
- Testing Mosquitto Broker and Client on Raspbbery Pi<\/a><\/li><\/ul>\n\n\n\n
- Unzip the .zip<\/em> folder and you should get pubsubclient-master<\/strong> folder<\/li>
- Wire neutral <\/strong>(blue) and phase out<\/strong> (red) to the HLK-PM03 input<\/li><\/ul>\n\n\n\n
- Log data to a Google Spreadsheet<\/a>;<\/li>
- ESP8266-01<\/a> – read Best ESP8266 Wi-Fi Development Boards<\/a><\/li>
- Power ESP8266 with Mains Voltage using Hi-Link HLK-PM03<\/a> <\/li>