CMSIS Packs  Version 0.10
Mechanism to install software, device support, APIs, and example projects
 All Pages
/package/examples level

The element /package/examples/example describes fully defined examples contained in the PACK. An example lists the files that belong to an example. The example itself and each individual file may refer to a condition that must resolve to true; if it is false the example or file will be ignored. The board element is used to specify the target board and device this is example is targeted for. Each example can specify attributes specifying related components using Class (Cclass=), Group (Cgroup=), Subgroup (Csub) and a Version (Cversion=)

Example

<examples>
<example name="Blinky" folder="Boards\Keil\MCBSTM32F200\Blinky" doc="Abstract.txt" version="1.0">
<description>This is a basic example demonstrating the development flow and letting the LED on the board blink</description>
<board name="MCBSTM32F200" vendor="Keil" Dvendor="STMicroelectronics:13" Dname="STM32F207IG"/>
<project>
<environment name="uv" load="ARM\Blinky.uvproj"/>
<environment name="iar" load="IAR\Blinky.ewarm" />
</project>
<attributes>
<component Cclass="CMSIS" Cgroup="CORE"/>
<component Cclass="Device" Cgroup="Startup"/>
<tag>Blinky</tag>
<tag>Getting Started</tag>
</attributes>
</example>
</examples>

 


/package/examples

Grouping element for examples. No more than one such group can exist in a PACK.

Parent Chain
package /package
Child Elements Description Type Occurrence
example Description of fully specified project ExampleType 1..*

 


/package/examples/example

An example section is used to provide the required information for accessing an example project contained in a PACK. All examples contained in the installed packs can be listed including a brief description. A selected example will get copied into a user selected destination folder. Based on the user selected environment the respective project file will be loaded. The ID of an example is the combination of the PACK vendor, the board information and the example name and version. Examples with the same ID are treated as a single example.

Parent Chain
examples /package/examples
Attributes Description Type Occurrence
name name of the example displayed xs:string 1
folder relative path to the example base folder within the package. If selected the directory including all sub folders and files will be copied, unless the archive attribute gets set. xs:string 1
archive filename and extension of the archive file containing all files and subfolders of the example. The archive is located in the path specified by the attribute folder. If selected the whole archive will be extracted. xs:string 0..1
doc relative path to the file documenting the example xs:string 0..1
version specifies the version of the example. VersionType 1
Child Elements Description Type Occurrence
description briefly documents the purpose and scope of the example for display in an example selector xs:string 1
board Complex type describing a board specifying board name, vendor, device vendor and device name.. BoardType 1
project Complex type describing the project files for different environments ExampleProjectType 1..*
attributes group element for project attributes listing required components, defining example categories and keywords being used for filtering and example search ExampleAttributesType 1