From 17561a21da8609871664ee27a7e784b651488444 Mon Sep 17 00:00:00 2001 From: Alano Terblanche Date: Mon, 14 Dec 2020 22:18:26 +0200 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b66d58d..d0d3a6c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@

Reolink Python Api Client

+ Reolink Approval GitHub GitHub tag (latest SemVer) PyPI + Discord

--- -A Reolink Camera client written in Python. +A Reolink Camera client written in Python. This repository's purpose **(with Reolink's full support)** is to deliver a complete API for the Reolink Camera's, +although they have a basic API document - it does not satisfy the need for extensive camera communication. Other Supported Languages: - Go: [reolink-go-api](https://github.com/ReolinkCameraAPI/reolink-go-api) @@ -17,18 +20,7 @@ Other Supported Languages: https://discord.gg/8z3fdAmZJP -### Purpose -This repository's purpose is to deliver a complete API for the Reolink Camera's, ( TESTED on RLC-411WS ) - - -### But Reolink gives an API in their documentation - -Not really. They only deliver a really basic API to retrieve Image data and Video data. - -### How? - -You can get the Restful API calls by looking through the HTTP Requests made the camera web console. I use Google Chrome developer mode (ctr + shift + i) -> Network. ### Get started @@ -50,6 +42,20 @@ Install the package via Pip This project intends to stick with [PEP8](https://www.python.org/dev/peps/pep-0008/) +### How can I become a contributor? + +#### Step 1 + +Get the Restful API calls by looking through the HTTP Requests made in the camera's web UI. I use Google Chrome developer mode (ctr + shift + i) -> Network. + +#### Step 2 + +Fork the repository and make your changes. + +#### Step 3 + +Make a pull request. + ### API Requests Implementation Plan: Stream: @@ -113,7 +119,7 @@ SET: - [X] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate) - [X] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR) -### Supported Camera's +### Supported Cameras Any Reolink camera that has a web UI should work. The other's requiring special Reolink clients do not work and is not supported here.