1. Manuals
  2. Brands
  3. Lumenera Manuals
  4. Security Camera
  5. Network Camera
  6. Reference manual

Lumenera Network Camera Reference Manual

Api reference manual
Hide thumbs Also See for Network Camera:
Table of Contents

Advertisement

Quick Links

See also: User Manual
Lumenera Network Camera
API Reference Manual
Release 1.8.1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Network Camera and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Lumenera Network Camera

Summary of Contents for Lumenera Network Camera

  • Page 1 Lumenera Network Camera API Reference Manual Release 1.8.1...
  • Page 3 The Software 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 Software provided that the Software is used only in conjunction with Lumenera's family of products.
  • Page 4 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.

  • Page 5: Table Of Contents

    API Reference Manual Release 1.8.1 Table of Contents INTRODUCTION ......................1 ............1 UMENERA ETWORK AMERA AMILY ................2 HERE OCUMENTATION ..................2 ECHNICAL SSISTANCE NETWORK CAMERA API ....................3 API ...............3 UMENERA ETWORK AMERA ..............4 AMERA EATURES ETTINGS ..............6 UPPORTED ETWORK ROTOCOLS .................7 ROGRAMMING NTERFACES 2.4.1...
  • Page 6 Lumenera Network Camera Release 1.8.1 API Reference Manual reset ..............................36 save_settings ............................. 37 set............................... 38 start ..............................39 stop..............................40 strobe ..............................41 test_email_alarm..........................42 udp_stream ............................43 udp_stream_stop ..........................45 udp_stream_stop_all.......................... 46 version..............................47 video..............................48 API PROPERTY REFERENCE..................50 API P ................50...
  • Page 7 Lumenera Network Camera API Reference Manual Release 1.8.1 aperture_min ............................58 auto_algorithm ........................... 59 auto_height ............................59 auto_jpeg_quality ..........................60 auto_width ............................60 auto_window_enable ......................... 61 auto_x..............................61 auto_y..............................61 autoexposure ............................. 62 autoexposure_knee..........................62 autoexposure_target .......................... 63 autogain.............................. 63 autogain_knee............................
  • Page 8 Lumenera Network Camera Release 1.8.1 API Reference Manual dhcp_timeout............................71 dns_domain_name..........................71 edge_enhancement ........................... 72 ethaddr ............................... 72 exposure............................. 72 exposure_bias ............................ 73 focus..............................73 focus_max ............................73 focus_min ............................74 frame_buffer_enable .......................... 74 framerate ............................74 gain..............................74 gain_blue............................75 gain_blue_max ...........................
  • Page 9 Lumenera Network Camera API Reference Manual Release 1.8.1 led............................... 82 lighting_frequency ..........................82 link_local_ip............................83 low_light_criteria ..........................83 low_light_settings ..........................83 low_light_stable_duration........................84 luminance ............................84 MAC ..............................84 max_height............................85 max_jpeg_size ........................... 85 max_subsample ..........................85 max_width ............................86 maximum_exposure...........................
  • Page 10 Lumenera Network Camera Release 1.8.1 API Reference Manual netmask.............................. 95 normal_light_criteria........................... 95 normal_light_settings ......................... 95 normal_light_stable_duration ......................96 ntp_servers............................96 number_of_buffers ..........................96 number_of_buffers_raw ........................97 output_select ............................97 privacy_map ............................98 privacy_map_enable .......................... 98 privacy_map_height ........................... 99 privacy_map_width ..........................99 projected_network_bandwidth ......................
  • Page 11 Lumenera Network Camera API Reference Manual Release 1.8.1 use_link_local........................... 108 user_password ..........................108 video_mode............................109 watchdog_codec ..........................109 watchdog_enable ..........................110 watchdog_http ..........................110 watchdog_ping ..........................110 whitebalance ............................ 111 whitebalance_preset ........................111 width ..............................111 x................................ 112 x_mirror ............................112 y................................
  • Page 12 Lumenera Network Camera Release 1.8.1 API Reference Manual List of Tables Table 2-1 URI Escape Code for Special Characters .............10 Table 2-2 Available Access Levels in Network Cameras..........14 Table 3-1 Summary of Camera API Functions ..............16 Table 4-1 MakerNote Field Descriptions..............115 Page x Copyright ...

  • Page 13: Introduction

    Support 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 CMOS and CCD image sensors in both color and monochrome types.

  • Page 14: 1.2 Where To Find Documentation

    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 support@lumenera.com to obtain a user name and password:...

  • Page 15: Network Camera Api

    Lumenera Network camera SDK. 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.

  • Page 16: 2.2 Camera Features And Settings

    Lumenera Network Camera Release 1.8.1 API Reference Manual 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...
  • Page 17 Lumenera Network Camera API Reference Manual Release 1.8.1 • Image processing o Saturation (monochrome through to bright color) o Contrast o Sharpening o Brightness • Light source color temperature corrections with color gain limits o Default o Daylight o Fluorescent...

  • Page 18: 2.3 Supported Network Protocols

    API interface. Subsequent 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.

  • Page 19: 2.4 Programming Interfaces

    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 Section 2.4.1 for more details) CGI/HTTP/Javascript (see Section 2.4.2 for more details)
  • Page 20 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).

  • Page 21: 2.4.2 Cgi/Http/Javascript Environment

    CGI, HTTP and Javascript environments all use the same protocol for accessing the Network camera API. The protocol used is HTTP on port 80 using the GET method, the same method that a web browser uses to access a web page. For a description of the CGI standard see http://hoohoo.ncsa.uiuc.edu/cgi/.

  • Page 22: Table 2-1 Uri Escape Code For Special Characters

    Lumenera Network Camera Release 1.8.1 API Reference Manual Table 2-1 URI Escape Code for Special Characters Character Character Escape Escape Code Code SPACE & < > Below are some examples of how to access the camera’s API interface. Where indicated, replace “CamIP” with the camera IP address (e.g. 192.168.2.89) or the DNS name of the camera.

  • Page 23: 2.4.2.1 No Process Header (Nph) Commands

    Lumenera Network Camera API Reference Manual Release 1.8.1 All camera properties use the get and set camera API functions. Below are some examples of how these properties can be accessed: Set fixed gain and exposure: http://CamIP/cgi-bin/set?gain=1&exposure=10 Enable auto-brightness: http://CamIP/cgi-bin/set?autogain=1&autoexposure=1 Enable automatic white balance:...

  • Page 24: 2.4.2.2 Response On Success

    (if any), and a hyperlink to the index page of the camera. Example: query firmware version http://CamIP/cgi-bin/version Return value: Lumenera/explorer2 r5281 hw1.1 1.8.0.10 : le075c-dn -- Fri, 21 Sep 2007 13:31:21 -0400 Success template response: <html> <head>...
  • Page 25 Lumenera Network Camera API Reference Manual Release 1.8.1 Example: get a non-existent API property http://CamIP/cgi-bin/get?foo Failure template response: <html> <head><title>Error</title> <!-- CAMERA ERROR 3 Invalid Argument property=foo: . ctl.c:265 --> </head> <body> get produced error: <pre id=error> Invalid Argument property=foo: . ctl.c:265 </pre>...

  • Page 26: 2.4.2.4 Access Levels

    Lumenera Network Camera Release 1.8.1 API Reference Manual 2.4.2.4 Access Levels Lumenera Network cameras support three levels of access, as shown below. Table 2-2 Available Access Levels in Network Cameras Login Password Privileges CGI path Webserver port in API property in API...

  • Page 27: 2.4.3 Telnet Environment

    Lumenera Network Camera API Reference Manual Release 1.8.1 2.4.3 Telnet Environment The telnet client establishes a TCP connection typically on port 23. It can be used to establish a connection to the camera to change camera settings, run camera functions or get the camera status.

  • Page 28: Api Function Reference

    Lumenera Network Camera Release 1.8.1 API Reference Manual API Function Reference 3.1 Summary of API Functions Table 3-1 provides a quick summary of the camera API functions supported for the Network cameras. Not all functions listed below will be supported for every...

  • Page 29: 3.2 Api Function Description

    Lumenera Network Camera API Reference Manual Release 1.8.1 Function Description start Starts the image processing pipeline stop Stops the image processing pipeline strobe Causes a single strobe pulse on the GPIO output subimage_yuv Transfers a sub-image in Abekas YUV format...
  • Page 30 Lumenera Network Camera Release 1.8.1 API Reference Manual Example CGI: /cgi-bin/add_parameter?name=MyProperty&value=MyValue Telnet: l add_parameter name=MyProperty value=MyValue Page 18 Copyright     2008...

  • Page 31: Ftp_Images

    Lumenera Network Camera API Reference Manual Release 1.8.1 ftp_images Transfers an image or a stream of JPEG images to an FTP server. Arguments string server The server name or IP address string path Relative or absolute file path on the FTP server in which image(s) will be stored.
  • Page 32 Lumenera Network Camera Release 1.8.1 API Reference Manual <optional> string ref_date Date and time for the requested index frame (image number 0) to a precision of seconds. The camera will send images beginning with the most recent image still in the buffer that was captured prior to the requested time.
  • Page 33 Lumenera Network Camera API Reference Manual Release 1.8.1 1E+20. ftp_stream_stop commands will not work if async=0. To stop streaming when async=0, close the associated pipe. Any of the arguments that contain special characters or spaces must be URL encoded. This usually applies only to the path. The password may also be affected.

  • Page 34: Ftp_Stream_Last_Error

    Lumenera Network Camera Release 1.8.1 API Reference Manual ftp_stream_last_error Returns the last error, if any, from an ftp_images stream. The stream does not need to be running to get this error. Arguments string session Session name. For an alarm FTP session, use 'alarm' for this argument.
  • Page 35 Lumenera Network Camera API Reference Manual Release 1.8.1 Telnet: l ftp_stream_last_error session=alarm Copyright     2008 Page 23...

  • Page 36: Ftp_Stream_Status

    Lumenera Network Camera Release 1.8.1 API Reference Manual ftp_stream_status Returns the status of the FTP stream. Arguments string session Session name. For an alarm FTP session, use 'alarm' for this argument. Return Values Returns a boolean on success where a value of 1 states that the asynchronous stream is running.

  • Page 37: Ftp_Stream_Stop

    Lumenera Network Camera API Reference Manual Release 1.8.1 ftp_stream_stop Stops an FTP stream. Arguments <optional> string session Session name. The default session name is noname. For an alarm FTP session, use 'alarm' for this argument. Return Values Returns nothing on success. Throws a fault on error.

  • Page 38: Ftp_Stream_Stop_All

    Lumenera Network Camera Release 1.8.1 API Reference Manual ftp_stream_stop_all Stops all FTP streams. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes If you call ftp_stream_stop_all, calls to ftp_images started and still running in a Telnet session will exit with the message Terminated or Killed echoed on the console.

  • Page 39: Get

    Lumenera Network Camera API Reference Manual Release 1.8.1 Returns the value of a specified property. Arguments string property_name Valid property name Return Values On success, returns the value of the property. Throws a fault on error. Notes None. Examples CGI:...

  • Page 40: Get_Settings

    Notes The entire table of delimited settings is issued twice following the standard format of templates/success.tmpl, once in the <--LUMENERA --> tag and again in the body of the HTML. Only property values that are saved in the configuration database will be returned.

  • Page 41: Image

    Lumenera Network Camera API Reference Manual Release 1.8.1 image Transfers a single image in JPEG format. Arguments <optional> int number Specifies the image in the rolling buffer to be returned where 1 corresponds to the most recent image in the buffer.
  • Page 42 Lumenera Network Camera Release 1.8.1 API Reference Manual Example CGI: /cgi-bin/nph-image.jpg Telnet: l image Page 30 Copyright     2008...

  • Page 43: Load_Settings

    Lumenera Network Camera API Reference Manual Release 1.8.1 load_settings Loads camera settings from a file in non-volatile memory. Arguments filename <optional> string Filename of saved settings file. { default: persistent } Return Values Returns nothing on success. Throws a fault on error.

  • Page 44: Ptz_Command

    Applies only to Pan Tilt Zoom (PTZ) systems that use the camera’s RS232 serial port to interface the network camera to a pan-tilt motor and a motorized zoom lens. Calling ptz_command sends a command to a PTZ controller board via the camera’s RS232 serial port.

  • Page 45: Ptz_Preset

    Applies only to Pan Tilt Zoom (PTZ) systems that use the camera’s RS232 serial port to interface the network camera to a pan-tilt motor and a motorized zoom lens. Calling ptz_preset sends a command to a PTZ controller board via the camera’s RS232 serial port.

  • Page 46: Put_Settings

    Lumenera Network Camera Release 1.8.1 API Reference Manual put_settings Sets multiple properties in a single function call. This function has the same effect as calling the set API function multiple times for each property or with multiple property-value pairs. Each property-value pair must be separated from the next pair by the user-defined delimiter.

  • Page 47: Put_Settings_From_Property

    Lumenera Network Camera API Reference Manual Release 1.8.1 put_settings_from_property Sets multiple properties from a given property. Similar to the put_settings API function, this function sets multiple properties in a single function call. It retrieves the value from an existing property and applies it to multiple properties.

  • Page 48: Copyright

    Lumenera Network Camera Release 1.8.1 API Reference Manual reset Reboots the camera. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes The camera will be unresponsive for approximately 30 seconds until it has finished booting.

  • Page 49: Save_Settings

    Lumenera Network Camera API Reference Manual Release 1.8.1 save_settings Saves the current camera settings to non-volatile memory. The settings may be saved to a user-defined filename so that they may be reloaded via load_settings, or the default filename 'persistent' may be used. The special filename 'persistent' defines the set that will be automatically loaded by the camera when rebooted.

  • Page 50: Set

    Lumenera Network Camera Release 1.8.1 API Reference Manual Set the value of a particular property. Arguments string property Existing property name <based on property> value Value of the same data type as the property. Return Values Returns nothing on success. Throws a fault on error.

  • Page 51: Start

    Lumenera Network Camera API Reference Manual Release 1.8.1 start Starts the image processing pipeline on the camera. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes The start command is disruptive to normal camera operations. Use of the start command is not recommended.

  • Page 52: Stop

    Lumenera Network Camera Release 1.8.1 API Reference Manual stop Stops the image processing pipeline in the camera. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes The stop command is disruptive to normal camera operations. Use of the stop command is NOT recommended.

  • Page 53: Strobe

    Lumenera Network Camera API Reference Manual Release 1.8.1 strobe Causes a single analog pulse to occur on the GPIO output. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes The property output_select must be set to 'on' for this function to work correctly.

  • Page 54: Test_Email_Alarm

    Lumenera Network Camera Release 1.8.1 API Reference Manual test_email_alarm Unconditionally execute the motion_email_script. This will force a motion alarm type email message to be generated and sent to the assigned email address. Arguments None. Return Values Returns an int value on success. Throws a fault on error.

  • Page 55: Udp_Stream

    Lumenera Network Camera API Reference Manual Release 1.8.1 udp_stream Transfers an image or a stream of JPEG images to a UDP client. Arguments string client Client name or IP address. port Client port address. <optional> int The image number for the last image to transfer from the rolling buffer. If start is 0, this value corresponds to the number of images to transfer.
  • Page 56 Lumenera Network Camera Release 1.8.1 API Reference Manual Image sequence number: Specifies the frame number from the camera. Packet position/image offset: Location of this packet in the image in bytes. For example, a packet position of X means this packet should be inserted into the image at the Xth byte of the image.

  • Page 57: Udp_Stream_Stop

    Lumenera Network Camera API Reference Manual Release 1.8.1 udp_stream_stop Stops a UDP stream. Arguments string client The client name or address. port The client port. Return Values Returns nothing on success. Throws a fault on error. Notes None. Example CGI: /cgi-bin/udp_stream_stop?client=123.123.123.123&port=...

  • Page 58: Udp_Stream_Stop_All

    Lumenera Network Camera Release 1.8.1 API Reference Manual udp_stream_stop_all Stops all open UDP streams. Arguments None. Return Values Returns nothing on success. Throws a fault on error. Notes None. Examples CGI: /cgi-bin/udp_stream_stop_all Telnet: l udp_stream_stop_all Page 46 Copyright     2008...

  • Page 59: Version

    Notes None. Examples CGI: /cgi-bin/version Telnet: l version Sample Output Lumenera/explorer2 r5565 hw1.2 1.8.0.16 : le165c-dn -- Mon, 24 Dec 2007 12:31:56 -0500 Indicates the camera type Lumenera/explorer2 Firmware build number r5565 Hardware version, “hw1.3” indicates extended RAM hw1.2 1.8.0.16 Firmware version is the major version of firmware.

  • Page 60: Video

    Lumenera Network Camera Release 1.8.1 API Reference Manual video Transfers a stream of images in JPEG format. Optional Arguments <optional> string type Stream type. Two options available - multipart/mixed is used for older versions of the firmware, multipart/x-mixed-replace is used for newer versions and is more compatible with third party software.
  • Page 61 Lumenera Network Camera API Reference Manual Release 1.8.1 Return Values Returns a binary JPEG image data on success. Throws a fault on error. Notes Local storage of Motion JPEG binary data in the camera file system is not recommended. The Telnet example that follows is for test purposes only.

  • Page 62: Api Property Reference

    Lumenera Network Camera Release 1.8.1 API Reference Manual API Property Reference 4.1 API Property Description This section describes all of the camera’s API properties and how to use them. admin_password Type string Description Access to the administrator password for the camera. This property can be used to set the password.

  • Page 63: Alarm_Enable_Email

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Defines the delay time between alarms in seconds. Alarm notifications will not occur more frequently than once every alarm_delay seconds. For the Le series cameras, alarm_delay is the time in seconds between alarms due to a signal on the general-purpose dry-contact input or a motion alarm defined using the motion_map.

  • Page 64: Alarm_Enable_Udp

    Lumenera Network Camera Release 1.8.1 API Reference Manual alarm_enable_udp Type boolean Description Enable and disable alarm notifications via UDP. Alarm events can result from general-purpose hardware input, a motion alarm defined using the motion_map (Le series cameras), or a video analytics alarm event (Li series cameras).

  • Page 65: Alarm_Ftp_Passive

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note If this property is larger than the camera's current frame rate, images will be transferred as fast as possible assuming sufficient network bandwidth is available. alarm_ftp_passive Type boolean Description Accesses the FTP mode used by the camera to stream images to the FTP server on an alarm trigger.

  • Page 66: Alarm_Ftp_Pre_Trigger

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Duration in seconds of images occurring after an alarm event that will be transferred after an alarm is triggered. alarm_ftp_pre_trigger Type double Description Duration in seconds of images occurring before an alarm event that will be transferred when triggered.

  • Page 67: Alarm_Udp_Client

    Lumenera Network Camera API Reference Manual Release 1.8.1 alarm_udp_client Type string Description A comma-separated list of the target client IP addresses that receive UDP alarm packets. Note If the broadcast address for the subnet is specified, alarms will be broadcast.

  • Page 68: Analytics_Email_Script

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note Applies only to the Intelligent (Li series) cameras. analytics_email_script Type string Description Defines the script that is executed when an object video alarm is detected. The default value of this script uses the additional parameters motion_email_subject, motion_email_server, motion_email_recipient and alarm_delay to create and send an email message when object video alarm is detected.

  • Page 69: Aperture

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note Possible values include: Auto-Acquire Mode: This is the default value. When set, the analytics algorithm will take the current scene as the view for event detection. The algorithm will automatically adjust to a new scene as the view if/when the scene changes.

  • Page 70: Aperture_Hw_Min

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note This property applies only to camera models that use a Canon 35 mm lens with iris_type property set to calibrated. aperture_hw_min Type double, read only Description The hardware-imposed lower limit on the aperture property, used to accommodate different lens types and is expressed as an f-number between 2.8...

  • Page 71: Auto_Algorithm

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description The user-defined lower limit on the aperture property. This property can be read or set to a minimum aperture of the iris and is expressed as an f-number between 2.8 (most open) and 32 (most closed).

  • Page 72: Auto_Jpeg_Quality

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Height of the auto control window. Note The auto control window defines the area that is used by the auto_algorithm method when applying autoexposure, autogain and whitebalance. The auto control window is defined relative to the current viewing window. This window is defined by height, width, x, and y.

  • Page 73: Auto_Window_Enable

    Lumenera Network Camera API Reference Manual Release 1.8.1 auto_window_enable Type boolean Description Enables or disables the use of a ROI for calculating the value for the auto_algorithm. Note When set, the auto_x, auto_y, auto_width and auto_height properties are used to define the region of interest (ROI) that is used by the auto_algorithm to calculate the luminance and whitebalance values.

  • Page 74: Autoexposure

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Vertical offset of the auto control window from the bottom edge of the current viewing window. Note The auto control window defines the area that is used by the auto_algorithm method when applying autoexposure, autogain and whitebalance. The auto control window is defined relative to the current viewing window.

  • Page 75: Autoexposure_Target

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Defines an exposure value where the auto_algorithm will stop adjusting the exposure and starts adjusting the gain value until both the autoexposure_knee and autogain_knee points are reached. Note If both autoexposure and autogain are set, the camera will achieve the autoexposure_target by adjusting either exposure or gain.

  • Page 76: Autogain_Knee

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Enable or disable autogain functionality. Note When disabled, the gain value is strictly controlled by the value of the gain property. When enabled, the camera adjusts the gain to match the requested luminance set by the autoexposure_target value using the currently specified auto_algorithm algorithm.

  • Page 77: Boot_Version

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Enable or disable the auto iris functionality. Note When set and when the exposure value begins to drop below the minimum_exposure value, the camera reduces the lens aperture to achieve the requested luminance specified by autoexposure_target.

  • Page 78: Color_Preset

    Lumenera Network Camera Release 1.8.1 API Reference Manual color_preset Type string Description Specifies the color correction matrix to be applied after color gains and whitebalance are applied. Available values are unity, default, chip_default, fluorescent, daylight, xenon_flash and halogen. contrast Type...

  • Page 79: Current_Fqdn

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Provides the camera's current broadcast address. current_fqdn Type string, read-only Description Provides the fully qualified domain name. Note If both name and dns_domain_name properties are set and the camera has been rebooted so that these properties have taken effect, then this value is simply name.dns_domain_name.

  • Page 80: Current_Netmask

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Provides the nameserver assigned to the camera. current_netmask Type string, read-only Description Provides the IP subnet mask assigned to the camera. date Type string Description Accesses the camera’s current date in RFC 2822 format.

  • Page 81: Daynight_Gain_Boost

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note Applies only to the Le045 and Intelligent (Li series) cameras. daynight_gain_boost Type boolean Description If true, the camera will boost gain by 6dB during night mode operation. Note Applies only to the Le045 and Intelligent (Li series) cameras.

  • Page 82: Daynight_Gain_Out_Threshold

    Lumenera Network Camera Release 1.8.1 API Reference Manual daynight_gain_out_threshold Type double Description The gain level at which the camera gets out of night mode when daynight_mode is set to "auto". This has to be less than daynight_gain_in_threshold. Note A positive value will brighten the image and negative value will darken the image.

  • Page 83: Description

    Lumenera Network Camera API Reference Manual Release 1.8.1 description Type string Description Provides a string describing the camera. By default, the contents describe the camera model and MAC address. This property can be changed to provide a more descriptive string for a specific application.

  • Page 84: Edge_Enhancement

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description DNS domain name used by the camera. Note If this property is a null string, then the fully qualified domain name (current_fqdn) is determined dynamically by looking up the camera name in the DNS server (nameserver).

  • Page 85: Exposure_Bias

    Lumenera Network Camera API Reference Manual Release 1.8.1 closer to the autoexposure_target value. Not supported by Le045 and Intelligent (Li series) cameras. exposure_bias Type Description This parameter is the offset to the automatic system gain using a value between -18 and 18.

  • Page 86: Focus_Min

    Lumenera Network Camera Release 1.8.1 API Reference Manual focus_min Type Description Provides the minimum value of focus property. Note This property applies only to camera models that use a Canon 35 mm lens. frame_buffer_enable Type boolean Description Enable or disable analog video output.

  • Page 87: Gain_Blue

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Accesses the camera’s gain property. Note Increasing the gain increases the luminance, which can help in low light conditions; however, a higher gain also substantially increases the noise in the image. Image compression is greatly and negatively affected by noisy images. It is recommended that this property be kept as low as possible.

  • Page 88: Gain_Green

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Provides the minimum gain_blue value. This property can be set directly or by using the whitebalance_preset property. Not supported by Le045 and Intelligent (Li series) cameras. gain_green Type double Description Provides manual control of the green channel gain. This property is used to color/white balance the image and is adjusted when the whitebalance property is set.

  • Page 89: Gain_Red

    Lumenera Network Camera API Reference Manual Release 1.8.1 gain_red Type double Description Provides manual control of the red channel gain. This property is used to color/white balance the image and is adjusted when the whitebalance property is set. Not supported by Le045 and Intelligent (Li series) cameras.

  • Page 90: Gateway

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note The value range for this property is from 0.01 to 100, where a suitable value for this property is around 1.4 gateway Type string Description Provides the gateway the camera will use on the next reboot when DHCP is disabled.

  • Page 91: Imager_Mono

    Lumenera Network Camera API Reference Manual Release 1.8.1 Immediately after a change in the image geometry (x, y, width, and/or height), wait at least 2*(1/framerate) or a subsequent image call may fail with an error. imager_mono Type boolean, read-only Description Provides the imager type used by the camera.

  • Page 92: Io_In_Debounce_Time

    Lumenera Network Camera Release 1.8.1 API Reference Manual io_in_debounce_time Type Description GPIO input debounce time value in units of milliseconds. io_in_trigger_edge Type boolean Description Reads and sets the trigger mode the GPIO input. It can be set to trigger on a rising/falling edge or a voltage level.

  • Page 93: Iris_Type

    Lumenera Network Camera API Reference Manual Release 1.8.1 iris_type Type string Description Describes the type of iris that is installed on the camera. Values for this property are none, dc, and calibrated. Note When set to calibrated, the aperture property value is limited by aperture_min and aperture_max.

  • Page 94: Jpeg_Quality

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Provides the maximum size of each image in the rolling buffer. This value is inversely proportional to number_of_buffers value. jpeg_quality Type double Description Specifies the JPEG quality level using a value between 0.2 and 99.

  • Page 95: Link_Local_Ip

    Lumenera Network Camera API Reference Manual Release 1.8.1 should be set to 60. For 50Hz electrical power such as Europe, set it to 50. For all DC light sources such as sunlight, set this property to 0. link_local_ip Type string Description Provides the link-local IP address that will be used when use_link_local=1.

  • Page 96: Low_Light_Stable_Duration

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Describes a set of properties and values that are applied when the camera switches to night mode. Note The settings are provided as a semicolon separated list. The camera uses low_light_criteria and low_light_stable_duration to determine when to switch to night mode.

  • Page 97: Max_Height

    Lumenera Network Camera API Reference Manual Release 1.8.1 max_height Type int, read-only Description Provides the maximum height supported by the imager in the camera. max_jpeg_size Type Description Defines the maximum JPEG image size that should be used by the camera when compressing the video images.

  • Page 98: Max_Width

    Lumenera Network Camera Release 1.8.1 API Reference Manual max_width Type int, read-only Description Provides the maximum width supported by the imager used in the camera. maximum_exposure Type double Description Defines the limit of the exposure range when autoexposure=1. Note Setting this property to 0 sets the exposure limit so that the frame rate is not affected.

  • Page 99: Maximum_Gain_Limit

    Lumenera Network Camera API Reference Manual Release 1.8.1 maximum_gain_limit Type double, read-only Description The absolute maximum gain supported by the camera model in use. median_filter Type boolean Description Enables or disables the median filter correction. Note The median filter is used to correct for over-reactive pixels in an image typically arise due high gain situations when working in low light levels.

  • Page 100: Minimum_Exposure

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Defines the minimum desired JPEG size for use with auto_jpeg_quality. minimum_exposure Type double Description Limits the exposure value when autoiris=1. Note If autoexposure=0, this value is ignored. If autoiris=1 and autoexposure=1 then this value is used as the lower limit for the exposure.

  • Page 101: Motion_Email_Recipient

    Lumenera Network Camera API Reference Manual Release 1.8.1 motion_map. The area of interest is a grid of rectangular areas. Each area can be independently enabled or disabled. Only enabled areas will be tested for motion. Not supported by Le045, Intelligent (Li series), or Le11059 cameras.

  • Page 102: Motion_Email_Server

    Lumenera Network Camera Release 1.8.1 API Reference Manual motion_y`. Area is `l get motion_area`%. Not supported by Le045, Intelligent (Li series), or Le11059 cameras. motion_email_server Type string Description Defines an email server that is used to send an email message upon a motion alarm event when the default motion_email_script is in use.

  • Page 103: Motion_Map

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note This property is similar to motion_skip. If this value is set too low, objects that are moving slowly may not get detected. If it is set too high, fast objects that can move through the region of interest during the skipped frames and may not get detected correctly.

  • Page 104: Motion_Map_Width

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note This property defines the number of rows in the motion map. It does not refer to the height of each rectangle in the motion map or the height of the entire motion map.

  • Page 105: Motion_Sensitivity

    Lumenera Network Camera API Reference Manual Release 1.8.1 section is used for motion detection. When this property is cleared, the camera uses the entire viewing area of the sensor for motion detection. Not supported by Le045, Intelligent (Li series), or Le11059 cameras.

  • Page 106: Motion_Y

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note The centroid can be located in a non-enabled area. For example, if the only enabled rectangles are the four corners of the imager and each corner registers motion at the same time, the centroid of the motion would be near the center of the imager which would not be inside of any of the four corner's rectangular areas.

  • Page 107: Netmask

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Provides the name server that the camera will use after the next reboot if DHCP is disabled (use_dhcp=0). netmask Type string Description The subnet mask the camera will have after the next reboot if DHCP is disabled (use_dhcp=0).

  • Page 108: Normal_Light_Stable_Duration

    Lumenera Network Camera Release 1.8.1 API Reference Manual Description Describes a set of properties and values that are applied when the camera switches to day mode. Note The settings are provided as a semicolon separated list. The camera uses normal_light_criteria and normal_light_stable_duration to determine when to switch to day mode.

  • Page 109: Number_Of_Buffers_Raw

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note The jpeg_buffer_size is inversely proportional to number_of_buffers. To continue processing new images when number_of_buffers is increased, it may be necessary to reduce jpeg_quality to keep the image size less than jpeg_buffer_size. Changes to this property only take effect on reboot of the camera.

  • Page 110: Privacy_Map

    Lumenera Network Camera Release 1.8.1 API Reference Manual be exposed to the flash. Not supported by Le045 and Intelligent (Li series) cameras. strobe: Strobe output when imager signals that all pixels are being exposed. This is the appropriate setting to use to trigger external strobe lighting with cameras using global shutter sensors.

  • Page 111: Privacy_Map_Height

    Lumenera Network Camera API Reference Manual Release 1.8.1 privacy_map_height Type double Description Defines the number of horizontal rows in the privacy_map. Note This property defines the number of rows in the privacy map. It does not refer to the height of each rectangle in the privacy map or the height of the entire privacy map.

  • Page 112: Projected_Network_Framerate

    Lumenera factory-ready PTZ system. Applies only to Pan Tilt Zoom (PTZ) systems that use the camera’s RS232 serial port to interface the network camera to a pan-tilt motor and a motorized zoom lens. Calling ptz_command or ptz_preset sends a command to a PTZ controller board via the camera’s RS232 serial port.

  • Page 113: Ptz_Protocol

    Lumenera factory-ready PTZ system. Applies only to Pan Tilt Zoom (PTZ) systems that use the camera’s RS232 serial port to interface the network camera to a pan-tilt motor and a motorized zoom lens. Calling ptz_command or ptz_preset sends a command to a PTZ controller board via the camera’s RS232 serial port.

  • Page 114: Rtp_Enable

    Lumenera Network Camera Release 1.8.1 API Reference Manual rtp_enable Type boolean Description Enables or disables the RTP daemon. Note RTP streaming does not necessarily end when clients disconnect, so explicitly disabling RTP may be required to reclaim the bandwidth. Once enabled, RTSP clients may connect via rtsp://camera/ or http://camera/rtp.sdp.

  • Page 115: Rtp_Port

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note A size of 1450 ensures that Ethernet fragmentation does not occur. A size of 65400 provides much faster transfers. It is recommended to use a packet size of 1450 to minimize the fragmentation at a lower level in the protocol stack.

  • Page 116: Serial_Echo

    Lumenera Network Camera Release 1.8.1 API Reference Manual Note Applying a negative value will decrease the amount of color and cause the video to change towards black and white. A positive value will increase the amount of color in the video. Applies only to the Le045 and Intelligent (Li series) cameras.

  • Page 117: Show_Motion_Detected

    Lumenera Network Camera API Reference Manual Release 1.8.1 Note To apply changes first call save_settings to store the change to persistent memory and then reboot the camera. show_motion_detected Type boolean Description Displays the motion that was detected by the camera by applying a white overlay that appears as a “ghosted image”.

  • Page 118: Strobe_Length

    Lumenera Network Camera Release 1.8.1 API Reference Manual strobe_length Type double Description Defines the amount of time in milliseconds that the output is on when the strobe function is called or when an alarm strobe is fired. This property is ignored when output_select=strobe.

  • Page 119: Telnetd

    Lumenera Network Camera API Reference Manual Release 1.8.1 telnetd Type boolean Description When telnetd is true, the telnet daemon is enabled. When telnetd is false, the telnet daemon is disabled. temperature Type double, read-only Description Provides the approximate internal temperature of the camera measured on the image sensor circuit board.

  • Page 120: Use_Dhcp

    Lumenera Network Camera Release 1.8.1 API Reference Manual saving time apply to this locale. Newfoundland Daylight Time is 1.5 hours earlier than Coordinated Universal Time (UTC). use_dhcp Type boolean Description Enables or disables DHCP support. Note When set, the camera attempts to obtain its network settings from a DHCP server on its next reboot.

  • Page 121: Video_Mode

    Lumenera Network Camera API Reference Manual Release 1.8.1 camera’s API functions. To remove a password, set it to the null (empty) string. If the password starts with "$1$", the string is assumed to be the MD5 hash of the password rather than the password itself. The expected username is user. The user username and password may also be used to access the user sections of the camera.

  • Page 122: Watchdog_Enable

    Lumenera Network Camera Release 1.8.1 API Reference Manual watchdog_enable Type boolean Description Enables or disables the watchdog. Note The watchdog will periodically check various system parameters. If these parameters indicate that the camera is functioning as expected, the timer is reset.

  • Page 123: Whitebalance

    Lumenera Network Camera API Reference Manual Release 1.8.1 camera is difficult to access and resetting the camera is likely to fix network connectivity issues. whitebalance Type string Description Provides access to the white balance algorithm in use. Possible values for this property include single, continuous, and off.

  • Page 124: X_Mirror

    Lumenera Network Camera Release 1.8.1 API Reference Manual Notes This property must be a multiple of 32 and will round down any value provided to the next lowest valid multiple of 32. The maximum width supported for RTP streaming is 2048 pixels. RTP streaming of images with wider dimensions will produce incorrectly formatted images.

  • Page 125: Y_Mirror

    Lumenera Network Camera API Reference Manual Release 1.8.1 Description Defines the vertical offset of the image in pixels from the top edge of the camera’s sensor. Notes The value of y must be a multiple of 8 pixels. Any value specified will be rounded down to the next lowest multiple of 8.

  • Page 126: Appendix: Interpreting Exif Headers

    General information on EXIF header format Using v.1.6 or higher firmware, the header for each JPEG image generated by the Lumenera Network cameras is fully compliant with the EXIF standard. The header includes time stamp information to microsecond precision. The formatting is as specified in the EXIF 2.2 standard: official http://www.jeita.or.jp...

  • Page 127: Table 4-1 Makernote Field Descriptions

    Lumenera Network Camera API Reference Manual Release 1.8.1 The value offset is 0x60 which places the start byte of the MakerNote at byte 108 of the header. Below are the 38 bytes of MakerNote starting at byte 108. Table 4-1 MakerNote Field Descriptions...

  • Page 128: Glossary

    EXIF cameras produce JPEG images with an EXIF-compliant header. The metadata tags include information identifying Lumenera as the manufacturer, a frame number, the time in seconds, and the time in microseconds for each image. For details, refer to Appendix A1.

  • Page 129: Copyright

    Hyper Text Transfer Protocol. The data throughput for HTTP Lumenera Network cameras over HTTP is 1.5 MB/s and about 50% greater over UDP. Internet Protocol. Infrared. The cameras use silicon-based imagers and as such are sensitive to near-infrared wavelengths from about 700 nm to about 1100 nm.
  • Page 130 Lumenera Network Camera Release 1.8.1 API Reference Manual use the MD5 hash of the password. See user_password and admin_password for more information. Motion JPEG. A video stream composed of a series of JPEG MJPEG images, in which every frame updates the entire field. While...
  • Page 131 Packets may arrive out of order or fail to arrive without notice. URI or URL Uniform Resource Identifier, Uniform Resource Locator. A URL such as http://www.lumenera.com is a type of URI that identifies a resource and the particular representation of that information.
  • Page 132 7 Capella Court, Ottawa, ON, Canada K2E 8A7 Phone: (613) 736-4077 | Fax: (613) 736-4071 www.lumenera.com © 2008 Lumenera Corporation, all rights reserved. Design, features, and specifications are subject to change without notice.

This manual is also suitable for:

Le075Le165Le175Le275Le375Le045 ... Show all

Table of Contents