1. Manuals
  2. Brands
  3. AMS Manuals
  4. Motherboard
  5. OSRAM NanEye
  6. Manual

AMS OSRAM NanEye Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Product
Document
Published by
ams OSRAM Group

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the OSRAM NanEye and is the answer not in the manual?

Questions and answers

Related Manuals for AMS OSRAM NanEye

Summary of Contents for AMS OSRAM NanEye

  • Page 1 Product Document Published by ams OSRAM Group...
  • Page 2 User Guide UG001036 NanEye Evaluation Kits Fiber Optic Box 2.0 and NanoUSB2.2 v3-00 • 2022-May-31...

  • Page 3: Table Of Contents

    Document Feedback NanEye Content Guide Content Guide Start the Application ........23 Introduction ........3 Common Issues .......... 38 Ordering Information ........3 Schematics and Source Code ..41 Hardware Description ....4 Revision Information ....42 Fiber Optic Box 2.0 ........4 NanoUSB2.2 ..........

  • Page 4: Introduction

    Document Feedback NanEye Introduction Introduction NanEye is a family of miniature sized image sensors for vision applications where size is a critical factor. The ability of the camera head to drive a signal through long cables makes this the ideal component for minimal diameter endoscopes.

  • Page 5: Hardware Description

    Attention The Fiber Optic Box 2.0 Demo Kit is intended solely for evaluation purposes, has no EMI approval and is not advisable for medical use. ams OSRAM therefore is not liable for any damage or harm resulting from its use.
  • Page 6 Document Feedback NanEye Hardware Description Figure 2: Fiber Optic Box 2.0 Benefits/Features Benefits Features ® Easy to use plug and play solution Supports up to two NanEye 2D, XS and M Stand alone video output via HDMI (no PC Integrated adjustable current source for required) illumination High quality image output...
  • Page 7 Document Feedback NanEye Hardware Description 2.1.2 Plug and Play Recommended Connection The following image shows the necessary equipment for a direct connection to a monitor. Figure 4: Fiber Optic Box Plug and Play Equipment Connection Firstly connect the NanEye module to the box Then connect the box to the monitor using a HDMI cable Plug in the 12 V DC power adapter and wait for the Fiber Optic Box to power up Fiber Optic Box Operation...
  • Page 8 Document Feedback NanEye Hardware Description Figure 5: Fiber Optic Box Rotary Switch Rotary Switch Push Button Rotate Action Function Function White balance optimized for fiber light color Adjusts light intensity temperature Optimized white balance Default Mode Press during one second for LED ring color Adjusts light intensity temperature...
  • Page 9 Document Feedback NanEye Hardware Description Figure 6: Fiber Optic Box Plug and Play Layout 2.1.3 Operation with PC Recommended Connection The following image shows the necessary equipment for a direct connection to a PC. Figure 7: Fiber Optic Box NanEye Viewer Equipment Connection Eval Kit Manual •...
  • Page 10 Installing FX3 Driver Manually If the driver is not correctly installed after installing NanEye Viewer, please go to: ● Program Files (x86)\ams OSRAM\NanEye Viewer vx.x.x.x\driver\FX3_Driver Then, according to the operating system, run the respective Drive Package Installer (dpinst_x86/x64). Eval Kit Manual • PUBLIC UG001036 •...
  • Page 11 If the NanEye Viewer does not run, this section can help to debug the board. When the NanEye Viewer is installed, the programs included inside the folder Program Files (x86)\ams OSRAM\NanEye Viewer vx.x.x.x\application\debug\Usb3, can be used to debug any occurring issues.
  • Page 12 Document Feedback NanEye Hardware Description To permanently store the programming file in the flash, it can be done via JTAG. However, this procedure is not so elegant at user’s side, once the box needs to be opened. To overcome this situation, the system was upgraded to permanently program the flash via USB3. This procedure is performed via NanEye Viewer Software (only available from version v6.3.x.x on).
  • Page 13 Document Feedback NanEye Hardware Description Figure 11: Programming Layout Folder Directory After choosing the respective programming file, the user can Start the programming, as show below. This step basically transfers the file into the FOB. Figure 12: Programming File Upload Process Once the programming data is transferred to the EVK, the NanEye Viewer will notify to disconnect the USB3 cable, as shown below.

  • Page 14: Nanousb2.2

    Document Feedback NanEye Hardware Description After disconnecting the USB3 cable, the system will start to erase the flash, which can take up to two minutes. Right after, it will start flash programming, as shown below. Figure 15: Figure 16: Flash Erasing Flash Programming Once programmed, to conclude the process it will perform a flash verification.
  • Page 15 Controlled FPGA register Attention The NanoUSB2 Demo Kit is intended solely for evaluation purposes, has no EMI approval and is not advisable for medical use. ams OSRAM therefore is not liable for any damage or harm resulting from its use. 2.2.2...
  • Page 16 Document Feedback NanEye Hardware Description Figure 20: NanoUSB2 Demo Kit Connection Material The NanEye2D sensor FlexPCB connector should be connected as shows in Figure 21, where the pcb tracks and epoxy are facing outwards the NanoUSB2. Figure 21: NanEye2D Sensor Placed On NanoUSB2 Connector Eval Kit Manual •...
  • Page 17 If in Device Manager, the NanoUSB2.2 is not recognized in Figure 22 and shows: ● Cesys Device (NANOUSB, loading stage…) → Install or reinstall the driver (udk3usb-drivers- windows-1.3) ● Go to C:\Program Files (x86)\ams OSRAM\NanEye Viewer vx.x.x.x\driver\cesys ● CeusbUni → Update the driver Eval Kit Manual • PUBLIC UG001036 • v3-00 • 2022-May-31...
  • Page 18 How to Debug NanoUSB2 Board If the viewer is not programming the NanoUSB2 FPGA, please run the Board Tester program located at C:\Program Files (x86)\ams OSRAM\NanEye Viewer vx.x.x.x\application\debug\Usb2. This will check if there is a problem with the board or sensor.
  • Page 19 Document Feedback NanEye Hardware Description Figure 24: Board Tester Layout – Sensor Data Read Successfully If the NanoUSB2.2 is correctly identified, but cannot read data from the sensor, as shown in Figure 25, it can be a sensor related issue. Therefore, in order to find the root cause, please see below the possible situations, such as: ●...
  • Page 20 Document Feedback NanEye Hardware Description Figure 25: Board Tester Layout – Cannot Read Sensor Data Information If the issues are still not solved, please contact the Technical Support team. Eval Kit Manual • PUBLIC UG001036 • v3-00 • 2022-May-31 │ 19...

  • Page 21: Naneye Viewer Software

    Document Feedback NanEye NanEye Viewer Software NanEye Viewer Software General Description NanEye Viewer is a software that allows the user to grab data from the NanEye® sensors with its respective evaluation board. The Viewer Software has the following features: ● Possibility to save directly to .avi streams of the processed image, or save the raw data in the awvideo format ●...
  • Page 22 Document Feedback NanEye NanEye Viewer Software Figure 26: NanEye Viewer Installer Language Select the installation folder Figure 27: NanEye Viewer Installation Folder Eval Kit Manual • PUBLIC UG001036 • v3-00 • 2022-May-31 │ 21...
  • Page 23 Document Feedback NanEye NanEye Viewer Software Select the media folder (where correction masks and other files will be saved) Figure 28: NanEye Viewer Media Folder Selection Installs the drivers for all the boards Figure 29: NanEye Viewer Installing Eval Kit Manual • PUBLIC UG001036 •...

  • Page 24: Start The Application

    Document Feedback NanEye NanEye Viewer Software Installation completed Figure 30: NanEye Viewer Completed Installation Start the Application 3.3.1 Choosing the Sensor and Board If the board is correctly recognised on Device Manager, then the NanEye Viewer can be started choosing the Sensor, Board and Viewer, following the suitable combination available on Figure 31. If the board is not recognised correctly, please check sections 2.1.3 and 2.2.2.
  • Page 25 Document Feedback NanEye NanEye Viewer Software Before entering the Viewer main interface, there are three different configurations: Last, Default or From File as represented in Figure 32. For the first time initiating the software, please choose Load Default. Figure 32: NanEye Viewer Initial Interface 3.3.2 Graphical User Interface Description...
  • Page 26 Document Feedback NanEye NanEye Viewer Software Figure 33: NanEye Viewer Main Interface Frame Rate and Exposure Time Image Processing Display Image FPN Correction Zoom Sensor/FPGA Registers History Fast Menu Fast Menu Figure 34: NanEye Viewer Fast Menu Function of icons from left to right: ●...
  • Page 27 Document Feedback NanEye NanEye Viewer Software ● Record Videos ● Take Snapshots ● Menu More Options Figure 35: NanEye Viewer More Options Menu The More Options Menu presents different features: ● Load/Save configurations of the NanEye Viewer ● Image Statistics ●...
  • Page 28 Document Feedback NanEye NanEye Viewer Software Figure 36: NanEye Viewer Histogram Pixel Graphic To record a video, the user should hit record button, as described in Figure 34. A directory and a name for the file should be chosen (if no name is inserted, or the cancel button is pressed, the video is cancelled).
  • Page 29 Document Feedback NanEye NanEye Viewer Software Processed Image: ● PNG format; ● 24 bits per pixel. Raw Image: ● PGM format; ● 10-bit raw pixels. The images are saved in user data folder selected by the user. It saves as Raw_Sen[x] for the Raw Image and as Processed_Sen[x] to the Processed Image.
  • Page 30 Document Feedback NanEye NanEye Viewer Software Figure 39: NanEye2D Manual Register Control ● Gain ● ADC ramp gain ● Has four different values between ‘0’ (darkest) and ‘3’ (brightest) ● Offset ● ADC ramp offset ● Has four different values between ‘0’ (darkest) and ‘3’ (brightest) ●...
  • Page 31 Document Feedback NanEye NanEye Viewer Software ● ● Switch on/off ● Slider adjust the LED intensity The Viewer allows the possibility of having the Exposure and ADC Gain auto controlled according to the illumination. Figure 40: NanEye2D Automatic Register Control ●...
  • Page 32 Document Feedback NanEye NanEye Viewer Software ● Step Size ● The speed that the algorithm will converge to the target value. If this value is high, then the algorithm will converge faster, but if the value is too high, the system can become unstable, due to a high overshoot.
  • Page 33 Document Feedback NanEye NanEye Viewer Software Figure 43: NanEye2D Expert Registers ● Expert Registers ● Digipot: Supply Voltage in mV – changes Frame Rate ● DAC_DSTEP1/2 and DAC_DREGEN_REG ● Relates to the “Reset Line Algorithm”. Please refer to NanEye_NanEyeStereo_AN000447. ● RegSen0 –...
  • Page 34 Document Feedback NanEye NanEye Viewer Software Figure 44: Figure 45: NanEyeXS Manual Register Control NanEyeM Manual Register Control The NanEyeM/XS Expert Registers tab (Figure 46) shows the different registers. To configure the sensor to idle mode, the user needs to first deactivate the “Automatic sensor power cycling” and then insert the value 1 into IdleMode register.
  • Page 35 Document Feedback NanEye NanEye Viewer Software Black and White Mask To improve image quality, the user can create a Black Mask to reduce DSNU and a White Mask to reduce PRNU. Figure 47: Create Black/ White Masks ● How to Create Black Masks ●...
  • Page 36 Document Feedback NanEye NanEye Viewer Software Figure 48: NanEye2D Bayer Pattern Figure 49: Figure 50: NanEyeXS Bayer Pattern NanEyeM Bayer Pattern Figure 51 shows the color pre-gain options for the sensors. Please note that the adjustment of pixel colors factor will depend on the ambient light, therefore there is not a fixed standard adjustment for all situations.
  • Page 37 Document Feedback NanEye NanEye Viewer Software ● The algorithm will adjust the values automatically ● Color Reconstruction The color reconstruction options are shown in Figure 52. In order to have a colorful image, please check the Color Reconstruction checkbox. This will enable the demosaic algorithm, performing the transformation of a gray to RGB image.
  • Page 38 Document Feedback NanEye NanEye Viewer Software Figure 53: Frame Processing This menu shows different options, explained below: ● Image Processing ● The user can choose the processing algorithm: Awaiba or Open CV ● Rotate ● Performs a 90-degree image rotation ●...

  • Page 39: Common Issues

    Document Feedback NanEye NanEye Viewer Software Figure 54: Contrast Stretching Common Issues 3.4.1 Evaluation Kit Is Not Correctly Connected or Not Successfully Programmed Figure 55: NanEye Viewer Connection Error Message ● If the Fiber Optic Box is powered and does not show on Device Manager (Figure 8) please try a different: ●...
  • Page 40 Figure 56: NanEye Viewer Framework Error Message This error occurs when libraries are missing. Therefore, to load them: ● Go to C:\Program Files (x86)\ams OSRAM\NanEye Viewer vx.x.x.x\libraries ● Run vcredist_x86_15.exe Error Message “Can’t read from bulk pipe. System Error: 0x00000079/ Not 3.4.3...
  • Page 41 Document Feedback NanEye NanEye Viewer Software 3.4.6 NanEye Viewer Gets Sensor Images with Only Light and Dark Levels ● May not write successfully the register values for offset and gain configuration ● Possible poor electrical contact from the camera to the readout board. ●...

  • Page 42: Schematics And Source Code

    Document Feedback NanEye Schematics and Source Code Schematics and Source Code For more info regarding the Evaluation Kits schematics and source code, please contact the Technical Support team. Eval Kit Manual • PUBLIC UG001036 • v3-00 • 2022-May-31 │ 41...

  • Page 43: Revision Information

    Document Feedback NanEye Revision Information Revision Information Changes from previous version to current revision v3-00 Page Document format change from QG (QG000127) to UG (UG001036) Updated FOB2.0 Plug & Play operation 6 - 7 Added Flash Programming section 10 - 13 Updated NanEye2D Placement Figure 21 Updated footnotes Updated NanEye Viewer Main Interface Figure 33...

  • Page 44: Legal Information

    AG shall not be liable to recipient or any third party for any damages, including but not limited to personal injury, property damage, loss of profits, loss of use, interruption of business or indirect, special, incidental or consequential damages, of any kind, in connection with or arising out of the furnishing, performance or use of the technical data herein.

Table of Contents