Lumenera Network Camera User manual

Lumenera Network Camera
API Reference Manual
Release 1.8.1

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page i
License Agreement (Software):
This Agreement states the terms and conditions upon which Lumenera Corporation
("Lumenera") offers to license to you (the "Licensee") the software together with all
related documentation and accompanying items including, but not limited to, the
executable programs, drivers, libraries, and data files associated with such programs
(collectively, the " oftware").
The oftware is licensed, not sold, to you for use only under the terms of this
Agreement.
Lumenera grants to you the right to use all or a portion of this oftware provided that the
oftware is used only in conjunction with Lumenera's family of products.
In using the oftware you agree not to:
a) decompile, disassemble, reverse engineer, or otherwise attempt to derive the source
code for any Product (except to the extent applicable laws specifically prohibit such
restriction);
b) remove or obscure any trademark or copyright notices.
Limited Warranty (Hardware and Software):
ANY U E OF THE OFTWARE OR HARDWARE I AT YOUR OWN RI K. THE
OFTWARE I PROVIDED FOR U E ONLY WITH LUMENERA' HARDWARE AND
OTHER RELATED OFTWARE. THE OFTWARE I PROVIDED FOR U E "A I "
WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY
LAW, LUMENERA DI CLAIM ALL WARRANTIE OF ANY KIND, EITHER EXPRE
OR IMPLIED, INCLUDING, WITHOUT LIMITATION, IMPLIED WARRANTIE OR
CONDITION OF MERCHANTABILITY, QUALITY AND FITNE FOR A
PARTICULAR PURPO E. LUMENERA I NOT OBLIGATED TO PROVIDE ANY
UPDATE OR UPGRADE TO THE OFTWARE OR ANY RELATED HARDWARE.
Limited Liability (Hardware and Software):
In no event shall Lumenera or its Licensors be liable for any damages whatsoever
(including, without limitation, incidental, direct, indirect, special or consequential
damages, damages for loss of business profits, business interruption, loss of business
information, or other pecuniary loss) arising out of the use or inability to use this
oftware or related Hardware, including, but not limited to, any of Lumenera's family of
products.
Product Warranty
Lumenera Corporation warrants to the original purchaser that our cameras are
guaranteed to be free from manufacturing defects for a period of one (1) year from the
original date of purchase.
hould the unit fail during the warranty period, Lumenera will, at its option, repair or
replace the failed unit. Repaired or replaced units will be covered under warranty for the
remainder of the original one (1) year warranty period.

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page ii Copyright 

 008
This warranty does not apply to units that, after being inspected by Lumenera, have
been found to have failed due to customer abuse, accidents, mishandling,
tampering/alteration, improper installation, improper power source, negligence, opening
of the enclosure, or if the serial number has been removed or damaged. This warranty
does not cover labor or incurred charges required in removing or installing the unit, any
business interruption, loss of profits/revenues, or any consequential damages.
Units returned to Lumenera beyond the warranty period will be repaired, if possible, and
all appropriate material and labor charges will apply. The repaired part will be covered
under an additional 90-day warranty.
Any returning product, specifically those being returned under warranty, must follow the
Returned Material Authorization (RMA) process. Units must be properly packaged, in
original packing when possible. Lumenera will not cover damage sustained in shipping
due to improper packing.
All shipping charges incurred for the return of failed units are the customer’s
responsibility, including shipping, broker fees, duties and taxes. Once the unit is repaired
or replaced, Lumenera will pay the shipping charges to return the unit back to the
customer.
For RMA instructions, please refer to our website at www.lumenera.com.
RoHS/WEEE Compliance Statement
The Restriction of Hazardous ubstances in Electrical and Electronic Equipment (RoH )
Directive was passed into law by the European Union (E.U.). It affects manufacturers,
sellers, distributors and recyclers of electrical and electronic equipment containing lead,
cadmium, mercury, hexavalent chrome, polybrominated biphenyl (PBB) and
polybrominated diphenyl ether (PBDE). After July 1, 2006 the use of these materials will
be banned in new products sold in Europe. The RoH Directive complements the WEEE
Directive. China is expected to adopt similar legislation within a similar timeline.
The Waste Electrical and Electronic Equipment Directive (WEEE) aims to reduce the
waste arising from electrical and electronic equipment and to improve the environmental
performance of all those involved in the life cycle of these products.
Lumenera is committed to protecting people and the environment and we are working on
identifying any materials used in our processes that could pose a potential hazard to our
employees, customers or the environment.
For this reason we are committed to have all our products comply with the RoH and
WEEE directives. We are constantly improving our compliance with these directives. For
more information on our compliance or to track our progress please refer to our website.

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page iii
Table of Contents
INTRODUCTION .............................................................................................................1
1.1 T HE L UMENERA N ETWORK C AMERA F AMILY ..........................................................1
1.2 W HERE T O F IND D OCUMENTATION ........................................................................2
1.3 T ECHNICAL A I TANCE ......................................................................................2
NETWORK CAMERA API ..............................................................................................3
2.1 T HE L UMENERA N ETWORK C AMERA API ...............................................................3
2.2 C AMERA F EATURE A ND ETTING ......................................................................4
2.3 UPPORTED N ETWORK P ROTOCOL .....................................................................6
2.4 P ROGRAMMING I NTERFACE .................................................................................7
2.4.1 XML-RPC Environment........................................................................................................... 7
2.4.2 CGI/HTTP/Javascri t Environment ......................................................................................... 9
2.4.2.1 No Process Header (NPH) commands ...................................................................................... 11
2.4.2.2 Response on uccess ............................................................................................................... 12
2.4.2.3 Response on Failure.................................................................................................................. 12
2.4.2.4 Access Levels ............................................................................................................................ 14
2.4.3 Telnet Environment ............................................................................................................... 15
API FUNCTION REFERENCE......................................................................................16
3.1 UMMARY OF API F UNCTION ............................................................................16
3.2 API F UNCTION D E CRIPTION ..............................................................................17
add_ arameter ................................................................................................................................... 17
ft _images.......................................................................................................................................... 19
ft _stream_last_error ......................................................................................................................... 22
ft _stream_status............................................................................................................................... 24
ft _stream_sto ................................................................................................................................. 25
ft _stream_sto _all............................................................................................................................ 26
get ...................................................................................................................................................... 27
get_settings ........................................................................................................................................ 28
image.................................................................................................................................................. 29
load_settings ...................................................................................................................................... 31
tz_command..................................................................................................................................... 32
tz_ reset........................................................................................................................................... 33
ut_settings ........................................................................................................................................ 34
ut_settings_from_ ro erty ............................................................................................................... 35

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page iv Copyright 

 008
reset ................................................................................................................................................... 36
save_settings ..................................................................................................................................... 37
set....................................................................................................................................................... 38
start .................................................................................................................................................... 39
sto ..................................................................................................................................................... 40
strobe ................................................................................................................................................. 41
test_email_alarm................................................................................................................................ 42
ud _stream ........................................................................................................................................ 43
ud _stream_sto ............................................................................................................................... 45
ud _stream_sto _all.......................................................................................................................... 46
version................................................................................................................................................ 47
video................................................................................................................................................... 48
API PROPERTY REFERENCE.....................................................................................50
4.1 API P ROPERTY D E CRIPTION .............................................................................50
admin_ assword ................................................................................................................................ 50
alarm_delay........................................................................................................................................ 50
alarm_enable_email........................................................................................................................... 51
alarm_enable_ft ............................................................................................................................... 51
alarm_enable_ud ............................................................................................................................. 52
alarm_ft _framerate........................................................................................................................... 52
alarm_ft _ assive .............................................................................................................................. 53
alarm_ft _ assword........................................................................................................................... 53
alarm_ft _ ath ................................................................................................................................... 53
alarm_ft _ ost_trigger ....................................................................................................................... 53
alarm_ft _ re_trigger......................................................................................................................... 54
alarm_ft _server ................................................................................................................................ 54
alarm_ft _user ................................................................................................................................... 54
alarm_ud _client................................................................................................................................ 55
alarm_ud _ ort .................................................................................................................................. 55
analytics_alarm_enable ..................................................................................................................... 55
analytics_email_scri t ........................................................................................................................ 56
analytics_enable ................................................................................................................................ 56
analytics_view_select_model............................................................................................................. 56
a erture .............................................................................................................................................. 57
a erture_hw_max .............................................................................................................................. 57
a erture_hw_min ............................................................................................................................... 58
a erture_max ..................................................................................................................................... 58

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page v
a erture_min ...................................................................................................................................... 58
auto_algorithm ................................................................................................................................... 59
auto_height ........................................................................................................................................ 59
auto_j eg_quality ............................................................................................................................... 60
auto_width .......................................................................................................................................... 60
auto_window_enable ......................................................................................................................... 61
auto_x................................................................................................................................................. 61
auto_y................................................................................................................................................. 61
autoex osure ..................................................................................................................................... 62
autoex osure_knee............................................................................................................................ 62
autoex osure_target .......................................................................................................................... 63
autogain.............................................................................................................................................. 63
autogain_knee.................................................................................................................................... 64
autoiris................................................................................................................................................ 64
boot_version....................................................................................................................................... 65
brightness........................................................................................................................................... 65
color_conversion ................................................................................................................................ 65
color_ reset ....................................................................................................................................... 66
contrast............................................................................................................................................... 66
crosshair_enable................................................................................................................................ 66
current_broadcast_address ............................................................................................................... 66
current_fqdn ....................................................................................................................................... 67
current_gateway................................................................................................................................. 67
current_i ........................................................................................................................................... 67
current_nameserver ........................................................................................................................... 67
current_netmask ................................................................................................................................ 68
date .................................................................................................................................................... 68
date_utc.............................................................................................................................................. 68
daynight_bw_mode ............................................................................................................................ 68
daynight_gain_boost .......................................................................................................................... 69
daynight_gain_in_threshold ............................................................................................................... 69
daynight_gain_limit ............................................................................................................................ 69
daynight_gain_out_threshold ............................................................................................................. 70
daynight_mode................................................................................................................................... 70
default_image_ arams....................................................................................................................... 70
descri tion .......................................................................................................................................... 71
dhc _fallback ..................................................................................................................................... 71

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page vi Copyright 

 008
dhc _timeout...................................................................................................................................... 71
dns_domain_name............................................................................................................................. 71
edge_enhancement ........................................................................................................................... 72
ethaddr ............................................................................................................................................... 72
ex osure............................................................................................................................................. 72
ex osure_bias.................................................................................................................................... 73
focus................................................................................................................................................... 73
focus_max .......................................................................................................................................... 73
focus_min ........................................................................................................................................... 74
frame_buffer_enable .......................................................................................................................... 74
framerate ............................................................................................................................................ 74
gain..................................................................................................................................................... 74
gain_blue............................................................................................................................................ 75
gain_blue_max................................................................................................................................... 75
gain_blue_min.................................................................................................................................... 75
gain_green ......................................................................................................................................... 76
gain_green_max ................................................................................................................................ 76
gain_green_min ................................................................................................................................. 76
gain_red ............................................................................................................................................. 77
gain_red_max .................................................................................................................................... 77
gain_red_min ..................................................................................................................................... 77
gamma ............................................................................................................................................... 77
gateway .............................................................................................................................................. 78
h264_enable ...................................................................................................................................... 78
height.................................................................................................................................................. 78
imager_mono ..................................................................................................................................... 79
intensity .............................................................................................................................................. 79
io_in_alarm_enable............................................................................................................................ 79
io_in_debounce_time ......................................................................................................................... 80
io_in_trigger_edge ............................................................................................................................. 80
io_in_trigger_neg ............................................................................................................................... 80
i addr ................................................................................................................................................. 80
iris_ty e .............................................................................................................................................. 81
ir_shuttle_ osition .............................................................................................................................. 81
is_running........................................................................................................................................... 81
j eg_buffer_size................................................................................................................................. 81
j eg_quality ........................................................................................................................................ 82

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page vii
led....................................................................................................................................................... 82
lighting_frequency .............................................................................................................................. 82
link_local_i ........................................................................................................................................ 83
low_light_criteria ................................................................................................................................ 83
low_light_settings............................................................................................................................... 83
low_light_stable_duration................................................................................................................... 84
luminance ........................................................................................................................................... 84
MAC ................................................................................................................................................... 84
max_height......................................................................................................................................... 85
max_j eg_size ................................................................................................................................... 85
max_subsam le ................................................................................................................................. 85
max_width .......................................................................................................................................... 86
maximum_ex osure........................................................................................................................... 86
maximum_framerate .......................................................................................................................... 86
maximum_gain................................................................................................................................... 86
maximum_gain_limit .......................................................................................................................... 87
median_filter....................................................................................................................................... 87
mem_free ........................................................................................................................................... 87
min_j eg_size .................................................................................................................................... 87
minimum_ex osure............................................................................................................................ 88
motion_alarm_area ............................................................................................................................ 88
motion_alarm_enable......................................................................................................................... 88
motion_email_reci ient ...................................................................................................................... 89
motion_email_scri t ........................................................................................................................... 89
motion_email_server.......................................................................................................................... 90
motion_email_subject ........................................................................................................................ 90
motion_ga ........................................................................................................................................ 90
motion_ma ....................................................................................................................................... 91
motion_ma _height............................................................................................................................ 91
motion_ma _width ............................................................................................................................. 92
motion_ma _windowed ..................................................................................................................... 92
motion_sensitivity............................................................................................................................... 93
motion_ski ........................................................................................................................................ 93
motion_x............................................................................................................................................. 93
motion_y............................................................................................................................................. 94
name .................................................................................................................................................. 94
nameserver ........................................................................................................................................ 94

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page viii Copyright 

 008
netmask.............................................................................................................................................. 95
normal_light_criteria........................................................................................................................... 95
normal_light_settings ......................................................................................................................... 95
normal_light_stable_duration ............................................................................................................. 96
nt _servers......................................................................................................................................... 96
number_of_buffers ............................................................................................................................. 96
number_of_buffers_raw ..................................................................................................................... 97
out ut_select...................................................................................................................................... 97
rivacy_ma ....................................................................................................................................... 98
rivacy_ma _enable .......................................................................................................................... 98
rivacy_ma _height ........................................................................................................................... 99
rivacy_ma _width ............................................................................................................................ 99
rojected_network_bandwidth ........................................................................................................... 99
rojected_network_framerate .......................................................................................................... 100
tz_enable........................................................................................................................................ 100
tz_ rotocol...................................................................................................................................... 101
ram_size........................................................................................................................................... 101
raw_mode......................................................................................................................................... 101
rt _enable ........................................................................................................................................ 102
rt _framerate.................................................................................................................................... 102
rt _ acket_size ................................................................................................................................ 102
rt _ ort ............................................................................................................................................. 103
saturation.......................................................................................................................................... 103
saturation_bias................................................................................................................................. 103
serial_echo ....................................................................................................................................... 104
serial_flow ........................................................................................................................................ 104
serial_s eed..................................................................................................................................... 104
serial_use ......................................................................................................................................... 104
show_motion_detected .................................................................................................................... 105
show_motion_windows .................................................................................................................... 105
strobe_length ................................................................................................................................... 106
subsam led ...................................................................................................................................... 106
target_j eg_size............................................................................................................................... 106
telnetd............................................................................................................................................... 107
tem erature ...................................................................................................................................... 107
timezone........................................................................................................................................... 107
use_dhc .......................................................................................................................................... 108

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page ix
use_link_local................................................................................................................................... 108
user_ assword................................................................................................................................. 108
video_mode...................................................................................................................................... 109
watchdog_codec .............................................................................................................................. 109
watchdog_enable ............................................................................................................................. 110
watchdog_htt .................................................................................................................................. 110
watchdog_ ing ................................................................................................................................. 110
whitebalance .................................................................................................................................... 111
whitebalance_ reset ........................................................................................................................ 111
width ................................................................................................................................................. 111
x........................................................................................................................................................ 112
x_mirror ............................................................................................................................................ 112
y........................................................................................................................................................ 112
y_mirror ............................................................................................................................................ 113
APPENDIX: INTERPRETING EXIF HEADERS ..........................................................114
A1.1 G ENERAL INFORMATION ON EXIF HEADER FORMAT .........................................114
A1.2 D ETAILED EXAMPLE OF EXIF HEADER ............................................................114
GLOSSARY ................................................................................................................116

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page x Copyright 

 008
List of Tables
Table 2-1 URI Escape Code for pecial Characters .....................................................10
Table 2-2 Available Access Levels in Network Cameras...............................................14
Table 3-1 ummary of Camera API Functions ..............................................................16
Table 4-1 MakerNote Field Descriptions....................................................................115

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page 1
1
Introduction
1.1 The Lumenera Network Camera Family
The Lumenera Network camera Application Programming Interface (API)
provides tools for users to access and customize advanced functionality
governing a full suite of camera control and image processing features. A
Function and Property (API) Reference document is stored on every camera in
HTML format for viewing using a web browser. This manual provides additional
information on these functions and properties.
Lumenera Network Cameras provide high resolution images and are designed to
satisfy both general-purpose and high-end surveillance applications while
delivering outstanding image quality. The cameras use on-board JPEG
compression to deliver high quality images over a standard 10/100baseT Fast
Ethernet connection. Most models support Power over Ethernet (PoE). In video
surveillance applications, Lumenera cameras work with an extensive list of third-
party NVR/DVR software and hardware to provide complete video management
solutions. upport for different camera models is kept uniform using a common
Application Programming Interface to the greatest extent possible.
Lumenera’s product line is unique in its breadth, with resolutions ranging from
VGA to 11 megapixels along with a choice of several CMO and CCD image
sensors in both color and monochrome types. Most models use C/C - mount
lenses commonly found in CCTV and factory automation, and are available with
an integrated day/night filter option for use with active-infrared illumination. For
demanding applications such as low-light surveillance, traffic enforcement, and
industrial process monitoring, Lumenera provides high-sensitivity, low-noise
CCD’s with global shutter. Large-format models use off-the-shelf 35-mm
motorized lenses to provide exceptional image quality and sensitivity.
The Li-series intelligent cameras provide additional features including embedded
rules-based video content analysis, audio input and output, and analog video
output for use during camera installations..
The description of the Application Programming Interface (API) applies
specifically to firmware version 1.8.1. Extensions specific to the Li series
intelligent cameras refer to firmware version 2.3.1.

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page Copyright 

 008
1.2 Where To Find Documentation
All camera documentation can be found in the <Install Directory>\Documentation
folder. The documentation that is provided includes this manual, the Network
Camera User’s manual, camera Application Notes and White Papers.
To obtain the latest software release, Application Notes, answers to Frequently
Asked Questions (FAQs), Knowledge Base access and other technical
information please visit our website at:
www.lumenera.com
Note: A user name and password is required to access the Knowledge Base. If
you do not yet have one, or require a new one, please send an email to
[e-mail] to receive a new password.
1. Technical Assistance
If you need assistance with the installation or use of the software, or, if you need
help with general camera operation, please contact the Technical Assistance
Centre (TAC) via email at:
[e-mail]
or by phone at [phone] (press 1 from the auto attendant).
To obtain the latest software release and other technical information you may
visit our technical support website at:
http://www.lumenera.com/support/index.php
Our support website contains technical information available to the general public
such as Frequently Asked Questions (FAQ’s). For our Lumenera customers we
provide a Knowledge Base with more product specific solutions and a Download
Centre for customers to obtain the most recent software releases.
As a customer, you will need to provide the TAC with some basic information to
gain access to the customer Knowledge Base and the Download Centre. Please
provide the following details via email to [e-mail] to obtain a user
name and password:
Your name, Company Name, address and telephone number
Your camera model and serial number
Your purchase information (e.g. did you purchase from an OEM or distributor?)
Upon providing the above information, you will receive your access information
via email from a TAC representative.

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page 3
2
Network Camera API
2.1 The Lumenera Network Camera API
The API supports several functions that initiate tasks such as the transmission of
images or saving settings on the camera. In addition, the API includes properties
governing all camera settings (e.g. autoexposure, autogain) that can be altered
using the set function and queried using the get function.
Entering the IP address of any accessible camera in a web browser allows the
user to adjust most of the camera functions embodied in this API using a
graphical user interface (GUI). The complete set of API commands and settings
can be issued by entering an appropriate URL in a web browser or through
various console interfaces such as a Telnet session or a serial connection the
camera’s R 232 interface.
For custom applications, the API commands can be applied programmatically.
Access the camera by using either the Visual Basic or C++ XML-RPC libraries
provided on the Network Camera’s installation CD-ROM, by using either Java or
Python scripts or by using the HttpWebRequest class in C#.NET. imple
examples using many of these languages are provided on the CD-ROM provided
as part of the Lumenera Network camera DK.
The API includes an optional administrator’s (admin) password that grants full
access to all functions and settings available on the Network camera. In addition,
one may set a user password that grants access only to video, single images, the
firmware version information or simple queries using the get function.
ome of the more advanced camera features that are available using the API
include the ability to configure the JPEG quality settings and the on-board image
buffer. Using the video command, it is possible to request pre-event images
from the on-camera memory. The camera can also transfer pre- and post-event
images to an FTP server for a user-selected duration. The image file transfer
using FTP can be initiated by a client. Alternatively, the FTP session can begin
automatically upon an alarm. This alarm can be triggered by the camera’s built-in
video motion detection or by a signal received on the GPIO input port of the
camera.

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page 4 Copyright 

 008
The Network Camera API provides a full set of functions and properties that
allows one to completely control and configure the camera based on your
application needs.
2.2 Camera Features And Settings
The Lumenera Network cameras provide many features that can be applied to
any application environment to achieve the best image with the best data quality
available. A list of features supported by Lumenera Network Cameras follows.
• Auto Brightness Control (ABC)
• Autogain or fixed gain control
• Autoexposure or fixed exposure control
• 60 Hz / 50 Hz lighting synchronization
• Configurable ABC iris, gain, & exposure knee points
• Autoiris enable or disable
• 4-wire DC autoiris on C -mount models:
Le075, Le165, Le175, Le275, & Le375
• Configurable brightness targets
• Four histogram-based ABC algorithms
o Average (default)
o Median
o Peak detect (regulate only on brightest areas)
o Dark detect (regulate only on darkest areas)
• White balance
o Continuous auto white balance
o ingle shot white balance
o User-defined AutoWindow selection
• Defines region of interest for white balance and Auto Brightness Control
(ABC)
• EF-mount (Canon) LR lens control:
o For large-format models Le259C & Le11059C
o Remote control of focus
o Autoiris or user-specified aperture

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page 5
• Image processing
o aturation (monochrome through to bright color)
o Contrast
o harpening
o Brightness
• Light source color temperature corrections with color gain limits
o Default
o Daylight
o Fluorescent
o Halogen
o Wide
• Gamma (mid-tone brightness)
• JPEG quality
• Frame rate transmitted over the network
• Number of buffers (images) in on-camera memory
• Geometry (Region of Interest)
o Configurable width, height, and location
o ubsampling (decimation) and/or binning
o Horizontal (x-mirror) or vertical (y-flip) image flip
• Privacy map – blocks private areas from view
• Day/Night functions
o With ‘-DN’ option, infrared-cut filter switches to infrared-transparent
glass in low light
o Define day/night thresholds based on exposure, gain, and/or
luminance properties.
• Alarms
o Video motion detection in specific checkerboard areas, a.k.a. the
motion map, can generate an alarm
o Alarm input signal can be detected on the optically isolated dry-
contact GPIO input
o Email notification on alarm
o FTP image transfer to a specified server on alarm, including pre-
alarm images.

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page 6 Copyright 

 008
o UDP alarm notification to a specified client
o User can edit Linux script to perform other functions upon alarms
• tatic or dynamic IP settings
• Date/time/time zone settings
o Can specify one or more NTP (Network Time Protocol) servers
• Passwords
o Admin (full rights)
o User (view images and simple queries)
• Enable/disable telnet daemon
• Enable/disable serial console (R 232 port)
• Watchdogs – periodic built-in self tests
• Firmware upgrade through web browser interface
• Reset default image settings
• ave user settings to camera memory
• Reboot camera
Many of these functions are accessible through the camera’s web interface. All of
them are accessible through the camera’s API interface. ubsequent sections of
this manual explain how to access and control these features through the API.
The Lumenera Network Camera User’s manual explains how these features can
be accessed through the camera’s web interface.
2. Supported Network Protocols
Communication to the Network camera can be done using several standard
Ethernet/Network based protocols. ome of the standard protocols supported by
the camera include:
TCP/IP: Transmission Control Protocol/Internet Protocol suite, used for
command and control of the camera programmatically
FTP (client only): File Transfer Protocol, used for transferring image data from
the camera to an FTP server using either a FTP client application or
programmatically
XML-RPC: eXtensible Markup Language – Remote Procedure Call, used for
command and control of the camera programmatically

Lumenera Network Camera
API Reference Manual Release 1.8.1
Copyright 

 008 Page 7
HTTP: HyperText Transfer Protocol, used for transferring image data from the
camera using either a web browser, media player, or a custom application
programmatically
CGI: Common Gateway Interface, used for command and control of the camera
using external application software such as web browsers or media players.
Telnet: TELecommunication NETwork protocol, used for command and control of
the camera
UDP: User Datagram Protocol, used for streaming image data with higher
throughput. The trade-off compared to TCP/IP is that receipt of all packets is not
guaranteed.
ARP: Address Resolution Protocol, used for finding and resolving network
addresses
DHCP: Dynamic Host Control Protocol, used to get camera’s IP, gateway, subnet
mask and DN servers.
DN : Domain Name ystem, used to translate domain names, email servers and
other information into addresses
MTP (client only): imple Mail Transfer Protocol, used to transmit emails from
the camera (used for alarm notification)
ICMP: Internet Control Message Protocol, used for ping requests and error
messages
Zeroconf: ZERO CONFiguration networking, used to setup a quick, simple
network without the need for additional network servers
2.4 Programming Interfaces
Accessing the Network camera’s API functions and properties is accomplished
through any of the following interfaces:
XML-RPC (see ection 2.4.1 for more details)
CGI/HTTP/Javascript (see ection 2.4.2 for more details)
Telnet (see ection 2.4.3 for more details)
The following sections will describe how to access the camera’s functions and
properties within their respective interface.
.4.1 XML-RPC Environment
XML-RPC is a form of remote procedure calls that can be done over the Internet
using XML as an encoding format for the requests. An XML-RPC message
request is an HTTP-PO T request where the body of the request is an XML

Lumenera Network Camera
Release 1.8.1 API Reference Manual
Page 8 Copyright 

 008
formatted message. More information about XML-RPC can be found at
www.xmlrpc.com.
All Network camera functions can be accessed through the XML-RPC library. All
camera API functions are prefixed with “le.” when accessed through this
interface. They communicate through port 80 using the camera’s RPC interface
URI (Uniform Resource Identifier).
The Network Camera DK installation CD-ROM includes a XML-RPC library,
called XML-RPC++, that can be used in a Microsoft Windows based application.
An example of an XML-RPC request using this library is shown below. This
example queries the camera for the type of imager used.
BOOL GetImagerType(CStringA *csImager)
XmlRpcValue args;
XmlRpcValue result;
CStringA csCommand;
CString csDebug;
BOOL bReturn = TRUE;
CHAR *pcBuffer;
XmlRpcClient *xmlClient;
xmlClient = new XmlRpcClient(“192.168.2.24”, 80, "/cgi-
bin/rpc");
if (xmlClient != NULL)
// Need to add 1 for '\0' at the end of the string
pcBuffer = new CHAR [20];
// setup function arguments
strcpy_s(pcBuffer, 20, "imager_type");
args[0] = XmlRpcValue(pcBuffer);
// setup function command
pcBuffer = new CHAR [10];
strcpy_s(pcBuffer, 10, "le.gets");
if(!xmlClient->execute(pcBuffer, args, result))
bReturn = FALSE;
}
// copy return information into function arguments
provided
*csImager = static_cast<std::string>(result).c_str();