Skip to content

Commit

Permalink
doc: shields: add list in Board names
Browse files Browse the repository at this point in the history
Added a table listing all shields in sdk-nrf.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer authored and cvinayak committed Jan 15, 2024
1 parent 1d68539 commit 1b12d99
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
21 changes: 20 additions & 1 deletion doc/nrf/config_and_build/board_support/board_names.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,23 @@ The following boards are defined in the :file:`nrf/boards/arm/` folder.
| | | | ``nrf7002dk_nrf5340_cpuapp_ns`` |
+-------------------+------------+----------------------------------------------------------+---------------------------------------+

The :ref:`nRF21540 EK shield <ug_radio_fem_nrf21540ek>` is defined in the :file:`nrf/boards/shields` folder.
.. _shield_names_nrf:

Shields included in sdk-nrf
***************************

The following shields are defined in the :file:`nrf/boards/shields` folder.

+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
| Hardware platform | PCA number | Board name | Build target |
+==========================================================+============+==========================================================================+=======================================+
| nRF7002 :term:`Evaluation Kit (EK)` | PCA63556 | :ref:`nrf7002ek <nrf70_gs_shields_evaluation_kit_nrf7002ek>` | ``nrf7002ek`` |
+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
| nRF7002 EK with emulated support for the nRF7001 IC | PCA63556 | :ref:`nrf7002ek_nrf7001 <nrf70_gs_shields_evaluation_kit_nrf7002ek>` | ``nrf7002ek_nrf7001`` |
+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
| nRF7002 EK with emulated support for the nRF7000 IC | PCA63556 | :ref:`nrf7002ek_nrf7000 <nrf70_gs_shields_evaluation_kit_nrf7002ek>` | ``nrf7002ek_nrf7000`` |
+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
| nRF7002 :term:`Expansion Board (EB)` | PCA63561 | :ref:`nrf7002eb <nrf70_gs_shields_expansion_boards_nrf7002eb>` | ``nrf7002eb`` |
+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
| nRF21540 EK | PCA63550 | :ref:`nrf21540ek <ug_radio_fem_nrf21540ek>` | ``nrf21540ek`` |
+----------------------------------------------------------+------------+--------------------------------------------------------------------------+---------------------------------------+
4 changes: 4 additions & 0 deletions doc/nrf/device_guides/working_with_nrf/nrf70/gs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,8 @@ Shields and expansion boards

Shields and expansion boards are add-on hardware that can be attached to a development kit or prototyping platform to extend their features and functionalities.

.. _nrf70_gs_shields_evaluation_kit_nrf7002ek:

nRF7002 EK
==========

Expand Down Expand Up @@ -365,6 +367,8 @@ For example, you can use the following command when building on the command line
To build for the nRF7002 EK and the nRF7001 or nRF7000 ICs, you can use the corresponding shield name in the above command.

.. _nrf70_gs_shields_expansion_boards_nrf7002eb:

nRF7002 EB
==========

Expand Down

0 comments on commit 1b12d99

Please sign in to comment.