Added README.md

This commit is contained in:
slashtechno 2022-12-18 14:51:07 -06:00
parent cf78914a09
commit 4f8520a5be
Signed by: slashtechno
GPG Key ID: 8EC1D9D9286C2B17
3 changed files with 40 additions and 1 deletions

3
.gitignore vendored
View File

@ -1,4 +1,5 @@
# person.jpg # person.jpg
# config.json # config.json
config/ config/*.jpg
.env .env

21
README.md Normal file
View File

@ -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

17
config/config.json Normal file
View File

@ -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"
}