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.
Oleaintueri 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=onhere.
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/reolinkapigo@v0.0.2
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.
package main
import"github.com/ReolinkCameraAPI/reolinkapigo/pkg/reolinkapi"funcmain() {
// 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)
}
// filenames are lowercase snake case
foo_bar.go// usually a singular name or camelCasepackage fooBar
// Format the parameters underneath one anotherfuncHasManyParameters(
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 camelCasetype fooOption stringfunc(f fooOption) apply(opts *options) {
opts.foo = string(f)
}
// All variables are camelCasetype barOption boolfunc(b barOption) apply(opts *options) {
opts.bar = bool(b)
}
funcWithFoo(foo string) OptionFooBar {
return fooOption(foo)
}
funcWithBar(bar bool) OptionFooBar {
return barOption(bar)
}
type FooBar struct {
PublicVar string
*options
}
funcNewFooBar(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
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
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
A phishing attack targeted developers using a typosquatted npm domain (npnjs.com) to steal credentials via fake login pages - watch out for similar scams.