shinobiclient

README

shinobi-alerter

a way to alert to shinobi ip camera software

Config example

config.json

{
	"server": "https://shinobi.video",
	"apikey": "oEhEEeUWaTLA92xiY9oXq9BGK5QdvE",
	"cameras": [
		{
			"name": "Frontdoor-01",
			"ip": "10.1.1.2",
			"group": "bPBPi7PLzg",
			"region": "front"
		},{
			"name": "Driveway-01",
			"ip": "10.1.1.3",
			"group": "bPBPi7PLzg",
			"region": "g1iU3"
		}
	]
}

Documentation

Index

• type Shinobi
  • func (sa *Shinobi) GetMonitors(cameraGroup string) (string, error)
  • func (sa *Shinobi) GetStartedMonitors(cameraGroup string) (string, error)
  • func (sa *Shinobi) GetVideos(cameraGroup string) (string, error)
  • func (sa *Shinobi) GetVideosById(cameraGroup string, cameraID string, query string) (string, error)
  • func (sa *Shinobi) RunRequest(httpMethod string, URL string, apiPath string, queryParam string) (string, error)
  • func (sa *Shinobi) TriggerMotion(host string) (string, error)
• type ShinobiCamera
• type ShinobiClient
  • func New(config string) ShinobiClient
• type ShinobiConfig

Types

type Shinobi

type Shinobi struct {
	// contains filtered or unexported fields
}

func (*Shinobi) GetMonitors

func (sa *Shinobi) GetMonitors(cameraGroup string) (string, error)

func (*Shinobi) GetStartedMonitors

func (sa *Shinobi) GetStartedMonitors(cameraGroup string) (string, error)

func (*Shinobi) GetVideos

func (sa *Shinobi) GetVideos(cameraGroup string) (string, error)

func (*Shinobi) GetVideosById

func (sa *Shinobi) GetVideosById(cameraGroup string, cameraID string, query string) (string, error)

func (*Shinobi) RunRequest

func (sa *Shinobi) RunRequest(httpMethod string, URL string, apiPath string, queryParam string) (string, error)

func (*Shinobi) TriggerMotion

func (sa *Shinobi) TriggerMotion(host string) (string, error)

type ShinobiCamera

type ShinobiCamera struct {
	Name   string `json:"name"`
	IP     string `json:"ip"`
	Group  string `json:"group"`
	Region string `json:"region"`
}

type ShinobiClient

type ShinobiClient interface {
	TriggerMotion(string) (string, error)
	GetMonitors(string) (string, error)
	GetVideos(string) (string, error)
	GetVideosById(string, string, string) (string, error)
	GetStartedMonitors(string) (string, error)
	RunRequest(string, string, string, string) (string, error)
}

func New

func New(config string) ShinobiClient

type ShinobiConfig

type ShinobiConfig struct {
	Server  string          `json:"server"`
	Apikey  string          `json:"apikey"`
	Cameras []ShinobiCamera `json:"cameras"`
}