1. Manuals
  2. Brands
  3. PHOTONIS Manuals
  4. IP Camera
  5. NOCTURN XS MONO
  6. User manual

PHOTONIS NOCTURN XS MONO User Manual

Engineering user guide rugged low light monochrome camera module
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
PHOTONIS USA, Inc.
6170 Research Road | Suite 208
Frisco, TX USA 75033
T: +1 (469) 713‐6108
F: +1 (469) 713‐2880
W: www.photonis.com
PHOTONIS USA Proprietary and Confidential Information
6170 Research Road | Suite 208, Frisco, Texas 75033
NOCTURN XS MONO
NOCTURN XS Monochrome 
Engineering User Guide 
USER GUIDE
September 2014 
Doc. No.: 200‐LC‐4020 
Version B.01 
i

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NOCTURN XS MONO and is the answer not in the manual?

Questions and answers

Summary of Contents for PHOTONIS NOCTURN XS MONO

  • Page 1 NOCTURN XS MONO USER GUIDE NOCTURN XS Monochrome  Engineering User Guide  September 2014  Doc. No.: 200‐LC‐4020  Version B.01  PHOTONIS USA, Inc. 6170 Research Road | Suite 208 Frisco, TX USA 75033 T: +1 (469) 713‐6108 F: +1 (469) 713‐2880 W: www.photonis.com PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...
  • Page 2 WRITTEN CONSENT OF PHOTONIS PENNSYLVANIA, INC. THE INFORMATION FURNISHED IN THIS DOCUMENT IS BELIEVED TO BE CORRECT AT THE TIME OF PUBLICATION BUT IS NOT GUARANTEED AND IS SUBJECT TO CHANGE WITHOUT PRIOR NOTICE. NO LIABILITY IS ASSUMED BY PHOTONIS FOR ITS USE. NO CLAIMS OR WARRANTIES ARE MADE AS TO THE APPLICATION OF PHOTONIS PRODUCTS. CUSTOMERS SHOULD VERIFY THEY HAVE THE CORRECT DOCUMENTATION BEFORE USE.
  • Page 3 NOCTURN XS MONO USER GUIDE Document Revisions  Version Date Document Changes Number Dec. 12, 2013 A‐1 Initial Draft Jan. 17, 2014 A‐2 Initial Release Sept. 13, 2014 B‐1 Update for software version 610   PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...

  • Page 4: Table Of Contents

    NOCTURN XS MONO USER GUIDE   Table of Contents  Introduction ................................ 6 1.1 .. S cope and Purpose ................................ 6 1.2 .. P roduct Configuration .............................. 6 1.3 .. P roduct Specifications .............................. 7 1.4 .. Q uantum Efficiency ................................ 9 Getting Started with the Camera ........................10 2.1 .. U npacking Instructions ..............................10 Camera Controls ..............................12 3.1.1 B asic Communication Settings ............................ 1 2 3.1.2...
  • Page 5 NOCTURN XS MONO USER GUIDE SAFETY SUMMARY WARNING and CAUTION statements have been strategically placed throughout the text prior to operating or maintenance procedures, practices, or conditions considered essential to the protection of personnel (WARNING) or equipment and property (CAUTION). NOTES emphasize necessary and important data. CAUTIONS and NOTES appear in the text as applicable. Definitions for WARNINGS, CAUTIONS and NOTES are as follows: WARNING A warning indicates an operation, condition, or statement, etc., which, if not strictly observed, could result in injury to or death of personnel. CAUTION A caution indicates an operation, maintenance procedure, or condition, etc., which, if not strictly observed, could result in...

  • Page 6: Introduction

    With its 9.7µm×9.7µm pixel pitch and 4e‐ median read noise, the NOCTURN provides unsurpassed signal to noise at low light with video rates up to 100 frames per second. Leveraging PHOTONIS expertise in night vision imaging, the NOCTURN electronics incorporates a multitude of functions to enhance the low light level performance. This camera features automatic gain control (AGC), automatic exposure control (AEC), high dynamic range (HDR), non‐uniformity correction (NUC) and advanced image enhancement,...

  • Page 7: P Roduct Specifications

    NOCTURN XS MONO USER GUIDE Figure 2 Back Side View of the NOCTURN XS Camera For full pin‐out of the NOCTURN XS camera please refer to the NOCTURN XS Electro‐ Mechanical ICD. The NOCTURN XS input power specifications are provided in Table 1. Even though the camera can be operated down at 2.5V if specified, it is recommended to provide a regulated input between 4.3‐4.7 for optimum performance. Table 1 NOCTURN XS Input Power Specifications Parameter...
  • Page 8 Full on screen display capability with text, standard geometrical shape and graphics By default the camera is optimized only for 60 and 100fps mode. Please contact PHOTONIS if you need the camera optimized for 50fps. Digital zoom only available in the 60 and 50fps modes Feature only available on the digital video output interface with OSD disabled...

  • Page 9: Q Uantum Efficiency

    NOCTURN XS MONO USER GUIDE Parameter Specification Snapshots On board capture of *.JPG (8b) or *. PGM (8/10b) Camera/Imaging Start Up Time < 5 seconds Operating Temperature ‐40° to +60° C Storage Temperature ‐50° to +80° C Input Voltage +2.5 to +5.5 VDC or regulated +4.5 VDC (factory configurable) Power (Typical) 60/50Hz mode < 1.6W (typ.) 1.4 Quantum Efficiency  The typical quantum efficiency as a function of wavelength for the LYNX CMOS for versions with and without micro‐lenses is shown in Figure 3. Figure 3 LYNX CMOS Quantum Efficiency Curve Improves noise performance PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...

  • Page 10: Getting Started With The Camera

    (ESD) protective handling procedures. Under no circumstances, should the camera be disassembled unless directed to do so by PHOTONIS personnel. Disassembly of the camera and damage to the anti‐tamper sticker on the side of the camera will void the warranty.
  • Page 11 NOCTURN XS MONO USER GUIDE Description Image Open shipping container by breaking the PHOTONIS seal and lifting the cardboard lid. Remove the antistatic bag containing the camera module from the suspended clear plastic clamshell. Unseal antistatic bag and remove camera module using proper ESD procedures. PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...

  • Page 12: Camera Controls

    NOCTURN XS MONO USER GUIDE Description Image Inspect camera module for proper configuration and potential shipping damage. Immediately report any problem to PHOTONIS personnel. 3 Camera Controls  The NOCTURN XS is controlled by a serial communication protocol. This section of the user guide provides an overview of the command and associated syntax to control the camera as well as the serial port settings needed. 3.1.1 Basic Communication Settings  The serial communication should be set with the following configuration for both the main and the aux serial interface:  Number of bits: 8  Baud rate: 115200 bps  Parity: none  Number of stop bits: 1 bit  Flow control: none. NOTE The NOCTURN XS cameras are shipped with a default baudrate of 115200bps. The latter can be changed by the user...
  • Page 13 NOCTURN XS MONO USER GUIDE “>OK” to all user command that are accepted and “>Error <error message>” when an error occur. A standard message to the camera should have the following architecture: <Command><Optional Payload><CR> <LF> NOTE With this current firmware/software release, the camera no longer echos command by default. The echo can be re‐enabled by using the “echo” command. To enable the echo on the USB port, type “echo usb 1<CR><LF>” at the serial interface. This can be saved as power on default state for the camera by saving the flash configuration (type “save flash<CR><LF>”).
  • Page 14 NOCTURN XS MONO USER GUIDE XFER Print file transfer I/O menu<CR><LF> DR Print OSD menu<CR><LF> ==============================================================<CR><LF> > //camera ready for next command  Example 2: requesting contrast function help > //camera ready for command video contrast ?<CR><LF> //serial message sent by user to get contrast help //response from camera VIDEO contrast Selects contrast enhancement: <CR><LF> 0 ‐ No enhancement<CR><LF> 1 ‐ histogram stretching<CR><LF> 2 ‐ histogram equalization<CR><LF> 3 ‐ limited equalization<CR><LF> 4 ‐ histogram unrounded equalization<CR><LF> 99 ‐ auto contrast (table driven) <CR><LF> > //camera ready for next command  Example 3: changing the contrast > //camera ready for command video contrast 1<CR><LF> //serial message sent by user to enable hist. stretching OK<CR><LF>...

  • Page 15: C Amera Serial Commands

    NOCTURN XS MONO USER GUIDE video contrast <CR><LF> //serial message sent by user to get contrast status CONTRAST = 1<CR><LF> //reply that contrast is set to hist. stretching OK<CR><LF> //reply from camera that command was accepted > //camera ready for next command  Example 5: invalid parameter resulting in an error > //camera ready for command video contrast 500<CR><LF> //message sent by user with invalid contrast setting //error response from the camera Error 6012, Video Pipeline: Invalid contrast parameter<CR><LF> <CR><LF> //blank line sent by camera > //camera ready for next command 3.1.3 Camera Serial Commands  The following section contains all of the serial command available on the NOCTURN XS. 3.1.3.1 Top Level Commands  Table 4 Top Level Commands Command Optional Payload Description help Display console help menu Display console help menu baudrate (see 3.1.3.2) Set serial port baudrate echo (see 3.1.3.3)
  • Page 16 NOCTURN XS MONO USER GUIDE Command Optional Payload Description status Reprint sign on information update ?/help Flash update menu help user Update user flash factory Update factory flash (For factory use only) Camera sensor command menu. Type “?” to get embedded (see 3.1.3.4) help menu VIDEO (see 3.1.3.4) Video pipeline command menu PIC (see 3.1.3.6) Picture command menu (see 3.1.3.7) Digital video output command menu NUC (see 3.1.3.9)
  • Page 17 NOCTURN XS MONO USER GUIDE Command Optional Payload Description USB Display baudrate help and current setting for the USB port (main external serial port) USB 921600 Set the USB baud rate to 921600bps 460800 Set the USB baud rate to 460800bps 230400 Set the USB baud rate to 230400bps 115200 Set the USB baud rate to 115200bps 57600 Set the USB baud rate to 57600bps 38400 Set the USB baud rate to 38400bps 28800 Set the USB baud rate to 28800bp 19200 Set the USB baud rate to 19200bps 9600 Set the USB baud rate to 9600bps AUX Display baudrate help and current setting...
  • Page 18 NOCTURN XS MONO USER GUIDE All valid serial command shown in Table 6 should be sent as: echo <Port> <Optional Payload><CR><LF> Table 6 Echo commands Command Optional Payload Description Echo help menu USB USB port echo off USB port echo on AUX AUX port echo off AUX port echo on 3.1.3.4 CS Commands  CAUTION Adjusting the default CMOS settings could affect the low light level performance of the camera and the default non‐ uniformity correction tables All valid serial command shown in Table 7 should be sent as: CS <Command> <Optional Payload><CR><LF> Table 7 CS Commands Command Optional Payload Description...
  • Page 19 NOCTURN XS MONO USER GUIDE Command Optional Payload Description Set the line noise filter to use 16 columns cs vbo [0‐255] Sets the video black offset when the line noise filter is enabled cs active Clears the sensor active signal to the CMOS image sensor Set the sensor active signal to the CMOS image sensor cs dumptbl Displays camera sensor register default table data to console (store in camera) cs dump...
  • Page 20 NOCTURN XS MONO USER GUIDE Name Address Size Description SENSOR_ACTIVE Disable/Enable continuous grabbing of images; external SENSOR_ACTIVE pulses are ignored 60FPS Use 2 or 4 output channels, resulting in 60fps or 100 fps operation ADDR_Y 2‐3 The start address of the readout window. Valid range for this register is 0 to 1044‐SIZE_Y. SIZE_Y 4‐5 The number of rows in the readout window. Valid range for this register is 1 to 1044 NROF_SLOPES The number of slopes is 1, 2 or 3. ‘0’ is an invalid setting for this register. INTE_FIRST 7‐9 The number of slots light integrates on the pixels for the 1st first slope of the response curve.
  • Page 21 NOCTURN XS MONO USER GUIDE Name Address Size Description for the 3rd slope of the response curve. By default, the third slope is not used, so the default value is 0. ADC_CALIB_MODE Set the ADC calibration mode: 0  No calibration 1  Calibration during overhead row 2  Calibration at start of each (conversion) row (60 fps mode only!) 3  Calibration during overhead row and at start of each (conversion) row (60 fps mode only!) COL_CALIB_MODE Set the column amplifier calibration mode: 0  No calibration 1  Calibration at start of each row CLOCK_SELECTION Select the (input) high speed clock: 0  LVDS input clock 1  Analog PLL 2 & 3  Digital PLL SELECT_PULSED Change the behavior of the row select: 0  Select constant high during sampling...
  • Page 22 NOCTURN XS MONO USER GUIDE Name Address Size Description COL_EB Controls behavior of electrical black columns 0  All columns normal 1  First 20 columns (in non‐flipped readout) are black, rest are normal DB_TEST_IMAGE Disable/Enable digital test image output DB_OVF_DISABLE Change the handling of large conversion results 0  Output is clipped at ‘1111111111’ 1  Output overflows and outputs lowest 10 bits DB_LOAD_FALLING Change the clock edge that is used to sample the digital data when going from parallel to serial data FLIP 0  Read out left bottom to right top 1  Read out right bottom to left top...
  • Page 23 NOCTURN XS MONO USER GUIDE Name Address Size Description 5  sync_x_odd 6  line_0_sample 7  line_0_adc 8  line_0_read 9  adc_ramp_r 10  adc_ramp_s 11  adc_vtzero 12  col_init 13  col_init_off 14  pix_select 15  pix_transfer TMUX2 Select output signal on digital multiplexer 2: 0  clk_adc_gated 1  slot_pix 2  lval 3  bypass_even 4  sensor_idle 5  reset_first 6  reset_second 7  reset_third 8  row_clk_y 9  row_sync_y_read 10  row_sync_y_inte0 11  row_sync_y_inte1 PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...
  • Page 24 NOCTURN XS MONO USER GUIDE Name Address Size Description 12  row_sync_y_inte2 13  write 14  read 15  col_vtzero DPLL_MULT Digital PLL multiplication factor (252 = x10) DPLL_EN Disable/Enable digital PLL DPLL_DIVMODE Internal selection of feedback mechanism in digital PLL DPLL_F_RANGE Select output frequency range of digital PLL APLL_MULT Analog PLL multiplication factor = APLL_MULT + TMUXA Select output signal on analog multiplexer: 0  ground 1  CMDN_LVDS_REC 2  CMDN_2X 3  REF144 4  REF270 5  VDCPC_ADC 6  VCLAMP_ADC 7  VBGAP_BIAS...
  • Page 25 NOCTURN XS MONO USER GUIDE Name Address Size Description 12  DPLL_LOCKED 13  DPLL_UNDERFLOW 14  DPLL_OVERFLOW 15  VRAMP CLKMATCH Set compensation for channel‐to‐channel skew: 0  no compensation 254  maximum compensation Note: ‘255’ is an invalid setting PGA_GAIN Set the analog gain in the column amplifier: 0  0.8 1  1.2 2  1.6 3  2.0 4  2.4 5  3.6 6  4.8 7  6.0 ADC_GAIN Set the gain in the ADC CHANNEL_EN Disable/Enable output, clock and control channels: Bit[0]‐Bit[3] Data channels...
  • Page 26 NOCTURN XS MONO USER GUIDE Name Address Size Description I_COL Column load current I_COLAMP Column amplifier current I_ADC ADC comparator current I_COMPINV ADC output invertor current limit I_ADCPC ADC precharge voltage buffer current I_LVDS_REC LVDS receiver current I_LVDS_DRIV LVDS driver current V_ADCPC ADC precharge voltage V_ADCCLAMP ADC clamp voltage RST_LOW Pixel reset low voltage VTX_LOW0 Set the saturation/anti‐blooming level for the integration after slope 3.
  • Page 27 NOCTURN XS MONO USER GUIDE Name Address Size Description V_TREF Reference voltage for the reset conversion test_mode V_TSIG Reference voltage for the signal conversion test_mode V_TEST_HIGH Highest voltage adjustment of V_TREF and V_TSIG V_TEST_LOW Lowest voltage adjustment for V_TREF and V_TSIG V_BLSUN Voltage setting for clipping of reset in black sun protection TEMP 62‐63 Temperature sensor (readout only!) 3.1.3.5 Video Commands ...
  • Page 28 NOCTURN XS MONO USER GUIDE Command Optional Payload Description Stretching contrast Equalization contrast Limited/adaptive equalization contrast Unrounded equalization contrast Automatic based on AGC settings hconalways Do not service contrast enhancement every histogram update Service contrast enhancement every histogram update imgfmt Selects PGM snapshot image format...
  • Page 29 NOCTURN XS MONO USER GUIDE Command Optional Payload Description Output fit for zoom set to window screen Output fit for zoom set to sensor resolution zoom [x.xxxxx] Set the digital video zoom to x.xxxxx (1.0 to 8.0) framerate Sets the video frame rate to 60Hz mode...
  • Page 30 NOCTURN XS MONO USER GUIDE Command Optional Payload Description hist status Displays on the console the histogram settings and current metrics pan [+/-xxx] [+/-yyy] Pan the center image while in zoom to the XY coordinate (positive coordinate is down/right of center with standard imaging...
  • Page 31 NOCTURN XS MONO USER GUIDE Command Optional Payload Description trigi delay Sets delay in micro seconds between start of new frame and the trigger input. Valid value range from 0 to 16000000. trigi enable Disables the external trigger input Enables the external trigger input...
  • Page 32 NOCTURN XS MONO USER GUIDE Command Optional Payload Description Picture help menu snap bpp Takes a snapshot of the frame buffer with bpp bits per pixel list List currently stored snapshots erase Erase snapshot n all Erase snapshot all By default, when using a NOCTURN camera, the snapshots will be store under “/a/snapshots/”. To download a snapshot to a PC, use YMODEM protocol:...
  • Page 33 NOCTURN XS MONO USER GUIDE Table 12 Analog Video commands Command Optional Payload Description Analog Video help menu gamma [x.xxxxx] Sets the gamma value for the analog video output channel power Turns off the analog video output channel Turns on the analog video output channel set NTSC Sets the analog video output to NTSC...
  • Page 34 NOCTURN XS MONO USER GUIDE Command Optional Payload Description off correction Disables non-uniformity offset correction global gain Displays the global gain for the non- uniformity correction on the console global gain xxx Sets global gain for the non-uniformity correction to xxx global offset Displays the global offset for the non-...
  • Page 35 NOCTURN XS MONO USER GUIDE Command Optional Payload Description [xx] [dd] Writes the temperature register [xx] with value [dd] The NOCTURN only has one temperature sensor available. It can be read by sending the following command: TEMP RD 0<CR><LF> 3.1.3.11 Transfer Commands  All valid serial command shown in Table 15 should be sent as: XFER <Command> <Optional Payload><CR><LF> Table 15 Transfer commands Command...
  • Page 36 NOCTURN XS MONO USER GUIDE Command Optional Payload Description x y w h p Cleans an area with top x, left y coordinate, w width, h height and effect p (should be set to 0 by default) n x y r p Draws a filled circle n (should be > or = 1) at coordinate x y, radius r, and effect p n x y r p Draws a circle n (should be > or = 1) at coordinate x y, radius r, thickness t and effect p dly Introduces an n milliseconds delay between time draw commands are entered and the...
  • Page 37 NOCTURN XS MONO USER GUIDE Command Optional Payload Description n x y p s Draws icon n at x y coordinates using effects value p and size s n ax ay bx by t p Draws a line n between screen coordinate (ax, ay) and (bx, by) with thickness t and effect p ovlintensity xxx Set the overlay intensity (0‐255) n x y r p...
  • Page 38 NOCTURN XS MONO USER GUIDE Command Optional Payload Description rws ax ay bx by Sets the reticles window with top left corner at (ax, axy) and bottom right corner at (bx, by) n ax ay w h t p Draws a rectangle with top left corner at (ax, ay), width w, height h, thickness t and effects p Clears the overlay screeen n ax ay bx by cx cy p...
  • Page 39 NOCTURN XS MONO USER GUIDE  Value 2‐ overlay 25% transparent  Value 3‐ overlay is opaque o [2]: XOR enable‐ XOR’s MSB of video data with 1 to provide 50% contrast between the overlay and the video data o [3]: blink enable 3.1.3.13 AGC Commands  A list of valid AGC functions and current value can be queried from the camera by sending the following command: AGC status <CR><LF> All valid serial command shown in Table 17 should be sent as: AGC <Command> <Optional Payload><CR><LF> Table 17 AGC Commands Command Optional Payload Description status Display the AGC commands and settings...
  • Page 40 NOCTURN XS MONO USER GUIDE Command Optional Payload Description value bhipccontrast Percentage of the cumulative histogram at which the histogram stretching maps to 1023 digital value output blopccontrast Percentage of the cumulative histogram at which the histogram stretching maps to 0 digital value output bhitgt XXX Target brightness that AGC tries to maintain “bhipcagc”...

  • Page 41: Maintenance

    NOCTURN XS MONO USER GUIDE Command Optional Payload Description gain Sets camera gain to x if the AGC is disabled minbins Minimum number of bins used to stretched the image is contrast stretching is enabled table Selects the default AGC look‐up table to use with the camera. By default, the NOCTURN camera is shipped with only one AGC table (0). 4 Maintenance  This section covers basic maintenance that should be performed periodically by the end user. Please note that all servicing of the NOCTURN XS camera should be referred to...

  • Page 42: Storage

    NOCTURN XS MONO USER GUIDE 3. Visually inspect the sensor for dust, debris, and residue (e.g., fingerprints, smears, etc.) 4. Clean the sensor and board with low pressure, dry, compressed air or nitrogen if necessary. 5. If there are fingerprints, smears, or other oily residue, the sensor glass may be cleaned with a lint free cotton‐tipped applicator moistened with a small amount of...

  • Page 43: Warranty

    Buyer or to have failed for any reason of faulty design, material or workmanship for a period of twelve (12) months following the date of delivery. Such warranty does not apply: (i) if the product has been modified or altered in any way by parties other than Photonis, (ii) iif the product has been exposed to unusual or excessive environmental, mechanical, electrical, or thermal stress during the course of installation or use, or (iii) if the absolute maximum ratings are exceeded for any reason including, but not limited to, equipment design and improper device installation or application, or (iv) if...

  • Page 44: Photonis Usa Proprietary And Confidential Information 6170 Research Road | Suite 208, Frisco, Texas

    NOCTURN XS MONO USER GUIDE OTHER OR FURTHER WARRANTY, INCLUDING ANY WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR WARRANTY OF MERCHANTABILITY. All warranties, conditions and other terms implied by stature or common law are, to the fullest extent permitted, excluded. PHOTONIS USA Proprietary and Confidential Information 6170 Research Road | Suite 208, Frisco, Texas 75033...

Table of Contents