AMS OSRAM NanEye User manual

Product
Document
Published by
ams OSRAM Group

User Guide
UG001036
NanEye
Evaluation Kits
Fiber Optic Box 2.0 and NanoUSB2.2
v3-00 •2022-May-31

Document Feedback
NanEye
Content Guide
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │2
Content Guide
1Introduction ................................... 3
1.1 Ordering Information ....................................3
2Hardware Description ................... 4
2.1 Fiber Optic Box 2.0.......................................4
2.2 NanoUSB2.2...............................................13
3NanEye Viewer Software............. 20
3.1 General Description....................................20
3.2 Software Installation...................................20
3.3 Start the Application ...................................23
3.4 Common Issues..........................................38
4Schematics and Source Code ....41
5Revision Information...................42
6Legal Information.........................43

Document Feedback
NanEye
Introduction
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │3
1 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.
The sensor has been specially designed for medical endoscopic applications where high SNR is
mandatory. The sensor includes a 10-bit ADC and a bit serial LVDS data interface. The sensors are
able to drive the signal through a cable length of up to 3 m.
The data line is semi duplex, such that configuration can be communicated to the sensor in the frame
brake. The exposure time, dark level, analog gain and frame rate can be programmed over the serial
configuration interface.
The Fiber Optic Box and NanoUSB2 evaluation kits are able to communicate with the NanEye
sensors. The NanEye Viewer software enables the user to send the sensor register values, as well as
grab the RAW images to store or add image processing. Additional features are referred along the
document.
Information
For more information about the NanEye family specifications, please see its datasheets on the
webpage.
1.1 Ordering Information
Ordering Code
Description
NANO_FIB_BOX_2.0
Fiber Optic Box 2.0 Evaluation Kit(1)
NANOUSB2.2
NanoUSB2.2 Evaluation Kit(1)
(1) Please note that the sensors do not come with the Evaluation Kit. The sensors need to be ordered separately, according
to each respective ordering code, in the respective NanEye datasheets.

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │4
2 Hardware Description
2.1 Fiber Optic Box 2.0
2.1.1 Out of the Box
NanEye Fiber Optic Box 2.0 (FOB2.0) is a fully embedded all in one image processing unit that
interfaces the NanEye® micro camera head signals and provides an output of 1080p/60 format HDMI
video signal which can be directly plugged to a HDMI compatible monitor, which in this mode no
additional PC or image processing is required.
The USB3 interface allows the connection to the NanEye Viewer running on a PC to get access to the
sensor’s raw images and control settings.
The main body of the demo kit measures only 17 cm x 17 cm x 5.6 cm and provides all necessary
video processing and display driving plus the adjustable illumination.
Figure 1:
Fiber Optic Box 2.0 Demo Kit
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.

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │5
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
required)
Integrated adjustable current source for
illumination
High quality image output
HDMI 1080p/60 video output
All-in-one eval kit with illumination
USB3 PC interface to NanEye Viewer
Raw image data access and sensor control via
USB3 and NanEye Viewer
Image processing, correction and
enhancements
Figure 3:
Fiber Optic Box 2.0 Pinout Description
Front Side
Rear Side
JST Connector
HDMI Output
●2 x NanEye2D/M/XS
●1080P60 to display NanEye
●1 x Current source up to 22.7 mA (channel 1)
●No additional PC needed
Rotary Switch
USB3.0
●Light mode and intensity control
●Display NanEye channel 1 & 2 with NanEye
Viewer software
Adjust light intensity of distal LED ring
Adjust image processing
Dual Color Status LED
LEMO Connector
Power Supply
●Do not use
12 V DC, 1.5 A minimum
Attention
Do not connect the NanEye2D simultaneously with NanEyeM or NanEyeXS. NanEye2D works with
a lower voltage range than NanEyeXS and NanEyeM. A higher voltage on NanEye2D will cause
irreversible damage to the sensor. Also do not connect a NanEyeXS simultaneously with NanEyeM.

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │6
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
1. Firstly connect the NanEye module to the box
2. Then connect the box to the monitor using a HDMI cable
3. Plug in the 12 V DC power adapter and wait for the Fiber Optic Box to power up
Fiber Optic Box Operation
●Dual Color Status LED
●Constant Green → Status ok, no sensor connected, test pattern output via HDMI
●Blinking Green → Sensor data transmission, sensor is working successfully
●Blinking Amber (pulse > 1 second) → at least one error during sensor data decoding
detected
●Blinking Amber (pulse < 250 ms) → Flash programming (more details on section 2.1.4)

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │7
Figure 5:
Fiber Optic Box Rotary Switch
Rotary Switch
Push Button
Rotate
Action
Function
Function
Default Mode
Press during one second
White balance optimized
for fiber light color
temperature(1)
Adjusts light intensity(1)
Optimized white balance
for LED ring color
temperature(2)
Adjusts light intensity
Neutral color temperature.
No tuning of white
balance
N/A
User Mode
Double click
Histogram Stretching
Mode
On/Off
Additional Long Press
White Balance Mode
Default Values/ Keep
Values / Calibration
Additional Long Press
Back to Histogram
Stretching Mode
On/Off
Double click
Back to Default Mode
Depends on chosen
function
(1) NanEye2D with fiber illumination is a discontinued product. Moreover, the latest FOB version no longer have the fiber
optic hardware. The illumination feature only works for previous versions of the FOB.
(2) NanEye2D version with LED ring is a discontinued product.
When entering the User Mode for White Balancing:
●Keep Values: no changes relative to the White Balance set previously. This is for the case the
'White Balance' menu is entered the but actually is not intended to modify the current settings
●Default Values: sets the default values, i.e. 1.0 for RGB in case of no illumination, LED
dependent in case of illumination
●Calibrating: shows a ROI into which the white target has to be placed. Calibration is performed
in real time, so the results will be seen immediately. It can be set back to 'keep values', or exit
the menu by a long press or exit user mode by a double click. To calibrate properly, please
point the sensor to a white surface/object (homogeneous illumination)
Image Viewing
The following image shows the Fiber Optic Box layout on the monitor. The coloured screensaver
represents the mode when there is no NanEye module connected, where the status LED is constant
green. In the bottom left corner it is possible to observe the hardware and firmware version.

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │8
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

Document Feedback
NanEye
Hardware Description
Eval Kit Manual •PUBLIC
UG001036 •v3-00 • 2022-May-31
43 │9
Please take the following steps to perform the correct connection:
1. Please ensure that the NanEye Viewer software has been correctly installed, refer to section
3.2.
2. Plug the USB3 type A cable to the Fiber Optic Box and the PC.
3. Plug in the 12 V DC power adapter and wait for the Fiber Box to power up.
4. Wait for it to be automatically recognized. Please check on the Device Manager if your device
is recognized as Cypress FX3 USB StreamerExample Device as shown in Figure 8.
5. Connect the sensor to the respective port and wait for the green LED to be blinking.
6. The NanEye Viewer can be started choosing the Camera, Board and Viewer, following the
suitable combination available on Figure 31. If the board is not recognised correctly please
check next sections Installing FX3 Driver Manually and How to Debug Fiber Optic Box.
Figure 8:
Fiber Optic Box Device Connection
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).