Open-CMSIS-Pack  Version 1.7.44
Delivery Mechanism for Software Packs
/package/csolution element

The element /package/csolution describes the pack content that relates to csolution projects that are managed using the CMSIS-Toolbox.

/package/csolution

Grouping element for csolution. No more than one such group can exist in a package description.

Parent Chain
package /package
Child Elements Description Type Occurrence
clayer Description of a clayer; a software layer collects source files and software components along with configuration files for re-use in different projects. ClayerType 0..*
template Description of project templates that are used in an IDE to start new csolution projects. ClayerType 0..*

Example:

<csolution>
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copy-to="Blank" condition="STM32H7S-Series">
<description>Create a basic project with empty main function</description>
</template>
<clayer type="Board" path="layers/board/FRDM-MCXA153-MW" file="Board.clayer.yml" copy-to="board/FRDM-MCXA153" condition="FRDM-MCXA153-Board" />
</csolution>

 


/package/csolution/clayer

A clayer section provides the information for accessing a software layer that is stored in a pack. If a condition is specified, the clayer is only listed when the condition resolves to true.

Parent Chain
csolution /package/csolution
Attributes Description Type Use
type Type of the clayer xs:string required
path Path to the directory that contains the software layer. xs:string required
file Name of the *.clayer.yml file (optional with relative path to the directory specified with path). xs:string required
copy-to Path that used to copy the software layer into the csolution project (default is attribute path). xs:string optional
condition Enter the id of a condition. The clayer is available and will be listed only when the filter condition is true (no component dependencies are evaluated). xs:string optional

Example:

<csolution>
<clayer type="Board" path="layers/board/FRDM-MCXA153-MW" file="Board.clayer.yml" copy-to="board/FRDM-MCXA153" condition="FRDM-MCXA153-Board" />
<clayer type="Board" path="board/FRDM-MCXA153" file="Board.clayer.yml" condition="FRDM-MCXA153-Board"/>
</csolution>

 


/package/csolution/template

A template section provide one or more project templates for starting a new csolution project in an IDE. If a condition is specified, the template is only available when the condition resolves to true.

Parent Chain
csolution /package/csolution
Attributes Description Type Use
name Name of the template xs:string required
path Path to the directory that contains the template. xs:string required
file Name of the *.csolution.yml file (optional with relative path to the directory specified with path). xs:string required
copy-to Path that used to copy the template into the csolution project (default is attribute path). xs:string optional
condition Enter the id of a condition. The template is available and will be listed only when the filter condition is true (no component dependencies are evaluated). xs:string optional
Child Elements Description Type Occurrence
description Briefly documents the purpose and scope of the template (maximum 256 characters, recommended 128 characters). BriefDescType 1

Example:

<csolution>
<template name="Basic csolution project" path="templates/blank" file="Blank.csolution.yml" copy-to="Blank" condition="STM32H7S-Series">
<description>Create a basic project with empty main function</description>
</template>
<template name="TrustZone csolution project" path="templates/trustzone" file="TrustZone.csolution.yml" condition="STM32H7S-Series">
<description>Create a basic solution with secure and non-secure projects</description>
</template>
</csolution>