Reolink Python Api Client

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 Cameras, although they have a basic API document - it does not satisfy the need for extensive camera communication.

Check out our documentation for more information on how to use the software at https://reolink.oleaintueri.com

Other Supported Languages:

• Go: reolinkapigo

Join us on Discord

https://discord.gg/8z3fdAmZJP

Sponsorship

Oleaintueri is sponsoring the development and maintenance of these projects within their organisation.

Get started

Implement a "Camera" object by passing it an IP address, Username and Password. By instantiating the object, it will try retrieve a login token from the Reolink Camera. This token is necessary to interact with the Camera using other commands.

See the examples directory.

Using the library as a Python Module

Install the package via PyPi

pip install reolinkapi

Install from GitHub

pip install git+https://github.com/ReolinkCameraAPI/reolinkapipy.git

If you want to include the video streaming functionality you need to include the streaming "extra" dependencies

pip install 'reolinkapi[streaming]'

Contributors

Styling and Standards

This project intends to stick with PEP8

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
• pip install -r requirements.txt
• Make your changes

Step 3

Make a pull request.

API Requests Implementation Plan:

Stream:

• [X] Blocking RTSP stream
• [X] Non-Blocking RTSP stream

GET:

• [X] Login
• [X] Logout
• [X] Display -> OSD
• [X] Recording -> Encode (Clear and Fluent Stream)
• [X] Recording -> Advance (Scheduling)
• [X] Network -> General
• [X] Network -> Advanced
• [X] Network -> DDNS
• [X] Network -> NTP
• [X] Network -> E-mail
• [X] Network -> FTP
• [X] Network -> Push
• [X] Network -> WIFI
• [X] Alarm -> Motion
• [X] System -> General
• [X] System -> DST
• [X] System -> Information
• [ ] System -> Maintenance
• [X] System -> Performance
• [ ] System -> Reboot
• [X] User -> Online User
• [X] User -> Add User
• [X] User -> Manage User
• [X] Device -> HDD/SD Card
• [x] PTZ -> Presets, Calibration Status
• [ ] Zoom
• [ ] Focus
• [ ] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate)
• [ ] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR)
• [X] Image Data -> "Snap" Frame from Video Stream

SET:

• [X] Display -> OSD
• [X] Recording -> Encode (Clear and Fluent Stream)
• [ ] Recording -> Advance (Scheduling)
• [X] Network -> General
• [X] Network -> Advanced
• [ ] Network -> DDNS
• [ ] Network -> NTP
• [ ] Network -> E-mail
• [ ] Network -> FTP
• [ ] Network -> Push
• [X] Network -> WIFI
• [ ] Alarm -> Motion
• [ ] System -> General
• [ ] System -> DST
• [X] System -> Reboot
• [X] User -> Online User
• [X] User -> Add User
• [X] User -> Manage User
• [X] Device -> HDD/SD Card (Format)
• [x] PTZ (including calibrate)
• [x] Zoom
• [x] Focus
• [X] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate)
• [X] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR)

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.

• RLC-411WS
• RLC-423
• RLC-420-5MP
• RLC-410-5MP
• RLC-510A
• RLC-520
• C1-Pro
• D400
• E1 Zoom