diff --git a/.gitignore b/.gitignore index 658b8fa..16fac0c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ # person.jpg # config.json -config/ +config/*.jpg + .env \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c41f49 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Wyze Face Recognition +Recognize faces in Wyze Cam footage and send notifications to your phone (or other devices) + +## Pre-requisites +* Docker +* Docker Compose +* A Wyze Cam + +## What's not needed +* A Wyze Cam subscription + +## How to use +1. Clone this repo + ` git clone https://github.com/slackner/wyze-face-recognition.git` +2. Add images to the `config` directory +3. Edit `config/config.json` and edit the faces array to match the images you added, and the face names +4. Either set the `WYZE_EMAIL` and `WYZE_PASSWORD` environment variables, or edit `docker-compose.yml` and add your Wyze credentials +5. Run `docker-compose up -d` + +### How to uninstall +1. Run `docker-compose down` in the `wyze-face-recognition` directory \ No newline at end of file diff --git a/config/config.json b/config/config.json new file mode 100644 index 0000000..bfbd55d --- /dev/null +++ b/config/config.json @@ -0,0 +1,17 @@ +{ + "URL": "rtsp://bridge:8554/cv", + "RUN_SCALE": "0.5", + "VIEW_SCALE": "0.5", + "faces": { + "person1": { + "image": "config/person1.jpg", + "last_seen": "" + }, + "person2": { + "image": "config/person2.jpg", + "last_seen": "" + } + }, + "display": false, + "ntfy_url": "http://ntfy:80/cam" +} \ No newline at end of file