ONVIF Interface Guide Specification v1.

ONVIF®
Interface Guide Specification
Version 1.1

January 2019

www.onvif.org
ONVIF Interface Guide Specification v1.1

© 2008 - 2019 by ONVIF: Open Network Video Interface Forum, Inc. 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.

www.onvif.org
2
ONVIF Interface Guide Specification v1.1

REVISION HISTORY

Vers. Date Description Contributors

1.0 2013-09-19 Initial requirements • Matt Powers, Anixter

• Ulf Svensson, Axis Communications
• Johan Svensk, Axis Communications
• Gregor Wegrzynek, Bosch Security
Systems
• Markus Wierny, Bosch Security Systems
• Neelendra Bhandari, Honeywell
• Ramesh Subbaiah, Honeywell
• Scott Hudson (Ed.), Pelco by Schneider
Electric
• Joseph Moeller, Pelco by Schneider
Electric
• Andreas Schneider, Sony Corporation
• Masashi Tonomura, Sony Corporation

1.0.1 2013-10-11 Updated template to include • Matt Powers, Anixter

stylesheet reference • Ulf Svensson, Axis Communications
• Johan Svensk, Axis Communications
• Gregor Wegrzynek, Bosch Security
Systems
• Markus Wierny, Bosch Security Systems
• Neelendra Bhandari, Honeywell
• Ramesh Subbaiah, Honeywell
• Scott Hudson (Ed.), Pelco by Schneider
Electric
• Joseph Moeller, Pelco by Schneider
Electric
• Andreas Schneider, Sony Corporation
• Masashi Tonomura, Sony Corporation

1.1 2019-01-23 Conditional requirement for listing • Bob Dolan, Anixter

all Product Names of a Family of • Johan Svensk, Axis Communications
Products as identified in a DoC • Anders Johansson (Ed.), Axis
Communications
• Andre Eichhorn, Bosch Security
• Marwan Obeidat, Pelco by Schneider
Electric
• Andreas Schneider, Sony Corporation
• Hiroyuki Sano, Sony Corporation

www.onvif.org
3
ONVIF Interface Guide Specification v1.1

TABLE OF CONTENTS
1 Introduction ......................................................................................................................... 5
1.1 IMPORTANT ............................................................................................................... 5
1.2 Scope .......................................................................................................................... 5
1.3 Normative References................................................................................................. 5
1.4 Informative References ............................................................................................... 5
2 Terms and Definitions ........................................................................................................ 7
2.1 Conventions ................................................................................................................ 7
2.2 Definitions ................................................................................................................... 7
3 Purpose of the ONVIF Interface Guide .............................................................................. 8
4 Requirement Levels ............................................................................................................ 9
5 Mandatory Sections .......................................................................................................... 10
5.1 Overview ................................................................................................................... 10
5.2 Prerequisites ............................................................................................................. 11
5.3 Installation ................................................................................................................. 11
5.4 Default Network Settings ........................................................................................... 11
5.5 Default Login ............................................................................................................. 11
5.6 Local Configuration ................................................................................................... 11
5.7 Enabling ONVIF ........................................................................................................ 11
5.8 Querying Capabilities ................................................................................................ 12
6 Optional Sections ............................................................................................................. 13
6.1 Remote Configuration ............................................................................................... 13
7 XML Template .................................................................................................................... 14
8 Suggested tools and more information .......................................................................... 15

www.onvif.org
4
ONVIF Interface Guide Specification v1.1

1 Introduction

1.1 IMPORTANT
This ONVIF Interface Guide Specification v1.1 replaces the previously released version 1.0.1. As
of April 1, 2019 ONVIF Members shall only apply this version of the specification together with the
latest XML template to prepare an Interface Guide.

In order to facilitate an automated checking mechanism by the ONVIF office, the ONVIF Interface
Guide shall be provided in XML format, conforming to the DocBook v5.x standard and using the
provided template.

1.2 Scope
This specification defines and describes the ONVIF Interface Guide, which shall accompany any
DoC submission via the ONVIF Member Portal as part of the ONVIF Conformance Process.

1.3 Normative References

[ONVIF Conformance Process] ONVIF Conformance Process Specification
URL: https://www.onvif.org/profiles/conformance/
[DocBook-v5.x] OASIS DocBook Schema Version 5.x.
URL:https://www.oasis-
open.org/committees/tc_home.php?wg_abbrev=docbook
Specification: http://docs.oasis-open.org/docbook/specs/

1.4 Informative References

[ONVIF Profile Specs] All ONVIF Profiles Specifications documents
URL: https://www.onvif.org/profiles/
[ONVIF Specifications] All ONVIF Network Interface Specifications documents
URL: https://www.onvif.org/profiles/specifications/
[ONVIF Test Spec] ONVIF, “Device Test Specifications”
URL: https://www.onvif.org/profiles/conformance/device-test/
or “Client Test Specifications”
URL: https://www.onvif.org/profiles/conformance/client-test/
[ONVIF Test Tool] ONVIF, “Device Test Tool” or “Client Test Tool” as applicable
URL: https://developer.onvif.org/forum.php (Accessible to
ONVIF members only)

www.onvif.org
5
ONVIF Interface Guide Specification v1.1

[ONVIF Logo] ONVIF, “Logo Guidelines”

URL: https://developer.onvif.org/forum.php (Accessible to
ONVIF members only)
[ONVIF Profile Policy] Profile Policy
URL: https://www.onvif.org/profiles/
[ISO/IEC Directives] ISO/IEC Directives Part 2 “Principles and rules for the structure
and drafting of ISO and IEC documents”, chapter 7 “Verbal forms
for expression of provisions”
[ISO/IEC G2] ISO/IEC Guide 2 “Standardization and Related Activities:
General Vocabulary”
[ONVIF Schema] ONVIF, “Schema”
URL: https://www.onvif.org/profiles/specifications/

www.onvif.org
6
ONVIF Interface Guide Specification v1.1

2 Terms and Definitions

2.1 Conventions
The key words “shall”, “shall not”, “should”, “should not”, “may”, “need not”, “can”, “cannot” in this
specification are to be interpreted as described in [ISO/IEC Directives].

2.2 Definitions
member organization participating in good standing in the Full,
Contributing, or User Membership level in ONVIF
ONVIF device networked appliance or software program that exposes one or
multiple ONVIF Web Services
ONVIF client networked appliance or software program that uses ONVIF
Webservices
profile specific and unambiguous set of features that an ONVIF device
or ONVIF client shall implement or use to claim conformance to,
as defined in the Profile Specification for that specific profile
Product Name basic product identifier including the product name and model
Version Number release number for firmware version or client software version

www.onvif.org
7
ONVIF Interface Guide Specification v1.1

3 Purpose of the ONVIF Interface Guide

The purpose of the ONVIF Interface Guide is to provide the initial steps required to operate an
ONVIF client or device using the ONVIF API. Intended audience for the Interface Guides are
installers, system integrators, architects and engineers, end users.

The Member should make the ONVIF Interface Guide available on its website or as part of the
product documentation materials. ONVIF shall make the Interface Guides provided by the members
available as part of the product information on the ONVIF conformant product homepage.

The ONVIF Interface Guide shall be provided by the indicated Member which is solely responsible
for declared conformance and the information in the guide. Conformity is valid ONLY for the ONVIF
product identified when used in a manner consistent with the intent of the referenced documents.
The conformity assessment is the “activity concerned with determining directly or indirectly that
relevant requirements are fulfilled,” as stated in the ISO/IEC Guide 2: Standardization and Related
Activities: General Vocabulary [ISO/IEC G2].

www.onvif.org
8
ONVIF Interface Guide Specification v1.1

4 Requirement Levels
Each feature in this document has a requirement level for device and client that shall be provided
in the ONVIF Interface Guide document.

The requirement levels are:

• Mandatory = Documentation shall be provided for a device or client in the ONVIF Interface
Guide.
• Optional = Documentation of a feature or function may be provided for a device or client in
the ONVIF Interface Guide.
• Conditional = Documentation of a feature or function or requirement shall be provided if
applicable for devices and clients in the ONVIF Interface Guide.

Function Lists use the following abbreviations:

• M = Mandatory
• O = Optional
• C = Conditional

www.onvif.org
9
ONVIF Interface Guide Specification v1.1

5 Mandatory Sections
The ONVIF Interface Guide shall provide the following sections. Any differences between product
models or product family within the scope of an ONVIF Interface Guide shall be indicated in the
respective sections of the ONVIF Interface Guide.

5.1 Overview
• [M] Standard template text:
The purpose of this guide is to provide the initial steps required to operate this product
using the ONVIF API. For more information on ONVIF, refer to http://www.onvif.org.

This ONVIF Interface Guide is issued by the indicated Member which is solely responsible
for declared conformance and the information in this guide. Conformity is valid ONLY for
the ONVIF product identified when used in a manner consistent with the intent of the
referenced documents.

5.1.1 Product Information

• [M] Product type. Can be device, client or device/client.
• [O] Company Logo
• [M] Product Name and Version Number. This section shall list the matching Product Name
and FW/SW Version Number as identified in the DoC and in the feature list.
• [C] For use with a family of products DoC, the ONVIF Interface Guide shall include all
applicable product names (as identified in the DoC).

5.1.2 Supported ONVIF Profiles

• [M] List of supported ONVIF Profiles

5.1.3 Support Information

• [M] Technical Support contact information including:
o [M] General international support mailing address
 [M] Company name
 [M] Street name and number
 [M] City
 [O] State
 [O] Postal code
 [M] Country
o [O] Regional support contact address
o [M] Technical support website URL
o [O] Technical support email

www.onvif.org
10
ONVIF Interface Guide Specification v1.1

o [O] Technical support phone

5.2 Prerequisites
• [C] Hardware or software required to interact with each of the ONVIF clients or devices,
including:
o Hardware and operating system
o Internet browser
o Network configuration

5.3 Installation
• [M] Instructions for how to install the product as applicable, could include:
o Power Source
o Network Connection
o Wiring
o Software installation

5.4 Default Network Settings

• [Device:M, Client:C] Instructions on how to obtain the IP Address for the ONVIF clients or
devices, including:
o Default IP Address
o DHCP

5.5 Default Login

• [Device:M, Client:C] Instructions for how to log on to the ONVIF clients or devices, including:
o Default Username and Password
o Default Access URL

5.6 Local Configuration

• [M] Instructions for how to navigate to the settings or configuration page to modify the
general settings, network settings, set up users, configure events, or other key functionality,
including:
o [M] Where to find (path, menus, settings, etc.)
o [C] On-board configuration

5.7 Enabling ONVIF

• [M] Information on whether the ONVIF interface is enabled by default or not.
• [C] Instructions for how to enable the ONVIF interface, if it is not enabled by default.

www.onvif.org
11
ONVIF Interface Guide Specification v1.1

5.8 Querying Capabilities

• [Client:M] Instructions for how to query the capabilities of an ONVIF device from an ONVIF
client.
o Discovery
 how to add a device
o Get Capabilities
 Querying GetCapabilities or Get Services

www.onvif.org
12
ONVIF Interface Guide Specification v1.1

6 Optional Sections
The ONVIF Interface Guide may provide the following sections:

6.1 Remote Configuration

• [O] Instructions for how to remotely configure the device using the client, including:
o Configure a media stream
o Configure a recording
o Configure an access point

www.onvif.org
13
ONVIF Interface Guide Specification v1.1

7 XML Template
Members shall use the most current XML template available to create their Interface Guide. The
provided XML document template uses the DocBook v5.x standard.

The template is available on the ONVIF Member Forum in the Conformance Process area:
ONVIF Forum > Member Information > Documents & Specifications > Conformance Process >
ONVIF Interface Guide Specification v1.1.

www.onvif.org
14
ONVIF Interface Guide Specification v1.1

8 Suggested tools and more information

• http://www.docbook.org/
• https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook

Picture upload guide:

• https://developer.onvif.org/showthread.php?1382-HOWTO-Managing-images-for-your-
Interface-Guide

www.onvif.org
15