onvif

README

onvif protocol

Simple management of onvif IP-devices cameras. onvif is an implementation of ONVIF protocol for managing onvif IP devices. The purpose of this library is convenient and easy management of IP cameras and other devices that support ONVIF standard.

Installation

To install the library, use go get:

go get github.com/b0shka/onvif

Supported services

The following services are implemented:

• Device
• Media
• PTZ
• Imaging
• Event
• Discovery
• Auth(More Options)
• Soap

Using

General concept

1. Connecting to the device
2. Authentication (if necessary)
3. Defining Data Types
4. Carrying out the required method

Connecting to the device

If there is a device on the network at the address 192.168.13.42, and its ONVIF services use the 1234 port, then you can connect to the device in the following way:

device := onvif.NewDevice(onvif.DeviceParams{Xaddr: "192.168.13.42:1234"})
_, err := device.Inspect()

The ONVIF port may differ depending on the device , to find out which port to use, you can go to the web interface of the device. Usually this is 80 port.

Authentication

If any function of the ONVIF services requires authentication, you must use the Authenticate method.

device := onvif.NewDevice(onvif.DeviceParams{Xaddr: "192.168.13.42:1234", Username: "username", Password: "password"})
_, err := device.Inspect()

Defining Data Types

Each ONVIF service in this library has its own package, in which all data types of this service are defined, and the package name is identical to the service name and begins with a capital letter. onvif defines the structures for each function of each ONVIF service supported by this library. Define the data type of the GetCapabilities function of the Device service. This is done as follows:

capabilities := device.GetCapabilities{Category:"All"}

Why does the GetCapabilities structure have the Category field and why is the value of this field All?

The figure below shows the documentation for the GetCapabilities. It can be seen that the function takes one Category parameter and its value should be one of the following: 'All', 'Analytics',' Device ',' Events', 'Imaging', 'Media' or 'PTZ'`.

An example of defining the data type of GetServiceCapabilities function in PTZ:

ptzCapabilities := ptz.GetServiceCapabilities{}

The figure below shows that GetServiceCapabilities does not accept any arguments.

Common data types are in the xsd/onvif package. The types of data (structures) that can be shared by all services are defined in the onvif package.

An example of how to define the data type of the CreateUsers function in Devicemgmt:

createUsers := device.CreateUsers{User: onvif.User{Username:"admin", Password:"qwerty", UserLevel:"User"}}

The figure below shows that ,in this example, the CreateUsers structure field must be a User whose data type is the User structure containing the Username, Password, UserLevel, and optional Extension fields. The User structure is in the onvif package.

Carrying out the required method

To perform any function of one of the ONVIF services whose structure has been defined, you must use the CreateRequest of the device object.

ctx := context.Background()
device := onvif.NewDevice(onvif.DeviceParams{Xaddr: "192.168.13.42:1234", Username: "username", Password: "password"})
if _, err := device.InspectWithCtx(ctx); err != nil {
	panic(err)
}

profilesResponse := media.GetProfilesResponse{}
if err := device.CreateRequest(media.GetProfiles{}).WithContext(ctx).Do().Unmarshal(&profilesResponse); err != nil {
    panic(err)
}

Great Thanks

Enhanced and Improved from: goonvif

Documentation

Overview

Package onvif is developed to provide an ONVIF client implementation on Go programming language

Index

• type Device
  • func GetAvailableDevicesAtSpecificEthernetInterface(interfaceName string) []Device
  • func NewDevice(params DeviceParams) *Device
  • func (dev *Device) CreateRequest(method interface{}) *networking.Request
  • func (dev *Device) DeltaTime() time.Duration
  • func (dev *Device) GetDeviceInfo() DeviceInfo
  • func (dev Device) GetEndpoint(endpoint string) (string, error)
  • func (dev *Device) GetServices() map[string]string
  • func (dev *Device) Inspect(headers map[string]string) (*device.GetCapabilitiesResponse, error)
  • func (dev *Device) InspectWithCtx(ctx context.Context, headers map[string]string) (*device.GetCapabilitiesResponse, error)
  • func (dev *Device) ReplaceHostToXAddr(u string) (string, error)
  • func (dev *Device) UpdateDeltaTime(headers map[string]string) (time.Duration, error)
  • func (dev *Device) UpdateDeltaTimeCtx(ctx context.Context, headers map[string]string) (time.Duration, error)
• type DeviceInfo
• type DeviceParams
• type DeviceType
  • func (devType DeviceType) String() string

Types

type Device

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

Device for a new device of onvif and DeviceInfo struct represents an abstract ONVIF device. It contains methods, which helps to communicate with ONVIF device

func GetAvailableDevicesAtSpecificEthernetInterface

func GetAvailableDevicesAtSpecificEthernetInterface(interfaceName string) []Device

GetAvailableDevicesAtSpecificEthernetInterface ...

func NewDevice

func NewDevice(params DeviceParams) *Device

NewDevice function construct a ONVIF Device entity

func (*Device) CreateRequest

func (dev *Device) CreateRequest(method interface{}) *networking.Request

func (*Device) DeltaTime

func (dev *Device) DeltaTime() time.Duration

DeltaTime return delta time between local time and device time (time.Now() - deviceTime).

func (*Device) GetDeviceInfo

func (dev *Device) GetDeviceInfo() DeviceInfo

GetServices return available endpoints

func (Device) GetEndpoint

func (dev Device) GetEndpoint(endpoint string) (string, error)

getEndpoint functions get the target service endpoint in a better way

func (*Device) GetServices

func (dev *Device) GetServices() map[string]string

GetServices return available endpoints

func (*Device) Inspect

func (dev *Device) Inspect(headers map[string]string) (*device.GetCapabilitiesResponse, error)

func (*Device) InspectWithCtx

func (dev *Device) InspectWithCtx(ctx context.Context, headers map[string]string) (*device.GetCapabilitiesResponse, error)

func (*Device) ReplaceHostToXAddr

func (dev *Device) ReplaceHostToXAddr(u string) (string, error)

ReplaceHostToXAddr replacing host:port on string to dev.params.Xaddr. NAT needed.

func (*Device) UpdateDeltaTime

func (dev *Device) UpdateDeltaTime(headers map[string]string) (time.Duration, error)

func (*Device) UpdateDeltaTimeCtx

func (dev *Device) UpdateDeltaTimeCtx(ctx context.Context, headers map[string]string) (time.Duration, error)

type DeviceInfo

type DeviceInfo struct {
	Manufacturer    string
	Model           string
	FirmwareVersion string
	SerialNumber    string
	HardwareId      string
}

DeviceInfo struct contains general information about ONVIF device

type DeviceParams

type DeviceParams struct {
	Xaddr      string
	Username   string
	Password   string
	HttpClient *http.Client
}

type DeviceType

type DeviceType int

DeviceType alias for int

const (
	NVD DeviceType = iota
	NVS
	NVA
	NVT
)

Onvif Device Type

func (DeviceType) String

func (devType DeviceType) String() string