IoT Doorbell With Built-in IR Camera (Python, Flask, Raspberry Pi)

by arned_nmct in Circuits > Sensors

4082 Views, 27 Favorites, 0 Comments

IoT Doorbell With Built-in IR Camera (Python, Flask, Raspberry Pi)

IMG_20170615_191657.jpg

For school related purposes, I have been working on an IoT doorbell that takes pictures/records video of people who come stand near your front door. It has been a fun little project albeit not completely finished, this instructable will teach you how to set up to the point I've reached given the time limit.

Parts

IMG_20170614_130028.jpg

First and foremost, you will need a couple of components in order to recreate the circuit:

  • Raspberry Pi 3 Model B + power supply: €39.90

(You are free to choose a different model, but you will need Bluetooth and Wi-Fi functionality in order for this to work)

  • HC-SR501 PIR Infrared Motion Sensor: €5.95
  • 1x Push button
  • 1x Buzzer (a speaker will work as well, as long as you add an additional capacitor)
  • 1x Any LED
  • 1x 220 Ω resistor
  • 1x 1000 Ω resistor
  • Cable connectors
  • Raspberry Camera Module V2: €31.95
  • Bluetooth speaker with power supply (I bought one for under €10 in the local Action, but any speaker will do)
  • SD card (at least 8GB, ideally more if you want to store a lot of camera footage)
  • Network cable

Building Circuit

breadboardschema.png
Camera board setup

Note: while preparing this build I was utilizing a T-Cobbler Plus and a speaker. To make your build more compact, I advise connecting the cables to the pins directly and using a buzzer instead of speaker in order to save space. Note 2: ideally you want to use a PCB while finalizing the doorbell. If you want, you can keep the breadboard connections, but you will have to solder the button and LED light as it's hard to connect them properly by simpler means.

For this build, we are a voltage of 5V. The camera will be connected directly to the Pi with the camera port. In order to connect the Pi camera properly, I recommend watching the video above if you want to safely connect the camera to your Raspberry Pi without causing damage to the cable/tin connectors. A short summary of the video:

  1. Open the box the camera got delivered in. It's covered in an anti-static bag: I recommend keeping it in case you want to safely store away the camera for later projects, so you don't harm the camera with static electricity.
  2. Open up the Camera port on the Raspberry Pi. Don't touch the tin connectors as the camera is very sensitive to static.
  3. Insert the camera with the tin connectors facing the HDMI and the blue label facing the Ethernet port.

Installing Python / IDE of Choice (Pycharm)

python-logo.png

In order to start installing everything, you first need to have the proper software installed. An IDE (Integrated Development Environment) will make your life a lot easier while editing code.

The Python installer can be downloaded directly from their website.

You are free to utilize any IDE you want. This instructable will cover how to install necessary packages and how to make database connections in Pycharm.

Downloading/installing Raspbian Jessie/PuTTy/WinSCP/XMing/Win32DiskImager

putty-05-535x535.jpg
hqdefault.jpg

You will need to install an operating system on the Raspberry Pi (and be able to connect to it with SSH). In this instructable, we will be working with Raspbian Jessie (note: to establish the SSH connection with Raspbian Jessie, either download a version released before November 2016 or read this article in order to enable SSH on startup). To make the SSH connection, we will use PuTTY.

WinSCP is not a necessity, but will come in handy if you want to view the camera footage directly from the Pi rather than the website.

Setting Up the Raspberry Pi, Establishing Connection Between Pi and Pycharm

Win32DiskImager_2017-06-18_16-36-03.png
pycharm_2017-06-18_17-13-41.png
putty_2017-06-18_17-15-39.png
putty_2017-06-18_17-16-48.png
  1. Open Win32DiskImager and write the Raspbian Jessie image to the SD card. Once installed, open the file "cmdline.txt" and add "ip=169.254.x.x" in front of "rootwait" (replace the x with whatever works for you, for example 169.254.10.11).
  2. Safely unplug the SD card from your PC and insert it into the Raspberry Pi. Open PuTTY, select SSH (it's the default option) and connect to the IP address you have inserted earlier into the cmdline.txt file. It will ask you for a username and password: the default username and password are 'pi' and 'raspberry' respectively.
  3. Configure your network connection. You can do this in /etc/dhcpcd.conf and /etc/wpa_supplicant/wpa_supplicant.conf. To restart the network, type 'sudo service networking restart'.
  4. Type 'sudo raspi-config' in the terminal window. Enable the camera module and expand the filesystem.
    1. In order to test if the camera module is enabled and the camera is properly connected, type 'vcgencmd get_camera'. This can be handy while troubleshooting issues with the camera connection.
  5. Update the Pi if necessary by performing the following command: 'sudo apt-get update && sudo apt-get upgrade'. This can take a while depending on how it has been since the last time you have updated the operating system.
  6. You will need to install a couple of (Python) libraries in order to make everything work properly. (due to issues with Pycharm it's easier to install these from the terminal, other libraries like os, time, datetime etc aren't half as difficult to install)
    1. sudo pip install python3-dev

    2. sudo pip install pybluez

    3. sudo pip install bluetooth

    4. sudo apt-get install libbluetooth-dev

    5. sudo pip install pygame

    6. sudo apt-get install python-picamera

  7. Open Pycharm and make a Flask project. You are free to name this as you please, however be aware you will need to edit the path to certain folders accordingly as Flask requires images and other static material to be in the 'static' folder in order for you to be able to display them on your website.
  8. In order to make coding more convenient, we will establish a remote connection between the IDE and the Pi. Go to Settings → Deployment and edit the credentials accordingly.
    1. The SFTP host is the IP address of your Raspberry Pi.
    2. The root path is the folder in which the project will be saved on your Pi.
    3. Don't forget to define the local and deployment path in Mappings!
  9. Press Ctrl+Shift+A in Pycharm and search for 'Project interpreter'. Choose 'Add remote' in the top right corner (cog wheel). Choose 'Deployment Configuration' and select the configuration you made in the previous step. The Python interpreter is usually '/usr/bin/python3' by default.

Configuring Bluetooth Speaker to Auto-connect With Pi on Boot (Part 1)

IMG_20170604_175057.jpg

The title says it all, we need to make the Bluetooth speaker connect with the Raspberry Pi on startup. In order to do this, we must first acquire the MAC-address of your speaker. Be sure to note it down somewhere for future reference as you will need this to edit the appropriate sound card and device for audio in the programming code. I'm assuming you have already installed the bluetooth tools and libraries listed in the previous step.

  1. Go to the Terminal and type the following commands:
    1. sudo apt-get install pulseaudio -y

    2. pulseaudio --start

    3. bluetoothctl -a

    4. scan on
      1. You should be able to see your device and its corresponding MAC address, implying the Bluetooth speaker is on. Save it for future reference.
    5. pair
    6. trust
    7. connect
  2. Your Bluetooth speaker should now be connected (you won't be able to play audio yet however, as you haven't selected the audio card yet). However, we want to automate this process so we don't need to do this every single time we launch the Pi.
  3. Go to the Terminal and type the following commands:
    1. mkdir -p ~/scripts

    2. nano ~/scripts/autopair

    3. (enter the code below into the nano file and save it with CTRL + X)
      #!/bin/bash
      bluetoothctl << EOF
      connect [enter your MAC add]
      EOF

    4. chmod +x ~/scripts/autopair

    5. nano ~/.bashrc

    6. (go to the bottom and add this line of code)
      pulseaudio --start

Github Code, Editing Code to Your Liking, How to Set Up PIRCamera

docam.PNG
github-logo.png

To download the code, go to Github and download as .zip. Paste the necessary code in your project (docam.py is redundant and only for manual testing purposes).

Open PIRCamera.py and make sure all the Python libraries are installed. To install these, navigate to Settings → Deployment and press the green + button. Type in the packages listed in the various imports if you are missing a few.

Navigate to __bluetoothScan() and edit the last line to match your MAC address.

call('pacmd set-default-sink bluez_sink.', shell=True)

Check if the mentioned paths in takePicture(), recordVideo() and knop_callback are correct and edit accordingly depending on your deployment path.

Open docam_examen.py and adapt the UPLOAD_FOLDER path accordingly.

Edit the pin numbers of the PIRCamera object if needed according to the following format: pir, led, button, speaker

Setting Up MySQL Database on Raspberry Pi

1NMCT4_Debouvere_Arne_P1_erd.png
chrome_2017-06-18_19-26-23.png
chrome_2017-06-18_19-26-50.png
  1. Open the Terminal window and type in the following commands.
    1. Optional: sudo apt-get update && sudo apt-get upgrade (only necessary if you haven't done this yet in the previous steps)
    2. sudo apt-get install mysql-server
    3. sudo apt-get install mysql-client
    4. mysql -uroot -p
    5. We have to make two users.
      CREATE USER 'finley' @ 'localhost' IDENTIFIED BY 'some_pass';
      GRANT ALL PRIVILEGES ON *.* TO 'finley' @ 'localhost' WITH GRANT OPTION;
      CREATE USER 'finley' @ '%' IDENTIFIED BY 'some_pass';

      GRANT ALL PRIVILEGES ON *.* TO 'finley' @ '%' WITH GRANT OPTION;

    6. We can now make our database.
      CREATE DATABASE docam;

    7. To quit the MySQL connection, type:
      quit

    8. sudo apt-get install python3-mysql.connector

    9. Open a data source in Pycharm. Fill in your made credentials (use the pictures as a reference).

    10. Add the tables in Pycharm's editor (use the ERD as a reference on how to make them).

    11. Open DbClass.py and edit the credentials located in the init if necessary.

Your database should be connected to your project now.

Case

IMG_20170615_191742.png
IMG_20170614_125817.jpg
IMG_20170615_191633.jpg

The way you make the case is up to you, just make sure the case is big enough. The material can be anything as long as it's non-conductive. I personally opted for multiplex due to its simplicity since I was running out of time.

Things to consider while making the case:

  • You'll need to drill a couple of holes in the material. A standard LED light is about 5mm wide, the camera lens is 7.5mm wide and the PIR sensor is about 22mm wide. The button depends on the button you own, the push buttons in the Raspberry Pi toolkit that I used are about 7.5mm wide.
  • Depending on how thick your material is, you might need to make the hole for the camera bigger going outwards so it doesn't pick up the material while gathering footage.
  • The camera connector is very small. Ideally you would extend the camera connector by using a different flex cable. The reason this is a problem is because it's genuinely not a good idea to leave a box with the Pi in it because of various reasons:
    • It means people can get direct access to your Pi and its files without much effort.
    • Rather than trying to collect data from your Pi at your front door, it's more likely that thieves will take advantage of your Pi not being in a separate case and simply steal it. Considering the pricing of the parts, it'd be a real shame if someone stole all the parts. So either separate the Pi from the pir/camera/button/led or make your case a real pain to open by regular means.
    • The login system only requires a quick glance at the docam_examen.py file to figure out. A better way to secure the data would be to make an additional table with (a) user()s and encrypt the password(s) (with MD5 for example).
  • On the back, you will need to add a large enough hole to fit a network cable and power adapter in.

Testing

chrome_2017-06-18_20-23-47.png
chrome_2017-06-18_21-21-45.png
chrome_2017-06-17_18-02-20 (1).png
chrome_2017-06-17_18-01-50 (1).png

Now you have set up everything, it's time to test how it works.

Type the IP address and the corresponding port number in your browser of choice (Chrome recommended for optimal results).

Once you have connected to the website, fill in the login form. You can find/edit the credentials in 'def do_admin_login():'

if request.form['password'] == '<b>password</b>' and request.form['username'] == '<b>admin</b>':<br>

When you have successfully logged in, you will be referred to the homepage.

  • Timeline contains a list of all images (and videos, but I have not managed to finish that functionality as of writing) captured by the camera
  • Sound contains a volume slider and a list of all available ringtones. You can select .mp3 and .wav files to play from your Bluetooth speaker and add your own!
  • User settings contains options to change framerate, resolution, camera mode (image, video) and brightness. (everything but brightness is still in progress)

If everything is working fine, make a script so it executes the Python script on boot.