Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

[Reset]

Reset the sensor to its power-on state. Activated by the Reset button the DevWare toolbar.

[Demo Initialization]

The recommended register settings for the sensor in the demo environment. Activated by the Init button on the DevWare toolbar.

[DevWare Initialization]

Settings to initialize DevWare and the sensor for the demo environment. If this preset doesn't exist, Demo Initialization is used.

[SensorDemo Initialization]

Settings to initialize SensorDemo (DevWare /DEMO) and the sensor. If this preset doesn't exist, SensorDemo will fall back to DevWare Initialization or Demo Initialization.

[Monochrome Initialization]

Recommended register settings to use for the monochrome version of the sensor.

[Initialize]

Create a file called prescan.ini and put it in the apps_data directory of the installation directory. In the file have a preset called [Initialize].
[Initialize] will be executed prior to other board initialization and prior to accesses to the sensor board. This works for Demo 2, 2X, 3 and 3X.

Note: There aren't separate initialize preset names per base board type, but it's possible to distinguish between, for example, Demo3 and 3X, with an IF_SERIAL command in the [Initialize] preset.

[Startup Wizard]DevWare will run that instead of the Startup Wizard dialog. Doing that is unconditional, though. There is no way to run Startup Wizard from ini script.

[Viewfinder ON]

Switch into Preview mode. Activated by the Preview button on the DevWare toolbar.

[Viewfinder OFF]

Switch out of Preview mode. Activated by the Preview button on the DevWare toolbar.

[Video Capture ON]

Switch into Video Capture mode. Activated by the Record button on the DevWare toolbar unless Screen capture only (no register changes) is selected on Sensor Control, Video Capture dialog.

[Video Capture OFF]

Switch out of Video Capture mode. Activated when video capture ends, unless Screen capture only (no register changes) is selected on Sensor Control, Video Capture dialog.

[Color Processing ON]

Enable software color processing. Activated by the Auto button on the DevWare toolbar.

[Color Processing OFF]

Disable software color processing. Activated by the Auto button on the DevWare toolbar.

[Camera 1]

Select primary sensor on a two-sensor system.

[Camera 2]

Select secondary sensor on a two-sensor system.

[Pre Still Capture]

Activated before a still image capture, unless Current Image is selected on Sensor Control, Still Capture dialog.

[Post Still Capture]

Activated after a still image capture, unless Current Image is selected on Sensor Control, Still Capture dialog.

[Data Types]

Define data types for sensor registers and bitfields. Activated at DevWare startup. Deprecated since the .xsdat files contain this information now.

[Register Tabs]Define the tabs, groups, and controls for the optional "Scripts" version of the Register Dialog.
[Python:]Python code that will be executed automatically when the file is opened in a Presets dialog in DevWare. This is a good place to put import statements, function def statements and any other definitions that may be used by other presets in the file.
[Python: Unload]Python code that will be executed automatically when the Presets dialog is closed (including when DevWare exits).

...

You may create your own presets using a text editor, or various tools in DevWare DevWareX.
The preset name may consist of any combination of ASCII characters (alphanumeric, symbolic, space, etc.) except "[", "]", "," or the sequence "//".
To execute the preset select it in the DevWare Presets dialog and click Load.

...

List of INI Commands


Command

Definition

83269893BITFIELD

Write a value to a bitfield of a register.

83269893DATATYPE

Define the data type and optional valid range of a named register or bitfield.

83269893DELAY

Delay a certain amount of time (in milliseconds) before continuing.

83269893ERROR_IF

Output an error message and stop execution if a condition is met.

83269893FAR1

Write a value to a sensor register on the first attached camera.

83269893FAR2

Write a value to a sensor register on the second attached camera.

83269893FIELD_WR

Write to a register or bitfield by name. Command works for any kind of register, variable or SFR.

83269893ICON

Define the icon for a User Toolbar button.

83269893IF_FIELD

Similar to LOAD, but conditioned on the value of a register.

83269893IF_REG

Similar to LOAD, but conditioned on the value of a register.

83269893IF_SERIAL

Similar to IF_REG, but can access any device on the SHiP bus.

83269893IMAGE

Set software to expect the given image size and type. Command does not change sensor mode.

83269893LOAD

Load a preset from an ini file.

83269893LOAD_PROM

Load a preset from an EEPROM.

83269893LOG

Add a text string to the Log window.

83269893MEM

Write a value to an SOC RAM location.

83269893MEM8

Write a value to an 8-bit SOC RAM location.

83269893MEM32

Write a value to a 32-bit SOC RAM location.

83269893MENUITEM

Define sub-menu items for a User Toolbar button.

83269893OPTION

Set a DevWare Option variable.

83269893POLL_FIELD

Poll a register. Similar to DELAY, but conditioned on the value of a register.

83269893POLL_REG

Poll a register. Similar to DELAY, but conditioned on the value of a register.

83269893POLL_VAR

Poll a variable. Similar to DELAY, but conditioned on the value of a variable.

83269893PROMPT

Give the user a multiple-choice dialog, or show a message.

83269893PYTHONInvoke a one-line Python statement.

83269893REG

Write a value to a register.

83269893REG_BURST

Write a sequence of register values in one bus transaction.

83269893SAVE_IMAGE

Write image data to files.

83269893SAVE_REGS

Write register values to a file.

83269893SENSOR_BASE

Set or detect the sensor SHiP base address.

83269893SERIAL_REG

Low-level write to Two-Wire Serial Interface register.

83269893SFR

Write a value to a special function register, on certain sensors.

83269893SFR8

Write a value to an 8-bit special function register, on certain sensors.

83269893SHORTCUT

Define a keyboard shortcut for a User Toolbar button.

83269893STATE

Set a variable within the software, not on the sensor.

83269893TOOLTIP

Define a tooltip for a User Toolbar button.

83269893VAR

Write a value to a firmware variable.

83269893VAR32

Write a value to a 32-bit firmware variable.

83269893VAR8

Write a value to an 8-bit firmware variable.

83269893XMCLK

Set the XMCLK (sensor external clock) frequency.

...

Anchor
ICON
ICON
ICON = <icon name> [,CHECKED|RADIO= <register name>[:<bitfield name>]|STATE:<STATE variable> <condition>] [,ENABLED= <register name>[:<bitfield name>|:<mask>]|STATE:<STATE variable> <condition>]  //<comment>

Defines the icon image and button state for a User Toolbar button in DevWare. Only takes effect if the preset name begins with “Toolbar:” or “Toolbar2:”.

If the <icon name> contains a dot “.” character, it's interpreted as a filename with a path relative to the ini file. The icon file can be a .ico or a .bmp (24x24 pixels, 32-bpp, R-G-B-alpha) file.

Example: Load icon from file zoom.ico.
ICON = zoom.ico

Otherwise the name specifies a built-in icon image. The built-in images are different colored shapes. Specify the shape and color. The shapes are circle, square, triangle and star. The colors are black, brown, red, orange, yellow, green, blue, violet, gray and white.

Example: Use a built-in icon image.
ICON= green square.

Optionally you can define the 'checked' (pressed-in) and enabled (not grayed out) state for the button, based on the value of a register, bitfield or DevWare STATE variable. The <condition> can be ==, !=, <, >, <=, or >= followed by a numerical constant. Use the RADIO keyword for a group of mutually exclusive buttons. Use the CHECKED keyword for independent buttons.

Example: Load icon from file antishake.bmp, and declare that the button should be pressed-in when SEQ_STATE_CFG_2_AS equals 1 and not pressed otherwise.
ICON= antishake.bmp, CHECKED= SEQ_STATE_CFG_2_AS == 1

Example: Load icon from file Zoom1.bmp, and declare that the button should be pressed-in when the DevWare STATE variable Display Zoom Percent equals 100.
ICON= Zoom1.bmp, CHECKED= STATE:Display Zoom Percent == 100

See also the MENUITEM= and TOOLTIP= commands.

...