slashtechno
/
wyzely-detect
mirror of https://github.com/slashtechno/wyzely-detect
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
73 Commits 10 Branches 4 Tags 533 KiB
Python 87.4%
Jupyter Notebook 11.3%
Dockerfile 1.3%
Go to file
slashtechno 1cf74e13ed
Add details on installing from PyPi in README 
Also:
- Bump version to `0.1.1`
- Pull Docker image rather than building in docker-compose.yml
 		2023-10-27 12:54:28 -05:00
.github/workflows Added facial recognition confidence threshold 2023-10-22 16:45:01 -05:00
.vscode Fix representations_<model>.pkl not being created 2023-10-22 16:20:57 -05:00
faces Create Deepface Jupyter Notebook 2023-10-13 20:51:16 -05:00
wyzely_detect Fixed nonexistent arg being used for RTSP 2023-10-27 12:00:17 -05:00
.Dockerfile.old Fixed Docker support and updated README.md 2023-10-14 22:31:48 -05:00
.dockerignore Fixed Docker support and updated README.md 2023-10-14 22:31:48 -05:00
.gitignore Fix representations_<model>.pkl not being created 2023-10-22 16:20:57 -05:00
.python-version Manually plot boxes, rather than using `r.plot()` 2023-10-13 17:44:38 -05:00
Dockerfile Add details on installing from PyPi in README 2023-10-27 12:54:28 -05:00
LICENSE Change license to GNU GPL v3 2022-12-17 20:38:48 -08:00
README.md Add details on installing from PyPi in README 2023-10-27 12:54:28 -05:00
deepface-test.ipynb Fix representations_<model>.pkl not being created 2023-10-22 16:20:57 -05:00
docker-compose.yml Add details on installing from PyPi in README 2023-10-27 12:54:28 -05:00
poetry.lock Fix representations_<model>.pkl not being created 2023-10-22 16:20:57 -05:00
pyproject.toml Add details on installing from PyPi in README 2023-10-27 12:54:28 -05:00

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

Prerequisites

Python

  • Camera, either a webcam or a Wyze Cam
    • All RTSP feeds should work, however.
  • Python 3.10 or 3.11
  • Poetry (optional)

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

Cloning the repository is not required when installing from PyPi but is required when installing from source

  1. Clone this repo with git clone https://github.com/slashtechno/wyzely-detect
  2. cd into the cloned repository
  3. Then, either install with Poetry or run with Docker

Docker

  1. Modify to docker-compose.yml to achieve desired configuration
  2. Run in the background with `docker compose up -d

Installing from PyPi with pip

This assumes you have Python 3.10 or 3.11 installed

  1. pip install wyzely-detect
    a. You may need to use pip3 instead of pip
  2. wyzely-detect

Poetry

  1. poetry install
  2. 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