Help - Detailed

Help - Detailed


Here's a link to a description of DevWareX new features.

1. Welcome to DevWareX


Application setup:
           Installation(See 2.1.1)
           Running the Application(See 2.1.2)
Application layout and options:
           Menu Commands(See 2.2.1)
           Toolbar Buttons(See 2.2.2)
           Display Screen (See 2.2.3)
Main Dialogs:
           Info Dialog (See 2.2.5)
           Sensor Control Pages(See 2.2.4)
           Presets Dialog (See 2.2.6)
           Register Dialog(See 2.2.7)
           Register Log Dialog(See 2.2.8)
           Analysis Graph Dialog(See 2.2.9)
           Magnifier(See 2.2.10)
           Peek & Poke(See 2.2.12)
           Watch Dialog (See 2.2.13)
           Embedded Data Viewer(See 2.2.14)
           Options Dialog (See 2.2.15)
Troubleshooting:
           Warning Messages(See 2.2.16)
           Troubleshooting(See 2.2.17)
           Reporting a Bug(See 2.2.18) (mail to: Aptina-IMAGING_DEMO_BUGS@onsemi.com )

2. DevWareX Help

2.1 Using the Application

2.1.1 Installation

Please refer to the document titled "DevSuite Quick-Start Guide", found in the "doc" folder and through the "Docs" shortcut.

2.1.2 Windows XP / 2000: Running the Application

It is best to read through and follow the instructions in the "DevSuite Quick-Start Guide" as to the proper sequence of installation and running of the DevSuite software.

After installing the software, use the following instructions to install the USB driver.

  1. Plug the kit into your computer using a USB cable. After a few seconds, your computer should detect new hardware and start the "Found New Hardware Wizard" application to prompt you for the location of an appropriate USB driver. Please follow the instructions found in DevWareX USB Drivers User Guide and then the USB XP Driver User Guide.

  2. When completed, you will able to run the DevSuite software.

The program can now be opened by going to the start menu and selecting "Programs" then "Aptina Imaging" then "DevWareX". A popup window will appear while DevWareX probes for attached devices. Then the main DevWareX window and a dialog box will appear that is slightly different for each sensor. Select the appropriate settings and click finish. Unless an error occurs(See 2.2.17) the application will open the display dialog and start capturing and displaying sensor images.
Note: Sensor data files can be manually loaded. Click the esc key to exit automatic probe. Make sure that the box next to "Automatically probe at startup" is unchecked. Click on "Sensor..." to browse for the corresponding sensor data (sdat) file. The file will be found in C:\Aptina Imaging\sensor_data.

2.1.3 Windows 7 / Windows Vista: Additional Information

DevSuite is ready to use on the Vista and Windows 7 operating systems when installed in the correct folder, but there is a requirement that the Demo2X demo board have a FW version of 28 or newer to match to the USB driver.
Note; the Demo3 FW is already Windows 7 compatible.
Firmware Upgrade
Note that a demo board with FW older than version 28 can only be upgraded on an XP operating system since only the XP-based USB driver supports the older versions of the FW. As of May of 2010, all newly delivered Demo2X boards will have version 28 of the FW. Demo2X boards received earlier than that may have an older FW version, and the FW version should be verified on an XP-based system before proceeding.
If you aren't sure that your FW has version 28 or newer, install the DevSuite SW on an XP-based system by following the instructions thru the section titled "Starting Up the Software" as found in "DevSuite Quick-Start Guide", which can be accessed from the DevWareX menu item "Documents". Then follow the FW upgrade instructions as found in "Demo FW User Guide", which can be accessed from the DevWareX menu item "Documents -> User Guides".
If you are fairly sure that your FW has version 28 or newer, then install the DevSuite SW on your Vista or Windows 7-based system by follow the instructions thru "Starting Up the Software" section of the Quick-Start guide. Once the USB cable is connected to the Demo2X demo board, Vista and Windows 7 will automatically attempt to download the matching USB driver from the Microsoft driver web site; if the driver installs correctly then your FW is current and no further action is required - continue with the instructions found in the Quick-Start guide.
If the USB driver download fails, it is either due to downgraded FW or a network problem. You can attempt to load the USB driver manually by following the instructions in the "Aptina Drivers User Guide", which can be accessed from the DevWareX menu item "Documents -> User Guides".
If the USB driver installs correctly then your FW is current and no further action is required - continue with the instructions found in the Quick-Start guide.
If the USB driver manual load failed, you will need to use an XP-based operating system to upgrade your Demo2X demo board as described earlier in this document. 
Software Installation
Do not install DevSuite in "C:\Program Files", due to the strict system security checking performed by Vista and Windows7.
The installer defaults to the recommended installation location of "C:\Aptina Imaging". If necessary this can be changed when prompted for the installation location.

2.1.4 Windows 8: Additional Information

onsemi will not be getting the USB drivers certified to run on Windows 8. In the mean time, please follow the instructions in Windows8 USB3 Driver Usage instructions to be able to install and enable the drivers.

2.1.5 Windows 10: Additional Information

These USB drivers are certified, so once you plug in the Demo plug-and-play should download and installer the driver.  If not, follow the instructions in Windows10 USB3 Driver Usage instructions.

2.1.6 Command Line Parameters

Command line parameters can be used with DevWareX.
Usage
Open a "CMD" window, navigate to the installation folder of C:\Aptina Imaging, and provide any of the following parameters.Note that parameters can be in all upper-case or all lower-case, and can be provided in any order.


devwarex [/help | ?] [/ini=["]filename["]]  [/preset=["]name["]]  [/camera=decimal number]  [/probe=0 | 1]  [/fullauto[=0 | 1]]  [/mono[=0 | 1]][/play[=0 | 1]]  [<sensor_sdat_file>.xsdat] [/nul]

  • /help or ? - Display this page.  You are given the option to continue to DevWareX or to exit.  Note: if "?" is used, all other parameters are ignored.

  • /ini=filename or /ini="filename" - Specify the INI file to be used, overriding the one selected by DevWareX if "Probe" is enabled.

  • /preset[=name] or /preset[="name"] - Run the optionally supplied specified preset. Note that the Startup Wizard dialog will be skipped whether or not the preset name is supplied.

  • /checksensor[=0 | 1 (default if not supplied)] - Disable | Force reading of sensor registers at startup. Disabled gives faster startup.

  • /camera=<number in decimal> - Force a specific camera id selection, in case more than one camera was detected.

  • /probe[=0 | 1 (default if not supplied)] - Disable | Force a "Probe". Note: ignored if SDAT filename is provided, and no "Probe" is performed if the parameter itself is not supplied.

  • /fullauto[=0 | 1 (default if not supplied)] - Disable | Force "Full Auto" option on the Startup Wizard. Note: enabled if parameter itself is not supplied.

  • /mono[=0 | 1 (default if not supplied)] - Disable | Force "Monochrome" option on the Startup Wizard. Note: disabled if parameter itself is not supplied.

  • /play[=0 | 1 (default if not supplied)] - Disable | Force "Play on Start" option on the Startup Wizard. Note: enabled if parameter itself is not supplied.

  • <sensor_sdat_file>.sdat - Specify the SDAT file to be used, overriding the one selected by DevWareX if "Probe" is enabled.

  • /nul - start without HW needing to be attached. An SDAT file can be loaded, and Presets can be run as long as it doesn't expect register reads to provide valid data.

  • /detfar - detect FAR sensor on start.

  • /warnings=filename - Specify the warnings file name.

  • /restorepresets - 1 to restore the additional Presets windows from the last session, 0 to not restore the windows.

  • /suppressallwindows - Start DevWareX will all windows suppressed - only the image display is enabled.

  • /startfullscreen - Start DevWareX in full screen mode.

  • /dll=DLLname. Include a new Transport DLL. And alternative is to copy the DLL to the Plugins folder.

  • <sensor_sdat_file>.xsdat - if opening an .xsdat file with no directory path given and the file doesn't exist, the sensor_data directory will be searched.

2.2 Application Layout and Options

2.2.1 Menu Commands

File(See 4.2)

Sensor handling functions.

Edit(See 4.9)

Image and Preset Edit Options

View(See 4.6)

Toolbars and dialogs.

Plug-ins(See 2.2.1.1)

Activate plug-in dialogs (the contents of this menu vary).

Command(See 4.1)

Commands like Play, Pause and Reset.

User Toolbar

Lists all of the Custom Toolbars for the currently-active INI file

Select(See 4.4)

Mouse selection (used with the Analysis Dialog).

Documents(See 4.8)

Relevant Documents

Help(See 4.3)

Access the help library.

 

2.2.1.1 About Plug-ins

Introduction
The DevWareX application framework includes the ability to extend and customize its behavior.  Two types of extensions are supported:

  1. Dialog Plug-in - a dynamically linked library (DLL) which can be integrated with DevWareX and can be used to:

    • Display custom user interfaces.

    • Access and run DevWareX INI presets.

    • Access sensor registers.

    • Process the image data.

For details on how to write your own dialog plug-ins, refer to the document DevWare Plugin Development Guide.  You can also refer to a fully functional implementation example under the folder samples\DialogDLL.

  1. Midlib Transport DLL - a DLL which can be integrated with the midlib library in order to create a "driver" for midlib/DevWareX in order to support new devices.  With a midlib Transport DLL you can:

    • Support an ON Semiconductor sensor on a device other than the Demo System camera so DevWareX or any other midlib-based application will work with the device.

    • Create a software simulated camera and sensor, simulating either an existing sensor or new sensor, and be able to use DevWareX as the user interface for the simulation.

For details on how to write your own midlib transport DLLs, refer to the document Midlib Transport Interface.  You can also refer to a fully functional implementation example under the folder samples\TransportDLL.
 
Shipping Plugins
The DevSuite plug-ins and transport DLL's are located under the Plugins folder of your installation.  Below is the list of items under the Plugins folder that are shipped in DevSuite:

Module name

"*" = separate User Guide

Description

ActiveAlignment.dll

Interfaces with Matlab scripts to give dynamic plotting of x, y z, alpha, beta and theta values to help with  lens positioning. Details are .

AwbTuningMap.dll

For ICP2 (AP1300) and ICP3 (AP1302), this plug-in is used for advanced AWB tuning.

DemoTune.dll *

This plug-in automates the Lens Shading Correction process.

Dewarp.dll *

Dialog plug-in for lens warping correction (Dewarp) of wide angle lenses.  This module is loaded only with MT9V126/128 (MI-356SOC) and ASX344.

FocusModuleUniversalDlg.dll *

This plug-in implements manual and automatic focus on non-SOC sensors and modules.

GainExposureSweep.dll

Allows a sweep of a set of exposures for a given number of gain settings, along with option to capture images.

HorizontalDistortionCorrectionDlg.dll

For ASX353, plot distortion for lens profiles correction.

HostCommandInterface_plugin.dll

For automotive parts that use the Host Command Interface, this plug-in allows the user to compose and issue host commands.

InterestPoint.dll

This plug-in implements the detection of Interest Points, and allows the user to control various configuration parameters.

MacbethOverlay_Plugin.ini

An initialization file for the Macbeth color overlay dialog plug-in (see below).

MacbethOverlay_Plugin_SMPTE.ini

An initialization file for the Macbeth color overlay dialog plug-in (see below).  This file supports SMPTE color charts instead of Macbeth charts.

macbeth_overlay.dll

Dialog plug-in for color analysis using the Macbeth and SMPTE color charts.

PresenceDetection.dll

For the SOC1040 (MT9M114) and SOC2340 (AS0260), this plug-in is used to demonstrate the sensor's ability to detect ambient light and if a person is present.

RgbIR4x4Pipe.dll

For AR0237IR, subtract IR for strong IR light sources.

STEDlg.dll

For AP0100/AP0102/AP0200 parts only, generates transforms that will eventually be burned in to Flash memory.

SystemCurve.dll

For AP0101 parts only, generates gamma (ALTM), gamma, ALTM, and linear data for the given scene.

uart_transport.dll

TransportDLL for parts that have a UART.

 

2.2.2 Toolbar Buttons

The toolbar is displayed across the top of the application window, below the menu bar. The toolbar provides quick access to many tools used in DevWareX.
To hide or display the Toolbar, choose Toolbar from the View menu (ALT-V, T).

Detect

Detect Devices - same action as "File→Detect Devices".  Find all sensors attached to the PC.

 

Info

Open or close the Info Dialog. The Info Dialog(See 2.2.5) contains an information window, Display Format choices and the current Mouse Selection choice.

 <F2> or <Ctrl-I>

Control

Open or close the Sensor Control Dialog(See 2.2.4). This set of pages gives access to a variety of image sensor registers through a user friendly interface.

 <F3> or <Ctrl-S>

Preset

Open or close the Preset Dialog(See 2.2.6). This dialog can be used to load or save the current state of the sensors (registers and color pipe settings).

 <Ctrl-P>

Register

Open or close the Register Dialog(See 2.2.7). The Register Dialog allows the user to read and write registers on the image sensor.

 <F4> or <Ctrl-R>

Warn

Open or close the Register Overwrite Dialog.  User Guide is here.

 

Log

Open or close the Register Log Dialog(See 2.2.8). This dialog logs sensor register writes.

 <Ctrl-L>

Graphs

Open or close the Analysis Dialog(See 2.2.9). The Analysis Dialog displays a graphical interpretation of a selected area of the display.

 <F5>

Magnify

Open or close the Magnifying Glass(See 2.2.10).  Allows user to magnify a section of the display window.

 

Image

Opens the Image Navigation(See 2.2.11) window.  Useful for navigating an image whose output size is larger than display area.

 

Watch

Opens the Watch Dialog(See 2.2.13) that allows the user to monitor volatile registers by re-reading them at a set time period.

 

Options

Opens the Options Dialog(See 2.2.15).

 

Play

Start displaying the image stream.

 

Pause

Pause the image stream.

 

Stop

Stop displaying the image stream.

 

Reset

(Soft) Reset the sensor to the power-on-defaults. This option loads the [reset] section from the appropriate .ini file.
Note: After resetting the sensor the user should re-load the default register settings by clicking the 'Init' button on the toolbar.

 

Init

Load the initialization register settings for the sensor. The register settings can be found in the [Demo Initialization] section from the appropriate .ini file.

 

Full Auto

Enable the default software color processing options.
Note: For Bayer sensors only.

 

Preview

Toggle the sensor between Preview (viewfinder), snapshot mode, and for sensors that support it video mode via a pull-down.
Note: Typically not supported for VGA size and smaller sensors.

 

Grab

Capture the displayed sensor image to hard disk or cancel an image capture.

 <F9>

Lock

For sensors that support it,  simulates half-press of a camera shutter to lock auto-functions such as AE, AWB, and Auto Focus.

 

Snapshot

Capture the "full resolution" image to hard disk or cancel an image capture.
For sensors that support them, there is a pull-down where features such as SnapShot-and-lock, Zero shutter lag, and Snapshot Over Video can be demonstrated

 <Ctrl-F9>

Record

Records the image stream to hard disk.
Note: The video is uncompressed and will take significant hard disk space. This mode is for characterization only.

 

A Power-Point remote clicker's page-down and page-up buttons can be to start/stop recording when the PC is equipped with the IR interface.

 <F8> or

page-down = record start

page-up =
record stop

In

Zoom in on the displayed image.
Note: Zooming beyond 2x might not be supported by your graphics adapter and could lead to image artifacts and potentially to program instability.

 <F10>

Out

Zoom out on the displayed image.

 <F11>

Full

Displays the image in a full screen mode. This feature supports the following standard display modes:
640x480, 800x600, 1024x768, 1280x1024, 1600x1200 and 2048x1536
If the image from the sensor is not one of these sizes, the full screen mode will use the next larger size and fill in the extra area with black pixels. If the image is larger than the maximum size supported by the display device, it will shrink the image to fit. To return back to windowed mode, hit any key or click the mouse.

 <F12>

Bug

Generates a bug report that collects information directly related to the camera setup which is useful for debugging.

 

Home

Opens the ON Semiconductor homepage (http://www.onsemi.com/) in your browser.

 

 

2.2.3 Display


This area is where the sensor images are displayed.
If an image is not displayed here (when expected), please refer to the troubleshooting(See 2.2.17) pages.

Note that processed video streams, such as JPEG and H.264, will be slower than Bayer or RGB due to Software-based processing.
These same types of video streams will also have some "lag" (delay), again to due to the Software-based processing.  This is most notable with H.264.

Images and Videos can be loaded for viewing, either by drag-and-drop method, or via the "File" menu via "Open Image or Video File".
Most image and video types can be viewed, including 32-bit BMP file format. See the Sensor Control dialogs of "Image Save Options" and "Video Record" for specifics.

Use the mouse wheel to zoom in, including to the maximum zoom level to see each pixel value:

To see the MIPI Virtual Channel (VC) and Data Type in use:

  1. Navigate to the "Options" Dialog (See 2.2.15) and enable "No Pixel Decoding (Pure Raw)" for the programmed bit-depth.

  2. Using the mouse wheel, zoom in all the way to see the pixel values and look at column 0.

You will see:

The VC number is displayed first ("vc0") and then the MIPI Data Type in hex ("2C").

2.2.4 Control Dialog (Sensor Control)

This is the main control page. The dialog provides a set of tab pages that give user friendly access to logically grouped sensor registers or color pipe state settings. To access the registers directly use the Register Dialog(See 2.2.7)
The available tab pages depend on the type of image sensor you are using.
SOC Image Sensor Control Pages (See 2.2.4.4)
AP010x Sensor Control Pages (See 2.2.4.3)
SOC JPEG Image Sensor Control Pages (See 2.2.4.5)
Bayer Image Sensor Control Pages (See 2.2.4.2)
All sensors also share the following pages:
Capture Sensor Control Pages (See 2.2.4.6)
Diagnostics Sensor Control Pages (See 2.2.4.7)

There are also other pages available for most parts, and are simple to use.

HDMI Output 
For Demo3 only, enable/disables the HDMI output port. 
Focus Assist 
SW implementation of a focus score.  This "score" is a relative value, having no meaning other than a higher value indicates a crisper image focus.

The focus score is calculated as;

The value of a pixel is R/4 + G/2 + B/4.
At each pixel in the ROI, the following filter kernel is applied to the pixel values:
0 0 -64 0 0
0 0 0 0 0
-64 0 256 0 -64
0 0 0 0 0
0 0 -64 0 0
Then take absolute value, and divide by the value of the center pixel. (Pixels of value 0 are skipped.)
Add the results for all pixels in the ROI.

"Enable Audio FeedBack" allows the user to focus a module using sounds as a feedback method.
Select the "Enable Audio FeedBack" check-box, and then select "Keep Going" (a "Ping") and "Switch Directions" (a "Buzzer") to hear the sounds that will be issued.
You can either us the "Universal Auto Focus" plug-in to manually focus the module, and physically focus it.

Image Orientation 
Set flip/mirror of the image.

2.2.4.1 Developer-only Pages

There are some pages that are only available in our internal version (available only to ON Semiconductor employees).

Diagnostics/Noise vs. Exposure 
This page will evaluate noise and exposure over a given number of frames. 

If you want to measure the effect of a particular image processing function on noise level, then manually activate that function.  To measure noise at the output of the sensor, turn off all image processing, except black level.
Also, make sure auto is disabled, and integration time set to a predefined value, and make sure software gain set to 1.

And in both cases, select "Raw Bayer Color". 

For "'Raw Bayer Color - Sensor Output", disable all DevWareX ColorPipe options.


Bayer Bypass/SW FRF Advanced 
This page implements a Flat Region Filter using Sigma, Edge, and Chroma thresholds.. 
Bayer Bypass/SW Green Balance This page allows the user to enable Green Balance Correction for the DevWareX SW ColorPipe and adjust Highlights and Shadows. Bayer Bypass/SW Black Color KillThis page allows the user to enable Black Color Kill for the DevWareX SW ColorPipe and adjust its thresholds.