ONVIF Interface Guide Specification

Transcription

1 ONVIF Interface Guide Specificatin Versin Octber, 2013 ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 1

2 by ONVIF. All rights reserved. Recipients f this dcument may cpy, distribute, publish, r display this dcument s lng as this cpyright ntice, license and disclaimer are retained with all cpies f the dcument. N license is granted t mdify this dcument. 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. ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 2

3 Revisin Histry Ver. Date Descriptin Cntributrs Updated template t include stylesheet reference Matt Pwers, Anixter Ulf Svenssn, Axis Cmmunicatins Jhan Svensk, Axis Cmmunicatins Gregr Wegrzynek, Bsch Security Systems Markus Wierny, Bsch Security Systems Neelendra Bhandari, Hneywell Ramesh Subbaiah, Hneywell Sctt Hudsn (Ed.), Pelc by Schneider Electric Jseph Meller, Pelc by Schneider Electric Andreas Schneider, Sny Crpratin Masashi Tnmura, Sny Crpratin Initial requirements Matt Pwers, Anixter Ulf Svenssn, Axis Cmmunicatins Jhan Svensk, Axis Cmmunicatins Gregr Wegrzynek, Bsch Security Systems Markus Wierny, Bsch Security Systems Neelendra Bhandari, Hneywell Ramesh Subbaiah, Hneywell Sctt Hudsn (Ed.), Pelc by Schneider Electric Jseph Meller, Pelc by Schneider Electric Andreas Schneider, Sny Crpratin Masashi Tnmura, Sny Crpratin ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 3

4 Table f Cntent inf@nvif.rg 1 Scpe 5 2 IMPORTANT 5 3 Nrmative references 5 4 Infrmative References 5 5 Terms and Definitins Cnventins Definitins Purpse f the ONVIF Interface Guide 6 7 Requirement Levels 6 8 Mandatry Sectins Overview Prerequisites Installatin Default Netwrk Settings Default Lgin Lcal Cnfiguratin Enabling ONVIF Querying Capabilities Optinal Sectins Remte Cnfiguratin XML Template 9 11 Suggested tls and mre infrmatin 12 ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 4

5 1 Scpe This specificatin defines and describes the ONVIF Interface Guide, which must accmpany any DC submissin t the ONVIF ffice as part f the ONVIF Cnfrmance Prcess. The cnfrmity assessment is the activity cncerned with determining directly r indirectly that relevant requirements are fulfilled, as stated in the ISO/IEC Guide 2: Standardizatin and Related Activities: General Vcabulary [ISO/IEC G2]. 2 IMPORTANT As f September 30, 2013 ONVIF Members shall prvide an ONVIF Interface Guide as part f the [ONVIF Cnfrmance Prcess]. Befre January 1, 2014, as a grace perid, it is still pssible t claim cnfrmance t previus versins f ONVIF Cnfrmance Prcess versin 2.0. In rder t prvide an autmated checking mechanism by the ONVIF ffice, the ONVIF Interface Guide shall be prvided in XML frmat, cnfrming t the DcBk v5.x standard and using the prvided template. 3 Nrmative references [ONVIF RM] ONVIF, Rules f Membership URL: [ONVIF Cnfrmance Prcess] ONVIF Cnfrmance Prcess Specificatin URL: [DcBk-v5.x] The OASIS DcBk Schema Versin 5.x. URL: Specificatin: 4 Infrmative References [ONVIF Prfile Specs] [ONVIF Specificatin Set] [ONVIF Test Spec] [ONVIF Test Tl] [ONVIF Lg] [ONVIF Prfile Plicy] [ISO IEC Directives] [ISO/IEC G2] All ONVIF Prfiles Specificatins dcuments URL: All ONVIF Netwrk Interface Specificatin Set dcuments URL: ONVIF, Test Specificatin URL: ONVIF, Test Tl URL: (Develpers Frum nly) ONVIF, Lg Guidelines URL: (Develpers Frum nly) Prfile Plicy URL: Part 2 Rules fr the structure and drafting f Internatinal Standards, Annex H: Verbal frms fr the expressin f prvisins ISO/IEC, Guide 2: Standardizatin and Related Activities: General Vcabulary. ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 5

6 [ISO/IEC CS] [ONVIF Schema] ISO/IEC 17050, Cnfrmity assessment Supplier s declaratin f cnfrmity Part 1: General requirements. ONVIF, Schema URL: 5 Terms and Definitins 5.1 Cnventins The key wrds shall, shall nt, shuld, shuld nt, may, need nt, can, cannt in this specificatin are t be interpreted as described in [ISO IEC Directives]. 5.2 Definitins Member ONVIF Device Organizatin participating in gd standing in the Full, Cntributing, r User Membership level in ONVIF. Netwrked appliance r sftware prgram that expses ne r multiple ONVIF Web Services. ONVIF Client Netwrked appliance r sftware prgram that uses ONVIF Webservices.. Prfiles Prduct Name Versin Number A specific and unambiguus set f features that an ONVIF Device r ONVIF Client shall implement r use t claim cnfrmance t, as defined in the Prfile Specificatin fr that specific Prfile. The basic prduct identifier including the prduct name and mdel. The release number fr firmware versin r client sftware versin. 6 Purpse f the ONVIF Interface Guide The purpse f the ONVIF Interface Guide is t prvide the initial steps required t perate an ONVIF client r device using the ONVIF API. Intended audience fr the Interface Guides are installers, system integratrs, architects and engineers, end users. The Member shuld make the ONVIF Interface Guide available n its website r as part f the prduct dcumentatin materials. ONVIF shall make the Interface Guides prvided by the members available as part f the prduct infrmatin n the ONVIF cnfrmant prduct hmepage. The ONVIF Interface Guide shall be prvided by the indicated Member which is slely respnsible fr declared cnfrmance and the infrmatin in the guide. Cnfrmity is valid ONLY fr the ONVIF prduct identified when used in a manner cnsistent with the intent f the referenced dcuments. 7 Requirement Levels Each feature in this dcument has a requirement level fr Device and Client that shall be prvided in the ONVIF Interface Guide dcument. The requirement levels are: Mandatry = Dcumentatin shall be prvided fr a device r client in the ONVIF Interface Guide. Optinal = Dcumentatin f a feature r functin may be prvided fr a device r client in the ONVIF Interface Guide. Cnditinal = Dcumentatin f a feature r functin r requirement shall be prvided if applicable fr devices and clients in the ONVIF Interface Guide. Functin Lists use the fllwing abbreviatins: M = Mandatry O = Optinal C = Cnditinal ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 6

7 8 Mandatry Sectins The ONVIF Interface Guide shall prvide the fllwing sectins. Any differences between prduct mdels r prduct family within the scpe f an ONVIF Interface Guide shall be indicated in the respective sectins f the ONVIF Interface Guide. 8.1 Overview [M] Standard template text: The purpse f this guide is t prvide the initial steps required t perate this prduct using the ONVIF API. Fr mre infrmatin n ONVIF, refer t This ONVIF Interface Guide is issued by the indicated Member which is slely respnsible fr declared cnfrmance and the infrmatin in this guide. Cnfrmity is valid ONLY fr the ONVIF prduct identified when used in a manner cnsistent with the intent f the referenced dcuments Prduct Infrmatin [O] Cmpany Lg [M] Prduct Name and Versin Number. This sectin shall list the matching Prduct Name and Versin Number as identified in the DC Supprted ONVIF Prfiles [M] List f supprted ONVIF Prfiles Supprt Infrmatin [M] Technical Supprt cntact infrmatin including: [M] General internatinal supprt mailing address [O] Reginal supprt cntact address [M] Technical supprt website URL [O] Technical supprt [O] Technical supprt phne 8.2 Prerequisites [C] Hardware r sftware required t interact with each f the ONVIF clients r devices, including: Hardware and perating system Internet brwser r Test Tl Netwrk cnnectin t the client/device Knwledge f IP infrastructure / netwrk envirnment 8.3 Installatin [M] Instructins fr hw t install the prduct as applicable, including: Pwer Surce Netwrk Cnnectin Wiring Sftware installatin ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 7

8 8.4 Default Netwrk Settings [Device:M, Client:C] Instructins n hw t btain the IP Address fr the ONVIF clients r devices, including: Default IP Address DHCP 8.5 Default Lgin [Device:M, Client:C] Instructins fr hw t lg n t the ONVIF clients r devices, including: Default Username and Passwrd Default Access URL 8.6 Lcal Cnfiguratin [M] Instructins fr hw t navigate t the settings r cnfiguratin page t mdify the general settings, netwrk settings, set up users, cnfigure events, r ther key functinality. [M] Where t find (path, menus, settings, etc.) [C] On-bard cnfiguratin 8.7 Enabling ONVIF [M] Infrmatin n whether the ONVIF interface is enabled by default r nt. [C] Instructins fr hw t enable the ONVIF interface, if it is nt enabled by default. 8.8 Querying Capabilities [Client:M] Instructins fr hw t query the capabilities f an ONVIF device frm an ONVIF client. Discvery hw t add a device Get Capabilities Querying GetCapabilities r Get Services 9 Optinal Sectins The ONVIF Interface Guide may prvide the fllwing sectins: 9.1 Remte Cnfiguratin [O] Instructins fr hw t remtely cnfigure the device using the client, including: Cnfigure a media stream Cnfigure a recrding Cnfigure an access pint ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 8

9 10 XML Template The XML dcument template shall use the DcBk v5.x standard. The template shall be available n the ONVIF Member Frum in the Cnfrmance Prcess area (Member Infrmatin > Dcuments & Specificatins > Cnfrmance Prcess). The cntent f the XML template shall cntain the fllwing: <?xml versin="1.0" encding="utf-8"?> <?xml-mdel href=" schematypens=" <?xml-mdel href=" type="applicatin/xml" schematypens=" <?xml-mdel href="check_nvif_interface_guide.sch" type="applicatin/xml" schematypens=" <?xml-stylesheet href="dcbk-css/dcbk.xsl" type="text/xsl"?> <article xmlns=" xmlns:xlink=" xmlns:xhtml=" versin="5.0" audience="installer/integratr" xml:id="cmpany_mdel"> <inf> <title>onvif Interface Guide</title> <!-- Add yur cmpany and prduct infrmatin in the subtitle. --> <subtitle>fr <rgname>cmpany</rgname> <prductname class="registered">brand</prductname> <prductnumber>mdel</prductnumber></subtitle> <cpyright> <year>2013</year> </cpyright> <cver> <!-- D NOT change ONVIF infrmatin. --> <para><rg> <rgname> <inlinemediabject> <imagebject> <imagedata fileref="onvif_clr_a_1.png" frmat="png"/> </imagebject> <textbject> <phrase>onvif Inc.</phrase> </textbject> </inlinemediabject> </rgname> <address> <street>2400 Camin Ramn</street> <theraddr>suite 375</theraddr> <city>san Ramn</city>, <state>ca</state> <pstcde>94583</pstcde> <cuntry>usa</cuntry> <phne> </phne> <fax> </fax> < >inf@nvif.rg</ > <uri xlink:href=" </address> </rg></para> ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 9

10 </cver> </inf> <sectin xml:id="verview"> <!-- D NOT change Overview text! --> <title>overview</title> <para>the purpse f this guide is t prvide the initial steps required t perate this prduct using the ONVIF API. Fr mre infrmatin n ONVIF, refer t <uri xlink:href=" </para> <para>this ONVIF Interface Guide is issued by the indicated Member which is slely respnsible fr declared cnfrmance and the infrmatin in this guide. Cnfrmity is valid ONLY fr the ONVIF prduct identified when used in a manner cnsistent with the intent f the referenced dcuments.</para> <sectin xml:id="prduct_inf"> <!-- Add yur cmpany lg and prduct infrmatin in this sectin. --> <title>prduct Infrmatin</title> <para><rgname> <inlinemediabject> <imagebject> <imagedata fileref="cmpany_lg.png" frmat="png"/> </imagebject> <textbject> <phrase>cmpany</phrase> </textbject> </inlinemediabject> </rgname></para> <itemizedlist> <listitem> <para><prductname class="registered">brand</prductname> <prductnumber>mdel</prductnumber> </para> </listitem> </itemizedlist> <sectin xml:id="supprted_prfiles"> <!-- Update supprted prfiles infrmatin here. Remve r cmment ut prfiles that are nt supprted. --> <title>supprted ONVIF Prfiles</title> <itemizedlist> <listitem> <mediabject> <imagebject> <imagedata fileref="onvif_icns_s_cmyk.png" frmat="png"/> </imagebject> <textbject> <phrase>onvif Prfile S</phrase> </textbject> </mediabject> </listitem> <listitem> <mediabject> ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 10

11 <imagebject> <imagedata fileref="onvif_icns_g_cmyk.png" frmat="png"/> </imagebject> <textbject> <phrase>onvif Prfile G</phrase> </textbject> </mediabject> </listitem> <listitem> <mediabject> <imagebject> <imagedata fileref="onvif_icns_c_cmyk.png" frmat="png"/> </imagebject> <textbject> <phrase>onvif Prfile C</phrase> </textbject> </mediabject> </listitem> </itemizedlist> </sectin> </sectin> <sectin xml:id="supprt_inf"> <title>supprt Infrmatin</title> <para> <rg> <rgname>cmpany</rgname> <address> <street>street</street> <city>city</city>, <state>state</state> <pstcde>pstalcde</pstcde> <cuntry>cuntry</cuntry> <phne>phne</phne> < >supprt </ > <uri xlink:href="url">url</uri> </address> </rg> </para> </sectin> </sectin> <sectin xml:id="prereqs"> <title>prerequisites</title> <!-- Hardware and Operating System Internet brwser r Test Tl Netwrk cnnectin t the client/device Knwledge f IP infrastructure / netwrk envirnment Specify "Nt Applicable" if nt needed --> </sectin> <sectin xml:id="installatin"> <title>installatin</title> <!-- Installatin instructins --> </sectin> <sectin xml:id="netwrk"> <title>default Netwrk Settings</title> <!-- IP Address Settings (DHCP r default address lcatin). ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 11

12 Specify "Nt Applicable" if nt needed. --> </sectin> <sectin xml:id="lgin"> <title>default Lgin</title> <!-- Hw t lgin t the device r client. Default username / passwrd. Specify "Nt Applicable" if nt needed.--> </sectin> <sectin xml:id="cnfig"> <title>lcal Cnfiguratin</title> <!-- Where t find (path, menus, settings, etc.) Hw t enable ONVIF interface On-bard cnfiguratin --> </sectin> <sectin xml:id="enable_nvif"> <title>enabling ONVIF</title> <!-- Hw t enable ONVIF if it is nt enabled by default. --> </sectin> <!-- <sectin xml:id="get_capabilities"> <title>determining Capabilities f an ONVIF Device</title> <para>t determine the supprted capabilities f the camera, the ONVIF Client shuld call <methdname>getcapabilities</methdname>.</para> </sectin>--> <!-- <sectin> <title>remte Cnfiguratin (OPTIONAL)</title> <!-\- Cnfiguring the device using the client - Cnfigure a media stream - Cnfigure a recrding - Cnfigure an access pint -\-> </sectin>--> </article> 11 Suggested tls and mre infrmatin ONVIF Interface Guide Specificatin Octber, 2013 Cpyright ONVIF All rights reserved. Page 12