Component information

The CMSIS component metadata should be compliant with CMSIS and ST requirements.

Refer to STMicroelectronics UM2388 (Development guidelines for STM32Cube firmware Packs) on st.com.

Vendor Defines the component vendor this component is shipped by. It is a mandatory part of the component ID and will be inherited from the package vendor if not specified. Must not be specified for a component within a bundle.
Bundle Select a bundle previously created.
Class Defines the component class to which the component belongs. This is a mandatory part of the component ID. Must not be specified for a component within a bundle.
Authorized characters : Alphanumeric, "-", "_", " " (blank).
Min 2 characters, Max 32 characters
Leading or trailing spaces forbidden
Group Defines the component group to which the component belongs. Is a mandatory part of the component ID.
Authorized characters : Alphanumeric, "-", "_", " " (blank).
Min 2 characters, Max 32 characters
Leading or trailing spaces forbidden
SubGroup Defines the component subgroup. Is an optional part of the component ID.
Authorized characters : Alphanumeric, "-", "_", " " (blank).
Max 32 characters
Leading or trailing spaces forbidden
Version Defines the version of this component. Is a mandatory part of the component ID.
Must not be specified for a component within a bundle.
Format version is MAJOR.MINOR.PATCH[-Pre Release][+Build Metadata]
Description Brief description of the component.
Condition Enter the id of a condition. The component is available and can be selected when the condition is true.
Variant Defines a variant of a component. Is an optional part of the component ID. The variant specifier is a brief string (for example: release, debug). In case of Class=Device Group=Application, you shall provide as variant the name of its application (without space or special characters).
Default Variant Identifies this component variant to be the preferred variant for tool driven selection.
RTE_Components Source code that is copied into the file RTE_Components.h when the component is selected by the run time environment configuration.
Max Instances Maximum allowed instances of a component in a project. Default is 1 for one instance. The range is [1..10].
Api Version For components that are based on an API header files, it defines the version of the API used by this component. It ensures that the API header file with the same or higher version is acceptable for using that component.
Format version is MAJOR.MINOR.PATCH[-Pre Release][+Build Metadata]
Generator This links the component with a generator description located in the same file. If this component is selected by the run time configuration, the tool will test whether the configured gpdsc file does already exist or not. If the file is not present, then the command specified by the referenced generator section, will be invoked. If the gpdsc file already exists it will be included into the project.
Deprecated When set to true, then the component is deprecated and no longer maintained. Default is false to indicate an actively maintained component.