Skip to content

Commit 17561a2

Browse files
authored
Update README.md
1 parent bd6d39f commit 17561a2

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
<h1 align="center"> Reolink Python Api Client </h1>
22

33
<p align="center">
4+
<img alt="Reolink Approval" src="https://img.shields.io/badge/reolink-approved-blue?style=flat-square">
45
<img alt="GitHub" src="https://img.shields.io/github/license/ReolinkCameraApi/reolink-python-api?style=flat-square">
56
<img alt="GitHub tag (latest SemVer)" src="https://img.shields.io/github/v/tag/ReolinkCameraApi/reolink-python-api?style=flat-square">
67
<img alt="PyPI" src="https://img.shields.io/pypi/v/reolink-api?style=flat-square">
8+
<img alt="Discord" src="https://img.shields.io/discord/773257004911034389?style=flat-square">
79
</p>
810

911
---
1012

11-
A Reolink Camera client written in Python.
13+
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,
14+
although they have a basic API document - it does not satisfy the need for extensive camera communication.
1215

1316
Other Supported Languages:
1417
- Go: [reolink-go-api](https://github.com/ReolinkCameraAPI/reolink-go-api)
@@ -17,18 +20,7 @@ Other Supported Languages:
1720

1821
https://discord.gg/8z3fdAmZJP
1922

20-
### Purpose
2123

22-
This repository's purpose is to deliver a complete API for the Reolink Camera's, ( TESTED on RLC-411WS )
23-
24-
25-
### But Reolink gives an API in their documentation
26-
27-
Not really. They only deliver a really basic API to retrieve Image data and Video data.
28-
29-
### How?
30-
31-
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.
3224

3325
### Get started
3426

@@ -50,6 +42,20 @@ Install the package via Pip
5042

5143
This project intends to stick with [PEP8](https://www.python.org/dev/peps/pep-0008/)
5244

45+
### How can I become a contributor?
46+
47+
#### Step 1
48+
49+
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.
50+
51+
#### Step 2
52+
53+
Fork the repository and make your changes.
54+
55+
#### Step 3
56+
57+
Make a pull request.
58+
5359
### API Requests Implementation Plan:
5460

5561
Stream:
@@ -113,7 +119,7 @@ SET:
113119
- [X] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate)
114120
- [X] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR)
115121

116-
### Supported Camera's
122+
### Supported Cameras
117123

118124
Any Reolink camera that has a web UI should work. The other's requiring special Reolink clients
119125
do not work and is not supported here.

0 commit comments

Comments
 (0)