 |
Open-CMSIS-Pack
Version 1.7.36
Delivery Mechanism for Software Packs
|
|
Open-CMSIS-Pack
Version 1.7.36
Delivery Mechanism for Software Packs
|
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 reference to one or more board descriptions using the board vendor and name an example is targeted for. Each example may optionally specify attributes e.g. providing a short list of the most significant components using Class (Cclass=), Group (Cgroup=), Subgroup (Csub) and a Version (Cversion=).
Example
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..* |
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 | Use |
| name | Name of the example | xs:string | required |
| folder | Relative path to the example base folder within the package. If selected, then the directory including all sub-folders and files will be copied, unless the archive attribute gets set. | xs:string | required |
| archive | Filename and extension of the archive file containing all files and sub-folders of the example. The archive is located in the path specified by the attribute folder. If selected, then the whole archive will be extracted. | xs:string | optional |
| doc | Document that describes the example. | xs:string | required |
| version | Example version number. The version format is described in Version Type. | VersionType | optional |
| public | Set publishing permissions for the documentation. If <public> is true, then the vendor gives permission to extract the documentation from the pack and publish it on a web-page. Links to web pages are assumed to be public. The default value is false. | xs:boolean | optional |
| Child Elements | Description | Type | Occurrence |
| description | Briefly documents the purpose and scope of the example (maximum 256 characters, recommended 128 characters). The test can be displayed in an example selector. | BriefDescType | 1 |
| board | Complex type providing a reference to a board description using board name and vendor. | BoardReferenceType | 0..* |
| project | Complex type describing the project files for different environments | ExampleProjectType | 1 |
| attributes | Group element for project attributes, which list required components, define example categories, and set keywords to filter and search for examples. | ExampleAttributesType | 0..1 |
This element specifies the board that can be used with the example project.
Example:
| Parent | Chain | ||
|---|---|---|---|
| example | /package/examples/example | ||
| Attributes | Description | Type | Use |
| vendor | Vendor name of the board. | xs:string | required |
| name | Commercial name of the board. | xs:string | required |
| Dvendor | Vendor name of the device used on the board. Use predefined values as listed in the table Device Vendor. | DeviceVendorEnum | optional |
| Dfamily | Name of the target device family used on the board. This attribute is optional if either DsubFamily or Dname is already specified. Deprecated since version 1.1 | xs:string | optional |
| DsubFamily | Name of the target device sub-family used on the board. This attribute is optional if either Dfamily or Dname is already specified. Deprecated since version 1.1 | xs:string | optional |
| Dname | Name of the target device used on the board. This attribute is optional if either Dfamily or DsubFamily is already specified. Deprecated since version 1.1. | xs:string | optional |
Different development tools store project information in tool specific file formats. A single example may include project files for multiple tools or environments. Therefore the project element is a sequence of one or more environment elements that describe the name of the environment and the project file to be loaded by the respective development tool.
Example:
| Parent | Chain | ||
|---|---|---|---|
| example | /package/examples/example | ||
| Child Elements | Description | Type | Occurrence |
| environment | Specifies the environment and project file with extension. | xs:complexType | 1..* |
The environment element describes the name of the environment and the project file to be loaded.
Example:
| Parent | Chain | ||
|---|---|---|---|
| project | /package/examples/example/project | ||
| Attributes | Description | Type | Use |
| name | Identifier of the development tool (for example: uv, iar, csolution, etc.) targeted by the project file specified by the load attribute. | xs:string | required |
| load | Specifies the project file with extension. A path relative to folder attribute of the element /package/examples/example can be appended. | xs:string | required |
| folder | Specifies the subdirectory to be copied into the user's project folder relative to folder attribute of the element /package/examples/example. This attribute is used by example descriptions that support multiple tool-chains/IDEs, each stored in a separate folders. Note: for copying eclipse projects it is required that the .project file is located in the base directory and all project files are located in the base directory or in one of the subdirectories. In this case even common files are required to be duplicated. | xs:string | optional |
Example:
| Parent | Chain | ||
|---|---|---|---|
| example | /package/examples/example | ||
| Child Elements | Description | Type | Occurrence |
| category | Free form string defining an example category. A category can be used to filter examples in an example browser. | xs:string | 0..* |
| component | Group for defining the components used in the example. | ComponentCategoryType | 0..* |
| keyword | Free form string defining a keyword that relates to the example. A keyword can be used to search for examples. | xs:string | 0..* |
The component element specifies the Cclass to which the example belongs. This can be used to list all related components within an example.
Example:
| Parent | Chain | ||
|---|---|---|---|
| attribute | /package/examples/example/attributes | ||
| Attribute | Description | Type | Use |
| Cclass | Free form string defining an example class. Predefined values can be used as listed in the table Component Classes. | CclassType | required |
| Cgroup | Free form string defining an example group. Predefined values can be used as listed in the table Component Groups. | CgroupType | optional |
| Csub | Free form string defining an example subgroup. The type is described in Component Subgroups. | CsubType | optional |
| Cversion | Free form string defining an example version. The version format is described in Version Type. | VersionType | optional |
| Cvendor | Free form string defining the vendor of the example. | xs:string | optional |
