FCB-MA130 USB3.0 Board UVC Device Firmware User s Guide

Size: px

Start display at page:

Download "FCB-MA130 USB3.0 Board UVC Device Firmware User s Guide"

Felicity Carpenter
6 years ago
Views:

1 FCB-MA130 USB3.0 Board UVC Device Firmware User s Guide Rev Infinitegra, Inc. Infinitegra, Inc. 1

2 Notice for this document Infinitegra, Inc. (hereinafter referred to as Infinitegra ) have a right for all of information in this document. Infinitegra do not allow reproducing/redistribution any information in this document without approval from Infinitegra. Infinitegra may change the information in this document without further notice. Please contact Infinitegra if you find wrong information and /or have any unclear points in this document. This document is an English translation from Japanese (original) version for reference purpose. If there are any discrepancy between English version and Japanese version, Japanese version should prevail. Notice for the product / Disclaimer Please do not operate the product against the contents of this document. It may be cause of troubles. Infinitegra may not accept any responsibility for any troubles those are caused by illegal operation. This application is for experiment/evaluation purpose. Please do not use for the usage those require safety and/or reliability and have a possibility to affect one s life. Infinitegra will not accept any responsibility for any loss, damage or mal state incurred by this application. Infinitegra does not allow to modify, dis-assemble, change, alter, reverse assemble, reverse compile, reverse engineer or to undertake any similar action to software, firmware and/or hardware of the product. Copyright Infinitegra, Inc. All Rights Reserved. All product names of other companies mentioned in this document are trademarks or registered trademarks owned by the respective corporations. Infinitegra, Inc. 2

3 Contents 1 Overview UVC Device Firmware Basic specification of UVC device Sensor Control UVC extension control UVC standard control Multi-Function Device Mode Operating Environment Installation Troubleshooting Known Issues Release Notes Infinitegra, Inc. 3

4 1 Overview This document describes the basic specifications of UVC (USB Video Class) device firmware which supports FCB-MA130 USB board. 2 UVC Device Firmware 2.1 Basic specification of UVC device USB USB3.0, USB2.0 Compliant Image format YUY2 Still Image Capture Method Method 2 Preview resolution / SuperSpeed : frame rate 1920x1080, 1600x1200, 1280x960, 1280x720, 1024x768, 800x480, 640x480 / 30fps, 25fps HighSpeed : 800x480, 640x480 / 30fps, 25fps Still image resolution SuperSpeed : 4192x3104, 4128x3096, 3264x2448, 2592x1944, 1920x1080, 1280x960, 1280x720, 640x480 HighSpeed : 1920x1080, 1280x960, 1280x720, 640x480 Sensor control Focus (One-push AF / Manual) Zoom Auto Exposure Shutter Speed White Balance Brightness, Contrast, Sharpness, Hue, Gain Flip, Mirror Noise Reduction Face Detection Image Stabilization Infinitegra, Inc. 4

5 2.2 Sensor Control UVC extension control UVC Device Firmware provides the Extension Unit (XU) which is an extended interface of UVC standard. The camera module can be controlled by XU. Host Library in FX3Cam SDK provides interfaces which enables user application to control the camera module (For details, see FX3Cam SDK Programmer s Guide) UVC standard control User application can also control the camera module via UVC standard interfaces without Host Library, however UVC standard control cannot control all functions of the camera module. In addition, setting values of the UVC standard control defined by UVC standard and actual setting values of the camera module do not necessarily match. Furthermore, the original role of UVC standard control and the function of a camera module are not always the same. UVC standard control of UVC Device Firmware is mainly prepared for a user to be able to experience the sensor function where Host Library or application using Host Library is not provided. Note that the normal operation cannot be guaranteed if sensor control by XU and sensor control by UVC standard control are in use at the same time. List of UVC standard control supported by UVC Device Firmware: Unit/ Controls Control value on Control value on UVC Setting value on Function and Terminal UVC standard Device Firmware (A) Camera module (B) description CT CT_AE_MODE_CONTROL Bitmap Bitmap - AE mode D0: Manual D0: Manual D1: Auto D1: Auto D2: Shutter Priority D2: Shutter Priority D3: Aperture Priority D3: Aperture Priority CT_AE_PRIORITY_CONTROL 0: Fixed frame rate Same as on the left. - Slow shutter 1: Variable frame rate CT_EXPOSURE_TIME_ABSOLUTE_CONTROL Number 1 to 38 Same as on the left. Exposure time CT_FOCUS_ABSOLUTE_CONTROL Number 0 to 99 - Manual focus CT_FOCUS_AUTO_CONTROL 0: Disable 0: Disable - AF on still image 1: Enable 1: Enable capture CT_IRIS_ABSOLUTE_CONTROL Number 100 to 260 Same as on the left. Gain CT_ZOOM_ABSOLUTE_CONTROL Number 0 to 61 Same as on the left. Digital zoom CT_ROLL_ABSOLUTE_CONTROL Signed number 0: normal - Mirror, flip 1: right/left inverse 2: up/down/right/left Infinitegra, Inc. 5

6 inverse 3: up/down inverse PU PU_BACKLIGHT_COMPENSATION_CONTROL Number, 0: Disable Same as on the left. Backlight 0: Disable 1: Enable compensation. Other: Enable PU_BRIGHTNESS_CONTROL Signed number 0 to 15 Same as on the left. Brightness. PU_CONTRAST_CONTROL Number 0 to 16-8 to 8 Contrast. A = B + 8 PU_GAIN_CONTROL Number 0 to to 32 Gain. A = B + 32 PU_HUE_CONTROL Signed number -128 to 127 Same as on the left Hue. PU_SHARPNESS_CONTROL Number 0 to 16-8 to 8 Sharpness. A = B + 8 PU_WHITE_BALANCE_TEMPERATURE_CONTROL Number 0: AUTO - White balance mode 1: ATW 2: Light bulb 3: Neutral color fluorescent light 4: Clear sky 5: Cloudy sky 6: Daylight color fluorescent light 7: Light bulb color fluorescent light PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL 1: Enable 0: Current white balance - White balance HOLD Other: Disable mode 1: White balance HOLD Infinitegra, Inc. 6

7 2.3 Multi-Function Device Mode Multi-Function Device Mode, consists of UVC and Vendor Specific Class, was added from the version (note that this function is presently alpha version). Vendor Specific Device provides two main functions which are Sensor Control and still image data acquisition. For an example, when the operating system, such as Linux, does not support Method 2, still image capture method, Vendor Specific Class enables the still image capturing successfully. Please note that when Multi-Function Device Mode is active, UVC device will not perform still image capturing. Additionally, UVC standard control becomes inoperative. You can set Multi-Function Device Mode by using the Host Library. Multi-Function Device Mode is disabled by default. Please refer to FX3Cam SDK for FCB-MA130 Programmer s Guide attached to SDK for more details. Also, SDK s sample application CamControlTest contains setting option. Please access to help menu of CamControlTest for more details. The support of this function has been canceled. The operation cannot be guaranteed if this function is enabled. 2.4 Operating Environment Hardware FCB-MA130 camera module FPC/FFC cable USB3.0 board for FCB-MA130 UVC Device Firmware are compatible with following boards CAT-MA130B (manufactured by S.E.Technologies) CAT-MA130C (manufactured by S.E.Technologies) UB3-01 (manufactured by Sony) Software Image file of UVC Device Firmware CAT-MA130B : installed at the time of shipment CAT-MA130C : installed at the time of shipment UB3-01 : please ask your distributor Host Operating System Windows 7 SP1, Windows 8.1 Infinitegra, Inc. 7

8 2.5 Installation The device driver will be installed automatically when FCB-MA130 USB3.0 board with UVC Device Firmware is connected to HOST. This is solely because UVC Device Firmware is compatible with UVC specification. Device will appear under Imaging devices in Device Manager. If the type of USB3.0 board is CAT-MA130B/C, name of device will be CAT-MA130 as shown above. If the board is UB3-01, name of device will start with Infinitegra SW:. Infinitegra, Inc. 8

3 Troubleshooting 1. Device cannot be recognized as USB3.0 device. Ensure USB port/connector on HOST supports USB3.0. Reconnect (Unplug/Plug) USB cable. Ensure USB cable supports USB3.0. Insert the connector half way, and then insert all the way.

9 3 Troubleshooting 1. Device cannot be recognized as USB3.0 device. Ensure USB port/connector on HOST supports USB3.0. Reconnect (Unplug/Plug) USB cable. Ensure USB cable supports USB3.0. Insert the connector half way, and then insert all the way. There are some cases that USB3.0 cannot be recognized depending on the HOST environment without this step. 2. HOST is slow detecting UVC device A function to retrieve the serial number from the sensor during the firmware s initial processing was added from version Executing this function takes approximately two seconds which resulted in slow detection comparing to previous firmwares up to version This behavior is by design. Infinitegra, Inc. 9

10 4 Known Issues The same issue with Hi-Speed link in version occurs during the preview resolution VGA (640x480). Capturing still images consecutively at short intervals may cause the preview to freeze (Degraded due to installation of Multi-Function Device Mode) Output data from FCB-MA130 USB3.0 board sometimes is corrupted when controlling sensor by XU on a Hi-Speed link. As the result, unexpected performance may occur on Host such as losing camera board connection, etc. Infinitegra, Inc. 10

11 5 Release Notes Improved the performance of preview resolution VGA (640x480) with Hi-Speed connection. Fixed the problem of display being frozen when still images are captured consecutively Improved the performance under Hi-Speed connection. Added a function to retrieve the serial number from the sensor. Added an updating function for the firmware. Added Multi-Function Device Mode Improved the performance on Android Reduced ROM/RAM usage. Internal changes for the CAT-MA130 board Changed product name of USB descriptor. Added CT and PU control. Improved the performance on Linux and Mac environment. Fixed the problem that still image capture failed and video preview stay stopped on High Speed mode. Internal changes Added PU controls. Internal changes Internal changes First release Infinitegra, Inc. 11

12 User s Guide Revision History Rev Description Added description about cancellation of Multi-Function Device Mode function Added more description to 2.3 Multi-Function Device Mode. Added contents to 3 Troubleshooting and 4 Known Issues Added a section 2.3 Multi-Function Device Mode" Changed the document structure Changed description for firmware s file name and device name Added description about UVC controls Initial version Infinitegra, Inc. 12

FCB-MA130 USB3.0 Board UVC Device Evaluation Software User s Guide

FCB-MA130 USB3.0 Board UVC Device Evaluation Software User s Guide Rev 1.4.0 Infinitegra, Inc. www.infinitegra.co.jp Infinitegra, Inc. 1 Notice for this document Infinitegra, Inc. (indicate as Infinitegra