Skip to main content

In brightest day in blackest night no evil shall escape your sight!

Project description

pypi-version license

Metis is an application to make your home a safer place to live by watching and recording any movements. It also (optionally) supports notifications via Telegram.

Quickstart

  1. Install Metis:

    $ pip install metispi
    
  2. Run Metis:

    $ [sudo] python -m metis --conf=path/to/config.yaml
    

    Note

    Based on Linux you use, you may or may not need root privileges to run Metis.

Configuration

It’s mandatory to pass a config file because some of the options are required. Here’s an example:

pins:
  motion_sensor:   4  # pin number HC-SR501 attached to
  led_motion_on:  17  # pin number LED "motion detected" attached to
  led_motion_off: 20  # pin number LED "no motions" attached to
telegram:
  token: XXXXXXXXX:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
  recipient: 000000001

One more thing, a whole telegram node is optional and may be omitted if you are not interested in notifications via Telegram. If you do, you need to create a Telegram bot and pass its token as telegram.token option.

Project details


Download files

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

Files for metispi, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size metispi-0.2.0.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page