Home

Lumenera Network Camera API Reference Manual Release 1.8.1.16

1. The expression elements must be separated by at least 1 space The camera evaluates this expression once per second to determine if the night mode threshold has been achieved The criteria must be valid for a time in seconds given by normal light stable duration in order for the camera to switch to night mode by applying the normal light settings The exposure normal _ light exposure threshold gain normal light gain threshold luminance and normal light luminance threshold values are available for comparison by name in the provided expression Type string Page 98 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Type double Description Defines the time in seconds for which normal light criteria must be true before normal_light settings will be applied Type string Description Describes a list of NTP Network Time Protocol servers as a whitespace separated list Note Set to a null string to disable NTP When enabled it is recommended to enable clock synchronize from kernel _to_rtcas well Type int Description Defines the
2. Note Not supported by Le045 and Intelligent Li series cameras Type double Description Provides the maximum gain_ red value This property can be set directly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras Page 78 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double Description Provides the maximum gain_red value This property can be set directly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras Type double Description Accesses the gamma property which affects the mid tone brightness in the images Notes Higher values of gamma give the image an overall brighter cast The value range for this property is from 0 01 to 100 The practical range is from 1 to 2 The typical value is around 1 4 Type string Description Provides the gateway the camera will use on the next reboot when DHCP is disabled Copyright O 2009 y Page 79 YLumenera corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type boolean Description Enable or disable H 264 encoding for images Notes H 264 encoding requires the following settings jpeg_enable 0 analytics enable 0 and rep suebile 1 Applies only to the Le045 and Intelligent Li series cameras Type int Description Accesses the image height v
3. Return Values Returns a string on success Throws a fault on error Notes None Examples CGI cgi bin version Telnet 1 version Sample Output Lumenera explorer2 r5565 hw1 2 1 8 0 16 lel65c dn Mon 24 Dec 2007 12 31 56 0500 Lumenera explorer2 Indicates the camera type r5565 Firmware build number hwl 2 Hardware version hw1 3 indicates extended RAM 1 8 0 16 Firmware version 8 is the major version of firmware 0 Firmware branch number main branch A alpha firmware B beta firmware 16 Minor version with even odd value for release type even digit production release odd digit release candidate lel65c dn Camera model Mon 24 Dec 2007 12 31 56 0500 Date and time of the firmware build Page 46 i i y Copyright O 2009 YLumenera corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Transfers a stream of images in JPEG format Optional Arguments type lt optional gt string 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 default multipart mixed frameskip lt optional gt double 0 n default 0 The number of frames to discard for every frame sent Fractional values are supported This is in addition to skips required by the camera s maximum framerate global value default O framerate lt
4. Note Each preset limits the color gain ranges by specifying preset values of the properties gain_red min gain red max gain green min gain green max gain blue min and gain blue max Copyright O 2009 MLu menera Page 115 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual When this property is set to user a custom set of color gain limits can be specified Type int Description Defines the width of the image in pixels 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 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 Type int Description Defines the horizontal offset of the image in pixels from the left edge of the camera s sensor Notes The value provided must be an even number and will round down any value provided to the next lowest valid even number Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate seconds or a subsequent image call may fail with an error Page 116 i i y Copyright O 2009 YLumenera corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type
5. API Reference Manual Release 1 8 1 16 Type int read only Description Defines the y location of the centroid of motion in the detection window during the last alarm Notes 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 corners rectangular areas Not supported by Le045 Intelligent Li series or Le11059 cameras Type string Description Provides the camera s hostname Note Ifthe DHCP server passes a hostname this hostname overrides the value in this property Type string Description Provides the name server that the camera will use after the next reboot if DHCP is disabled use dhcp 0 Copyright O 2009 Lu me nera Page 97 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string Description The subnet mask the camera will have after the next reboot if DHCP is disabled use_dhcp 0 Type string Description Describes a list of criteria that describes the day mode threshold needed to set the camera into its day mode Notes A typical value is gain lt 16 The expression is phrased using comparison operators lt gt lt gt does not equal amp AND OR and arithmetic symbols
6. e Save Settings to the flash memory e Reboot the camera Example CGI commands are as follows Property values are URL escaped cgi bin set ipaddr 123 2E123 2E123 2E123 cgi bin set netmask 255 2E255 2E255 2E0 cgi bin set gateway 123 2E123 2E123 2E1 cgi bin set nameserver 123 2E123 2E123 2E5 cgi bin set use dhcp 0 cgi bin save settings cgi bin reset The camera will reboot with the new network settings applied Type string Description Enables or disables the link local address Note When set the camera is configured with a link local address on its next reboot Setting this property to O prevents the assignment of link local address Type string Page 112 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description Access to the user password for the camera This property can be used to set the password Notes If this property is not empty a password is needed to access any of the camera configuration commands in the cgi usr directory 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 Getting this property will return either 1 if a password is set or null
7. boolean Description Provides access to mirror the image flipping the image from left to right Type int 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 Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate seconds or a subsequent image call may fail with an error Type boolean Description Provides access to flip the image flipping the image from bottom to top Copyright O 2009 M Lu me nera Page 117 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Appendix Interpreting EXIF headers 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 unofficial http www exif org The human readable time in the DateTime and SubSecTime fields is specified for the time zone configured on the camera using the timezone property of the API The time in the MakerNote is recorded as an array of 2 binary long integers The elements are the seconds and the microseconds in the UNIX epoch time tagged as fiel
8. corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 2 4 2 return bReturn Note Image capturing functions should use CGI HTTP commanding instead of XML RPC as the latter interface results in a perceived decrease in camera performance Also note when using the provided XML RPC library it is recommended to create one object per XML RPC request and to delete the object once complete to improve the stability of the library within your application 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 Fora description of the CGI standard see http noohoo ncsa uiuc edu cgi Note Instead of a GET request an HTTP POST request may be used If so the mime type must be multipart form data but a GET request is the recommended and supported request format Examples follow GET cgi bin nph video HTTP 1 0 GET cgi bin version HTTP 1 0 GET cgi bin get exposure HTTP 1 0 GET cgi bin set x 10 y 15 width 150 height 100 HTTP 1 0 CGI commands are executed by constructing and requesting a specific Uniform Resource Indicator URI with a directory name of cgi bin The directory name is followed by a base name that specifies the command to be executed Arguments are appended to the base name to c
9. polybrominated diphenyl ether PBDE After July 1 2006 the use of these materials will be banned in new products sold in Europe The RoHS 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 RoHS 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 Page ii Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Table of Contents INTRODUCTION ici ieee tered cl eee eee ees 1 1 1 THE _LUMENERA NETWORK CAMERA FAMILY coooocooccccnocnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnncnnnnns 1 1 2 WHERE TO FIND DOCUMENTATION irccececctesetccetecenecetccepeuenecencuetccepenepescueuebicepmieeeiec 2 a TESCANIGAL ASSISTANCE 00 ta a oe BE Bee ee BE Ea Es 2 NETWORK CAMERA APU ois scsccsctccesc
10. Network Camera API Reference Manual Release 1 8 1 16 Returns the status of the FTP stream Arguments session string 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 Throws a fault on error Also returns a value of if the stream has produced an error but will be retried In this case ftp stream last error returns the value of the last error Notes None Example CGI cgi bin ftp stream _status session alarm Telnet 1 ftp stream status session alarm Copyright O 2009 ye Lu menera Page 23 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Stops an FTP stream Arguments session lt optional gt string 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 Notes None Example CGI cgi bin ftp stream stop session alarm or cgi bin ftp stream stop session alarm Telnet l ftp stream stop session alarm Page 24 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 start
11. 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 Some 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 Copyright O 2009 Lu menera Page 3 corporation Lumenera Network Camera Release 1 8 1 16 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 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 e Auto Brightness Control ABC e Autogain or fixed gain control e Autoexposure or fixed exposure control e 60 Hz 50 Hz lighting
12. O a EEEE EE E a R aa a a na ean E EE a E T a EEEE EEEE U i 90 TME SIZG O via sages vi PE EA E E A A A A A A 90 MIN MUM_EXPpOSUFE oir 90 motion alarm AICS ssanie anane A idea cea 90 motion alarm enable unico dn EE TEE EAEE anise ENRE ENTA 91 MOLION email r cipient smesse aan EE Aa ETENE naaa 91 MOTION COMAS CPE A A EOE EA 92 MO ION_eMAll_SllVeF iii rra 92 Motion email SUDJOCE ooccococcccoconicicicicononinarn caca 93 MONON Qa inti never sons ade O 93 MOON AD ae sinensie canadien vl S Ra ae EAEE ATT 93 motion Map _NOIGht 1 ccccccececeesne cece nr 94 motion map WICKS ic ati becas 94 MOON Map WINDOWED cios nde sre aa Hine nae 95 MOON SOSIIVILY aci AA AA AAA A Gebel aah 95 MOON SKID sos sess ssw A A a as 96 10010111010 E EEPE a ete as ene esta ate 96 Copyright 2009 Lu menera Page vii corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual SN sete E E A 97 A eva taste Len coud putea dlew cae casas otlip lea cev aaa athe dan vane ae cl A EE 97 ES 2 inna Mee ahi aes nied ai EEE Addn nnin wae ohn T aE S AEA EEE a 97 NOMAS Kio A AA dE Aa A 98 normallight criteri a AAA dt AAA EE AE EEAO RE EAE 98 normal_light_SettiN9S ooonnocinonniniinnonnncicinincccinarcccnnrccc rn 98 normal ONE Stable AULA ON ae 99 EE aE ETA E laisse iiss iano eels ile et S 99 number OF SDURCIS iii iaa aaa 99 number_of_buffersS_FaW occ rra 100 OUIDUE OO A A a A ai aeees 100 privacy MAP A Aa a aida 101 privacy MAD enable a
13. Table 4 1 MakerNote Field Descriptions in the EXIF header oooocoococoooncccccccccccccncnnoo 119 Page x Lu menera Copyright 2009 e orpor da tian Lumenera Network Camera API Reference Manual Release 1 8 1 16 Introduction 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 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
14. Type string Description Specifies the video format of the composite video output as ntsc default or pal Notes Applies only to the Intelligent Li series cameras and the Le045 The video mode property determines the boot configuration of the camera and is normally set at the factory Use the save settings command to store any change to video mode in persistent memory Use the reset command to reboot the camera in the new video mode Type boolean Description Enables or disables the check for hardware CODEC and imager Copyright O 2009 Lu menera Page 113 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Notes If set the camera will check the hardware CODEC and imager status before kicking the watchdog If the watchdog timer is exceeded because the watchdog is not reset the camera will reboot Enabling this property is not recommended under normal conditions because if the imager fails the camera will constantly reboot making communication with the camera very difficult An imager failure is generally not something a reboot will fix 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 If the timer expires before it is reset the camera will reboot Type boolean Description Enables or disables the check to
15. anaemia anne 67 CUENTA AMOSOIV iii A A 67 CUPTENL netmask sra a aida sia 67 A A A POET CIO eee 68 E E NA 68 VAY FOC PROS nn TN 68 dayon DW MOOS aiii A A A ad nage ed eee 69 daynight gain DOOSI ass sierrusriiduriseraras nro 69 OayNiQnt Galn IN ANES NO A as 69 CayniQht gain Umit ooo da Rea RRA EAA EEE AEAEE EEEE 70 Aaynight_Qain_OUt_threShld rreran anaa E AEE AA A A EAA S 70 daynignht AA A AE nRa N rS E R Er E Eia EA ANRE 71 lefault_ Mage _paraMS ooo nr 71 Copyright O 2009 Lu menera Page v corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual OOS CHPUON gt oda 71 dhep Tallbacken A he Pea A ai eae 72 dhep UMGOUL oii ave ave Rie eaten Banh ieee ion beens Wee Bet ea nui asda ade 72 dns domain NAME A aii ie ea dei a ae iii daha beeen 72 edge onhan omne Ni iii A A E at ai 73 A O O O eee 73 A a ai 73 OXPOSUTO Dl A ar 74 VOCUS di ta A AA A A A 74 VOCUS MA iaa 74 FOCUS AMO cia 74 frame DUM Er enable iii ia ii A A A ae aed oa Aa Ad needs ee 75 IEEE ula onc A ze cpt a dea ed wa ck Ac de ah vag ead ev ch ede Save ve gee A A nd cage ed eae 75 A NN 75 ga OUO at tias 76 DUNE MA A A aaa aca 76 g in DIE Mii a ee 77 gah QOON erai EAE AA A A A A 77 SS o UA 77 gangrena ata aa tan oe oe poi aia ted oe A cen dee ia 78 Gain A dada E E E A E nubian sade 78 JUNTO MaX eiii A A vA ennea canadian Vien iededvaad din vi A aii 78 GID TOO MiM sarees ONPE Pig ewes dake ridden 79 e E 1 4 4 COOPPCN__O CO RI E rE AE haan
16. analytics algorithms e g ObjectVideo and Page 54 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 those algorithms are enabled using analytics enable When true the on camera alarm responses to analytics alerts are enabled email FTP image transfer UDP alarm packet and general purpose output Note Applies only to the Intelligent Li series cameras 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 One needs to attach the object video alarm details received as the email body explicitly See also motion_email_ script Note Applies only to the Intelligent Li series cameras Type boolean Description Enable or disable analytics Note Applies only to the Intelligent Li series cameras Type int Copyright 2009 Lu me nera Page 55 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description This parameter defines the view model to use for the analytics algorithm Note Possible values include 0 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 al
17. any of the camera configuration commands in the cgi bin directory The expected username is admin The admin username and password may also be used to access the user sections of the camera 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 Getting this property will return either 1 if a password is set or null otherwise Type string read only Copyright O 2009 Lu menera Page 49 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description The date and time of the last alarm event in ISO 8601 format If no alarm has occurred since the camera s last boot the value will be none Note Not supported by the Le045 and the Li series Type int Description Defines the delay time between alarms in seconds Alarm notifications will not occur more frequently than once every alarm_delay seconds Notes 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 For the Li series intelligent cameras alarm_delay only affects events detected on the general purpose dry contact input Alarms due to video analytics events are not affected by alarm_delay because such events are distinct and highly specific Type boolean Description Enable and di
18. be affected This is the reason for the use of echo n TEXT url escape in the path argument in the Telnet example below Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate or a subsequent ftp images call may fail with an error Examples CGI use 25 URI escape code for the character ftp images server 10 10 111 111 amp path image 25H 25M 25S 255250 Jpg tuser guest password guest pre 1086post 106a rchive 18framerate 1 ftp images server 10 10 111 111 6path x325H9S25M 258 25 250 Jpgs user guest password guest post 3s ref useconds O amp ref date Fris2C 11 Jan 2008 17 3A52 3A00 2D050050A Telnet l ftp images server 10 10 111 111 user guest password guest pre 10 post 10 archive 1 framerate 1 path echo n image tHSM S Q jpg url escape l ftp images server 10 10 111 111 user guest password guest ref useconds 0 post 3 path x 25HS25M 25S 25 250 jpg ref date Fri 2C 11 Jan 2008 17 3A52 3A00 2D0500 0A Copyright O 2009 Lu menera Page 21 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Returns the last error if any from an ftp images stream The stream does not need to be running to get this error Arguments session string Session name For an alarm FTP session use alarm for this argument For the default session name use noname Return Values R
19. detected in the case of a motion alarm I O input triggered in the case of a dry contact alarm trigger signal To acknowledge the alarm packet send a UDP packet to the source address and port of the alarm packet If not acknowledged the alarm packet will be resent at one second intervals to a maximum of three packets The format of the acknowledgment is as follows Copyright 2009 Lu menera Page 51 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual event number r nACK r n Type double Description FTP stream frame rate to use when an alarm is triggered 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 Type boolean Description Sets the FTP mode used by the camera to stream images to the FTP server on an alarm event If true the camera uses passive PASV mode FTP Type string Description Password of the alarm ftp user account that will receive files via FTP on an alarm event Type string Page 52 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description File path for FTP file transfer upon an alarm event Type double Description Duration in seconds of images occurring after an alarm event that will be transferred after an alarm event occurs Type double Description D
20. ensure that the web server is still responsive Note If set the camera will check the web server s status before kicking the watchdog If the watchdog timer is exceeded because the watchdog is not reset the camera will reboot Type string Page 114 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description An IP address to ping in order to automatically test network communications Notes The camera will ping any IP address specified A correct reply to the ping is required in order to reset the watchdog timer If the ping consistently fails the watchdog timer will exceed its limit and the camera will reboot Using this property is not recommended under normal conditions Setting this property is only useful if the camera is difficult to access and resetting the camera is likely to fix network connectivity issues Type string Description Provides access to the white balance algorithm in use Possible values for this property include single continuous and off Note When this property is set to of f current balance is maintained A single one shot white balance is performed when this property is set to single An ongoing repetitive white balance is enabled when set to continuous Type string Description Defines a specific white balance preset for a given lighting environment Possible values include default wide fluorescent daylight and user
21. image sensors in both color and monochrome types Most models use C CS 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 16 Extensions specific to the Li series intelligent cameras refer to firmware version 2 3 1 2 Copyright 2009 Lu menera Page 1 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual All camera documentation can be found in the lt Install Directory gt 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
22. is used to correct for over reactive pixels in an image typically arise due high gain situations when working in low light levels The filter compares each pixel to its neighbors to determine if it is representative of its surroundings If not the filter will replace the value of the pixel by the mean of the neighboring pixels Not supported by Le045 and Intelligent Li series cameras Copyright O 2009 Lu me nera Page 89 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type int read only Description Provides the amount of free RAM memory in kilobytes available to the operating system Type int Description Defines the minimum desired JPEG image size in bytes for use with auto jpeg quality Type double Description Limits the exposure value when autoiris 1 Notes 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 Type double Page 90 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description Defines the percentage of the pixels in the motion detection area that must change before a motion alarm event occurs Note Not supported by Le045 Intelligent Li series or Le11059 cameras Type boolean Description Enable and disable motion detection alarms Notes Motion is defined as a minimum number of pixels chang
23. level in the protocol stack Type int Description Defines the RTP base port number to use for transmissions which must always be an even number Note This value should not be confused with the RTSP port number which is always at the IANA standard location of 554 Page 106 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double Description Provides access to control the boldness of color in the images Notes This property can take values between 100 and 100 The most common settings for this value are O normal color and 100 monochrome Not supported by Le045 and Intelligent Li series cameras Type double Description Adjusts the amount of color in the image This parameter takes a value between 100 and 100 Notes 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 Type boolean Description Enables or disables local echo on the camera s serial port Copyright O 2009 Lu me nera Page 107 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string Description Defines the flow control method for the serial port The available options are none sw hw and both Type int Description Defines
24. 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 Notes See documentation for the motion email script property You must specify a valid mail server and email recipient Example CGI cgi bin set motion email recipient me 40mydomain 2Ecom cgi bin set motion email server 123 2E123 2E123 2E123 cgi bin test email alarm Telnet l set motion email recipient me mydomain com set motion email server 123 123 123 123 test email alarm Copyright O 2009 Lu menera Page 41 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Transfers an image or a stream of JPEG images to a UDP client Arguments client string Client name or IP address port int Client port address end lt optional gt 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 If end is less than start then the UDP streaming will continue indefinitely default 1 start lt optional gt int The first image to transfer from the rolling buffer A positive number refers to future images not yet captured a negative number refers to older images in the rolling buffer default 0 frameskip lt optional gt double 0 n default 0 The number of frames to discard for every frame s
25. optional gt double The desired frame rate of the UDP stream If this value is non zero the camera calculates an appropriate frameskip value If the global framerate value changes the frame rate of this stream will change proportionately default O archive lt optional gt boolean Run in archive mode If set to 1 the camera will use its rolling buffer to send images without dropping any frames resulting in increased latency when network bandwidth is limited If set to 0 the camera may drop frames rather than increase latency default 0 start lt optional gt int The first image to transfer from the rolling buffer A positive number refers to future images not yet captured a negative number refers to older images in the rolling buffer default 0 ref date lt optional gt string Date and time for the requested index frame image number 0 to a precision of seconds formatted according to the requirements in RFC 2822 The camera will send the most recent buffered image that is prior to the requested time Attempting to retrieve images outside the rolling buffer will send no images at all even if the time specified is in the future or some of the images specified are in the buffer ref useconds lt optional gt int The portion of the time of the requested index frame image number 0 in microseconds default 1 Copyright 2009 Lu menera Page 47 corporation Lumenera Network Camera Release 1 8 1 16 API Refer
26. settings defined in the property low_light_settings Notes Applies only to the Le series cameras Requires firmware 1 8 1 14 or higher Does not apply to the Le045 cameras The day night mode can be set by the user e g 1 set day mode 0 to force a mode change Page 68 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Automatic day night settings changes can be set up that use the thresholds set in low light criteriaand normal light criteria if present Such settings can be defined for cameras with or without a day night visible near infrared filter shuttle option For camera models with the DN suffix to the model number a night mode with black and white images saturation 100 and an infrared transparent glass in the light path of the camera ir shuttle position 1 is the factory default configuration day mode can be saved loaded just like any other parameter day mode will be reset to factory default value 1 true by clicking Image Defaults Type boolean Description If true default the camera will disable color during night mode operation Note Applies only to the Le045 and Li045 cameras Type boolean Description If true the camera will boost gain by 6 dB during night mode operation Default is false gain boost disabled Note Applies only to the Le045 and Li045 cameras Type double Copyright O 2009 Lu menera Page 69 co
27. the last three octets 10 04 AB in this example vary from one camera to the next The MAC can be used to derive the link local IP address of the camera by converting the last two octets to decimal values using the following formula 169 254 93 MAC5 MAC6 For the example shown MAC5 4 MAC6 AB 171 decimal so the link local address is169 254 97 171 A commonly used 128 bit cryptographic hash function User and Admin passwords on Lumenera cameras can be set to Copyright 2009 Lu menera k corporation Release 1 8 1 16 Lumenera Network Camera API Reference Manual MJPEG NPH NTP RFC RGB RTC RTP RTSP Telnet 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 images in which every frame updates the entire field While other formats that update only the changes between key frames can consume less bandwidth under favorable conditions MJPEG provides an optimal balance between data compression and image quality under all conditions and a complete update of every image No Process Header Refer to section 2 4 2 on the Common Gateway Interface CGI Network Time Protocol The API property ntp_ servers is provided to allow one to specify the IP addresses of one or more NTP servers from which the camera s real time clock may be updated The term RAW image refers to the binary image data as recorded by t
28. 1 8 1 16 start of readout Output a pulse once per frame when the image sensor starts transferring data to the hardware CODEC that is after line 1 of the image completes its exposure This is the appropriate setting to use to trigger external strobe lighting with cameras using rolling shutter sensors The limitation is that line 1 of the image will never be exposed to the flash Not supported by Le045 and Intelligent Li series cameras strobe Output a pulse once per frame when the image sensor 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 Not supported by Le045 and Intelligent Li series cameras watchdog ping Output an alternating a series of on off pulses when a ping of the IP address specified in the watchdog_ ping property fails times out This provides an alarm in the event of network communications failure Type string Description Specifies rectangular portions of the image that will be hidden from view in all the images produced by the camera Notes The privacy map is a grid of privacy map width by privacy map height that is superimposed on top of the current viewing window or the entire image sensor if privacy map windowed is true Each grid rectangle is either enabled or disabled by this property The map is specified as a string of hexadecimal digits each bit corresponding to a single grid lo
29. 2Cexposure 3D3 amp delimeter 2C Telnet l put_settings gain 3D1 2Cexposure 3D2 delimeter 2C Copyright 2009 Lu menera Page 33 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual 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 Arguments property name string valid existing property name delimiter lt optional gt string Delimiter that separates the property value pair default Return Values Returns nothing on success Throws a fault on error Notes The delimiter cannot be 10 NULL If the current camera settings are unwanted the command put settings from property default image params can be used to restore the Image Defaults settings This command is similar to load settings factory defaults with the exception that none of the network settings are affected Example CGI cgi bin put_settings_from property default image params Telnet l put _ settings from property default image params Page 34 i Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 Reboots the camera Arguments None Return Values Returns nothing on success Throws a fault on error Notes The camera will be unresponsive for approxim
30. S OR CONDITIONS OF MERCHANTABILITY QUALITY AND FITNESS FORA PARTICULAR PURPOSE LUMENERA IS NOT OBLIGATED TO PROVIDE ANY UPDATES OR UPGRADES TO THE SOFTWARE 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 Software 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 Should 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 Copyright 2009 Lu menera Page i corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual 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 neglige
31. _from_property ooocoocociniccccconnnnnncnconcnncnnn cnn nr 34 Copyright O 2009 Lu menera Page iii corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual OSO pt ao rt ici bata a la Deere eee eT Det fa es 35 Savo CUNA A cates nen ata nae T eae 36 A E denen aete Wii ants Sada BAe Asati ana dee 37 A Bian ey tie ea ee Ad Bev ae noe a ee 38 SLOP E PEP E EE A A tE 39 SLOG NEIE E IEA A PEE E EA EA A E O A AA E A E T 40 LOSE email alarmaren A A haat t ai 41 UD stream A A Eaa EEEE eee 42 dp stram Stp seresa aaa 44 Vol MET SO AA 45 VOS A A A ed S A E 46 VIGGO EAT E E A E ian E E E E E ead beeen dela nae 47 API PROPERTY REFERENCE asno 49 4 1 API PROPERTY DESCRIPTION ssp 49 admin_paSsword ee 49 alarm date lastname e A leaa A ea E E ia ea e aea 49 ES E LEAN E E RN 50 DURMIENDO A E EE EEEE 50 alarm enable MP iii A A A EEE AAAA EAE Ad 51 alarm_enable_udp coooccoccocccncccniciccccconnn nene 51 alarm TP TAME ita A A aaa 52 alarm ftp PASIVA a nee 52 alarm FpEPASS WO Uca dan beds 52 alarm ftp PAN cocinar 52 alarm ft post tigger ccoo ii cn ni eaae iane ieri aaie AREE cody 53 alarm ftp pre TODO iii A A aden een bandana idan ada 53 alarm TDS OVA A id 53 UATE TED US it it A IA O dit Tage 53 alarm dp CHOP AAA UU RAE EEN r EERE ka SEREA erain nasties 54 alarm udp port ipni iein ON 54 analytics alarm nabl siisii anre a hue 54 analytics email Script asserere aeaea e AA asias 55 analytes enable oiiciccnnnicicinonoccc
32. a Network Camera API Reference Manual Release 1 8 1 16 Type double Description Adjusts the brightness value of the camera This value can be between 256 black and 256 white Note Not supported by Le045 and Li series cameras Type string Description Specifies the RGB gt YCbCr color conversion matrix to be applied after color gains and whitebalance are applied Available values are yuv 709 ITU R BT 709 specification and 601 ITU R BT 601 5 specification 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 Type double Copyright 2009 Lu me nera Page 65 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description Accesses the contrast value of the camera It can take values between 100 and 100 Type boolean Description Enable or disable crosshair overlay onto images captured from the camera This feature is used temporarily when setting up the camera Notes The privacy map may need to be disabled temporarily in order for the alignment crosshairs to be visible Not supported by Le045 and Intelligent Li series cameras Type string read only Description Provides the camera s current broadcast address Type string read only Description Provides the fully qualified domai
33. al electrical damage to the camera Hyper Text Transfer Protocol The data throughput for 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 For some color cameras the DN day night version provides the ability to detect IR light An infrared cut off filter is used in daylight conditions to provide accurate color rendition An uncoated infrared transparent glass is used during night time conditions to boost the sensitivity of the camera Images are normally rendered as monochrome black and white in night mode Joint Photographic Experts Group Denotes an image compression format that is commonly used in computing The compression procedure includes encoding the image in the YCbCr color space downsampling color chroma Cb Cr information dividing the image into an array of 8x8 pixel cells computing the discrete Fourier cosine transform of each cell quantization of brightness information and entropy coding The associated file format used in computing is called JFIF for JPEG File Interchange Format See also EXIF Media Access Control address The MAC consists of six bytes expressed as hexadecimal values For Lumenera products the MAC is of the form 00 0B E2 10 04 AB The first three octets 00 0B E2 identify Lumenera as the manufacturer and
34. al temperature of the camera measured on the image sensor circuit board Units are degrees Celsius C Type string Description Provides the camera s the time zone in standard Unix SUSv2 format Notes See http www opengroup org onlinepubs 007904975 basedefs xbd_chap08 html for the precise definition of the possible values Some examples are JST 9 means that Japanese Standard Time JST is 9 hours later than Coordinated Universal Time UTC and does not have daylight saving time MST7MDT means that Mountain Standard Time MST is 7 hours earlier than UTC Both standard time and daylight saving time apply to this locale By default Mountain Daylight Time MDT is one hour ahead of MST NST3 30NDT1 30 means that Newfoundland Standard Time NST is 3 5 hours earlier than Coordinated Universal Time UTC Both standard time and daylight saving time apply to this locale Newfoundland Daylight Time is 1 5 hours earlier than Coordinated Universal Time UTC Type boolean Description Enables or disables DHCP support Copyright 2009 Lu menera Page 111 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Note When use_dhcp is true the camera attempts to obtain its network settings from a DHCP server on its next reboot When use_dhcp is false the camera can be set to a static IP address as follows e Set IP address netmask gateway optional nameserver optional e Disable DHCP
35. alue MyValue Page 18 Lu menera Copyright 2009 Lumenera Network Camera API Reference Manual Release 1 8 1 16 Transfers an image or a stream of JPEG images to an FTP server Arguments server string The server name or IP address path string Relative or absolute file path on the FTP server in which image s will be stored user lt optional gt string FTP user name default ftp password lt optional gt string FTP password default ftp pre lt optional gt double Duration in seconds of the pre trigger images to be transferred default 0 post lt optional gt double Duration in seconds of the post trigger images to be transferred default O passive lt optional gt boolean FTP mode If set to 1 passive FTP mode PASV is used If set to 0 PORT mode is used default O async lt optional gt boolean Async FTP mode If set to 1 the command returns immediately and the FTP streaming is executed in the background with errors sent to the camera s syslog If set to 0 the command returns when the FTP streaming is complete with errors returned normally default 0 session lt optional gt string Session name default noname framerate lt optional gt double The frame rate of the desired FTP stream measured in frames per second fps If this value is larger than the camera s current frame rate images will be transferred at the fastest rate possible default 1000 archive lt optio
36. alue in pixels Notes This value must be a multiple of 8 with a minimum value of 16 If the specified height is not a multiple of 8 the camera will round down to the next lowest multiple of 8 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 Type boolean Description Activate automatic image stabilization of the lens Default is false disabled Set to true to power an IS image stabilized lens Page 80 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Notes Applies only to camera models that support Canon EF mount 35 mm lenses such as the Le259 and Le11059 Requires an IS lens with Canon EF mount Type boolean read only Description Provides the image sensor type used by the camera True if the sensor in the camera is a monochrome black and white imager False if the imager is color Type double Description Accesses the camera s numerical intensity value Notes This property is similar to contrast except that the slope is centered at black instead of gray Where contrast makes dark pixels darker and bright pixels brighter this property brightens every pixel Type boolean Description Enables or disables detection of GPIO alarms Notes When set an alarm event may occur due to a signal applied to the GPIO hardware input t
37. and YUV YUY2 XML RPC User Datagram Protocol The data throughput for Lumenera Network cameras over HTTP is 1 5 MB s and about 50 greater over UDP The speed of UDP is due to the lack of overhead for checking if every packet reaches its destination Packets may arrive out of order or fail to arrive without notice 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 Coordinated Universal Time The Lumenera Network cameras use UTC time to account for the timezone and changes between Daylight and Standard Time Alternative color spaces to RGB in which the image components are the luminance or luma Y and the color chroma values Cb and Cr or U and V respectively The Y component is related to the overall brightness and is a combination of the R G and B values In an analog composite video signal the Y component is sufficient to display monochrome black amp white images A format for image information in which luma Y brightness is encoded for each pixel but chroma Cb Cr color information is provided only for every second pixel Extensible Markup Language Remote Procedure Call A simple protocol for making remote procedure calls XML is used to encode the calls and HTTP is used for transport The installation CD ROM includes XMLRPC libraries for C and Vis
38. anual Does not apply to the Le045 or the Li series cameras Use the target _Jpeg size property instead Type boolean Description Enables or disables PTZ pan tilt zoom functions Notes 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 Set ptz enable to be true ptz protocol pelco_d serial use accessory and serial speed 2400 to work with a Lumenera factory ready PTZ system Resetting the camera to factory defaults will disable PTZ functions Type string Description Specifies the PTZ control protocol as pelco_d pelco_p or vt Note The normal Lumenera factory default setting is ptz_ protocol pelco_d Set ptz enable to be true ptz protocol pelco_d serial use accessory and serial speed 2400 to work with a 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 104 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type int read only Description Provides
39. ardware version http CamIP cgi bin version et camera settings information G http CamlP cgi bin get settings Save settings to persistent memory Etp CamiP egi bin save settings estore settings from memory ttp CamIP cgi bin load_ settings eboot the camera h R h R Page 10 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 http CamIP cgi bin reset 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 ttp CamIP cgi bin set gain 18exposure 10 nable auto brightness m z ttp CamIP cgi bin set autogain 1 amp autoexposure 1 nable automatic white balance m z ttp CamIP cgi bin set whitebalance continuous et the camera gain ttp CamIP cgi bin get gain et the camera MAC address Q OF http CamIP cgi bin get MAC Set custom day night modes Parameters to set low light settings ir shuttle position 1 auto_algorithm pea k lighting frequency 0 maximum_exposure 4 autoexposure targ et 20 autoexposure 1 autogain 1 Command with URL encoded special characters http CamIP cgi bin set low light _settings ir 5Fshuttlet5Fposition 3D1 3Bau toS5Falgorithm s 3Dpeak S3Blightings5Ffrequency 3D0 3Bmaximum 5FexposuresS3D4 3Bautoex
40. ately 30 seconds until it has finished booting Example CGI cgi bin reset Telnet l reset Copyright 2009 i L i y Page 35 umenera H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual 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 Arguments filename lt optional gt string Filename for saved settings file default persistent Return Values Returns nothing on success Throws a fault on error Notes None Example CGI jeqgi bin save settings Telnet l save settings Page 36 Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 Set the value of a particular property Arguments property string Existing property name value lt based on property gt Value of the same data type as the property Return Values Returns nothing on success Throws a fault on error Notes None Examples CGI cgi bin set autogain 1 or cgi bin set width 300 height 200 amp x 50 amp y 50 Telnet 1 set autogain 1 or set autoexposure 1 or set width 300 height 200 x 50 y 50 Copyright O 2009 E 3 Lu menera Page 37 H Lumenera Lumenera Network Cam
41. auto JPEG quality option to maintain JPEG image file sizes When enabled this property automatically adjusts the JPEG quality so that the image file size in bytes is always between max jpeg size and min jpeg size Notes For Le series cameras only setting auto jpeg quality true will ensure that the file size is also kept below the projected network bandwidth value divided by the lesser of projected_network framerate value or framerate value Copyright 2009 Lu menera Page 59 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual For the Le045 and the Intelligent Li series cameras the projected network bandwidth and projected network framerate properties are not supported See target jpeg size Type int Description Width of the auto control window Notes 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 top left of the current viewing window that is defined by height width x and y This property is enabled and disabled with auto window enable property Type boolean Description Enables or disables the use of a ROI for calculating the value for the auto algorithm Notes 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 lumina
42. cation as 1 active or 0 inactive The maximum value of the privacy map is 2 privacy map width privacy map height 1 for example 11111111 binary FFFF hexadecimal or 255 decimal for a 4 x 4 grid The most significant bit of this value corresponds to the upper left privacy map grid element The following bits correspond to the next grid element to the right until the end of the row The following bits continue on the next row to the last bit which defines the bottom right grid element Not supported by Le045 Intelligent Li series or Le11059 cameras Copyright 2009 Lu menera Page 101 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type boolean Description Enables or disables the entire privacy map Note Not supported by Le11059 cameras Type double Description Defines the number of horizontal rows in the privacy map Notes 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 The height of each rectangle in the privacy map if the privacy map windowed 0 is height privacy map height rounded to the nearest multiple of 4 If privacy map windowed 1 then the height is max height subsample 1 privacy map height rounded to the nearest multiple of 4 Not supported by Le11059 cameras Type double Description Defines the number of vertical columns i
43. cctccnsccasaceiassteccicssdassdctescccbasnsccebateiacceccausssdasstszcncesaces 3 2 1 THE LUMENERA NETWORK CAMERA API coccion ci 3 2 2 CAMERA FEATURES AND SETTINGS shied osado 4 23 SUPPORTED NETWORK PROTOCOLS iii 6 2 4 PROGRAMMING INTERFACES aaron A aero 7 241 XAMLERPC ENVIO MON Ett A pa 7 2 4 2 CGVHTTP Javascript ENvirOnimen 2 cccccccecceecseneeceeececeeecsaeaeeeseceseseesaeeeeeeeeeseneenenaseeeeettees 9 2 4 2 1 No Process Header NPH commands ccccceeeeeeceeceeeeeeeeeeeaeeeeeeeeeecaaeaeeeeeeeseneaeaeeeeeeeeeeeeea 11 2 4 2 2 RESPONSE ON SUCCESS ui Bnd eth ele Pd en en i ec 12 2 4 2 3 RESPONSE on Failure voir edad a eda Aa ae eaten 12 2 4 2 4 Access Levels aiii ad en 14 LAS Tehat ERVOOR das eatin 15 API FUNCTION REFERENCE wisscssccesccsccesccsscicicccesies cccsseeacsccscesceestendaedsseeddeeeseascssaceeisedes 16 3 1 SUMMARY OF API FUNCTIONS aaa tadd 16 32 AP FUNCTION DESCRIPTI N css Ie 17 add parameter arsi haradan e E a a a a E A e 17 fip IMAGES naaa a ENE AAEE AE es EE ae AE E AEN a 19 fip stream last error siss iaa aae a A A E A AE EE EE AA 22 FlD_SteaM_StatlUS ooo 23 fip stream Stop A A ey ee 24 flp stream stop PARE NO O 0 EE GPtt PP ee as es on ne dei Meee ed ee ee 25 A NN 26 A A EA E A EA aa tea tea savage tie erases ee 27 niant lo AAPP O NA 28 E sorsra riin aiina A EAEE EEEE AEAEE ae eee st dane EE EEEE EEREN 30 piz command ic A a 0 31 SS A NR 32 PUE SOU Sai A es ee ane 33 put_settings
44. cnnnancccn nar 55 analytics View _S leCt_MOE coooooococcconinicicococncnccononononccnncncnn rca n cnn 55 12 0151010 EPOC in E E oAGnGwwiahv An N I EE E A 56 apert re AW SIM AK zrei ous r innne RN 57 aperture PW MN iii rr 57 Page iv Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 APOLTULS MAX cit ita 0 T A a A a Rh 57 aperture y 4 ca ook ay ed Soe E A E 58 18 10 MRE 6 1075711 T EA E E A eas a bea Weeden dea esd adie 58 AULO HOIQNE s N EEA E NN 59 aulo JOGO QU NEY lt A A A AA A AAA As 59 QUO WII ti RA Aa a oa assi 60 QULO window 6nabl msn A A E A T t iaa aa 60 MULA ii A T 61 QUO Via A A AA AA AAA AA 61 QU DOOXPOSULO aa danse saa dace sind tn de nano donen aran dene sea aia tana o E a a ai Ha ai ada tons da 61 QU OEXPOSULO KM coccion ner 62 auloexposure TADO viii AAA AAA AAA AAA AA AAA A 63 ULOG IN a A A A A A A ane 63 E 8 qe Lo AINA KNOG eisini OA onan On vad Ses tights van dash dng dda onda dese BERSERI ddsb Une Peds vag NEEE nR EER 63 LIL OM roo 64 DOO VEO aii tds 64 DIIQHUNOSS coi A a aaa dae 65 COJON CONVOISION scsi a dan dai 65 COLOR POSO it aaa 65 COMAS iii ii a a Lasts A iaa eed 65 Crosshair enable on a a is A nae A bait A A aden 66 current_broadcast_addresS oooooooccocccococococccocononocanononcccccncnn nn 66 A sasha beets sees enna ae esate an ints east iaei EREE nG EERE 66 CUNETA a ayn era 67 CUENTE Pri nt an nanan andl an oA amusing Anan
45. corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 test_email_alarm Tests the motion email script udp_stream Transfers JPEG images to an UDP client udp_stream_stop Stops a particular UDP stream udp_stream_stop_all Stops all UDP streams version Returns firmware version information video Transfers a stream of JPEG images This section describes all of the camera s API functions and how to use them This function allows the saving of user defined properties on the camera Once properties have been added to the camera the get and set command can be used to access their values Arguments name string Must not contain spaces value string An arbitrary string Return Values Returns nothing on success Throws a fault on error Notes Setting the value of a property that does not exist results in an error Use save settings API function to save all user defined properties created using add parameter across camera reboots Copyright O 2009 Lu me nera Page 17 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Example CGI cgi bin add_parameter name MyProperty value MyValue Telnet l add parameter name MyProperty v
46. cription Enable or disable analog video output Note Applies only to the Le045 and Intelligent Li series cameras Type double read only Description Provides the frame rate of the camera in units of frames per second Notes This property may be affected by the image width height exposure and maximum exposure Network bandwidth may also affect perceived camera frame rate independent of this property Type double Description Accesses the camera s gain property Copyright O 2009 Lu me nera Page 75 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Notes 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 If autogain 0 the gain value is fixed at the value set by this property If autogain 1 the gain value may vary in order to bring the Luminance closer to the autoexposure target value Type double Description Provides manual control of the blue channel gain This property is used to color white balance the image and is adjusted when the whitebalance property is set Note Not supported by Le045 and Intelligent Li series cameras Type double Description Provides the maximum gain_blue value This property can be set dir
47. d path is first run through strftime so that a date can be added to the path name For full documentation of the conversion specifications please consult strftime documentation from http www opengroup org If path includes i or any other legal Unix SUSv2 printf variation such as 051 the relative image number will be inserted Increasing numbers apply to successive images The most recent image is assigned the number 0 Pre trigger images are assigned negative numbers If path includes Q the subsecond portion of the time in units of milliseconds 000 999 will be inserted An example path follows that uses the year month 1 12 day of month 1 31 24 hour time hours minutes and seconds and a relative image number Example path MyFilesYSm sdSHSM S 051i jpg Example result MyFile2008123123595900000 jpg If both post and pre values are zero then only one frame will be transferred The maximum value for pre is related to number of buffers and the global framerate property To stream indefinitely set post to a large value such as Page 20 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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
48. d number 0xFDE8 Utilities for reading EXIF header information are available from http home cfl rr com genecash digital_camera html http www exifer friedemann info Below is an example of the EXIF compliant header and how it can be parsed to retrieve its contents The tag 0x927C indicates MakerNote The field type for this tag is 0x7 meaning undefined format The length of the field is 0x26 or 38 bytes Page 118 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 in the EXIF header tagged data See byte 31 below 15 16 16 FD FFDEQ Identifying number number Copyright 2009 Lu me nera Page 119 corporation Release 1 8 1 16 Lumenera Network Camera API Reference Manual Glossary ABC API CGI CRLF or r n DC iris DHCP DNS EXIF FQDN FTP Auto Brightness Control As the image grows darker ABC will apply the following measures 1 Open the dc auto iris lens if present 2 Increase exposure up to the autoexposure_ knee 3 Increase analog gain up to the autogain_ knee 4 Increase exposure up to the maximum_exposure 5 Increase gain up to the maximum gain As the image gets darker the steps above are done in reverse o
49. default alternate and off Note Not supported by Le045 and Intelligent Li series cameras Type String read only Description Provides the factory set MAC address Type double Description Accesses the exposure time in milliseconds used by the image sensor Notes If autoexposure 0 the exposure time is fixed at the value set by this property If autoexposure 1 the exposure may vary in order to bring the luminance closer to the autoexposure target value Not supported by Le045 and Intelligent Li series cameras Copyright O 2009 Lu me nera Page 73 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type int Description This parameter is the offset to the automatic system gain using a value between 18 and 18 Note Applies only to the Le045 and Intelligent Li series cameras Type int Description Accesses the lens focal position Note This property applies only to camera models that use a Canon 35 mm lens Type int Description Provides the maximum value of focus property Note This property applies only to camera models that use a Canon 35 mm lens Type int Page 74 MLu me nera Copyright O 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description Provides the minimum value of focus property Note This property applies only to camera models that use a Canon 35 mm lens Type boolean Des
50. e 20 gain 2 0 Copyright O 2009 MLu menera Page 15 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual API Function Reference 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 camera Table 3 1 Summary of Camera API Functions Function Description add_parameter Adds a user defined property ftp_images Transfers JPEG images to an FTP server ftp_stream_last_error Returns last error from asynchronous FTP stream ftp_stream_status Returns status of an asynchronous FTP stream ftp_stream_stop Stops a particular FTP stream ftp_stream_stop_all Stops all FTP streams get Returns the value of the specified property get_settings Gets a summary of property values image Transfers a single image in JPEG format image_raw Transfers a single image in RAW format image_yuv Transfers a single image in Abekas YUV format lens _reset_aperture Synchronizes the iris control of a Canon lens load_settings Loads camera settings from non volatile memory put_settings Sets the values of multiple properties at once put_settings_from_property Applies settings stored in a property reset Reboots the camera save_settings Saves the current settings to non volatile memory set Sets the specified property to a new value Page 16 i i y Copyright O 2009 pLu menera
51. e will return the value 1 Type int Description Provides the IR filter shuttle position A value of 1 indicates night mode where the IR cut filter is removed from the light path Type boolean read only Description Provides the current status of the JPEG compression process A true value states that the encoder is busy converting images into JPEGs Type int read only Copyright 2009 Lu me nera Page 83 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description Provides the memory in bytes allocated to each JPEG image in the rolling buffer This value is inversely proportional to the number of buffers value Type double Description Specifies the JPEG quality level using a value between 0 2 and 99 Note The larger the number provided for this property the larger and higher quality the resulting JPEG image files produced by the camera This property becomes read only when auto jpeg quality 1 Type boolean Description Controls the state of the orange LED on the network connector When true the LED is active Type double Description AC mains frequency for artificial lighting in Hz Note This property limits the exposure to a multiple of a half cycle time 8 33ms for 60Hz 10 0ms for 50Hz in order to eliminate dark and light bands from appearing in the image It should be configured when the camera is placed in an environment where artificial AC based light is u
52. ease 1 8 1 16 TOMPOTA ULO 0 ii a ii a Sa beaded eae 111 UOZO A iia a ra 111 use dheis ROA Tu A ane 111 USO link lobala A A AA i da a da a 112 TI a PASSWOMG iii iaa Gi 112 VICO MOOG ii A A A Aa AE AAE 113 watchdog CUE ied ea ieee ea ees 113 Watchdog Gnable ince iicedties Gales EEEE ii 114 watchdog Milicia aii arde aletas 114 WAECHAOG PING AE AE VEA A E N N T A T 114 AIEEE EE E EE E E T ie Gen E AA SAE ATA S S 115 Whitebalance PreS tiantscudsnadeiin no ci E EE aaa Gaeta EEEE REEE EE 115 A ca aang de vhenasagnube 294 ni ancddeh andi vi nensacunbve ida ed naobanhansas E AE 116 Mi IA AAA A ARTE AA wanda Onna AAA IAE AE A EEE ONE A 116 BM 011 6 0 ia 117 aii aa 117 E A lanai ey eae E nate ilasiiaisniieiieii E 117 APPENDIX INTERPRETING EXIF HEADERS cccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 118 A1 1 GENERAL INFORMATION ON EXIF HEADER FORMA T ooooccccccccccccnnnnnnnnnnnnnnnnnnnnn 118 A1 2 DETAILED EXAMPLE OF EXIF HEADER sacate as 118 A cae tessa e cu scacns aae Eae aa aa aa EEN 120 Copyright 2009 L n y Page ix Ma Lumenera Network Camera Release 1 8 1 16 API Reference Manual List of Tables Table 2 1 URI Escape Code for Special Characters c seeeeeeeeeeeeeeeeeeeeeeeeeeeeees 10 Table 2 2 Available Access Levels in Network Cameras eeeeeeeeeeeeeeeeeeeeeeees 14 Table 3 1 Summary of Camera API FUNCTIONS oocccccccococoncccccnnnnncnnnnnnnnnnncnnnnnnnnnnnnnnnnnnnos 16
53. ectly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras Page 76 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double Description Provides the minimum gain blue value This property can be set directly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras 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 Note Not supported by Le045 and Intelligent Li series cameras Type double Description Provides the maximum gain green value This property can be set directly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras Copyright 2009 Lu me nera Page 77 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type double Description Provides the minimum gain green value This property can be set directly or by using the whitebalance preset property Note Not supported by Le045 and Intelligent Li series cameras 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
54. ed Centroid is l get motion 2 1 get motion y Area is l gel motion areas EOF Not supported by Le045 Intelligent Li series or Le11059 cameras 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 Note Not supported by Le045 Intelligent Li series or Le11059 cameras Page 92 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type string Description Defines the subject of the email message that is sent upon a motion alarm event when the default motion email script is in use Note Not supported by Le045 Intelligent Li series or Le11059 cameras Type double Description Defines the delay between frames being evaluated for motion detection This property is measured in milliseconds with a value between 0 and 255 frames Notes 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 Not supported by Le045 Intelligent Li series or Le11059 cameras Type string Description Enables and or disables the rectangles in the motion map Copyright O 2009 Lu me nera Page 93 corporation Lumenera Network Camera R
55. ed and still running in a Telnet session will exit with the message Terminated or Killed echoed on the console Example CGIL cgi bin ftp_stream stop all Telnet l ftp stream stop all Copyright 2009 ye Lu menera Page 25 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Returns the value of a specified property Arguments property name string Valid property name Return Values On success returns the value of the property Throws a fault on error Notes None Examples CGL cgi bin get autogain Return value 1 true or 0 false or cgi bin get width Returns an integer the image width in pixels Telnet l get autogain returns 1 true or 0 false or 1l get autoexposure returns 1 true or 0 false or l get gain 1 get exposure 1 get luminance returns all values in sequence Page 26 le al Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 This command returns an array of property value pairs representing all of the current settings in the camera Each property value pair is separated from the next pair by the user definable delimiter string Arguments delimeter lt optional gt string Separation character sequence that defines the individual property value pair Some settings may contain a carriage return line feed CRLF sequence as part of their value Setting the delimeter to a uniq
56. elease 1 8 1 16 API Reference Manual Notes The motion map is a grid of motion map width bymotion map height that is superimposed on top of the current viewing window or the entire image sensor ifmotion map windowed is true Each grid rectangle is either enabled or disabled by this property The map is specified as a string of hexadecimal digits each bit corresponding to a single grid location as 1 active or 0 inactive The maximum value of the motion map is 2 motion map width motion map height 1 for example 11111111 binary FFFF hexadecimal or 255 decimal for a 4 x 4 grid The most significant bit of this value corresponds to the upper left motion map grid element The following bits correspond to the next grid element to the right until the end of the row The following bits continue on the next row to the last bit which defines the bottom right grid element Not supported by Le045 Intelligent Li series or Le11059 cameras Type double Description Defines the number of horizontal rows in the motion_map Notes 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 The height of each rectangle in the motion map if motion map windowed 0 is height motion map height rounded to the nearest multiple of 4 lfmotion map windowed 1 then the height is max height subsampled 1 motion map height rounded to t
57. ence Manual 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 Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate or a subsequent video call may fail with an error Examples CGI cgi bin nph video or cgi bin nph video type multipart x mixed replaces framerate 5 or cgi bin nph video archive 1 amp start 100 Telnet Examples store binary data in camera file system and may exceed available storage capacity For test purposes only The video function is intended to be executed by a client computer cgi bin nph video cat gt myfile dat or 1 nph video type multipart x mixed replace cat gt myfile dat or l nph video archive 1 start 100 cat gt myfile dat In all Telnet examples above use CTRL C to halt their execution Page 48 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 API Property Reference This section describes all of the camera s API properties and how to use them Type string Description Access to the administrator password for the camera This property can be used to set the password Notes If this property is not empty a password is needed to access
58. ent Fractional values are supported This is in addition to skips required by the camera s maximum framerate global value default O framerate lt optional gt double The desired frame rate of the UDP stream If this value is non zero the camera calculates an appropriate frameskip value If the global framerate value changes the frame rate of this stream will change proportionately default O archive lt optional gt boolean Run in archive mode If set to 1 the camera will use its rolling buffer to send images without dropping any frames resulting in increased latency when network bandwidth is limited If set to 0 the camera may drop frames rather than increase latency default 0 Return Values Returns nothing on success Throws a fault on error Notes The first 16 bytes for each packet in the UDP stream are four integers each 4 bytes long which are described below Magic number Ensures the data received is from the camera Page 42 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Total image length in bytes This should be the same for each packet for a given image The remaining by
59. era Release 1 8 1 16 API Reference Manual 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 Example CGI cgi bin start Telnet l start Page 38 i i y Copyright O 2009 YLumenera corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Example CGI cgi bin stop Telnet l stop Copyright 2009 i L i y Page 39 umenera H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual 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 The duration of the pulse is set using the strobe length property Example CGI cgi bin strobe Telnet 1 strobe Page 40 i i y Copyright O 2009 YLumenera corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Unconditionally execute the motion email _ script This will force a
60. et the camera image properties back to the factory default state without affecting the non image properties 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 Copyright O 2009 Lu menera Page 71 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string Description Provides the default IP address fallback when no address information is provided when the camera is enabled with DHCP The factory setting for dhcp fallback is 192 168 1 222 Note If this value is empty and DHCP times out then no IP address will be set Type int Description Timeout value in seconds that the camera will wait for network settings from a DHCP server The factory setting for dhcp _timeout is 15 seconds Type string Description DNS domain name used by the camera Note If this property is a null string then the fully qualified domain name current fadn is determined dynamically by looking up the camera name in the DNS server nameserver This property can be set by the DHCP server Page 72 pLu menera Copyright O 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type string Description Sets the hardware built in edge enhancement image sharpening The valid values are
61. eturns the last error as a string Throws a fault if the command fails Typical error message returned are Unable to connect to FTP server IP address Login failure ftp open Notes Querying the last error does indicate if there was a subsequent successful FTP session using the same session name For example if the first session produces the error Login failure and is followed by another successful session that uses the same session name then ftp_stream_last_error will still report Login failure The return value of ftp stream last error may not reflect attempts to call the ftp _ images function where a required argument cannot be validated and the FTP session is never attempted For example calling ftp images with the path missing or incorrectly formatted fails with an error Missing Argument path but this does not affect the return value of a later call of ftp stream last error A return value of ftp open may indicate that a recent call to ftp images conflicted with an earlier call with the same session name For example very frequent alarm FTP events when using a small value of the alarm delay property may lead to conflicts In particular errors may result where more than one call to ftp images attempts to write to the same file path on the same server Example CGL cgi bin ftp stream last_error session alarm Telnet l ftp stream last error session alarm Page 22 i Lu menera Copyright 2009 H Lumenera Lumenera
62. ge call may fail with an error Example CGT cgi bin nph image jpg Telnet l image Copyright 2009 L y Page 29 umenera H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Loads camera settings from a file in non volatile memory Arguments filename lt optional gt string Filename of saved settings file default persistent Return Values Returns nothing on success Throws a fault on error Notes The filename can be any arbitrary name that was created using save settings API function or one of two special filenames persistent or factory defaults The filename persistent specifies the current power on defaults The filename factory defaults specifies the default settings with which the camera shipped Example CGI egi bin load settings Telnet l load settings Page 30 Lumenera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 Performs a pan tilt zoom PTZ control action of a motorized positioning system and motorized lens Arguments command lt optional gt string The action to perform where command is one of the following values default stop Pan Tilt actions stop up up_left up_right down down_left down_ right left right Lens focus actions far near Lens iris actions open close Lens zoom actions tele wide Return Values Returns nothing on success Throws a fault on error Notes App
63. gorithm will automatically adjust to a new scene as the view if when the scene changes A few frames are required for the algorithm to adapt to the new scene 1 Auto Force Mode When camera starts up the algorithm will use the first good scene as the view and will never change regardless if the scene changes in the future 2 User Select Mode When camera starts up the algorithm will use the first good scene as the view If the scene changes in the future the algorithm will report the unknown view It is up to the user to force the new scene as the new view in the analytics algorithm backend software Note Applies only to the Intelligent Li series cameras Type double Description The aperture of the lens expressed as an f number Notes This property applies only to camera models that use a Canon 35 mm lens A smaller f number represents a more open iris When iris_type is setto calibrated the aperture property value is limited by aperture min and aperture max If the lens is not properly installed aperture will return the value 1 When iris type is set to none or dc aperture will return the value 1 Page 56 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double read only Description The hardware imposed upper limit on the aperture property used to accommodate different lens types and is expressed as an f number Notes This prope
64. he image sensor No corrections or image processing are applied to this image In particular no JPEG compression has been applied For color images no demosaicing of the Bayer pattern of color filters on the pixels has been applied to generate RGB values for each pixel of the image See raw_mode for more information Request For Comments A numbered series of memoranda published on the Internet describing innovations in computer network engineering The Internet Engineering Task Force IETF may adopt some RFCs as standards Red Green and Blue A color image in which each pixel is assigned Red Green and Blue components In RGB color image capture each pixel of the image sensor acquires only the signal for only one color channel Color filters on each pixel are arranged in a regular mosaic pattern Values for the two missing color values for each pixel are derived by interpolating between the values of neighboring pixels Compare with YUV Real Time Clock The on camera clock Real Time Transfer Protocol Real Time Streaming Protocol Teletype Network A network protocol that provides means to communicate with a remote computer through a command line console client application The camera supports a telnet daemon for this purpose See telneta for more information Page 122 pLu menerg Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 UDP URI or URL UTC time YCbCr
65. he nearest multiple of 4 Not supported by Le045 Intelligent Li series or Le11059 cameras Type double Page 94 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description Defines the number of vertical columns in the motion map Notes This property defines the number of columns in the motion map It does not refer to the width of each rectangle in the motion map or the width of the entire motion map The width of each rectangle in the motion map if the motion map windowed 0 is width motion map width rounded to the nearest multiple of 4 If motion map windowed 1 then the height is max width subsampled 1 motion map width rounded to the nearest multiple of 4 Not supported by Le045 Intelligent Li series or Le11059 cameras Type Boolean Description Defines the motion map coverage over the camera s sensor Notes When this property is set only the viewable area of the camera s sensor is used for motion detection This means that if the camera is currently sub windowed down to only view one quarter of the full image dimensions only this sub windowed 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 Type double Description Defines the sensitivity of motion detection Val
66. ing defined by the motion alarm area property by a minimum amount defined by the motion sensitivity property in a specified area defined by the 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 Type string Description Provides the recipient email address for motion alarm events when the default motion email script is in use Note Not supported by Le045 Intelligent Li series or Le11059 cameras Copyright O 2009 Lu menera Page 91 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string Description Defines a script that is executed when a motion alarm event occurs Notes The factory set default value of this script uses the additional properties motion email subject motion email server motion email recipient and alarm delay to create and send an email message when motion is detected This script can be modified to change the body of the message take additional actions and or include variable properties in the subject line The contents of the script are as follows bin sh mail s l get motion email subject f motion alarm l get current fqdn S l get motion email server H l get current fqdn l get motion email recipient lt lt EOF 7 o y Motion detect
67. irmware 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 lt html gt lt head gt lt title gt Success lt title gt lt CAMERA Lumenera explorer2 r5281 hw1 1 1 8 0 10 le075c dn Fri 21 Sep 2007 13 31 21 0400 gt lt head gt lt body BGCOLOR white gt version executed successfully lt p gt lt pre gt Lumenera explorer2 r5281 hw1 1 1 8 0 10 leO75c dn Fri 21 Sep 2007 13 31 21 0400 lt pre gt lt p gt lt a href index html gt Home Page lt a gt lt body gt lt html gt 2 4 2 3 Response on Failure If there is an error templates error tmpl is processed and returns the command name and error number Page 12 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Example get a non existent API property http CamIP cgi bin get foo Failure template response lt html gt lt head gt lt title gt Error lt title gt lt CAMERA ERROR 3 Invalid Argument property foo Ctl Cr265 gt lt head gt lt body gt get produced error lt pre id error gt Invalid Argument property foo ctl c 265 lt pre gt lt body gt lt html gt Example set a property to invalid type string instead of double http CamIP cgi bin set gain X Failure template resp
68. lies 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 Each action is performed in one pre defined step size The same actions and step sizes are used in the graphical web page user interface for PTZ control Set ptz enable to be true when using ptz_ command A system error is thrown unless serial use accessory and serial speed 2400 Example CGIL cgi bin ptz_command up left Telnet l ptz_command up left Copyright 2009 i Lu menera Page 31 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Used to instruct the camera to set clear or move to a particular pan tilt zoom PTZ camera preset position Arguments command lt required gt string The action to take set goto or clear set Set the specified PTZ preset id_number at the current position goto Move to the PTZ preset position associated with id number clear Clear the PTZ preset associated with id number id number lt required gt string The preset number to which the action applies Return Values Returns nothing on success Throws a fault on error Notes 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_
69. limits The auto algorithm s primary guidance is to minimize noise in the image so it prefers to lower the gain rather than lower exposure and it prefers to raise exposure rather than raise gain The setting autoexposure knee 0 corresponds to setting this value to the maximum exposure that does not slow down the camera s frame rate Page 62 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double Description The luminance target The camera will adjust its settings in order to achieve an image with luminance near the value provided Notes The luminance is calculated as specified by the auto_algorithm property If autoiris autoexposure and or autogain are enabled the camera will adjust the iris diameter aperture exposure and or gain respectively Not supported by Le045 and Li045 cameras Type boolean Description Enable or disable autogain functionality Notes 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 _algorithnm algorithm The auto algorithm s primary guidance is to minimize noise in the image so it prefers to lower the gain rather than lower exposure and it prefers to raise exposure rather than raise gain Type double Copyright 2009 ML
70. lue of either projected network framerate or framerate When set to 0 the auto jpeg quality algorithm will use the jpeg buffer size value instead For the Le045 and the Intelligent Li series cameras the projected network bandwidth and projected network framerate properties are not supported See target jpeg size Copyright 2009 Lu menera Page 87 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type int read only Description Provides the maximum subsampling factor supported by the imager used in the camera Type int read only Description Provides the maximum width supported by the imager used in the camera Type double Description Defines the limit of the exposure range when autoexposure 1 Note Setting this property to O sets the exposure limit so that the frame rate is not affected Type double Description Defines a limit on the camera s maximum frame rate Page 88 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Note To disable the limit set this property to O to disable Type double Description Defines a limit to the gain range when autogain 1 Type double read only Description The absolute maximum gain supported by the camera model in use Type boolean Description Enables or disables the median filter correction Default is false Notes The median filter
71. lution Protocol used for finding and resolving network addresses DHCP Dynamic Host Control Protocol used to get camera s IP gateway subnet mask and DNS servers DNS Domain Name System used to translate domain names email servers and other information into addresses SMTP client only Simple 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 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 Telnet see Section 2 4 3 for more details The following sections will describe how to access the camera s functions and properties within their respective interface 2 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 POST request where the body of the request is an XML 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 whe
72. n accessed through this Copyright O 2009 Lu menera Page 7 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual interface They communicate through port 80 using the camera s RPC interface URI Uniform Resource Identifier The Network Camera SDK 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 O 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 strepy s peButf er 10 le gets 1f xmlClient gt execute pcBuffer args result bReturn FALSE copy return information into function arguments provided osimager static cast lt std string gt result c str Clean up and destroy object xmlClient gt close delete xmlClient Page 8 Lu menera Copyright 2009
73. n 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 Page 66 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 simply name dns domain name Otherwise it is obtained by asking the associated nameserver Type string read only Description Provides the gateway used by the camera Type string read only Description Provides current IP address assigned to the camera Type string read only Description Provides the nameserver assigned to the camera Type string read only Description Provides the IP subnet mask assigned to the camera Copyright O 2009 Lu me nera Page 67 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string Description Accesses the camera s current date in RFC 2822 format Example Mon 10 Nov 2006 15 48 06 0500 Type string read only Description Provides the camera s current UTC date in RFC 2822 format Example Mon 10 Nov 2006 15 48 06 0000 Type boolean Description Used to set or query the day night mode of the camera If day _mode 1 true the Factory Default Image Defaults startup value the camera is in day mode and uses the settings defined in the property normal light settings If day_mode 0 false the camera is in night mode and uses the
74. n the privacy map Page 102 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Notes This property defines the number of columns in the privacy map It does not refer to the width of each rectangle in the privacy map or the width of the entire privacy map The width of each rectangle in the privacy map if the privacy map windowed 0 is width privacy map width rounded to the nearest multiple of 4 lfprivacy map windowed 1 then the height is max_width subsample 1 privacy map width rounded to the nearest multiple of 4 Not supported by Le11059 cameras Type int Description Defines the estimated network bandwidth available in units of Bytes per second Notes The target JPEG image file size in bytes is determined by this property along with the projected_network framerate property Does not apply to the Le045 or the Li series cameras Use the target _Jpeg size property instead Type int Description Provides the anticipated frame rate in frames per second to be transmitted over the network This is different from the framerate property where this value defines the rate at which the camera captures new images Notes The target JPEG image file size in bytes is determined by this property along with the projected_network bandwidth property Copyright O 2009 Lu menera Page 103 corporation Lumenera Network Camera Release 1 8 1 16 API Reference M
75. nal gt boolean Run in archive mode If set to 1 the camera will use its rolling buffer to send images without dropping any frames resulting in increased latency when network bandwidth is limited If set to 0 the camera may drop frames rather than increase latency default 1 Copyright 2009 Lu menera Page 19 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual ref date lt optional gt string 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 A request for images that are no longer present in the buffer will produce the most recent images possible The ref date format is the same as that obtained from the cgi bin get date or 1 get date commands RFC 2822 see the documentation for the date property in the API The ref date must be URL encoded If ref date is used then ref useconds is also required The ref date is ignored if it is empty null ref useconds lt optional gt int The portion of the time of the requested index frame image number 0 in microseconds default 1 ref useconds is ignored Return Values Returns nothing on success Throws a fault on error Error can be retrieved by calling ftp stream last error API function Notes If path specifies directories that do not exist the directories will be create
76. ncaa rorya TEE Da EDA A Aia TDT ae 79 O A neil deen Ae eee del ieee 79 h264 enable emrenin e es AE E ls R ENARE bus aw EA AA iA A EOE ule dele ati AEREE ESE 80 E RN 80 image stabilizer ooooniiicinnnnniicinniccin acc rccrnnrrnnr 80 Magor MONO aaa abia ts ia atan ola ati aca pal 81 AP E A E A E A a eive 81 io i 2QIQMM ON ADIC aci tn EAE E EEE AEAEE aes 81 io_in_debounce_time eee 82 JO INSTIGA TO ii iba 82 0 MN 11 glo e 1 ACG E ee E E E E N E E ie hoes 82 PR 82 IS O AO 83 it shuttle position ia ii cn A A A A A 83 Page vi Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 E E er cece A E tre eras ere A errr peer ree A er ear E recat ere epee er er E ias 83 JPEG DUTICT 2SIZO A ai 83 IPC GQUAIlIY RECO COCO T EE haa dieinn i E A bees dati enanbe di ened a ited aaedes 84 NOC POP In in iesid init Yo aie Ge na a cee ee E 84 HQIUNG MOGUNE it a EA de Ah a AS AAA TOE 84 WE local p eea in is tia ai 85 IOW ligt Ct ici 85 low light Soling cocida 86 low NGL Sta DIO OUI QTON coca da AA AA A EEOAE aa 86 E E A aaa aaa 86 MAC O ae cet eat aes ca aN Soe aa ae ca tea eee eee 87 MAX e i A da a da aise A eel a E di 87 max Pog S20 ii ib A A ei nage oe ved E a E A AE a di 87 MAX SUD SAIN PIG occitano age ets 88 MIMI a aan 88 maximum OXPOS Uli A atacan 88 maxim m fram rat aid 88 UE E ioe eh E E A E 89 MAXIMUM_QA N Milicic 89 median Mores aeae A a e a aa A AO ae 89 MOM NOG PRI OP
77. nce 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 Substances in Electrical and Electronic Equipment RoHS 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
78. nce and whitebalance values The auto control window is defined relative to the top left of the current viewing window that is defined by height width x and y The auto brightness control also requires autogain autoexposure and or autoiris to be true When cleared the entire viewing window is used for the auto_algorithm calculations Page 60 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type int Description Horizontal offset of the auto control window from the left edge of the current viewing window Notes 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 This property is enabled and disabled with auto window enable property Type int Description Vertical offset of the auto control window from the top edge of the current viewing window Notes 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 This property is enabled and disabled with auto window enable property Type boolean Copyright O 2009 Lu menera Page 61 corpo
79. number of JPEG images stored in the rolling buffer memory Copyright O 2009 Yu me nera Page 99 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Notes The jpeg buffer size in bytes 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 if the save settings command is first used to store the change to non volatile memory and then the reset command is used to reboot the camera Type int Description Defines the number of raw uncompressed images the rolling buffer memory can hold Note This property must be set to a number larger than 2 for the image raw or image yuv functions to take effect Changes to this property only take effect on reboot of the camera Type string Description Defines the type of output available on the camera s general purpose output pins The valid settings are on Current can flow through the output connection off Output transistor is turned off alarm Output a pulse when an alarm occurs The pulse duration is defined by the strobe length property The alarm may be either a video motion detection alarm or a signal on the general purpose input pins Page 100 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release
80. o the camera Detection of an actual alarm event is affected by io in debounce time io in trigger edge and io in trigger neg Copyright 2009 MLu menera Page 81 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type int Description GPIO input debounce time value in units of milliseconds Note io in debounce time is not used on the Li series cameras or the Le045 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 Type boolean Description When true the GPIO input will trigger an alarm event based on a negative level or falling edge When false the alarm will be triggered on a positive level or rising edge Type string Description Provides the IP address the camera will be used on the next reboot if DHCP is disabled Page 82 L y Copyright O 2009 umenerd H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type string Description Describes the type of iris that is installed on the camera Values for this property are none de and calibrated Notes This property applies only to camera models that use a Canon 35 mm lens When iris type is set to calibrated the aperture property value is limited by aperture min and aperture max If the lens is not properly installed aperture will return the value 1 When iris type is set to none or dc apertur
81. omplete the URI There is no actual message body This means that the URI can be bookmarked in a web browser The camera returns a web page presenting the results of the request Arguments are specified as they would be in any standard HTML form submission A command is separated from its arguments with a question mark and arguments are separated with an ampersand s Each argument is of the form argument value The content of strings that include special characters must use conventional URL or URI escape codes In particular the characters in Table 2 1 may require substitution with the URL and URI escape codes indicated Copyright 2009 pLu menera as corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Table 2 1 URI Escape Code for Special Characters Character URI Character URI Escape Escape Code Code SPACE 20 3F 24 40 25 5B amp 26 5C 2F 5D 3A A 5E 3B 60 lt 3C 7B 3D 7C gt 3E 7D 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 Examples on how to access functions through the web interface Launch MJPEG video stream http CamIP cgi bin nph video Or http CamIP cgi bin nph video type multipart x mixed replace Query firmware amp h
82. onse lt html gt lt head gt lt title gt Error lt title gt lt CAMERA ERROR 3 Invalid Argument gain X invalid type CUlses715 gt gt lt head gt lt body gt set produced error lt pre id error gt Invalid Argument gain X invalid type ctl c 215 lt pre gt lt body gt lt html gt Copyright O 2009 i L y Page 13 umenera x erporation Lumenera Network Camera Release 1 8 1 16 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 admin admin_password Full access cgi bin Port 80 user user_password Limited access cgi usr Port 80 and Port 8080 read only public None Very limited cgi pub Port 80 and Port 8080 access The admin password sets access to the camera s cgi bin directory and admin htn file The user password provides only the specific commands from the path cgi usr that are listed below cgi usr get cgi usr image cgi usr nph image cgi usr nph image jpg cgi usr nph video cgi usr version cgi usr video Where a request is made for admin access without proper authentication the standard 401 Not Authorized response is issued lt HTML gt lt HEAD gt lt TITLE gt 401 Unauthorized lt TITLE gt lt HEAD gt lt BODY gt lt H1 gt 401 Unau
83. ontrol 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 Communication to the Network camera can be done using several standard Ethernet Network based protocols Some 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 HTTP HyperText Transfer Protocol used for transferring image data from the camera using either a web browser media player or a custom application programmatically Page 6 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Reso
84. 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 support lumenera com to receive a new password 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 support lumenera com or by phone at 1 613 736 4077 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 support lumenera com to obtain a user name and password e Your name Company Name address and telephone number e Your camera model and serial number e Your purchase information e g did you purchase from an OEM or distributor e Upon providing the above information you will receive you
85. p blocks private areas from view e 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 e 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 o UDP alarm notification to a specified client Copyright 2009 Lu menera Page 5 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual o User can edit Linux script to perform other functions upon alarms e Static or dynamic IP settings e Date time time zone settings o Can specify one or more NTP Network Time Protocol servers e Passwords o Admin full rights o User view images and simple queries e Enable disable telnet daemon e Enable disable serial console RS232 port e Watchdogs periodic built in self tests e Firmware upgrade through web browser interface e Reset default image settings e Save user settings to camera memory e 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 Subsequent sections of this manual explain how to access and c
86. posures5Ftarget 3D20 3Bautoexposures 3D1 3Bautogain 3D1 3B 2 4 2 1 No Process Header NPH commands You may also prefix any CGI command name that is specific to the camera API video image get set get_settings version etc with nph A NPH CGI program starts sending data immediately rather than buffering it to construct the Content Length HTTP header By using these commands the requests bypass the web server by writing directly to the HTTP socket The NPH command thus has a significantly lower latency The NPH command format is recommended for all image and video transfers Examples follow Single JPEG image http CamIP cgi bin nph image jpg MJPEG image stream http CamIP cgi bin nph video Copyright 2009 Lu menera Page 11 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual 2 4 2 2 Response on Success If the API function call succeeds then templates success tmpl is processed and returns a Success message formatted as HTML Functions that return binary results such as cgi bin nph image 4jpg do not use the response template mechanism unless there is an error The format of the success template places the return value in a lt CAMERA gt tag This is followed by an HTML formatted body that includes a lt function gt executed successfully message the return value if any and a hyperlink to the index page of the camera Example query f
87. preset sends a command to a PTZ controller board via the camera s RS232 serial port Set ptz_ enable to be true when using ptz_command A system error is thrown unless serial use accessory and serial _speed 2400 Example CGI egi bin ptz preset ysetss egi b1n ptz preset gotos3 egi bin ptz preset elearss3 Telnet l pee preset set 3 l ptz preset goto 3 l ptz preset clear 3 Page 32 i Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 The first equals sign in a name value pair separates the name from the value A value can contain equals signs Arguments settings string property value pairs string delimiter lt optional gt string Delimiter that separates the property value pair default Return Values Returns nothing on success Throws a fault on error Notes The delimiter cannot be 10 NULL It is recommended that the delimiter not contain a carriage return line feed pair CRLF as text translation may occur If using the CGI interface or the command line standard URI escapes are used Example CGI cgi bin put_settings gain 3D1
88. r access information via email from a TAC representative Page 2 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Network Camera APl 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 RS232 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 CH NET Simple examples using many of these languages are provided on the CD ROM provided as part of the 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
89. ration Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description Enable or disable the autoexposure functionality Notes When disabled the exposure time is strictly controlled by the value of the exposure property When enabled the camera adjusts the exposure to match the requested luminance set by the autoexposure target value using the currently specified auto _algorithnm algorithm The camera also uses the lighting frequency property to limit the exposure value to predefined multiples in order to avoid banding or flickering in images when using AC powered light sources The auto algorithm s primary guidance is to minimize noise in the image so it prefers to lower the gain rather than lower exposure and it prefers to raise exposure rather than raise gain Not supported by Le045 and Intelligent Li series cameras Type double 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 Notes If both autoexposure and autogain are set the camera will achieve the autoexposure target by adjusting either exposure or gain The auto algorithm will adjust one property until it reaches the knee point value and then adjust the other property to achieve the desire luminance value Once both values are reached the exposure and gain values are adjusted to the respective
90. rder Application Programming Interface Common Gateway Interface Refer to Section 2 4 2 Denotes the combination of the carriage return and line feed characters Cameras in the CS mount format support DC iris galvanometric lenses Video auto iris lenses are not supported Dynamic Host Control Protocol By default a camera will attempt to locate a DHCP server from which it will obtain an IP address Domain Name Server Exchangeable Image File Format The Lumenera Network 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 Fully Qualified Domain Name File Transfer Protocol In the camera this may be used to transfer images to a server on demand upon motion or upon receiving a signal on the GPIO input Page 120 Ya Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Gamma GPIO HTTP JPEG MAC MD5 A parameter that specifies a nonlinear characteristic for the mid tone brightness level in the image A value of 1 4 is typical See gamma in the API property reference General Purpose Input and Output The cameras are equipped with one pair of terminals for input and another for output Both are optically isolated to minimize the risk of accident
91. rporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description The gain level at which the camera enters into night mode when daynight mode is set to auto Default is 16 Notes Must be greater than daynight gain out threshold Takes effect only if autogain is enabled and daynight_mode is auto Applies only to the Le045 and Li045 cameras Type double Description Determines the highest gain that will be applied in night mode Default is 31 Notes Applies to all daynight_mode settings auto external and on Applies only to the Le045 and Li045 cameras Type double Description The gain level at which the camera exits night mode Default is 8 Notes Must be less than daynight_ gain in threshold Takes effect only if autogain is enabled and daynight_mode is auto Applies only to the Le045 and Li045 cameras Page 70 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type string Description Default is auto Legal values are o off always in day mode o on always in night mode and o auto switch in and out of night mode depending on the system gain daynight gain out threshold and daynight gain in threshold Notes Applies only to the Le045 and Li045 cameras Type string Description Provides a list of default image parameters that can be used by put settings from property API function to s
92. rporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type string 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 criteriaand low light stable duration to determine when to switch to night mode Type double Description Defines a time in seconds for which low light criteria must be valid before low light settings are applied Type double read only Description Provides the current luminance image intensity value expressed as a percentage of full bright image Note This property is affected by the settings for auto_x auto _y auto width auto height auto algorithm autoexposure autogain and autoiris Page 86 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type string read only Description Provides the camera s Ethernet MAC address Type int read only Description Provides the maximum height supported by the imager in the camera Type int Description Defines the maximum JPEG image size in bytes that should be used by the camera when compressing the video images Notes The maximum JPEG size that is used by the auto_jpeg_quality algorithm is the minimum value of the following max jpeg size or projected network bandwidth divided by the minimum va
93. rty applies only to camera models that use a Canon 35 mm lens with iris type property set to calibrated A smaller f number represents a more open iris 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 Notes This property applies only to camera models that use a Canon 35 mm lens with iris type property set to calibrated A smaller f number represents a more open iris Type double Description The user defined upper limit on the aperture property This property can be read or set to a maximum aperture of the iris and is expressed as an f number Copyright O 2009 Lu menera Page 57 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Notes This property applies only to camera models that use a Canon 35 mm lens A smaller f number represents a more open iris Type double 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 Note This property applies only to camera models that use a Canon 35 mm lens A smaller f number represents a more open iris Type string Description Specifies the method or algorithm used to calculate Luminance for purposes of the auto brightness control ABC Notes Setting autoexposure and or autogain to true will ca
94. sable alarms notifications via email 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 50 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type boolean Description Enable and disable alarm notifications via FTP 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 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 Notes When enabled and an alarm occurs a UDP packet is sent to the client defined by alarm udp client on the alarm udp port port The packet is in human readable format using carriage return line feed pair as the separator event number an incrementing unsigned long 32 bit integer IP address the camera s IP address xxx xXX xxX XXX hardware address the camera s hardware MAC address XX XX XX XX XX XX trigger time the time the trigger occurred Tue Jun 10 12 09 46 2006 trigger reason one of motion centroid x d y d area 2 4f that specifies the X Y coordinates where the motion was
95. sed to illuminate the scene Page 84 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 For countries using 60 Hz electrical power such as North America this property 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 Type string Description Provides the link local IP address that will be used when use_link local 1 Type string Description Describes a list of criteria that describes the night mode threshold needed to set the camera into its night mode Notes A typical value is gain gt 32 The expression is phrased using comparison operators lt gt lt gt does not equal amp AND OR and arithmetic symbols The expression elements must be separated by at least 1 space The camera evaluates this expression once per second to determine if the night mode threshold has been achieved The criteria must be valid for a time in seconds given by low light stable duration in order for the camera to switch to night mode by applying the low light settings The exposure low _ light exposure threshold gain low light gain threshold luminance and low light luminance threshold values are available for comparison by name in the provided expression Copyright O 2009 Lu menera Page 85 co
96. set simultaneously Not supported by Le045 Intelligent Li series or Le11059 cameras 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 Copyright O 2009 Lu menera Page 109 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type int Description Specifies the number of pixels that should be skipped decimation or subsampling or combined binning for each pixel that is displayed Note A change in subsampled involves a change in the image geometry dimensions 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 Type int Description The target JPEG image file size in bytes that is used by the auto jpeg quality algorithm If set to the special value of zero target _Jpeg size will be set to 90 of jpeg buffer size Note Applies only to the Intelligent Li series cameras and the Le045 Type boolean Description When telnetd is true the telnet daemon is enabled When telnetd is false the telnet daemon is disabled Page 110 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Type double read only Description Provides the approximate intern
97. sic oociiiai iii ad Ata 102 privacy Map Nell iia ti ti dt det AAA Adi 102 privacy map MI ata 102 projected_network_banQdWid h oooooooocooconcccoconaconcccconcnonnnnnannoncnnnnnnnnnnr nn nn n nn rra NEE EE aT EE 103 projected_network_framerale 2 ccccccccceeceneceeeceeeteseesenaeceseeetegeaaanaeeeseeeseaaaanaeeeseesteaeeasnaeeeseestees 103 PEZON iba ear 104 PEZ DFO OCO latas tia tii oia 104 TAMIZ A A a it 105 raw MOJ aneron aneia a a a a eae A ban eee 105 PUD ON ADIC errearen nd pnnsdehapadd E ERRERA EEEE ERARE E EA E EEEE E EEE TEERAA E E E ERAAI EE 105 ftp tramerat ises isinetsiisner rre iran ar aknan inei paraat ARER ap Eiane Daakia 106 Hp packot SiZo ies 106 TUDO DOF boicot E E A S 106 SAUNA A A AAA AAA AR 107 S t ration DIAS vecindad betas 107 SIRO 22 eccccececneccccececececneneeaecececeteaneaaenecececasaananaeceeeeesaseananaeseceessaseaaaaaeseseesseseaaeeeteseeseessenanestees 107 serial OWN A ganas ian coe Lean ct AAA 108 serial Spoed vi OPEN seizes eee v ea vee i EEA E EEEa EE aT E EE EEEE anak 108 A NO 108 Show_mMoti0n_detected oooooconcicccccnnnccnonncononcccncnnnn cnn 108 SHOW motion _WINCOWS ooooononocccccconnnnona nano 109 SUNODG longi moisioicin tia A EEE AEA EE EAEE 109 S bSamplod s sena da cata AAA A AAA 110 TT A ra nnen a EAE nRa N n Eann ieaie niina 110 11 e MEEA eit nerd neat en eee NO 110 Page viii Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Rel
98. synchronization e Configurable ABC iris gain amp exposure knee points e Auto iris enable or disable e 4 wire DC direct drive auto iris on CS mount models e Configurable brightness targets e Four histogram based ABC algorithms o Average o Median similar to Average but ignores extreme bright and dark o Peak detect regulate only on brightest areas o Dark detect regulate only on darkest areas e White balance o Continuous auto white balance o Single shot white balance o User defined AutoWindow selection e Defines region of interest for white balance and Auto Brightness Control ABC e EF mount Canon SLR lens control o For large format models Le259C amp Le11059C o Remote control of focus o Auto iris user specified day time and night time lens aperture e Image processing Page 4 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 o Saturation monochrome through to bright color o Contrast o Sharpening o Brightness e Light source color temperature corrections with color gain limits o Default o Daylight o Fluorescent o Halogen o Wide e Gamma mid tone brightness e JPEG quality e Frame rate transmitted over the network e Number of buffers images in on camera memory e Geometry Region of Interest o Configurable width height and location o Subsampling decimation and or binning o Horizontal x mirror or vertical y flip image flip e Privacy ma
99. t recent image still in the buffer that was captured prior to the requested time A request for images that are no longer present in the buffer will produce the most recent images possible The ref date format is the same as that obtained from the cgi bin get date or 1 get date commands RFC 2822 see the documentation for the date property in the API The ref date must be URL encoded If ref date is used then ref useconds is also required The ref date is ignored if it is empty null ref useconds lt optional gt int The portion of the time of the requested index frame image number 0 in microseconds 0 to 999999 default 1 ref useconds is ignored Return Values If the camera is stopped a value of 0 for the number may cause this command to hang for an undefined period of time Throws a fault on error Returns a binary JPEG image file on success The format of the response is as follows HTTP 1 0 200 OK Server lumenera nph cgi Cache Control no store Pragma no store Content Length 443552 Content Type image jpeg EXIF header and JPEG image data follows Page 28 Lu menera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Notes Use nph image or nph image jpg to make a No Process Header request for reduced latency Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate or a subsequent ima
100. tes in the packet are image data Each packet should be less than 64KB in size Immediately after a change in the image geometry x y width and or height wait at least 2 1 framerate or a subsequent udp stream call may fail with an error Example CGI cgi bin udp stream client 123 123 123 123 amp port 1234 Telnet l udp stream client 123 123 123 123 port 1234 Copyright 2009 Lu menera Page 43 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Stops a UDP stream Arguments client string The client name or address port int 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 amp port 1234 Telnet l udp_stream stop client 123 123 123 123 port 1234 Page 44 i Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Copyright 2009 Lu menera Page 45 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Returns a string describing the camera hardware and software This includes the hardware version camera name firmware version and firmware build date Arguments None
101. the amount of SDRAM that has been initialized in the camera Units are bytes Type boolean Description Disabled the image processing function and places the camera in RAW image mode Note When in RAW mode the JPEG hardware CODEC is turned off and the RAW imager data may be accessed using the image raw or image _yuv commands 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 orhttp camera rtp sdp For model Le045 and Intelligent Li series cameras additional video stream connections include rtsp camera mjpeg and rtsp camera h264 The maximum width supported for RTP streaming is 2048 pixels RTP streaming of images with wider dimensions will produce incorrectly formatted images Copyright 2009 Lu menera Page 105 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Type double Description Defines the frame rate used for RTP transfer Note Network bandwidth may affect the perceived frame rate Type int Description The size of RTP packets in units of bytes 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
102. the speed of the serial port Type string Description Enables or disables the serial port for console or for an accessory The valid values are console accessory Or none Notes To apply changes first call save settings to store the change to persistent memory and then reboot the camera In the accessory mode the camera serial port stops sending characters as soon as the TCP connection closes even if some characters have been received but have not been echoed on the serial port Type boolean Page 108 Lu me nera Copyright 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 Description Displays the motion that was detected by the camera by applying a white overlay that appears as a ghosted image Notes Since images sent by all methods will display the detected motion this mode is intended to be used only as a setup and calibration tool Both show motion windows and show motion detected cannot be set simultaneously Not supported by Le045 Intelligent Li series or Le11059 cameras Type boolean Description Displays the selected elements of the motion map grid that are defined in the motion map set in the camera The regions are highlighted with a grey rectangle Notes Since images sent by all methods will display the detected motion this mode is intended to be used only as a setup and calibration tool Both show motion windows and show motion detected cannot be
103. thorized lt H1 gt Your client does not have permission to get URL cgi bin version from this server lt BODY gt lt HTML gt In the example above a valid request at the user access level could specify cgi usr version instead of cgi bin version Public access allows access to the following commands cgi pub version index html images javascript favicon ico Page 14 MLu me nera Copyright O 2009 corporation Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 To access any function in the Camera API through a telnet session use either the luether command or 1 for short API functions and their individual arguments are separated by a space Below are some examples on how the functions can be accessed through a telnet client To save the current camera settings to non volatile memory luether save settings l save settings To get an image from the image buffer luether image number 2 l image number 2 To access a camera property use the get or set API functions as shown below To get the current camera gamma value luether get gamma l get gamma To set the camera s exposure and gain in one command luether set exposure 20 gain 2 0 set exposur
104. u menera Page 63 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description Defines a gain value where the auto_algorithm will stop adjusting the gain and starts adjusting the exposure value until both the autoexposure_ knee and autogain_ knee points are reached Notes If both autoexposure and autogain are set the camera will achieve the autoexposure target by adjusting either exposure or gain The auto algorithm will adjust one property until it reaches the knee point value and then adjust the other property to achieve the desire Luminance value Once both values are reached the exposure and gain values are adjusted to the respective limits The auto _ algorithm s primary guidance is to minimize noise in the image so it prefers to lower the gain rather than lower exposure and it prefers to raise exposure rather than raise gain Type boolean Description Enable or disable the auto iris functionality Notes When set and when the exposure value begins to drop below the minimum exposure value the camera closes the lens iris to achieve the requested luminance specified by autoexposure target If the target luminance cannot be achieved due to low light conditions the autoexposure and or autogain functionality is activated when enabled Type string read only Description Returns a string describing the bootloader version Page 64 Lu menera Copyright 2009 corporation Lumener
105. ual Basic Copyright 2009 Lu menera a corporation yg Lumenera corporation 7 Capella Court Ottawa ON Canada K2E 8A7 Phone 613 736 4077 Fax 613 736 4071 www lumenera com 2009 Lumenera Corporation all rights reserved Design features and specifications are subject to change without notice
106. ue value other than a simple CRLF will ensure that parsing the response will be accurate If a zero length string is passed the delimeter will be 10 NULL default r n r n Return Values Array of property value pairs on success throws a fault on error Notes The entire table of delimited settings is issued twice following the standard format of templates success tmpl once in the lt LUMENERA gt Or lt CAMERA gt tag and again in the body of the HTML Only property values that are saved in the configuration database will be returned Example CGI cgi bin get settings Telnet l get settings Copyright O 2009 Lu menera Page 27 H Lumenera Lumenera Network Camera Release 1 8 1 16 API Reference Manual Transfers a single image in JPEG format Arguments number lt optional gt int Specifies the image in the rolling buffer to be returned where 1 corresponds to the most recent image in the buffer number of buffers 1 indicates the oldest image A value of 0 requests the image currently being integrated Note that it is possible to pass a value of number that is out of range based on the current value of number of buffers lf ref date is used then ref useconds is also required The ref date is ignored if it is empty null default 1 ref date lt optional gt string Date and time for the requested index frame image number 0 to a precision of seconds The camera will send images beginning with the mos
107. ues from O to 100 are valid with 100 being the most sensitive meaning that the pixel has to change by the least Copyright 2009 MLu menera Page 95 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual amount to be counted as a changed pixel Not supported by Le045 Le11059 and Intelligent Li series cameras Type int Description Defines the delay between frames being evaluated for motion detection This value may be between 0 and 255 and is measured in frames Notes This property is similar to motion gap 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 Not supported by Le045 Intelligent Li series or Le11059 cameras Type int read only Description Defines the x location of the centroid of motion in the detection window during the last alarm Notes 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 Not supported by Le045 Intelligent Li series or Le11059 cameras Page 96 Lu menera Copyright 2009 corporation Lumenera Network Camera
108. uration in seconds of images occurring before an alarm event that will be transferred when an alarm event occurs Note Since new images are always being added to the rolling image buffer while the oldest images are overwritten the maximum value for this property is related to number of buffers property and the camera s global frame rate Type string Description IP address of the target FTP server that will receive files upon an alarm event Type string Copyright O 2009 Lu me nera Page 53 corporation Lumenera Network Camera Release 1 8 1 16 API Reference Manual Description User account name on the alarm_ftp server FTP server that receives image files sent upon an alarm event 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 Each client address can include an optional appended port number delimited by a colon Errors appear in the camera file system in var log messages Type int Description UDP client port that receives the UDP packets upon an alarm event Note Errors appear in var log messages The port can also be specified in alarm udp client property string by separating it from the IP address using a colon Type boolean Description Enable or disable analytics alarm delivery This parameter only has an effect when the camera is equipped with
109. use the camera to adjust the exposure time and or gain to achieve the target luminance specified by autoexposure target See auto window enable auto width auto height auto x and auto y for information on defining the auto control window used for these calculations If auto algorithm average the luminance value is calculated as the mean of the entire auto control window If auto_algorithm median the luminance value is calculated as the median of the whole auto control window The median algorithm is less sensitive to extreme bright and dark areas than the average algorithm Page 58 i Lu menera Copyright 2009 H Lumenera Lumenera Network Camera API Reference Manual Release 1 8 1 16 lfauto algorithm peak the luminance value is calculated using only the brightest areas of the auto control window Ifthe auto_algorithm dark the luminance value is calculated using only the darkest areas of the auto control window Applies only to the Intelligent Li series cameras Type int Description Height of the auto control window Notes 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 top left of the current viewing window that is defined by height width x and y This property is enabled and disabled with auto window enable property Type Boolean Description Enables or disables the
110. we Lumenera CO Tr oO fa 11 0 Lumenera Network Camera API Reference Manual Release 1 8 1 16 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 Software 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 In using the Software 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 USE OF THE SOFTWARE OR HARDWARE IS AT YOUR OWN RISK THE SOFTWARE IS PROVIDED FOR USE ONLY WITH LUMENERA S HARDWARE AND OTHER RELATED SOFTWARE THE SOFTWARE IS PROVIDED FOR USE AS IS WITHOUT WARRANTY OF ANY KIND TO THE MAXIMUM EXTENT PERMITTED BY LAW LUMENERA DISCLAIMS ALL WARRANTIES OF ANY KIND EITHER EXPRESS OR IMPLIED INCLUDING WITHOUT LIMITATION IMPLIED WARRANTIE

Lumenera Network Camera API Reference Manual Release 1.8.1.16

Contents

Download Pdf Manuals

Related Search

Related Contents