Merge pull request #1 from RedisGrafana/feat/update-scripts

Update Scripts and README

Author: mikhail-vl

README.md

@@ -1,2 +1,128 @@
-# redis-camera-ai
-Analyze Camera capture using RedisAI
+# Analyzing camera captures using RedisAI, OpenCV and Grafana
+
+![Camera AI](https://raw.githubusercontent.com/RedisGrafana/redis-camera-ai/main/images/camera-ai.png)
+
+[![Grafana 7](https://img.shields.io/badge/Grafana-7-orange)](https://www.grafana.com)
+[![Redis Data Source](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Data%20Source&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-datasource)](https://grafana.com/grafana/plugins/redis-datasource)
+[![Redis Application plug-in](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Application%20plug-in&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-app)](https://grafana.com/grafana/plugins/redis-app)
+[![Docker](https://github.com/RedisGrafana/redis-camera-ai/actions/workflows/docker.yml/badge.svg)](https://github.com/RedisGrafana/redis-camera-ai/actions/workflows/docker.yml)
+
+## Introduction
+
+This project demonstrates how to analyze camera frames stored as [Redis Streams](https://redis.io/topics/streams-intro) using serverless engine [RedisGears](https://oss.redislabs.com/redisgears/), [RedisAI](https://redisai.io/) and display analyzed frames with metrics in Grafana.
+
+![Redis-Camera-AI](https://raw.githubusercontent.com/RedisGrafana/redis-camera-ai/main/images/redis-camera-ai.png)
+
+## Requirements
+
+- [Docker](https://docker.com) to start Redis and Grafana.
+- [Python](https://www.python.org/) to run scripts.
+
+## Redis with OpenCV Docker image
+
+This project provides Docker image with Redis, RedisTimeSeries, RedisGears, RedisAI and installed [OpenCV for Python](https://docs.opencv.org/master/d6/d00/tutorial_py_root.html) library.
+
+Supported platforms are:
+
+- linux/amd64
+- linux/arm64
+- linux/arm
+
+```bash
+docker run -p 6379:6379 --name=redis-opencv ghcr.io/redisgrafana/redis-opencv:latest
+```
+
+## OpenCV requirements
+
+Check that OpenCV with dependencies downloaded, installed and registered in the RedisGears requirements:
+
+```
+cluster.remote:6379> rg.pydumpreqs
+1)  1) "GearReqVersion"
+    2) (integer) 1
+    3) "Name"
+    4) "Pillow"
+    5) "IsDownloaded"
+    6) "yes"
+    7) "IsInstalled"
+    8) "yes"
+    9) "CompiledOs"
+   10) "linux-buster-x64"
+   11) "Wheels"
+   12) 1) "Pillow-8.2.0-cp37-cp37m-manylinux1_x86_64.whl"
+2)  1) "GearReqVersion"
+    2) (integer) 1
+    3) "Name"
+    4) "opencv-python"
+    5) "IsDownloaded"
+    6) "yes"
+    7) "IsInstalled"
+    8) "yes"
+    9) "CompiledOs"
+   10) "linux-buster-x64"
+   11) "Wheels"
+   12) 1) "numpy-1.20.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl"
+       2) "opencv_python-4.5.2.52-cp37-cp37m-manylinux2014_x86_64.whl"
+3)  1) "GearReqVersion"
+    2) (integer) 1
+    3) "Name"
+    4) "numpy"
+    5) "IsDownloaded"
+    6) "yes"
+    7) "IsInstalled"
+    8) "yes"
+    9) "CompiledOs"
+   10) "linux-buster-x64"
+   11) "Wheels"
+   12) 1) "numpy-1.20.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl"
+```
+
+## Import AI model and script
+
+The loader script will load AI model and [PyTorch](https://pytorch.org/) script to the Redis database.
+
+```
+cd src/
+python3 ai-loader.py -u redis://redis:6379
+```
+
+## Start Grafana
+
+Grafana can be started using Docker Compose or installed locally with [Redis plug-ins for Grafana](https://redisgrafana.github.io) and [Volkov Labs Image panel](https://github.com/VolkovLabs/grafana-image-panel).
+
+```
+docker-compose pull
+docker-compose up
+```
+
+When starting using Docker Compose, dashboard and plug-ins will be auto-provisioned and available in Grafana.
+
+## Register RedisGears script
+
+Select `Camera Processing` dashboard and copy-paste `gears-yolo.py` script to RedisGears Script editor panel. Click on the `Run script` button and you should see `StreamReader` Registration.
+
+![RedisGears Script Editor](https://raw.githubusercontent.com/RedisGrafana/redis-camera-ai/main/images/gears-script-editor.png)
+
+## Start Camera
+
+Copy script `edge-camera.py` to IoT or any device with camera. Run script with specifing Redis URL, number of frames per second and rotate camera if required.
+
+```
+python3 camera.py -u redis://redis:6379 --fps 6 --rotate-90-clockwise true
+```
+
+## Learn more
+
+- Redis plug-ins for Grafana [Documentation](https://redisgrafana.github.io/)
+- [My Other Stack Is RedisEdge](https://redislabs.com/blog/my-other-stack-is-redisedge/)
+- [RedisEdge Real-time Video Analytics](https://github.com/RedisGears/EdgeRealtimeVideoAnalytics)
+
+## Contributing
+
+- Fork the repository.
+- Find an issue to work on and submit a pull request.
+- Could not find an issue? Look for documentation, bugs, typos, and missing features.
+
+## License
+
+- Apache License Version 2.0, see [LICENSE](https://github.com/RedisGrafana/redis-camera-ai/blob/main/LICENSE).