1. Usage[edit source]
The Board template is used to indicate for which board(s), an article part (chapter, paragraph, table...) is valid. Per default (i.e. if this template is not used), any part of an article is valid for all boards for which the entire article is valid.
It outputs a "standardized" string that might be used to name an article part.
Usage: {{Board | type=<type> | name=<name>}}
- Where:
- <type> is the mandatory identifier of the board type. The possible values are (see also the STM32MP13 part number codification for the STM32MP13 MPUs, the STM32MP15 part number codification for the STM32MP15 MPUs and the STM32MP25 part number codification for the STM32MP25 MPUs):
- MPU: any board with a STM32 MPU microprocessor device
- MP1: any board with a STM32MP1 microprocessor device
- 135F-DK: STM32MP135F-DK Discovery kit
- 135x-DK: any Discovery kit with a STM32MP135 MPU
- 157A-EV1: STM32MP157A-EV1 Evaluation board - Obsolete - This board is out of production
- 157D-EV1: STM32MP157D-EV1 Evaluation board
- 157C-EV1: STM32MP157C-EV1 Evaluation board - Obsolete - This board is out of production
- 157F-EV1: STM32MP157F-EV1 Evaluation board
- 157A/D-EV1: STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board
- 157C/F-EV1: STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board
- 157x-EV1: any Evaluation board with a STM32MP157 MPU
- 157A-DK1: STM32MP157A-DK1 Discovery kit - Obsolete - This board is out of production
- 157D-DK1: STM32MP157A-DK1 Discovery kit
- 157C-DK2: STM32MP157C-DK2 Discovery kit - Obsolete - This board is out of production
- 157F-DK2: STM32MP157F-DK2 Discovery kit
- 157x-DK1: STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit
- 157x-DK2: STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit
- 157x-DKx: any Discovery kit with a STM32MP157 MPU
- MP2: any board with a STM32MP2 microprocessor device
- 235F-DK: STM32MP257F-DK Discovery kit supplemented by the following message: To help you get started with the evaluation of the STM32MP23x product lines, you can rely on the STM32MP257F-DK Discovery kit, and the applicable STM32 MPU embedded software, running with the STM32MP23 software configuration (peripherals, features, and performance).
- 257x-DK: any Discovery kit with a STM32MP257 MPU - Not recommended, use 257F-DK instead
- 257F-DK: STM32MP257F-DK Discovery kit
- 257x-EV1: any Evaluation board with a STM32MP257 MPU - Not recommended, use 257F-EV1 instead
- 257F-EV1: STM32MP257F-EV Evaluation board
- <name> is the optional parameter that allows to select the way the board name is displayed. Per default (if <name> is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for <name> is:
- short: the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed
The icon indicates that the board is already available, and clicking on this icon links to the article about the boards hardware description (e.g. STM32MP157x-DKx - hardware description).
The icon indicates that the board is currently not available.
The icon indicates that there's a custom message associated with the board.
2. Basic examples[edit source]
You type | You get |
---|---|
All boards with a STM32 MPU microprocessor device
{{Board | type=MPU}}<br /> {{Board | type=MPU | name=short}} |
|
All boards with a STM32MP1 microprocessor device
{{Board | type=MP1}}<br /> {{Board | type=MP1 | name=short}} |
|
STM32MP135F-DK
{{Board | type=135F-DK | name=short}} |
|
STM32MP135x-DK Discovery kit
{{Board | type=135x-DK}} |
|
STM32MP135F-DK Discovery kit
{{Board | type=135F-DK}} |
|
STM32MP157F-EV1 Evaluation board
{{Board | type=157F-EV1}} |
|
STM32MP157C-DK2 Discovery kit
{{Board | type=157C-DK2}} |
STM32MP157C-DK2 Discovery kit |
STM32MP157C-EV1
{{Board | type=157C-EV1 | name=short}} |
STM32MP157C-EV1 |
STM32MP157A-DK1
{{Board | type=157A-DK1 | name=short}} |
STM32MP157A-DK1 |
All boards with a STM32MP2 microprocessor device
{{Board | type=MP2}}<br /> {{Board | type=MP2 | name=short}} |
|
Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU
{{Board | type=235F-DK}}<br> |
STM32MP257F-DK Discovery kit |
Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU: short name
{{Board | type=235F-DK}|name=short}<br> |
|
STM32MP257F-EV1 Evaluation board
{{Board | type=257F-EV1}} |
|
STM32MP257x-EV1 Evaluation board
{{Board | type=257x-EV1}} |
|
STM32MP257F-DK Discovery kit
{{Board | type=257F-DK}} |
|
STM32MP257x-DK Discovery kit
{{Board | type=257x-DK}} |
3. More examples[edit source]
You type | You get |
---|---|
Discovery kits with a STM32MP135 MPU
{{Board | type=135F-DK}}<br> |
|
Discovery kits with a STM32MP135 MPU: short name {{Board | type=135F-DK | name=short}}<br> |
|
Evaluation boards with a STM32MP157 MPU
{{Board | type=157A-EV1}}<br> {{Board | type=157D-EV1}}<br> {{Board | type=157C-EV1}}<br> {{Board | type=157F-EV1}}<br> {{Board | type=157A/D-EV1}}<br> {{Board | type=157C/F-EV1}}<br> {{Board | type=157x-EV1}} |
STM32MP157A-EV1 Evaluation board |
Discovery kits with a STM32MP157 MPU
{{Board | type=157A-DK1}}<br> {{Board | type=157D-DK1}}<br> {{Board | type=157C-DK2}}<br> {{Board | type=157F-DK2}}<br> {{Board | type=157x-DK1}}<br> {{Board | type=157x-DK2}}<br> {{Board | type=157x-DKx}} |
STM32MP157A-DK1 Discovery kit |
Evaluation boards with a STM32MP157 MPU: short name
{{Board | type=157A-EV1 | name=short}}<br> {{Board | type=157D-EV1 | name=short}}<br> {{Board | type=157C-EV1 | name=short}}<br> {{Board | type=157F-EV1 | name=short}}<br> {{Board | type=157A/D-EV1 | name=short}}<br> {{Board | type=157C/F-EV1 | name=short}}<br> {{Board | type=157x-EV1 | name=short}} |
STM32MP157A-EV1 |
Discovery kits with a STM32MP157 MPU: short name
{{Board | type=157A-DK1 | name=short}}<br> {{Board | type=157D-DK1 | name=short}}<br> {{Board | type=157C-DK2 | name=short}}<br> {{Board | type=157F-DK2 | name=short}}<br> {{Board | type=157x-DK1 | name=short}}<br> {{Board | type=157x-DK2 | name=short}}<br> {{Board | type=157x-DKx | name=short}} |
STM32MP157A-DK1 |
Evaluation boards with a STM32MP257 MPU
{{Board | type=257F-EV1}} |
|
Discovery kits with a STM32MP257 MPU
{{Board | type=257F-DK}} |
|
Evaluation boards with a STM32MP257 MPU: short name
{{Board | type=257F-EV1 | name=short}} |
|
Discovery kits with a STM32MP257 MPU: short name
{{Board | type=257F-DK | name=short}} |
|
Unspecified board
{{Board}} |
unknown board type identifier |
Unknown boards
{{Board | type=153C-EV1}}<br> {{Board | type=157C-DK3}} |
unknown board type identifier |
Unknown value for <name>
{{Board | type=157C-EV1 | name=long}}<br> {{Board | type=157C-EV1 | name=}} |
STM32MP157C-EV1 Evaluation board |
Check that there's no space before and after the text
BEFORE{{Board | type=157C-EV1}}AFTER<br> BEFORE{{Board | type=157C-DK2}}AFTER<br> |
BEFORESTM32MP157C-EV1 Evaluation board |
4. Code[edit source]
unknown board type identifier