README.md

MMM-Face-Recognition-SMAI

A module for the MagicMirror project by SmartBuilds.io adding (faceID) face recognition.

How it works

This module allows you to access profiles using face recognition. This works on the back of OpenCV face recognition module.

Screenshots

A guest profile as default	User has been recognised

Preconditions

• MagicMirror² instance
• Node.js version >= 7
• npm
• OpenCV face-recognition
• Raspberry Pi 4 Camera Module

Step 1 – Install the module

In your MagicMirror directory:

   git clone https://github.com/EbenKouao/MMM-Face-Recognition-SMAI.git
   cd MMM-face-rec
   npm install

Step 2 – Add files to the Config.js

Here is an example for an entry in config.js

{
  module: "MMM-Face-Recognition-SMAI",
  position: "top_right",
  config: {
    //prompt: "Put in your own text"
  }
  
  
}

Step 3 – Configuring the Face Recognition Python Script

Pre-requisite: Ageitgey Face_recognition Library is installed:

Run the python script seen in the /MMM-Face-Recognition-SMAI. Creating an Autostart script is recommended to keep it running in the background of you MagicMirror.

sudo python3 /home/pi/MagicMirror/modules/MMM-Face-Recognition-SMAI/MMM-Face-Recognition-SMAI.py

You could test a successful installation by running the Python script. From here you could program to add multiple profiles. We encourage contribution to this project.

Download Beta image of MMM-Face-Recognition-SMAI integration

Any troubles installing, try out the already compiled Raspberry Pi (Buster) Image of Magic Mirror with Face Recognition module.