Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/natm/cctv-gif-buffer

HTTP endpoint to create animated GIFs from CCTV IP cameras on demand
https://github.com/natm/cctv-gif-buffer

cctv home-automation ipcamera mqtt rtsp

Last synced: 9 days ago
JSON representation

HTTP endpoint to create animated GIFs from CCTV IP cameras on demand

Host: GitHub
URL: https://github.com/natm/cctv-gif-buffer
Owner: natm
License: mit
Created: 2017-01-24T12:52:41.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2021-03-25T21:57:11.000Z (over 3 years ago)
Last Synced: 2023-03-29T05:58:09.821Z (over 1 year ago)
Topics: cctv, home-automation, ipcamera, mqtt, rtsp
Language: Python
Homepage:
Size: 11.3 MB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CCTV GIF Buffer

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/natm/cctv-gif-buffer/master/LICENSE)
[![Build Status](https://travis-ci.org/natm/cctv-gif-buffer.svg?branch=master)](https://travis-ci.org/natm/cctv-gif-buffer)
[![Coverage Status](https://coveralls.io/repos/github/natm/cctv-gif-buffer/badge.svg?branch=master)](https://coveralls.io/github/natm/cctv-gif-buffer?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/natm/cctv-gif-buffer/badges/quality-score.png)](https://scrutinizer-ci.com/g/natm/cctv-gif-buffer/)
[![Docker build](https://img.shields.io/docker/automated/natmorris/cctv-gif-buffer.svg)](https://hub.docker.com/r/natmorris/cctv-gif-buffer/)

Polls IP CCTV cameras every couple of seconds (configurable), stores the last 1 minute in an in-memory ring buffer per camera. Provides a simple HTTP endpoint to retrieve a GIF. This service is designed to be easily integrated with home automation systems.

Example uses:

* Send you a private message containing the last 20 seconds of motion when the door opens
* Post a GIF to a private slack channel when the door bell is rang

`GET /gif?camera=frontdoor&duration=60&interval=0.25`

![Screenshot](https://raw.github.com/natm/cctv-gif-buffer/master/docs/demo1.gif)

## Configuration

Cameras are listed in YAML configuration file. The poll interval is specified per camera, optionally HTTP basic authentication can be used.

```yaml
cameras:
frontdoor:
url: http://192.168.0.9/ISAPI/Streaming/channels/101/picture
interval: 2
backdoor:
url: http://192.168.0.10/jpg/1/image.jpg
interval: 2
auth: basic
username: admin
password: letmein
server:
web:
port: 8080
listen: 0.0.0.0
```

Per camera fields:

* `url`: URL to retrieve a JPEG from the camera from. (required)
* `interval`: Time in seconds between polls (required)
* `auth`: HTTP authentication type, only `basic` is supported (optional)
* `username`: HTTP basic authentication username
* `password`: HTTP basic authentication password

## Usage

`./buffer.py -c home.yaml`

## Deployment

### Quick and easy - Docker!

```
docker pull natmorris/cctv-gif-buffer:latest
docker run -d --name cctvgifbuffer --rm -v /etc/cctvgifbuffer:/config -p 8080:8080 -t natmorris/cctv-gif-buffer
```

### Dependencies

libjpeg, install on Mac `brew install libjpeg`

### Installation

```
[email protected]:natm/cctv-gif-buffer.git
cd cctv-gif-buffer
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```

## License and Copyright

Licensed under the MIT License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.