slashtechno 9e39132506 | ||
---|---|---|
.github/workflows | ||
.vscode | ||
faces | ||
wyzely_detect | ||
.Dockerfile.old | ||
.dockerignore | ||
.gitignore | ||
.python-version | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
deepface-test.ipynb | ||
docker-compose.yml | ||
poetry.lock | ||
pyproject.toml |
README.md
Wyzely Detect
Recognize faces/objects in a video stream (from a webcam or a security camera) and send notifications to your devices
Features
- Recognize objects
- Recognize faces
- Send notifications to your phone (or other devices) using ntfy
- Optionally, run headless with Docker
- Either use a webcam or an RTSP feed
- Use mrlt8/docker-wyze-bridge to get RTSP feeds from Wyze Cams
Prerequisites
Poetry/Python
- Camera, either a webcam or a Wyze Cam
- All RTSP feeds should work, however.
- Python 3.10 or 3.11
- Poetry
Docker
- A Wyze Cam
- Any other RTSP feed should work, as mentioned above
- Docker
- Docker Compose
What's not required
- A Wyze subscription
Usage
Installation
- Clone this repo with
git clone https://github.com/slashtechno/wyzely-detect
cd
into the cloned repository- Then, either install with Poetry or run with Docker
Docker
- Modify to
docker-compose.yml
to achieve desired configuration - Run in the background with `docker compose up -d
Poetry
poetry install
poetry run -- wyzely-detect
Configuration
The following are some basic CLI options. Most flags have environment variable equivalents which can be helpful when using Docker.
- For face recognition, put images of faces in subdirectories
./faces
(this can be changed with--faces-directory
)- Keep in mind, on the first run, face rec
- By default, notifications are sent for all objects. This can be changed with one or more occurrences of
--detect-object
to specify which objects to detect- Currently, all classes in the COCO dataset can be detected
- To specify where notifications are sent, specify a ntfy URL with
--ntfy-url
- To configure the program when using Docker, edit
docker-compose.yml
and/or set environment variables. - For further information, use
--help
How to uninstall
- If you used Docker, run
docker-compose down --rmi all
in the cloned repository - If you used Poetry, just delete the virtual environment and then the cloned repository