com.github.03:onvif

ONVIF-Java

---

ONVIF is an open industry forum that provides and promotes standardized interfaces for effective interoperability of IP-based physical security products. ONVIF was created to make a standard way of how IP products within CCTV and other security areas can communicate with each other.

Features

• ONVIF & UPnP discovery
• ONVIF device management (Services, device information, media profiles, raw media stream uri, snapshot uri, PTZ Commands such as absoluteMove, getStatus, getPresets..)
• UPnP device information
• Easily extendable with your own requests
• Android supported!

Discovery

---

The OnvifDiscovery class uses the Web Services Dynamic Discovery (WS-Discovery). This is a technical specification that defines a multicast discovery protocol to locate services on a local network. It operates over TCP and UDP port 3702 and uses IP multicast address 239.255.255.250. As the name suggests, the actual communication between nodes is done using web services standards, notably SOAP-over-UDP.

With WS-Discovery, the discovery tool puts SSDP queries on the network from its unicast address to 239.255.255.250 multicast address, sending them to the well-known UDP port 3702. The device receives the query, and answers to the discovery tool's unicast IP address from its unicast IP address. The reply contains information about the Web Services (WS) available on the device.

UPnP works in a very similar way, but on a different UDP port (1900). Compared to the WS-Discovery, the UPnP is intended for a general use (data sharing, communication, entertainment).

DiscoveryManager manager = new DiscoveryManager();
manager.setDiscoveryTimeout(10000);
manager.discover(new DiscoveryListener() {
    @Override
    public void onDiscoveryStarted() {
        log.info("Discovery started");
    }

    @Override
    public void onDevicesFound(List<Device> devices) {
        for (Device device : devices)
            log.info("Devices found: " + device.getHostName());
    }
});

ONVIF

---

With the OnvifManager class it is possible to send requests to an ONVIF-supported device. All requests are sent asynchronously and you can use the OnvifResponseListener for errors and custom response handling. It is possible to create your own OnvifDevice or retrieve a list from the discover method in the DiscoveryManager

OnvifManager onvifManager = new OnvifManager(new OnvifResponseListener() {
    public void onResponse(OnvifDevice onvifDevice, OnvifResponse onvifResponse) {
            log.debug("PTZ response: " + onvifResponse.getXml());
            lastFailures.remove(onvifDevice.getHostName());
    }
    
    public void onError(OnvifDevice onvifDevice, int errorCode, String errorMsg) {
        if (shouldLogFailure(onvifDevice)) {
            log.warn("PTZ response err [{}]: {} ",errorCode, errorMsg);
            lastFailures.put(onvifDevice.getHostName(), Instant.now());
        }
    }
});

OnvifDevice device = new OnvifDevice("192.168.100.142", "username", "password");

Services

Returns information about services on the device.

onvifManager.getServices(device, new OnvifServicesListener() {
    @Override
    public void onServicesReceived(@Nonnull OnvifDevice onvifDevice, OnvifServices services) {
        
    }
});

Device information

Returns basic device information from the device. This includes the manufacturer, serial number, hardwareId, ...

onvifManager.getDeviceInformation(device, new OnvifDeviceInformationListener() {
    @Override
    public void onDeviceInformationReceived(@Nonnull OnvifDevice device, 
                                            @Nonnull OnvifDeviceInformation deviceInformation) {
        
    }
});

Media Profiles

Returns pre-configured or dynamically configured profiles. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.

onvifManager.getMediaProfiles(device, new OnvifMediaProfilesListener() {
    @Override
    public void onMediaProfilesReceived(@Nonnull OnvifDevice device, 
                                        @Nonnull List<OnvifMediaProfile> mediaProfiles) {
        
    }
});

Media Stream URI

Returns a raw media stream URI that remains valid indefinitely even if the profile is changed.

onvifManager.getMediaStreamURI(device, mediaProfiles.get(0), new OnvifMediaStreamURIListener() {
    @Override
    public void onMediaStreamURIReceived(@Nonnull OnvifDevice device, 
                                        @Nonnull OnvifMediaProfile profile, @Nonnull String uri) {
        
    }
});

UPnP

---

With the UPnPManager it is possible to retrieve device information from a locally connected UPnP device. A UPnPDevice can be created manually or discovered from the DiscoveryManager using discovery.discover(DiscoveryMode.UPNP)

UPnPDevice device = new UPnPDevice("192.168.100.142");
device.setLocation("http://192.168.100.142:49152/rootdesc1.xml");
UPnPManager uPnPManager = new UPnPManager();
uPnPManager.getDeviceInformation(device, new UPnPDeviceInformationListener() {
    @Override
    public void onDeviceInformationReceived(@Nonnull UPnPDevice device, 
                                            @Nonnull UPnPDeviceInformation information) {
        log.info("Device hostname: {}, friendly name: {}", getHostName(), information.getFriendlyName());
    }
    @Override
    public void onError(@Nonnull UPnPDevice onvifDevice, int errorCode, String errorMessage) {
        log.error("Error: {}", errorMessage);
    }
});

PTZ Commands

---

absoluteMove

onvifManager.absoluteMove(device, mediaProfiles.get(0), 0.1f, 0.59f, 0.2f);

Device Status

---

getStatus

onvifManager.getStatus(device, mediaProfiles.get(0), (onvifDevice, profile, status) -> {
    log.info("onStatusReceived: pan: {}, tilt: {}, zoom: {}.", status.getPan(), status.getTilt(), status.getZoom());
});

Configurations

---

getConfigurations

onvifManager.getConfigurations(device, (onvifDevice, configurations) -> {
    log.info("onConfigurationsReceived: configurations: {}.", configurations);
});

Presets

---

getPresets / setPreset / removePreset

onvifManager.getPresets(device, mediaProfiles.get(0), (onvifDevice, profile, presets) -> {
    log.info("presets size: {}", presets.size());
});

onvifManager.setPreset(device, mediaProfiles.get(0), "presetNameABC", "2", (onvifDevice, onvifMediaProfile, presetToken) -> {
    log.info("presetToken: {}", presetToken);
});

onvifManager.removePreset(device, mediaProfiles.get(0), "2");

Custom Requests

---

It is possible to implement your custom ONVIF request by creating a new class and implementing the OnvifRequest interface and overriding the getXml() and getType() methods.

public class PTZRequest implements OnvifRequest {
    @Override
    public String getXml() {
        return "<GetServices xmlns=\"http://www.onvif.org/ver10/device/wsdl\">" +
                "<IncludeCapability>false</IncludeCapability>" +
                "</GetServices>";
    }
    @Override
    public OnvifType getType() {
        return OnvifType.CUSTOM;
    }
}

and send it to the appropriate OnvifDevice:

onvifManager.sendOnvifRequest(device, new PTZRequest());

Use the OnvifResponseListener to receive responses from your custom requests.

Android

---

In order to receive multicasts packets on your Android device, you'll have to acquire a lock on your WifiManager before making a discovery. Make sure to release the lock once the discovery is completed. More information can be found here: https://developer.android.com/reference/android/net/wifi/WifiManager.MulticastLock

private void lockMulticast() {
    WifiManager wifi = (WifiManager) getApplicationContext().getSystemService(Context.WIFI_SERVICE);
    if (wifi == null)
        return;

    WifiManager.MulticastLock lock = wifi.createMulticastLock("ONVIF");
    lock.acquire();
}

Download

Download the latest JAR or grab via Maven:

<dependency>
  <groupId>com.github.03</groupId>
  <artifactId>onvif</artifactId>
  <version>1.0.9</version>
</dependency>

or Gradle:

compile 'com.github.03:onvif:1.0.9'

Todos

• Implementation ONVIF version management

Pull Requests

---

Feel free to send pull requests.

License

Copyright 2018 TELETASK BVBA.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.