Skip to main content

Camera surveillance system with motion detection and object recognition for home security.

Project description

ViGi: A camera surveillance system

Features

  • Multiple camera support
  • Motion detection
  • Object recognition
  • Web server to view the camera feed and recordings
  • Notifications via SMS and email

Requirements

  • Python 3.8 or higher. Tested with Python 3.12
  • OpenCV
  • A USB camera that can be accessed via OpenCV

Installation and usage

pip install vigi
vigi

Configuration

The agent can be configured in two ways:

  • Using the vigi.ini file. This method is recommended for production use and when configuration is constant and does not change frequently.
  • Using command line arguments. This method is recommended for development and testing purposes:
usage: main.py [-h] [--debug] [--no-monitor] [--data-dir DATA_DIR] [--camera-id CAMERA_ID] [--host HOST] [--port PORT] [--max-errors MAX_ERRORS]
               [--sensitivity SENSITIVITY]

options:
  -h, --help            show this help message and exit
  --debug               Enable debug mode
  --no-monitor          Disable the camera monitor
  --data-dir DATA_DIR   Directory to store the recordings
  --camera-id CAMERA_ID
                        Camera ID to monitor
  --host HOST           Host to run the web server
  --port PORT           Port to run the web server
  --max-errors MAX_ERRORS
                        Maximum number of consecutive errors when reading a frame from the camera
  --sensitivity SENSITIVITY
                        Sensitivity of the motion detector, should be a float between 0 and 1

You can configure additional cameras by adding a [CAMERAn] section to the vigi.ini file, where n is the camera ID. The only required parameter is the CameraID:

[CAMERA0]
CameraID = 0

[CAMERA1]
CameraID = 1

MaxErrors=50
Sensitivity=0.5

You can specify MaxErrors and Sensitivity for each camera separately. If these parameters are not specified, the default values will be used.

Installation on Raspberry Pi (Raspberry Pi OS)

curl https://pyenv.run | bash # install pyenv

# initialize pyenv:
export PYENV_ROOT="$HOME/.pyenv"
[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"

pyenv install 3.12.2 # install Python 3.12
pyenv virtualenv 3.12.2 vigi # create a virtual environment
pyenv activate vigi # activate the virtual environment

# install the required packages
pip install -r requirements.txt

# Download a YOLOv8 nano model:
wget https://github.com/ultralytics/assets/releases/download/v8.1.0/yolov8n.pt

# run the agent
python main.py

Development

Run from the sources

# Set up a virtual environment
python -m venv .venv
. .venv/bin/activate

# Install the required packages
pip install -r requirements.txt

# Download a YOLOv8 nano model:
wget https://github.com/ultralytics/assets/releases/download/v8.1.0/yolov8n.pt

# run the agent
python main.py

Build a pip package

pip install build
python -m build

Publish the package to PyPI

python -m pip install --upgrade twine
python -m twine upload dist/*

Run unit tests

Download a samples dataset for the motion detection tests from here and extract it to the agent/tests directory.

Then run the tests:

python -m unittest discover

Test coverage

To generate a coverage report, run the following command:

pip install coverage
coverage run -m unittest discover
coverage html

Notification services

The agent can send notifications using the following channels:

  • SMS using Twilio API
  • Email using SMTP

Twilio

To enable SMS notifications, you need to set up a Twilio account and get the following credentials:

  • twilio account SID
  • twilio auth token

Set this configuration in the vigi.ini file.

Email

To enable email notifications, you need to set up an SMTP server and get the following credentials:

  • SMTP server address
  • SMTP server port
  • SMTP username
  • SMTP password

You can use a Gmail SMTP server for this purpose. Set this configuration in the vigi.ini file.

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

vigi-0.9.1.tar.gz (149.7 kB view hashes)

Uploaded Source

Built Distribution

vigi-0.9.1-py3-none-any.whl (149.3 kB view hashes)

Uploaded Python 3

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