...
[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. | |
| [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 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]. 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. | |
[Color Processing OFF]Disable software color processingVideo Capture ON] | Switch into Video Capture mode. Activated by the Auto Record 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 unless Screen capture only (no register changes) is selected on Sensor Control, Still Video Capture dialog. | |
[Post Still Video Capture OFF] | Activated after a still image capture, unless Current Image Switch out of Video Capture mode. Activated when video capture ends, unless Screen capture only (no register changes) is selected on Sensor Control, Still Video 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). |
User-Defined DevWare Presets
You may create your own presets using a text editor, or various tools in DevWare.
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.
Special Preset Name Prefixes
The following preset name prefixes have special meaning.
...
[Toolbar: …]
...
The preset will get a button on the User Toolbar assigned to it. See below.
...
[Toolbar2: …]
...
The preset will get a button on the 2nd User Toolbar assigned to it. See below.
...
[Python: …]
...
The preset contains Python code instead of ini commands. See the DevWare Python Development Guide document.
...
[Hidden: …]
...
The preset will not appear in the DevWare Presets dialog list box. You can leave off the 'Hidden:' part in 83269893= commands. For example 'LOAD=PLL-On' can load [Hidden: PLL-On].
...
[Patch <id>; <color>; <description>]
...
A preset name formatted like this will be recognized as a firmware patch by the Load Patches dialog page of the Sensor Control dialog.
<id> is the patch ID, usually four hex digits.
<color> is one of "critical", "recommended", "feature-recommended", "feature recommended", "customer", "customer-specific", "customer specific".
<description> is a short text description of the patch.
...
If the name of a preset begins with "Toolbar:" or "Toolbar2:" then DevWare will create a button on the corresponding User Toolbar that executes the preset. The remainder of the preset name after "Toolbar:" or "Toolbar2:" will be used as the button label. You can further define the characteristics and behavior of the toolbar button with the 83269893=, 83269893=, 83269893= and SHORTCUT= special commands.
The maximum number of buttons on a User Toolbar is 20.
...
Example: Menu button
[Toolbar: Quick Zoom]
ICON= zoom.ico
TOOLTIP= "Select a Display Zoom setting"
MENUITEM= "1/4", LOAD= Zoom.25X, RADIO= STATE:Display Zoom Percent == 25
MENUITEM= "1:1", LOAD= Zoom1X, RADIO= STATE:Display Zoom Percent == 100
MENUITEM= "4X", LOAD= Zoom4X, RADIO= STATE:Display Zoom Percent == 400
[Zoom.25X]
STATE= Display Zoom Percent, 25
[Zoom1X]
STATE= Display Zoom Percent, 100
[Zoom4X]
STATE= Display Zoom Percent, 400
List of INI Commands
...
Command
...
Definition
...
...
Write a value to a bitfield of a register.
...
...
Define the data type and optional valid range of a named register or bitfield.
...
...
Delay a certain amount of time (in milliseconds) before continuing.
...
...
Output an error message and stop execution if a condition is met.
...
...
Write a value to a sensor register on the first attached camera.
...
...
Write a value to a sensor register on the second attached camera.
...
...
Write to a register or bitfield by name. Command works for any kind of register, variable or SFR.
...
...
Define the icon for a User Toolbar button.
...
...
Similar to LOAD, but conditioned on the value of a register.
...
...
Similar to LOAD, but conditioned on the value of a register.
...
...
Similar to IF_REG, but can access any device on the SHiP bus.
...
...
Set software to expect the given image size and type. Command does not change sensor mode.
...
...
Load a preset from an ini file.
...
...
Load a preset from an EEPROM.
...
...
Add a text string to the Log window.
...
...
Write a value to an SOC RAM location.
...
...
Write a value to an 8-bit SOC RAM location.
...
...
Write a value to a 32-bit SOC RAM location.
...
...
Define sub-menu items for a User Toolbar button.
...
...
Set a DevWare Option variable.
...
...
Poll a register. Similar to DELAY, but conditioned on the value of a register.
...
...
Poll a register. Similar to DELAY, but conditioned on the value of a register.
...
...
Poll a variable. Similar to DELAY, but conditioned on the value of a variable.
...
...
Give the user a multiple-choice dialog, or show a message.
...
...
Write a value to a register.
...
...
Write a sequence of register values in one bus transaction.
...
...
Write image data to files.
...
...
Write register values to a file.
...
...
Set or detect the sensor SHiP base address.
...
...
Low-level write to Two-Wire Serial Interface register.
...
...
Write a value to a special function register, on certain sensors.
...
...
Write a value to an 8-bit special function register, on certain sensors.
...
...
Define a keyboard shortcut for a User Toolbar button.
...
...
Set a variable within the software, not on the sensor.
...
...
Define a tooltip for a User Toolbar button.
...
...
Write a value to a firmware variable.
...
...
Write a value to a 32-bit firmware variable.
...
...
Write a value to an 8-bit firmware variable.
...
...
Set the XMCLK (sensor external clock) frequency.
Command Syntax
...
| Anchor | | BITFIELD | BITFIELD | BITFIELD = [<page>,] <address>, <mask>, <value> //<comment>||||||||||||||||||||||
| Anchor | DATATYPE | DATATYPE | DATATYPE = <register name>, [<bitfield name>,] <type> [, RANGE= <min>:<max>] //<comment>|||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Anchor | DELAY | DELAY | DELAY = <milliseconds> //<comment>|||||||||||||||||||||||
| Anchor | ERROR_IF | ERROR_IF | ERROR_IF = <register name>, [<bitfield name>,] <condition>, "<message>" //<comment>|||||||||||||||||||||||
| Anchor | FAR1 | FAR1 | FAR1 = <page>, <address>, [<mask>,] <value> //<comment>|||||||||||||||||||||||
| Anchor | FAR2 | FAR2 | FAR2 = <page>, <address>, [<mask>,] <value> //<comment>|||||||||||||||||||||||
| Anchor | FIELD_WR | FIELD_WR | FIELD_WR = <register name>, [<bitfield name>,] <value> //<comment>|||||||||||||||||||||||
| 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>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). |
User-Defined DevWare Presets
You may create your own presets using a text editor, or various tools in 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.
Special Preset Name Prefixes
The following preset name prefixes have special meaning.
[Toolbar: …] | The preset will get a button on the User Toolbar assigned to it. See below. |
[Toolbar2: …] | The preset will get a button on the 2nd User Toolbar assigned to it. See below. |
[Python: …] | The preset contains Python code instead of ini commands. See the DevWare Python Development Guide document. |
[Hidden: …] | The preset will not appear in the DevWare Presets dialog list box. You can leave off the 'Hidden:' part in 83269893= commands. For example 'LOAD=PLL-On' can load [Hidden: PLL-On]. |
[Patch <id>; <color>; <description>] | A preset name formatted like this will be recognized as a firmware patch by the Load Patches dialog page of the Sensor Control dialog. |
| Anchor | ||||
|---|---|---|---|---|
|
If the name of a preset begins with "Toolbar:" or "Toolbar2:" then DevWare will create a button on the corresponding User Toolbar that executes the preset. The remainder of the preset name after "Toolbar:" or "Toolbar2:" will be used as the button label. You can further define the characteristics and behavior of the toolbar button with the 83269893=, 83269893=, 83269893= and SHORTCUT= special commands.
The maximum number of buttons on a User Toolbar is 20.
Example: Simple button
[Toolbar: Zoom 1X]
ICON= zoom.ico
TOOLTIP= "Restore the display zoom to 1X"
SHORTCUT= Ctrl+1
STATE= Display Zoom Percent, 100
Example: Menu button
[Toolbar: Quick Zoom]
ICON= zoom.ico
TOOLTIP= "Select a Display Zoom setting"
MENUITEM= "1/4", LOAD= Zoom.25X, RADIO= STATE:Display Zoom Percent == 25
MENUITEM= "1:1", LOAD= Zoom1X, RADIO= STATE:Display Zoom Percent == 100
MENUITEM= "4X", LOAD= Zoom4X, RADIO= STATE:Display Zoom Percent == 400
[Zoom.25X]
STATE= Display Zoom Percent, 25
[Zoom1X]
STATE= Display Zoom Percent, 100
[Zoom4X]
STATE= Display Zoom Percent, 400
List of INI Commands
Command | Definition |
Write a value to a bitfield of a register. | |
Define the data type and optional valid range of a named register or bitfield. | |
Delay a certain amount of time (in milliseconds) before continuing. | |
Output an error message and stop execution if a condition is met. | |
Write a value to a sensor register on the first attached camera. | |
Write a value to a sensor register on the second attached camera. | |
Write to a register or bitfield by name. Command works for any kind of register, variable or SFR. | |
Define the icon for a User Toolbar button. | |
Similar to LOAD, but conditioned on the value of a register. | |
Similar to LOAD, but conditioned on the value of a register. | |
Similar to IF_REG, but can access any device on the SHiP bus. | |
Set software to expect the given image size and type. Command does not change sensor mode. | |
Load a preset from an ini file. | |
Load a preset from an EEPROM. | |
Add a text string to the Log window. | |
Write a value to an SOC RAM location. | |
Write a value to an 8-bit SOC RAM location. | |
Write a value to a 32-bit SOC RAM location. | |
Define sub-menu items for a User Toolbar button. | |
Set a DevWare Option variable. | |
Poll a register. Similar to DELAY, but conditioned on the value of a register. | |
Poll a register. Similar to DELAY, but conditioned on the value of a register. | |
Poll a variable. Similar to DELAY, but conditioned on the value of a variable. | |
Give the user a multiple-choice dialog, or show a message. | |
| PYTHON | Invoke a one-line Python statement. |
Write a value to a register. | |
Write a sequence of register values in one bus transaction. | |
Write image data to files. | |
Write register values to a file. | |
Set or detect the sensor SHiP base address. | |
Low-level write to Two-Wire Serial Interface register. | |
Write a value to a special function register, on certain sensors. | |
Write a value to an 8-bit special function register, on certain sensors. | |
Define a keyboard shortcut for a User Toolbar button. | |
Set a variable within the software, not on the sensor. | |
Define a tooltip for a User Toolbar button. | |
Write a value to a firmware variable. | |
Write a value to a 32-bit firmware variable. | |
Write a value to an 8-bit firmware variable. | |
Set the XMCLK (sensor external clock) frequency. |
Command Syntax
Note: [ ] items are optional.
|
|
|
|
|
|
|
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. 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. |
...
|
...