boards: adafruit: adopt new zephyr:board directive and role
This updates the documentation of all the Adafruit boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
parent
77a35d835a
commit
599e0625e3
13 changed files with 13 additions and 97 deletions
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_feather_m0_basic_proto:
|
.. zephyr:board:: adafruit_feather_m0_basic_proto
|
||||||
|
|
||||||
Adafruit Feather M0 Basic Proto
|
|
||||||
###############################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -11,10 +8,6 @@ board with an onboard battery connector and charger for 3.7 V lithium
|
||||||
polymer batteries, charging status indicator and user LEDs, native USB
|
polymer batteries, charging status indicator and user LEDs, native USB
|
||||||
connector, 20 I/O pins, and a small prototyping area.
|
connector, 20 I/O pins, and a small prototyping area.
|
||||||
|
|
||||||
.. image:: img/adafruit_feather_m0_basic_proto.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit Feather M0 Basic Proto
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_feather_m0_lora:
|
.. zephyr:board:: adafruit_feather_m0_lora
|
||||||
|
|
||||||
Adafruit Feather M0 LoRa
|
|
||||||
########################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -11,10 +8,6 @@ boards with an onboard battery connector and charger for 3.7 V lithium
|
||||||
polymer batteries, charging status indicator and user LEDs, native USB
|
polymer batteries, charging status indicator and user LEDs, native USB
|
||||||
connector, 20 I/O pins, and a LoRa radio module from Semtech.
|
connector, 20 I/O pins, and a LoRa radio module from Semtech.
|
||||||
|
|
||||||
.. image:: img/adafruit_feather_m0_lora.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit Feather M0 LoRa
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_feather_nrf52840:
|
.. zephyr:board:: adafruit_feather_nrf52840
|
||||||
|
|
||||||
Adafruit Feather nRF52840 (Express, Sense)
|
|
||||||
##########################################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_feather_stm32f405:
|
.. zephyr:board:: adafruit_feather_stm32f405
|
||||||
|
|
||||||
Adafruit Feather STM32F405 Express
|
|
||||||
##################################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -12,10 +9,6 @@ devices labeled as Feathers or FeatherWings. The board is equipped
|
||||||
with a lithium ion battery charger, native USB C connector, 2MB of
|
with a lithium ion battery charger, native USB C connector, 2MB of
|
||||||
external flash memory, and SD card socket.
|
external flash memory, and SD card socket.
|
||||||
|
|
||||||
.. image:: img/adafruit_feather_stm32f405.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit Feather STM32F405 Express
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_grand_central_m4_express:
|
.. zephyr:board:: adafruit_grand_central_m4_express
|
||||||
|
|
||||||
Adafruit Grand Central M4 Express
|
|
||||||
#################################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -10,13 +7,6 @@ The Adafruit Grand Central M4 Express is an ARM development board with the
|
||||||
form factor of an Arduino Mega.
|
form factor of an Arduino Mega.
|
||||||
It features 70 GPIO pins, a microSDHC slot and 8MiB of QSPI Flash.
|
It features 70 GPIO pins, a microSDHC slot and 8MiB of QSPI Flash.
|
||||||
|
|
||||||
.. figure:: img/adafruit_grand_central_m4_express.webp
|
|
||||||
:width: 800px
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit Grand Central M4 Express
|
|
||||||
|
|
||||||
Adafruit Grand Central M4 Express (Credit: Kattni Rembor / Adafruit)
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_itsybitsy_nrf52840:
|
.. zephyr:board:: adafruit_itsybitsy
|
||||||
|
|
||||||
Adafruit ItsyBitsy nRF52840
|
|
||||||
###########################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -29,10 +26,6 @@ This development kit has the following features:
|
||||||
* :abbr:`USB (Universal Serial Bus)`
|
* :abbr:`USB (Universal Serial Bus)`
|
||||||
* :abbr:`WDT (Watchdog Timer)`
|
* :abbr:`WDT (Watchdog Timer)`
|
||||||
|
|
||||||
.. image:: img/adafruit_itsybitsy_nrf52840.jpeg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit ItsyBitsy nRF52840 Express
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
- nRF52840 ARM Cortex-M4F CPU at 64MHz
|
- nRF52840 ARM Cortex-M4F CPU at 64MHz
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_itsybitsy_m4_express:
|
.. zephyr:board:: adafruit_itsybitsy_m4_express
|
||||||
|
|
||||||
Adafruit ItsyBitsy M4 Express
|
|
||||||
#############################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -10,10 +7,6 @@ The Adafruit ItsyBitsy M4 express is a small (36 mm x 18 mm) ARM development
|
||||||
board with an onboard RGB LED, USB port, 2 MiB of SPI flash, and range of I/O
|
board with an onboard RGB LED, USB port, 2 MiB of SPI flash, and range of I/O
|
||||||
broken out onto 23 GPIO pins.
|
broken out onto 23 GPIO pins.
|
||||||
|
|
||||||
.. image:: img/adafruit_itsybitsy_m4_express.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit ItsyBitsy M4 Express
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_kb2040:
|
.. zephyr:board:: adafruit_kb2040
|
||||||
|
|
||||||
Adafruit KB2040
|
|
||||||
###############
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -27,13 +24,6 @@ Hardware
|
||||||
- On-board RGB LED
|
- On-board RGB LED
|
||||||
- 1 Watchdog timer peripheral
|
- 1 Watchdog timer peripheral
|
||||||
|
|
||||||
|
|
||||||
.. figure:: img/kb2040.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit KB2040
|
|
||||||
|
|
||||||
Adafruit KB2040 (Image courtesy of Adafruit)
|
|
||||||
|
|
||||||
Supported Features
|
Supported Features
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _nrf52_adafruit_feather:
|
.. zephyr:board:: nrf52_adafruit_feather
|
||||||
|
|
||||||
nRF52 Adafruit Feather
|
|
||||||
######################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -18,12 +15,6 @@ the following devices:
|
||||||
* RADIO (Bluetooth Low Energy)
|
* RADIO (Bluetooth Low Energy)
|
||||||
* Segger RTT (RTT Console)
|
* Segger RTT (RTT Console)
|
||||||
|
|
||||||
.. figure:: img/nrf52_adafruit_feather.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: nRF52 Adafruit Feather Board
|
|
||||||
|
|
||||||
nRF52 Adafruit Feather Board (Credit: Adafruit)
|
|
||||||
|
|
||||||
More information about the board and its features can be found at the
|
More information about the board and its features can be found at the
|
||||||
`Adafruit Feather nRF52 Bluefruit Learning Guide`_. The `Nordic Semiconductor Infocenter`_
|
`Adafruit Feather nRF52 Bluefruit Learning Guide`_. The `Nordic Semiconductor Infocenter`_
|
||||||
contains the processor's information and the datasheet.
|
contains the processor's information and the datasheet.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_qt_py_rp2040:
|
.. zephyr:board:: adafruit_qt_py_rp2040
|
||||||
|
|
||||||
Adafruit QT Py RP2040
|
|
||||||
#####################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -27,13 +24,6 @@ Hardware
|
||||||
- On-board RGB LED
|
- On-board RGB LED
|
||||||
- 1 Watchdog timer peripheral
|
- 1 Watchdog timer peripheral
|
||||||
|
|
||||||
|
|
||||||
.. figure:: img/qtpy_rp2040.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit QT Py RP2040
|
|
||||||
|
|
||||||
Adafruit QT Py RP2040 (Image courtesy of Adafruit)
|
|
||||||
|
|
||||||
Supported Features
|
Supported Features
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,4 @@
|
||||||
.. _adafruit_trinket_m0:
|
.. zephyr:board:: adafruit_trinket_m0
|
||||||
|
|
||||||
Adafruit Trinket M0
|
|
||||||
###################
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
********
|
********
|
||||||
|
|
@ -10,10 +7,6 @@ The Adafruit Trinket M0 is a tiny (27 mm x 15 mm) ARM development
|
||||||
board with an onboard RGB LED, USB port, and range of I/O broken out
|
board with an onboard RGB LED, USB port, and range of I/O broken out
|
||||||
onto 5 pins.
|
onto 5 pins.
|
||||||
|
|
||||||
.. image:: img/adafruit_trinket_m0.jpg
|
|
||||||
:align: center
|
|
||||||
:alt: Adafruit Trinket M0
|
|
||||||
|
|
||||||
Hardware
|
Hardware
|
||||||
********
|
********
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -177,7 +177,7 @@ More implementation details can be found in the :ref:`boards` documentation.
|
||||||
As a quick reference, see these three board documentation pages:
|
As a quick reference, see these three board documentation pages:
|
||||||
|
|
||||||
- :ref:`sam4e_xpro` (ROM bootloader)
|
- :ref:`sam4e_xpro` (ROM bootloader)
|
||||||
- :ref:`adafruit_feather_m0_basic_proto` (Adafruit UF2 bootloader)
|
- :zephyr:board:`adafruit_feather_m0_basic_proto` (Adafruit UF2 bootloader)
|
||||||
- :ref:`arduino_nano_33_iot` (Arduino bootloader)
|
- :ref:`arduino_nano_33_iot` (Arduino bootloader)
|
||||||
- :ref:`arduino_nano_33_ble` (Arduino legacy bootloader)
|
- :ref:`arduino_nano_33_ble` (Arduino legacy bootloader)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ See existing overlays for examples.
|
||||||
The build system uses these overlays by default when targeting those boards, so
|
The build system uses these overlays by default when targeting those boards, so
|
||||||
no ``DTC_OVERLAY_FILE`` setting is needed when building and running.
|
no ``DTC_OVERLAY_FILE`` setting is needed when building and running.
|
||||||
|
|
||||||
For example, to build for the :ref:`adafruit_feather_m0_basic_proto` using the
|
For example, to build for the :zephyr:board:`adafruit_feather_m0_basic_proto` using the
|
||||||
:zephyr_file:`samples/sensor/bme280/boards/adafruit_feather_m0_basic_proto.overlay`
|
:zephyr_file:`samples/sensor/bme280/boards/adafruit_feather_m0_basic_proto.overlay`
|
||||||
overlay provided with this sample:
|
overlay provided with this sample:
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue