Iqinvision IQ510 User manual

IQinVision
Network API
Manual
Release Date: August 9, 2011

Page 2 of 60
Table of Contents
IQinVision Network API Manual......................................................1
Notices ..................................................................................................5
1. About This Manual.......................................................................6
1.1. General...............................................................................................................6
2. Discovery and Control..................................................................7
2.1. Discovering IQeye cameras ...............................................................................7
2.1.1. Zeroconf discovery protocol............................................................................7
2.1.2. GSAUCE discovery protocol...........................................................................7
2.2. IQdevice DLL....................................................................................................7
3. Object Identifiers..........................................................................8
3.1. OID description..................................................................................................8
3.2. Reading OIDs.....................................................................................................8
3.3. Setting OIDs.......................................................................................................8
3.4. Efficiently setting multiple OID values .............................................................9
3.5. Commonly used OIDs......................................................................................10
3.5.1. Audio support ................................................................................................10
3.5.2. Crop window..................................................................................................10
3.5.3. Flash disk.......................................................................................................11
3.5.4. General camera ..............................................................................................11
3.5.5. H.264 control .................................................................................................12
3.5.6. H.264 RTSP stream control ...........................................................................13
3.5.7. Image control .................................................................................................14
3.5.8. Image gain control .........................................................................................15
3.5.9. Input/Output control.......................................................................................16
3.5.10. Motion windows ..........................................................................................16
3.5.11. Overlay control ............................................................................................17
3.5.12. Virtual camera (VCAM) ..............................................................................17
3.6. OIDs supported by camera family ...................................................................18
3.6.1. Audio support ................................................................................................18
3.6.2. Crop window..................................................................................................18
3.6.3. Flash disk.......................................................................................................18
3.6.4. General camera ..............................................................................................19
3.6.5. H.264 control .................................................................................................20
3.6.6. H.264 RTSP stream control ...........................................................................21
3.6.7. Image control .................................................................................................21
3.6.8. Image gain control .........................................................................................22
3.6.9. Input/Output control.......................................................................................23
3.6.10. Motion windows ..........................................................................................23
3.6.11. Overlay control ............................................................................................24
3.6.12. Virtual camera (VCAM) ..............................................................................24

Page 3 of 60
4. Image Data Formats...................................................................25
4.1. Image data supported by camera family ..........................................................25
4.2. URI modifiers supported by camera family.....................................................26
5. Single JPEG Image.....................................................................27
5.1. Requesting a single JPEG image......................................................................27
6. Serverpush Stream......................................................................28
6.1. Serverpush stream format ................................................................................28
6.2. Requesting a serverpush stream.......................................................................28
6.2.1. Serverpush modifiers .....................................................................................29
6.2.2. Image control modifiers.................................................................................29
6.2.3. Source/Destination resolution........................................................................29
6.3. Serverpush stream with embedded motion data...............................................30
6.4. Serverpush stream with embedded trigger data ...............................................30
6.5. Motion only serverpush stream........................................................................31
6.6. Serverpush stream with no image data.............................................................31
7. PGM Image Data ........................................................................32
7.1. PGM grayscale data.........................................................................................32
7.2. PGM serverpush stream...................................................................................32
8. Standalone Motion Data.............................................................33
9. Bitmap Motion Map ...................................................................34
10. H.264 Streams..............................................................................35
10.1. Requesting H.264 image data ........................................................................35
10.1.1. Unicast/Multicast UDP or TCP stream........................................................35
10.1.2. Unicast TCP stream tunneled over HTTP....................................................36
10.2. H.264 mode based operation..........................................................................37
10.2.1. IQ732/IQ832/IQD3xx/IQM3xx modes of operation ...................................37
10.2.2. IQA3xx modes of operation.........................................................................38
10.3. H.264 stream based operation........................................................................40
10.4. H.264 request URI modifiers.........................................................................41
10.5. H.264 stream with motion/time SEI data.......................................................42
11. Two-way Audio Support............................................................44
11.1. Camera setup..................................................................................................44
11.2. Sending audio data.........................................................................................44
12. IQinVision Cameras ...................................................................45
12.1. IQ04xx/D4xx/54xx series..............................................................................45
12.2. IQeye51x series..............................................................................................46
12.3. IQeye70x/75x/8xx series cameras..................................................................47
12.4. IQA1xx series cameras ..................................................................................48
12.5. IQA2xx series cameras ..................................................................................49
12.6. IQA3xx series cameras ..................................................................................50
12.7. IQ73xx/83xx/D3xx/M3xx series cameras......................................................51

Page 4 of 60
13. Host Based Interfacing...............................................................52
13.1. IQstream sample client software....................................................................52
13.2. ActiveX control..............................................................................................52
13.3. Win32 .Net interface......................................................................................52
14. ONVIF Support...........................................................................53
14.1. Supported ONVIF commands........................................................................53
15. PSIA Support...............................................................................54
15.1. Service requirements......................................................................................54
15.2. Resource requirements...................................................................................55
15.2.1. PSIA root service.........................................................................................55
15.2.2. PSIA/System................................................................................................55
15.2.3. PSIA/System/Storage...................................................................................55
15.2.4. PSIA/System/Network.................................................................................56
15.2.5. PSIA/System/IO...........................................................................................56
15.2.6. PSIA/System/Audio.....................................................................................56
15.2.7. PSIA/System/Video .....................................................................................57
15.2.8. PSIA/System/Serial......................................................................................57
15.2.9. PSIA/Diagnostics.........................................................................................57
15.2.10. PSIA/Security ............................................................................................57
15.2.11. PSIA/Security/AAA...................................................................................57
15.2.12. PSIA/Streaming .........................................................................................58
15.2.13. PSIA/PTZ...................................................................................................58
15.2.14. PSIA/Custom/MotionDetection.................................................................58
15.2.15. PSIA/Custom/Event...................................................................................59
A. Technical Support.......................................................................60

Page 5 of 60
Notices
©2011, IQinVision. All rights reserved. No part or contents of this manual may be transmitted or reproduced
without written permission from IQinVision.
The release date for this manual is August 9, 2011. Due to updates in the camera’s operating software, this
manual will change periodically and may change without notice. Contact IQinVison for the most current
version of this manual.
The screenshots in this manual are used for explanatory purposes. Your actual screens may differ from the
screenshots included in this manual.
This product contains source code that was developed by the University of California, Berkeley, Copyright
©1989 The Regents of the University of California. This product contains software that is based in part on the
work of the Independent JPEG Group.
Portions Copyright Netscape Communications Corporation, 1999. All Rights Reserved. Netscape Navigator
and the Netscape N Logo are registered trademarks of Netscape in the United States and other countries.
Microsoft Windows and Internet Explorer are registered trademarks of Microsoft Corporation. Other
company or product names are trademarks or registered trademarks of their respective owners.

Page 6 of 60
1. About This Manual
1.1. General
This IQinVision API manual contains the main functionality and API information required for host based
connections to IQeye cameras. It also describes how to customize IQeye camera web pages, startup options
and how to create a simple private labeled camera look and feel.
In addition this manual also includes documentation on how to use the IQeye Video System Management and
Control ("vSMAC") advanced programmatic interface. This allows a very feature-rich host based interface
with IQeye cameras. For example, the Cameo tab which is available on all IQinVision Pro Line cameras
(IQeye7xx/8xx/Axx) demonstrates the vSMAC functionality of VCAMS whereby the user is able to create
multiple video streams each with independent frame rate, resolution and area of interest.
Note: Not all of the commands used by IQinVision cameras are documented in this manual. For a
full description of all commands available from the IQeye command line please see the IQeye
Reference Manual.

Page 7 of 60
2. Discovery and Control
2.1. Discovering IQeye cameras
Currently two discovery mechanisms are used to search for IQeye cameras from a network host. Pro Line
cameras use IQinVision’s proprietary GSAUCE protocol. Basic Line cameras use Zero Configuration
Networking (Zeroconf).
Future firmware releases for the Pro Line will also support Zeroconf so that there will be a consistent
mechanism for finding all IQinVision cameras. In addition, IQinVision will be providing a Windows DLL
and sample source code that performs both GSAUCE and Zeroconf queries and will return to the caller a list
of cameras found.
2.1.1. Zeroconf discovery protocol
Basic Line cameras use Zeroconf (www.zeroconf.org) as their discovery mechanism. There are several
different mechanisms that host applications can use to find cameras using Zeroconf.
Host application programs can build the Zeroconf protocol right into an application based on the IETF draft
documentation and sample code available from www.zeroconf.org.
Applications can also use a Zeroconf client which can provide an API to discover network devices. Sample
clients include Bonjour (http://www.apple.com/macosx/technology/bonjour.html) and Avahi, http://avahi.org.
Basic line cameras will also self-assign a link-local IP address as defined in RFC 3927 if no other IP address
has been configured. This allows host machines to discover these cameras with no additional configuration.
2.1.2. GSAUCE discovery protocol
Pro Line cameras use IQinVision’s GSAUCE discovery protocol. GSAUCE is a UDP based protocol that
will use broadcast packets to query for cameras on a local area network. Once cameras have been found
authenticated UDP packets can be used to assign IP parameters. Please contact Engineering Support,
[e-mail] for the GSAUCE protocol definition and sample code.
2.2. IQdevice DLL
The IQdevice DLL supports camera discovery and basic camera manipulation functions such as assigning IP
address, rebooting a camera, and setting and getting OIDs. Please contact Engineering Support,
[e-mail] to get this software.

Page 8 of 60
3. Object Identifiers
All configurable options on IQeye cameras can be controlled using Object Identifiers. (“OIDs”)
3.1. OID description
OIDs are SNMP-like Object IDentifiers that allow host based applications and on-camera web pages to get
and set values on the camera. An object is a single piece of information that can be displayed and possibly
changed, i.e. a flag setting, a string, a counter variable, etc.
An OID is represented by a dot separated numerical value. For example, the OID 2.4 corresponds to the name
of the camera. OIDs are used in all built-in web pages and can also be used by host application programs to
configure the camera.
3.2. Reading OIDs
The simplest way to get specific information from the camera is to issue an http request to read an OID value.
For example, issuing the following http request:
http://<camera_ip>/get.oid?2.4
will return a page that has the value of OID 2.4 (the camera name) as the page contents.
3.3. Setting OIDs
When setting OID values the OID format contains additional information used to specify how the OID value
is to be written. The format of the OID command is:

set.oid ?Oid{type}{style}n.n.n ={value}
Where the following parameters must be defined:
type The type of field that is being set. Use the value “T” for text entry fields.
style Where the variable should be written. Specify “N” for writing to the camera’s
non-volatile memory, “R” for setting the run-time value only or “B” for both run-
time and non-volatile memory.
value The value to assign to the specified OID.
For example, to change the camera name to “IQcam”in the running system configuration use the http request:
http://<camera_ip>/set.oid?OidTR2.4=”IQcam”
Note: The syntax of the set.oid URL is case sensitive.
If this request completes successfully the camera name will be changed to the string “IQcam”in the run-time
system. The permanent value stored in non-volatile memory will not be changed.

Page 9 of 60
In order to change permanent parameters using the set.oid URL the request must be authenticated using either
basic or secure authentication. Basic authentication can be specified by including the username and password
as part of the URL. If the privileged password has not been changed use the URL:
http://root:system@<camera_ip>/set.oid?OidTB2.4=”IQcam”
This URL will permanently change the camera name to “IQcam”in both the runtime system and non-volatile
memory.
Note: Internet Explorer does not allow basic authentication to be specified as part of a URL.
3.4. Efficiently setting multiple OID values
To efficiently set multiple OID values use the runtime option to change them all in the currently running
system. When all OIDs in a functional group have been specified then write the single “Write to NVR”OID
for the functional group. This will commit all the runtime values to the flash memory.

Page 10 of 60
3.5. Commonly used OIDs
The following tables will show commonly used OIDs. Note that different camera models have varying
functionality. Please see “OID supported matrix”in Section 3.5.12 for the list of OIDs that each camera
family supports.
Note: For a complete list of available OIDs, request the URL http://<camera_ip>/oidtable.html from
any IQinVision camera.
For more information on any of these OIDs see the IQinVision Reference Manual.
3.5.1. Audio support
Name
OID Value
Description
Audio input state
1.9.5
Enable/disable the audio input (microphone). Default is Disabled.
Audio input gain
1.9.1
Input amplification amount. Possible values are low, medium and
high with the default value medium.
Audio output state
1.9.6
Enable/disable the audio output (speaker). Default is disabled.
Audio output gain
1.9.4
Speaker amplification amount. Possible values are low, medium and
high with the default value medium.
Audio duplex
mode
1.9.7
Determines whether audio is half or full duplex. Default is full.
Audio password
1.9.10
Password required to send audio to the camera. The username is
“audio”and the default password is “sound”. Note that these
passwords are case sensitive.
3.5.2. Crop window
Name
OID Value
Description
Top edge
1.2.6.1
Top edge of crop window in pixels. Default is 0.
Width
1.2.6.2
Width of crop window in pixels. Default value is the width of the
imager itself.
Height
1.2.6.3
Height of crop window in pixels. Default value is the height of the
imager itself.
Left edge
1.2.6.4
Left edge of crop window in pixels. Default is 0.
Reset crop to
maximum size
1.2.6.5
Writing this write only OID with the value “1”will reset the crop
window back to factory default settings.
The crop window coordinate system uses the value (0,0) as the upper left corner of the image.
The default size for the crop window is the entire imager.