Provisioning 16.12 ONVIF™ www.onvif.org December 2016 2008-2020 ONVIF™ All rights reserved. Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document. THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT.  THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION. 16.12 Dec-2016 Steve Wolf Ottavio Campana First release Scope This document defines the web service interface for ONVIF Provisioning features. A provisioning feature involves limited-lifetime components such as a stepper motor, where the vendor expects the feature to be used only during device installation Web service usage is outside of the scope of this document. Please refer to the ONVIF core specification. ONVIF Core Specification <> ONVIF Device I/O Specification <> Provisioning Doing something in advance to prepare for something else. Video Source Entity defined by [ONVIF Device I/O Specification] Video Source Token Token referencing a Device I/O Video Source The provisioning service allows device adjustments that are not intended for general day-to-day use. Its methods allow the following device adjustments: Pan (left/right) Tilt (up/down) Zoom (wide/telephoto) Roll (clockwise/counterclockwise, auto-level) Focus (near/far, auto-focus) There is a Stop method to stop movement on all provisioning methods. There is a GetUsage method to determine how much a particular movement has been used. Finally, there is a GetServiceCapabilities method used after device discovery to determine which provisioning methods are available on the device. The WSDL for this service is specified in <http://www.onvif.org/ver10/provisioning/wsdl/provisioning.wsdl>. Prefix Namespace URI env http://www.w3.org/2003/05/soap-envelope ter http://www.onvif.org/ver10/error xs http://www.w3.org/2001/XMLSchema tt http://www.onvif.org/ver10/schema tpv http://www.onvif.org/ver10/provisioning/wsdl All sections in this specification are normative unless explicitly marked as informative.

These operations continuously move the device until the requested timeout expires, the client sends a Stop command, the client sends another provisioning Move command, or the device reaches a physical limit and cannot move in the specified direction anymore. If the request doesn’t contain a timeout duration, then the device shall stop when the default timeout expires. A device shall accept any given value of timeout. If necessary the device may adapt this parameter value without returning an error. For simplicity in managing timeouts on the device, a timeout expiration on any axis may result in stopping movement on all axes, emulating a Stop operation.

This operation continuously moves the camera left or right. A device indicating MaximumPanMoves capability greater than zero shall support the provisional pan through the PanMove command. request VideoSource [tt:ReferenceToken] This message contains a request for the device to move left or right. Direction [tpv:PanDirection] Timeout optional [xs:Duration] response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. env:Sender - ter:ActionNotSupported - ter:NoProvisioning Provisioning is not supported for this operation on the given video source. access class WRITE_SYSTEM

This operation continuously moves the camera up or down. A device indicating MaximumTiltMoves capability greater than zero shall support the provisional tilt through the TiltMove command. request VideoSource [tt:ReferenceToken] This message contains a request for the device to move up or down. Direction [tpv:TiltDirection] Timeout optional [xs:Duration] response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. env:Sender - ter:ActionNotSupported - ter:NoProvisioning Provisioning is not supported for this operation on the given video source. access class WRITE_SYSTEM

This operation continuously moves the lens focal point in or out. A device indicating MaximumZoomMoves capability greater than zero shall support the provisional zoom through the ZoomMove command. request VideoSource [tt:ReferenceToken] This message contains a request for the device lens to move towards wide angle or telephoto. Direction [tpv:ZoomDirection] Timeout optional [xs:Duration] response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. env:Sender - ter:ActionNotSupported - ter:NoProvisioning Provisioning is not supported for this operation on the given video source. access class WRITE_SYSTEM

This operation continuously moves the camera clockwise or counterclockwise. A device indicating MaximumRollMoves capability greater than zero shall support the provisional roll through the RollMove command. If a device supports the AutoLevel capability, the direction may be Auto. request VideoSource [tt:ReferenceToken] This message contains a request for the device to roll clockwise or counterclockwise, or to auto-level. Direction [tpv:RollDirection] Timeout optional [xs:Duration] response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. env:Sender - ter:ActionNotSupported - ter:NoProvisioning Provisioning is not supported for this operation on the given video source. env:Sender - ter:ActionNotSupported - ter:NoAutoMode Cannot set position automatically. access class WRITE_SYSTEM

This operation continuously moves the camera lens in or out. A device indicating MaximumFocusMoves capability greater than zero shall support the provisional focus through the FocusMove command. If a device supports the AutoFocus capability, the direction may be Auto. request VideoSource [tt:ReferenceToken] This message contains a request for the device lens to focus near or far, or to auto-focus. Direction [tpv:FocusDirection] Timeout optional [xs:Duration] response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. env:Sender - ter:ActionNotSupported - ter:NoProvisioning Provisioning is not supported for this operation on the given video source. env:Sender - ter:ActionNotSupported - ter:NoAutoMode Cannot set position automatically. access class WRITE_SYSTEM

This operation immediately stops movement on all axes. request VideoSource [tt:ReferenceToken] This message contains a request to stop all movement. response This is an empty message. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. access class WRITE_SYSTEM

This operation returns information about how many provisioning operations have been performed on each axis. These values can be compared to the lifetime limits from GetServiceCapabilities to determine how close to (or past) vendor defined life limits the device is. The values shall survive a SetSystemFactoryDefault operation. A single provisioning operation may increase the corresponding usage number by more than 1. For example, pan usage may increment by the number of steps the stepper motor has moved, which can be multiple steps per operation. If a particular provisioning axis is not supported, the corresponding usage value may be omitted from the response. request VideoSource [tt:ReferenceToken] This message contains a request for the number of operations performed on each axis. response Usage [tpv:Usage] This message contains the number of operations that have been performed on each axis over the life of the device. faults env:Sender - ter:InvalidArgVal - ter:NoSource The video source does not exist. access class READ_SYSTEM

The capabilities reflect optional functions and functionality of a service. The information is static and does not change during device operation. There is one global capability: DefaultTimeout Device-defined timeout after which movement stops. The rest of the capabilities are related to a specific video source and returned in a separate element (tpv:SourceCapabilities) containing the following properties: VideoSourceToken The identifier of the video source, a device shall supply this value. MaximumPanMoves Lifetime limit for pan moves on this video source; indication of pan move support as described in Section . MaximumTiltMoves Lifetime limit for tilt moves on this video source; indication of tilt move support as described in Section . MaximumZoomMoves Lifetime limit for zoom moves on this video source; indication of zoom move support as described in Section . MaximumRollMoves Lifetime limit for roll moves on this video source; indication of roll move support as described in Section . AutoLevel Indication of an auto-level option in a roll move as described in Section . If MaximumRollMoves is not defined, AutoLevel is ignored. MaximumFocusMoves Lifetime limit for focus moves on this video source; indication of focus move support as described in Section . AutoFocus Indication of an auto-focus option in a focus move as described in Section . If MaximumFocusMoves is not defined, AutoFocus is ignored. request This is an empty message. response Capabilities [tpv:Capabilities] The capability response message contains the requested service capabilities using a hierarchical XML capability structure faults No command-specific fault codes. access class PRE_AUTH