Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ReolinkCameraAPI/reolinkapigo
Reolink camera api in Go
https://github.com/ReolinkCameraAPI/reolinkapigo
reolink reolink-api reolink-camera reolink-client reolink-go-api rtsp webrtc
Last synced: 2 days ago
JSON representation
Reolink camera api in Go
- Host: GitHub
- URL: https://github.com/ReolinkCameraAPI/reolinkapigo
- Owner: ReolinkCameraAPI
- License: gpl-3.0
- Created: 2020-12-05T12:41:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-12T22:27:18.000Z (almost 3 years ago)
- Last Synced: 2024-10-27T21:42:13.726Z (13 days ago)
- Topics: reolink, reolink-api, reolink-camera, reolink-client, reolink-go-api, rtsp, webrtc
- Language: Go
- Homepage:
- Size: 840 KB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pion - ReolinkCameraAPI/reolinkapigo - Reolink camera api in Go (Media API)
README
Reolink Go Api Client
---
A Reolink Camera client written in Go. 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](https://reolink.oleaintueri.com)
Other Supported Languages:
- Python: [reolink-python-api](https://github.com/ReolinkCameraAPI/reolink-python-api)
The reolink-go-api project is the go alternative to the reolink-python-api project. It provides the same functionality,
but just in pure Go.
### WARNING...This is an untested repository and is in heavy development
### Join us on Discord
https://discord.gg/8z3fdAmZJP
### Sponsorship
[Oleaintueri](https://oleaintueri.com) is sponsoring the development and maintenance of these projects within their organisation.
---
## Installation
If `go get` is not working for you, please check out this amazing post about
`GO111MODULE=on` [here](https://dev.to/maelvls/why-is-go111module-everywhere-and-everything-about-go-modules-24k).
### Using go get
GO111MODULE=on go get github.com/ReolinkCameraAPI/reolinkapigo@latest
A Specific version using `@v0.x.x`
GO111MODULE=on go get -u github.com/ReolinkCameraAPI/[email protected]
### From source
cd $GOPATH
mkdir -p src/github.com/ReolinkCameraAPI
cd src/github.com/ReolinkCameraAPI
git clone https://github.com/ReolinkCameraAPI/reolinkapigo.git
## Usage
Check the `examples/` directory for example code and implementations.
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.
```go
package main
import "github.com/ReolinkCameraAPI/reolinkapigo/pkg/reolinkapi"
func main() {
// This can throw an error due to the API trying to authorise with the camera
// to retrieve the necessary token for future requests.
camera, err := reolinkapi.NewCamera("192.168.1.100",
reolinkapi.WithUsername("foo"),
reolinkapi.WithPassword("bar"))
if err != nil {
panic(err)
}
// One can also defer the login process on object creation
// Omitting the username and password will default to the cameras defaults
// username: "admin"
// password: ""
camera, err = reolinkapi.NewCamera("192.168.1.100",
reolinkapi.WithDeferLogin(true))
err = camera.Login()
// now call any of the supported api's by passing it it's resthandler
ok, err := camera.FormatHdd(0)(camera.RestHandler)
}
```
Dependencies needed to make this work:
- [Deepch's VDK](github.com/deepch/vdk)
- [Pions's WebRTC](github.com/pion/webrtc/v2)
Dependencies needed for testing:
- [Gin](github.com/gin-gonic/gin)
- [HttpMock](github.com/jarcoal/httpmock)
## Contributors
---
### Styling and Standards
Golang project structure based off of https://github.com/golang-standards/project-layout
```go
// filenames are lowercase snake case
foo_bar.go
// usually a singular name or camelCase
package fooBar
// Format the parameters underneath one another
func HasManyParameters(
param1 string,
param2 int,
param3 bool)
// When there are too many parameters
// use uber functional options
// https://github.com/uber-go/guide/blob/master/style.md#functional-options
// ---
type options struct {
foo string
bar bool
}
type OptionFooBar interface {
apply(*options)
}
// All variables are camelCase
type fooOption string
func (f fooOption) apply(opts *options) {
opts.foo = string(f)
}
// All variables are camelCase
type barOption bool
func (b barOption) apply(opts *options) {
opts.bar = bool(b)
}
func WithFoo(foo string) OptionFooBar {
return fooOption(foo)
}
func WithBar(bar bool) OptionFooBar {
return barOption(bar)
}
type FooBar struct {
PublicVar string
*options
}
func NewFooBar(withPublic string, opts ...OptionFooBar) *FooBar {
// initialise the options
options := &options{
foo: "something",
bar: false,
}
for _, o := range opts {
o.apply(options)
}
return &FooBar{
PublicVar: withPublic,
options: options,
}
}
```
### 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.
### Test without a camera
All the tests implement a MockApi. The only test that could be a bit tricky is the RTSP client test.
To test this locally on your machine you could use the [rtsp-simple-server](https://github.com/aler9/rtsp-simple-server)
Setting it up is quite easy, however streaming the video feed needs some extra thought, especially if you are new to
ffmpeg.
Steps:
- Get rtsp-simple-server (download binary etc.) and Start server.
- Find a video file and push content to server
- Run the rtsp test
In your terminal:
//receives the stream and passes it along to clients
./rtsp-simple-server
// this will start and encode the stream on the fly
ffmpeg -re -stream_loop -1 \
-i vidfile.mkv \
-c:a aac -b:a 64k -c:v libx264 -preset ultrafast -b:v 500k -f hls -hls_time 1 -hls_list_size 3 -hls_flags delete_segments -hls_allow_cache 0 \
-f rtsp rtsp://localhost:8554/mystream
### API Requests Implementation Plan:
Stream:
- [X] RTSP
- [X] WebRTC
GET:
- [X] Login
- [ ] Logout
- [ ] Display -> OSD
- [ ] Recording -> Encode (Clear and Fluent Stream)
- [ ] Recording -> Advance (Scheduling)
- [ ] Network -> General
- [ ] Network -> Advanced
- [ ] Network -> DDNS
- [ ] Network -> NTP
- [ ] Network -> E-mail
- [ ] Network -> FTP
- [ ] Network -> Push
- [ ] Network -> WIFI
- [ ] Alarm -> Motion
- [ ] System -> General
- [ ] System -> DST
- [ ] System -> Information
- [ ] System -> Maintenance
- [ ] System -> Performance
- [ ] System -> Reboot
- [ ] User -> Online User
- [ ] User -> Add User
- [ ] User -> Manage User
- [ ] Device -> HDD/SD Card
- [ ] Zoom
- [ ] Focus
- [ ] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate)
- [ ] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR)
- [ ] Image Data -> "Snap" Frame from Video Stream
SET:
- [ ] Display -> OSD
- [ ] Recording -> Encode (Clear and Fluent Stream)
- [ ] Recording -> Advance (Scheduling)
- [ ] Network -> General
- [ ] Network -> Advanced
- [ ] Network -> DDNS
- [ ] Network -> NTP
- [ ] Network -> E-mail
- [ ] Network -> FTP
- [ ] Network -> Push
- [ ] Network -> WIFI
- [ ] Alarm -> Motion
- [ ] System -> General
- [ ] System -> DST
- [ ] System -> Reboot
- [ ] User -> Online User
- [ ] User -> Add User
- [ ] User -> Manage User
- [ ] Device -> HDD/SD Card (Format)
- [ ] PTZ
- [ ] Zoom
- [ ] Focus
- [ ] Image (Brightness, Contrast, Saturation, Hue, Sharp, Mirror, Rotate)
- [ ] Advanced Image (Anti-flicker, Exposure, White Balance, DayNight, Backlight, LED light, 3D-NR)
### Supported Camera's
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-520
### Integrated source code from:
- [RTSPtoWebRTC by Deepch](https://github.com/deepch/RTSPtoWebRTC)