README
¶
[!CAUTION] This library is intended solely for my personal use, so I may not fix bugs, actively support the project, and do ongoing maintenance.
ONVIF
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/av1ppp/onvif
Supported services
The following services are implemented:
- Device
- Media
- PTZ
- Imaging
- Event
- Discovery
- Authentication
- SOAP
- Error handling
Using
General concept
- Connecting to the device
- Authentication (if necessary)
- Carrying out the required method
Connecting to the device
If there is a device on the network at the address 192.168.12.34, and its ONVIF services use the 5678 port, then you can connect to the device in the following way:
dev, err := onvif.NewDevice(onvif.DeviceParams{
Xaddr: "192.168.12.34:5678",
})
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 ONVIF requires authentication, you can pass the username and password in the DeviceParams
when creating a new device instance:
device := onvif.NewDevice(onvif.DeviceParams{
Xaddr: "192.168.12.34:5678",
Username: username,
Password: password,
})
Example
You can find a simple example of using in the examples/device-service/main.go.
ONVIF Specifications
Almost all documentation you can find here.
Service specifications
Core specifications
Documentation
¶
Overview ¶
Package onvif is developed to provide an ONVIF client implementation on Go programming language.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Xlmns = map[string]string{
"onvif": "http://www.onvif.org/ver10/schema",
"tds": "http://www.onvif.org/ver10/device/wsdl",
"trt": "http://www.onvif.org/ver10/media/wsdl",
"tev": "http://www.onvif.org/ver10/events/wsdl",
"tptz": "http://www.onvif.org/ver20/ptz/wsdl",
"timg": "http://www.onvif.org/ver20/imaging/wsdl",
"tan": "http://www.onvif.org/ver20/analytics/wsdl",
"xmime": "http://www.w3.org/2005/05/xmlmime",
"wsnt": "http://docs.oasis-open.org/wsn/b-2",
"xop": "http://www.w3.org/2004/08/xop/include",
"wsa": "http://www.w3.org/2005/08/addressing",
"wstop": "http://docs.oasis-open.org/wsn/t-1",
"wsntw": "http://docs.oasis-open.org/wsn/bw-2",
"wsrf-rw": "http://docs.oasis-open.org/wsrf/rw-2",
"wsaw": "http://www.w3.org/2006/05/addressing/wsdl",
}
Xlmns XML Scheam
Functions ¶
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 ¶
GetAvailableDevicesAtSpecificEthernetInterface ...
func NewDevice ¶
func NewDevice(params DeviceParams) (*Device, error)
NewDevice function construct a ONVIF Device entity
func (*Device) GetDeviceInfo ¶
func (dev *Device) GetDeviceInfo() DeviceInfo
GetDeviceInfo return available endpoints
func (*Device) GetDeviceParams ¶
func (dev *Device) GetDeviceParams() DeviceParams
GetDeviceParams return available endpoints
func (*Device) GetEndpoint ¶
GetEndpoint returns specific ONVIF service endpoint address
func (*Device) GetServices ¶
GetServices return available endpoints
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 DeviceType ¶
type DeviceType int
DeviceType alias for int
const ( NVD DeviceType = iota NVS NVA NVT )
Onvif Device Tyoe
func (DeviceType) String ¶
func (devType DeviceType) String() string
Source Files
Directories