![]() |
CMSIS-Pack
Version 1.2
Delivery Mechanism for Software Packs
|
Configuration Wizard Annotations are items and modifiers required to create GUI-like elements in IDEs for configuration files. Using a GUI-like approach makes it easier for the user to check and adapt configuration files to his application's needs. The following applies to the configuration wizard annotations:
The Configuration Wizard section must begin within the first 100 lines of code and must start with the following comment line:
The Configuration Wizard section can end with the following optional comment:
The following table lists the Configuration Wizard Annotations:
Item | Text | Description |
---|---|---|
<h> | yes | Heading: the following options belong to a group. |
<e>* | yes | Heading with Enable: the following options belong to a group, which can be enabled via a checkbox. |
<e.4>* | yes | Heading with Enable: modifies a specific bit (bit 4, in this example). |
</h> or </e> | yes | Heading or Enable end. |
<i> | yes | Tool-tip help for previous item. |
<q>* | yes | Option for bit values which can be set via a checkbox. |
<o>* | yes | Option with selection or number entry. |
<o.4..5>* | yes | Modify a range of bits (example: bit 4 to 5). |
<o.4>* | yes | modify a single bit (example: bit 4). |
<s>* | yes | Option with ASCII string entry. |
<s.10>* | yes | Option with ASCII string entry and a size limit of 10 characters. |
Modifier | Description | |
<0-31> | no | Value range for option fields. |
<0-100:10> | no | Value range for option fields with step 10. |
<0x40-0x1000:0x10> | no | Value range in hex format and step 10. |
<0=> | yes | Value and text for selection. |
<#+1> <#-1> <#*8> <#/3> | no | value modification (add, sub, mul, div) before number is merged into field. |
It is left to the development tool how the Configuration Wizard Annotations are displayed. The uVision IDE displays the above code sample as follows:
Where
Option are the device properties, which can be represented in a tree structure. Each item can have an explanatory tool-tip.
Value sets the option value. Can contain controls to encapsulate data in predefined drop-down lists.