Skip to main content

A webcam security monitoring system with Telegram notifications

Project description

Webcam Security

A Python package for webcam security monitoring with Telegram notifications. This package provides motion detection capabilities with configurable monitoring hours and automatic video recording.

Features

  • 🎥 Real-time motion detection using webcam
  • 📱 Telegram notifications with snapshots and device identification
  • ⏰ Configurable monitoring hours (default: 10 PM - 6 AM)
  • 🔧 Telegram bot commands for remote configuration
  • 🚨 Force monitoring on/off via Telegram
  • 🎬 Automatic video recording on motion detection
  • 🎵 Audio recording with video (combined MP4 format)
  • 🧹 Automatic cleanup of old recordings
  • 🖥️ Live preview with monitoring status
  • 🚀 Easy-to-use CLI interface
  • 🔄 Self-update mechanism
  • ⚡ UV-powered for faster builds and dependency management

Telegram Bot Commands

Once the monitoring is running, you can control it remotely via Telegram commands:

Status & Control

  • /start - Welcome message and command list
  • /status - Show current configuration and monitoring status
  • /help - Show detailed help and command reference
  • /force_on - Force monitoring ON (ignores time schedule)
  • /force_off - Force monitoring OFF (returns to normal schedule)

Configuration

  • /set_hours <start> <end> - Set monitoring hours (24h format)
    • Example: /set_hours 22 6 (10 PM to 6 AM)
    • Example: /set_hours 0 24 (24/7 monitoring)

System

  • /update - Check for software updates

Usage

Quick Start

  1. Initialize configuration:

    webcam-security init --bot-token "YOUR_BOT_TOKEN" --chat-id "YOUR_CHAT_ID" --device-id "MyCamera"
    
  2. Start monitoring:

    webcam-security start
    
  3. Control remotely via Telegram:

    • Send /start to your bot for command list
    • Use /force_on to enable monitoring immediately
    • Use /set_hours 22 6 to set monitoring hours

Device Identification

All media sent to Telegram includes a device identifier:

  • If you specify --device-id during init, that name will be used
  • Otherwise, the system hostname will be used automatically
  • This helps identify which camera sent the alert when you have multiple systems

Available Commands

  • webcam-security init - Initialize configuration
  • webcam-security start - Start monitoring
  • webcam-security status - Show current configuration
  • webcam-security clean - Manually clean old recordings
  • webcam-security update - Check for and install updates

Installation

Using pip (traditional)

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

webcam_security-0.3.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

webcam_security-0.3.1-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file webcam_security-0.3.1.tar.gz.

File metadata

  • Download URL: webcam_security-0.3.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for webcam_security-0.3.1.tar.gz
Algorithm Hash digest
SHA256 609df5b11df81ddbaa3d4a44ef5ade2c29adb4357b1a26085d726300928cfe89
MD5 23518fc31373de2f3e8d2660e47b6679
BLAKE2b-256 7d25962708849f2edd9c92de44ef18dbc214aa071c702340b7d38049b92d5068

See more details on using hashes here.

File details

Details for the file webcam_security-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for webcam_security-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a577b726245e5b026ab96d405dc2f94622040f9a986feb1b90b55c63f56d6d30
MD5 678ce7c6668ea802a34e3cd7779ff23c
BLAKE2b-256 c04765167fab4bd7610c6792e42e1b94c573f6c1368b6171ae3d845a1ef4f4a2

See more details on using hashes here.

Supported by

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