Skip to main content

Recognize faces/objects in a video stream (from a webcam or a security camera) and send notifications to your devices

Project description

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

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

  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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wyzely_detect-0.1.0.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

wyzely_detect-0.1.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file wyzely_detect-0.1.0.tar.gz.

File metadata

  • Download URL: wyzely_detect-0.1.0.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.5 Windows/10

File hashes

Hashes for wyzely_detect-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e0f2c2b0b748f6b72c2251298fc543972a10598aba93e75616eef8ff4f190278
MD5 24d01deba27db00c856369bd341ab5bd
BLAKE2b-256 450c2b5ec9af93c7d2456be6539f72103eb2c41676d8d0670e961f8e1c0dd00c

See more details on using hashes here.

File details

Details for the file wyzely_detect-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: wyzely_detect-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.5 Windows/10

File hashes

Hashes for wyzely_detect-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c12bb10078263eb09b16b25eabcac881ed5f57b2fd6d012f4b658e8f374d6b7e
MD5 cae0d8ef53fc462c86a0e7a89ca02b40
BLAKE2b-256 69388aa9900b36f70d32688a6f3bf68e6e20612ec2f29855f9530890c712fa4a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page