samples: fully migrate basic samples to the new Sphinx extension
- Updated basic samples READMEs to use the new zephyr:code-sample:: directive. Dropped "-sample" suffix that's not required anymore now that samples have their own namespace. - Updated all references to the samples to use the :zephyr:code-sample: role. Checked and updated the wording of said references to account for the fact that samples should not have "... sample" in their name anymore. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
parent
9d0deabba2
commit
59e4c5aed0
131 changed files with 214 additions and 209 deletions
|
@ -107,7 +107,7 @@ The supported toolchains are listed in ``toolchain:`` array in ``.yaml`` file, w
|
||||||
particular toolchain.
|
particular toolchain.
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in
|
Use this configuration to run basic Zephyr applications and kernel tests in
|
||||||
nSIM, for example, with the :ref:`synchronization_sample`:
|
nSIM, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -67,7 +67,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
||||||
emulated environment, for example, with the :ref:`synchronization_sample`
|
emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample
|
||||||
(note you may use ``qemu_arc_em``, ``qemu_arc_hs``, ``qemu_arc_hs5x`` or
|
(note you may use ``qemu_arc_em``, ``qemu_arc_hs``, ``qemu_arc_hs5x`` or
|
||||||
``qemu_arc_hs6x`` depending on target CPU):
|
``qemu_arc_hs6x`` depending on target CPU):
|
||||||
|
|
||||||
|
|
|
@ -113,7 +113,7 @@ Flashing
|
||||||
Flashing Zephyr onto the ``adafruit_feather_nrf52480`` board requires
|
Flashing Zephyr onto the ``adafruit_feather_nrf52480`` board requires
|
||||||
an external programmer. The programmer is attached to the SWD header.
|
an external programmer. The programmer is attached to the SWD header.
|
||||||
|
|
||||||
Build the Zephyr kernel and the :ref:`blinky-sample` sample application.
|
Build the Zephyr kernel and the :zephyr:code-sample:`blinky` sample application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -100,7 +100,7 @@ of the built in DFU-Util bootloader is possible by following the
|
||||||
Flashing
|
Flashing
|
||||||
========
|
========
|
||||||
|
|
||||||
#. Build the Zephyr kernel and the :ref:`blinky-sample` sample application:
|
#. Build the Zephyr kernel and the :zephyr:code-sample:`blinky` sample application:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -119,8 +119,8 @@ or the :ref:`cdc-acm-console` sample applications to see how this works.
|
||||||
|
|
||||||
Testing LEDs and buttons on the Adafruit ItsyBitsy nRF52840 Express
|
Testing LEDs and buttons on the Adafruit ItsyBitsy nRF52840 Express
|
||||||
*******************************************************************
|
*******************************************************************
|
||||||
The :ref:`button-sample` sample lets you test the buttons (switches) and the red LED.
|
The :zephyr:code-sample:`button` sample lets you test the buttons (switches) and the red LED.
|
||||||
The :ref:`blinky-sample` sample lets you test the red LED.
|
The :zephyr:code-sample:`blinky` sample lets you test the red LED.
|
||||||
|
|
||||||
The DotStar LED has been implemented as a SPI device and can be tested
|
The DotStar LED has been implemented as a SPI device and can be tested
|
||||||
with the :ref:`led_apa102_sample` sample application.
|
with the :ref:`led_apa102_sample` sample application.
|
||||||
|
@ -151,7 +151,7 @@ Flashing
|
||||||
Flashing is done by dragging and dropping the built Zephyr UF2-file
|
Flashing is done by dragging and dropping the built Zephyr UF2-file
|
||||||
into the :code:`ITSY840BOOT` drive.
|
into the :code:`ITSY840BOOT` drive.
|
||||||
|
|
||||||
#. Build the Zephyr kernel and the :ref:`blinky-sample`
|
#. Build the Zephyr kernel and the :zephyr:code-sample:`blinky`
|
||||||
sample application:
|
sample application:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
|
|
|
@ -151,7 +151,7 @@ You should see the following message on the console:
|
||||||
|
|
||||||
Similarly, you can build and flash samples on the M4 target.
|
Similarly, you can build and flash samples on the M4 target.
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application on M4 core.
|
Here is an example for the :zephyr:code-sample:`blinky` application on M4 core.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -121,7 +121,7 @@ You should see the following message on the console:
|
||||||
Similarly, you can build and flash samples on the M4 target. For this, please
|
Similarly, you can build and flash samples on the M4 target. For this, please
|
||||||
take care of the resource sharing (UART port used for console for instance).
|
take care of the resource sharing (UART port used for console for instance).
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application on M4 core.
|
Here is an example for the :zephyr:code-sample:`blinky` application on M4 core.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -120,7 +120,7 @@ The B-G474E-DPOW1 Discovery board includes an ST-LINK/V3E embedded debug tool in
|
||||||
Flashing an application to the B_G474E_DPOW1
|
Flashing an application to the B_G474E_DPOW1
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -327,7 +327,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Default flasher for this board is openocd. It could be used in the usual way.
|
Default flasher for this board is openocd. It could be used in the usual way.
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -255,8 +255,8 @@ Testing the LEDs and buttons in the BL652 DVK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -162,8 +162,8 @@ Testing the LEDs and buttons on the BL653 DVK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -168,8 +168,8 @@ Testing the LEDs and buttons on the BL654 DVK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -233,8 +233,8 @@ Testing the LED and button on the BL654 Sensor Board
|
||||||
There are 2 samples that allow you to test that the button (switch) and LED on
|
There are 2 samples that allow you to test that the button (switch) and LED on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -130,7 +130,7 @@ before proceeding. These instructions were tested with version 6.1.0.
|
||||||
The blue LED should start a fade pattern, signalling the bootloader is
|
The blue LED should start a fade pattern, signalling the bootloader is
|
||||||
running.
|
running.
|
||||||
|
|
||||||
#. Compile a Zephyr application; we'll use :ref:`blinky <blinky-sample>`.
|
#. Compile a Zephyr application; we'll use :zephyr:code-sample:`blinky`.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:app: zephyr/samples/basic/blinky
|
:app: zephyr/samples/basic/blinky
|
||||||
|
@ -171,7 +171,7 @@ Testing the LED on the BL654 USB
|
||||||
There is a sample that allows you to test that the LED on
|
There is a sample that allows you to test that the LED on
|
||||||
the board is working properly with Zephyr:
|
the board is working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
|
|
||||||
You can build and flash the example to make sure Zephyr is running correctly on
|
You can build and flash the example to make sure Zephyr is running correctly on
|
||||||
your board. The LED definitions can be found in
|
your board. The LED definitions can be found in
|
||||||
|
|
|
@ -202,7 +202,7 @@ This interface is supported by the openocd version included in Zephyr SDK.
|
||||||
Flashing an application to BLACK_F407VE
|
Flashing an application to BLACK_F407VE
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
Run a serial host program to connect with your board:
|
Run a serial host program to connect with your board:
|
||||||
|
|
||||||
|
|
|
@ -184,7 +184,7 @@ This interface is supported by the openocd version included in Zephyr SDK.
|
||||||
Flashing an application to BLACK_F407ZG_PRO
|
Flashing an application to BLACK_F407ZG_PRO
|
||||||
-------------------------------------------
|
-------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
Run a serial host program to connect with your board:
|
Run a serial host program to connect with your board:
|
||||||
|
|
||||||
|
|
|
@ -239,8 +239,8 @@ Testing the LEDs and buttons on the BT510
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button, LED and sensor device definitions can be found in
|
your board. The button, LED and sensor device definitions can be found in
|
||||||
|
|
|
@ -593,8 +593,8 @@ Testing the LEDs and buttons on the BT610
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs
|
||||||
on the board are working properly with Zephyr:
|
on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly
|
You can build and flash the examples to make sure Zephyr is running correctly
|
||||||
on your board. The button, LED and sensor device definitions can be found in
|
on your board. The button, LED and sensor device definitions can be found in
|
||||||
|
|
|
@ -142,8 +142,8 @@ Testing the LEDs and buttons on the nRF9160 Feather
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -190,7 +190,7 @@ Cy_WDT_Disable().
|
||||||
Running on Dual Core
|
Running on Dual Core
|
||||||
********************
|
********************
|
||||||
|
|
||||||
#. Build the Zephyr kernel and the :ref:`button-sample` sample application:
|
#. Build the Zephyr kernel and the :zephyr:code-sample:`button` sample application:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/button
|
:zephyr-app: samples/basic/button
|
||||||
|
|
|
@ -101,7 +101,7 @@ To fetch Binary Blobs:
|
||||||
Build blinking led sample
|
Build blinking led sample
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -206,8 +206,8 @@ the board are working properly with Zephyr:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
:ref:`blinky-sample`
|
:zephyr:code-sample:`blinky`
|
||||||
:ref:`button-sample`
|
:zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -77,7 +77,7 @@ Programming
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Use this configuration to build basic Zephyr applications and kernel tests in the
|
Use this configuration to build basic Zephyr applications and kernel tests in the
|
||||||
Arm FVP emulated environment, for example, with the :ref:`synchronization_sample`:
|
Arm FVP emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -109,7 +109,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
|
||||||
applications as usual (see :ref:`build_an_application` and
|
applications as usual (see :ref:`build_an_application` and
|
||||||
:ref:`application_run` for more details).
|
:ref:`application_run` for more details).
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -118,7 +118,7 @@ The default flasher is ``jlink`` using the built-in SEGGER Jlink interface.
|
||||||
Flashing
|
Flashing
|
||||||
========
|
========
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -130,7 +130,7 @@ Red LED0 should blink at 1 second delay.
|
||||||
Debugging
|
Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -263,7 +263,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -199,10 +199,10 @@ Testing the LEDs and buttons in the nRF51 DK
|
||||||
There are samples below that allow you to test that the buttons (switches) and LEDs on
|
There are samples below that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
- :ref:`blinky-sample`
|
- :zephyr:code-sample:`blinky`
|
||||||
- :ref:`button-sample`
|
- :zephyr:code-sample:`button`
|
||||||
- :ref:`fade-led-sample`
|
- :zephyr:code-sample:`fade-led`
|
||||||
- :ref:`96b_carbon_multi_thread_blinky`
|
- :zephyr:code-sample:`multi-thread-blinky`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -106,7 +106,7 @@ The VBLUno51 board has on-board DAPLink (CMSIS-DAP) interface for flashing and d
|
||||||
You do not need any other programming device.
|
You do not need any other programming device.
|
||||||
You only need to install pyOCD tool (https://pypi.python.org/pypi/pyOCD)
|
You only need to install pyOCD tool (https://pypi.python.org/pypi/pyOCD)
|
||||||
|
|
||||||
This tutorial uses the blinky application :ref:`blinky-sample`.
|
This tutorial uses the blinky application :zephyr:code-sample:`blinky`.
|
||||||
|
|
||||||
See the :ref:`getting_started` for general information on setting up
|
See the :ref:`getting_started` for general information on setting up
|
||||||
your development environment. Then build and flash the application in
|
your development environment. Then build and flash the application in
|
||||||
|
@ -121,7 +121,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -136,8 +136,8 @@ Testing the VBLUno51 with Zephyr: buttons, LEDs, UART, BLE
|
||||||
components on the VBLUno51 board:
|
components on the VBLUno51 board:
|
||||||
|
|
||||||
* :ref:`hello_world`
|
* :ref:`hello_world`
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
* :ref:`bluetooth-beacon-sample`
|
* :ref:`bluetooth-beacon-sample`
|
||||||
* :ref:`peripheral_hr`
|
* :ref:`peripheral_hr`
|
||||||
|
|
||||||
|
|
|
@ -132,7 +132,7 @@ Segger IC.
|
||||||
Testing the LEDs on the nRF51 Dongle
|
Testing the LEDs on the nRF51 Dongle
|
||||||
************************************
|
************************************
|
||||||
|
|
||||||
Build and flash the :ref:`blinky-sample` sample to test that the onboard LED
|
Build and flash the :zephyr:code-sample:`blinky` sample to test that the onboard LED
|
||||||
is working properly with Zephyr.
|
is working properly with Zephyr.
|
||||||
|
|
||||||
References
|
References
|
||||||
|
|
|
@ -150,8 +150,8 @@ Testing the LEDs and buttons in the nRF52833 DK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -175,8 +175,8 @@ Testing the LEDs and buttons in the nRF52840 PDK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -140,7 +140,7 @@ device. Make sure ``nrfutil`` is installed before proceeding.
|
||||||
The red LED should start a fade pattern, signalling the bootloader is
|
The red LED should start a fade pattern, signalling the bootloader is
|
||||||
running.
|
running.
|
||||||
|
|
||||||
#. Compile a Zephyr application; we'll use :ref:`blinky <blinky-sample>`.
|
#. Compile a Zephyr application; we'll use :zephyr:code-sample:`blinky`.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:app: zephyr/samples/basic/blinky
|
:app: zephyr/samples/basic/blinky
|
||||||
|
@ -298,7 +298,7 @@ flashed with an offset.
|
||||||
Then build and flash applications as usual (see :ref:`build_an_application` and
|
Then build and flash applications as usual (see :ref:`build_an_application` and
|
||||||
:ref:`application_run` for more details).
|
:ref:`application_run` for more details).
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -321,7 +321,7 @@ Testing the LEDs and buttons on the nRF52840 Dongle
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
|
|
||||||
You can build and program the examples to make sure Zephyr is running correctly
|
You can build and program the examples to make sure Zephyr is running correctly
|
||||||
on your board.
|
on your board.
|
||||||
|
|
|
@ -166,11 +166,11 @@ Testing the LEDs and buttons on the nRF52 Adafruit Feather
|
||||||
There are several samples that allow you to test that the buttons (switches) and LEDs on
|
There are several samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
- :ref:`blinky-sample`
|
- :zephyr:code-sample:`blinky`
|
||||||
- :ref:`button-sample`
|
- :zephyr:code-sample:`button`
|
||||||
- :ref:`fade-led-sample`
|
- :zephyr:code-sample:`fade-led`
|
||||||
- :ref:`pwm-blinky-sample`
|
- :zephyr:code-sample:`pwm-blinky`
|
||||||
- :ref:`96b_carbon_multi_thread_blinky`
|
- :zephyr:code-sample:`multi-thread-blinky`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -101,7 +101,7 @@ Here are some sample applications that you can use to test different
|
||||||
components on the VBLUno52 board:
|
components on the VBLUno52 board:
|
||||||
|
|
||||||
* :ref:`hello_world`
|
* :ref:`hello_world`
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
* :ref:`bluetooth-beacon-sample`
|
* :ref:`bluetooth-beacon-sample`
|
||||||
* :ref:`peripheral_hr`
|
* :ref:`peripheral_hr`
|
||||||
|
|
|
@ -310,8 +310,8 @@ Testing the LEDs and buttons in the nRF5340 DK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and
|
There are 2 samples that allow you to test that the buttons (switches) and
|
||||||
LEDs on the board are working properly with Zephyr:
|
LEDs on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -245,8 +245,8 @@ Testing the LEDs and buttons in the nRF9160 DK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -184,8 +184,8 @@ Testing the LEDs and buttons in the nRF9161 DK
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -127,7 +127,7 @@ Nucleo C031C6 board includes an ST-LINK/V2-1 embedded debug tool interface.
|
||||||
Flashing an application to Nucleo C031C6
|
Flashing an application to Nucleo C031C6
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -149,7 +149,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F030R8
|
Flashing an application to Nucleo F030R8
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -169,7 +169,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -116,7 +116,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F030R8
|
Flashing an application to Nucleo F030R8
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -129,7 +129,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -116,7 +116,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F042K6
|
Flashing an application to Nucleo F042K6
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -129,7 +129,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -144,7 +144,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F070RB
|
Flashing an application to Nucleo F070RB
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -161,7 +161,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F091RC
|
Flashing an application to Nucleo F091RC
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -151,7 +151,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F103RB
|
Flashing an application to Nucleo F103RB
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -164,7 +164,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -143,7 +143,7 @@ Flashing an application to Nucleo F334R8
|
||||||
|
|
||||||
Connect the Nucleo F334R8 to your host computer using the USB port,
|
Connect the Nucleo F334R8 to your host computer using the USB port,
|
||||||
then build and flash an application. Here is an example for the
|
then build and flash an application. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -156,7 +156,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for
|
You can debug an application in the usual way. Here is an example for
|
||||||
the :ref:`blinky-sample` application.
|
the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -123,7 +123,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo G031K8
|
Flashing an application to Nucleo G031K8
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -155,7 +155,7 @@ Nucleo G070RB board includes an ST-LINK/V2-1 embedded debug tool interface.
|
||||||
Flashing an application to Nucleo G070RB
|
Flashing an application to Nucleo G070RB
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -159,7 +159,7 @@ Nucleo G071RB board includes an ST-LINK/V3 embedded debug tool interface.
|
||||||
Flashing an application to Nucleo G071RB
|
Flashing an application to Nucleo G071RB
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -168,7 +168,7 @@ following pyocd command:
|
||||||
Flashing an application to Nucleo G0B1RE
|
Flashing an application to Nucleo G0B1RE
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -294,7 +294,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -240,7 +240,7 @@ You should see the following message on the console:
|
||||||
Similarly, you can build and flash samples on the M4 target. For this, please
|
Similarly, you can build and flash samples on the M4 target. For this, please
|
||||||
take care of the resource sharing (UART port used for console for instance).
|
take care of the resource sharing (UART port used for console for instance).
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application on M4 core.
|
Here is an example for the :zephyr:code-sample:`blinky` application on M4 core.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -131,7 +131,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo L011K4
|
Flashing an application to Nucleo L011K4
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -124,7 +124,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo L031K6
|
Flashing an application to Nucleo L031K6
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -140,7 +140,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo L053R8
|
Flashing an application to Nucleo L053R8
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -154,7 +154,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo L073RZ
|
Flashing an application to Nucleo L073RZ
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -148,7 +148,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo L152RE
|
Flashing an application to Nucleo L152RE
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -289,7 +289,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Default flasher for this board is openocd. It could be used in the usual way.
|
Default flasher for this board is openocd. It could be used in the usual way.
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -288,7 +288,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -232,7 +232,7 @@ as flashing tool by default.
|
||||||
Flashing an application to Nucleo WBA52CG
|
Flashing an application to Nucleo WBA52CG
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -307,7 +307,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -136,7 +136,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -208,7 +208,7 @@ The ``blackmagicprobe`` can also be used to program the device.
|
||||||
Flashing
|
Flashing
|
||||||
========
|
========
|
||||||
|
|
||||||
Here is an example for the :ref:`button-sample` application.
|
Here is an example for the :zephyr:code-sample:`button` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/button
|
:zephyr-app: samples/basic/button
|
||||||
|
|
|
@ -414,7 +414,7 @@ Flashing an Application to OLIMEXINO-STM32
|
||||||
|
|
||||||
To upload an application to the OLIMEXINO-STM32 board a TTL(3.3V)
|
To upload an application to the OLIMEXINO-STM32 board a TTL(3.3V)
|
||||||
serial adapter is required. This tutorial uses the
|
serial adapter is required. This tutorial uses the
|
||||||
:ref:`button-sample` sample application.
|
:zephyr:code-sample:`button` sample application.
|
||||||
|
|
||||||
#. Connect the serial cable to the UEXT lines of the UART
|
#. Connect the serial cable to the UEXT lines of the UART
|
||||||
interface (pin #3=TX and pin #4=RX).
|
interface (pin #3=TX and pin #4=RX).
|
||||||
|
|
|
@ -160,8 +160,8 @@ Testing the LEDs and buttons
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and
|
There are 2 samples that allow you to test that the buttons (switches) and
|
||||||
LEDs on the board are working properly with Zephyr:
|
LEDs on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board.
|
your board.
|
||||||
|
|
|
@ -156,8 +156,8 @@ Testing the LEDs and buttons
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and
|
There are 2 samples that allow you to test that the buttons (switches) and
|
||||||
LEDs on the board are working properly with Zephyr:
|
LEDs on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board.
|
your board.
|
||||||
|
|
|
@ -161,8 +161,8 @@ Testing the LEDs and buttons
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and
|
There are 2 samples that allow you to test that the buttons (switches) and
|
||||||
LEDs on the board are working properly with Zephyr:
|
LEDs on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board.
|
your board.
|
||||||
|
|
|
@ -64,7 +64,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
||||||
emulated environment, for example, with the :ref:`synchronization_sample`:
|
emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -70,7 +70,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
||||||
emulated environment, for example, with the :ref:`synchronization_sample`:
|
emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -64,7 +64,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in the
|
Use this configuration to run basic Zephyr applications and kernel tests in the
|
||||||
QEMU emulated environment, for example, with the :ref:`synchronization_sample`:
|
QEMU emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -544,8 +544,8 @@ Testing the LEDs and buttons
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and
|
There are 2 samples that allow you to test that the buttons (switches) and
|
||||||
LEDs on the board are working properly with Zephyr:
|
LEDs on the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board.
|
your board.
|
||||||
|
|
|
@ -152,7 +152,7 @@ Using SEGGER JLink
|
||||||
You can Flash the rpi_pico with a SEGGER JLink debug probe as described in
|
You can Flash the rpi_pico with a SEGGER JLink debug probe as described in
|
||||||
:ref:`Building, Flashing and Debugging <west-flashing>`.
|
:ref:`Building, Flashing and Debugging <west-flashing>`.
|
||||||
|
|
||||||
Here is an example of building and flashing the :ref:`blinky-sample` application.
|
Here is an example of building and flashing the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -187,7 +187,7 @@ Depending on the interface used (such as JLink), you might need to
|
||||||
checkout to a branch that supports this interface, before proceeding.
|
checkout to a branch that supports this interface, before proceeding.
|
||||||
Build and install OpenOCD as described in the README.
|
Build and install OpenOCD as described in the README.
|
||||||
|
|
||||||
Here is an example of building and flashing the :ref:`blinky-sample` application.
|
Here is an example of building and flashing the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -247,7 +247,7 @@ Using OpenOCD
|
||||||
|
|
||||||
Install OpenOCD as described for flashing the board.
|
Install OpenOCD as described for flashing the board.
|
||||||
|
|
||||||
Here is an example for debugging the :ref:`blinky-sample` application.
|
Here is an example for debugging the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -168,8 +168,8 @@ Testing the LEDs and buttons on the RuuviTag
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in :file:`boards/arm/ruuvi_ruuvitag/ruuvi_ruuvitag.dts`.
|
your board. The button and LED definitions can be found in :file:`boards/arm/ruuvi_ruuvitag/ruuvi_ruuvitag.dts`.
|
||||||
|
|
|
@ -99,7 +99,7 @@ using GPIO driver or configuring the pinmuxing for the device drivers.
|
||||||
+-------------------+-------------+
|
+-------------------+-------------+
|
||||||
|
|
||||||
This board does not include user LED's or switches, which are needed for some
|
This board does not include user LED's or switches, which are needed for some
|
||||||
of the samples such as :ref:`blinky-sample` or :ref:`button-sample`.
|
of the samples such as :zephyr:code-sample:`blinky` or :zephyr:code-sample:`button`.
|
||||||
Follow the steps described in the sample description to enable support for this
|
Follow the steps described in the sample description to enable support for this
|
||||||
board.
|
board.
|
||||||
|
|
||||||
|
|
|
@ -109,7 +109,7 @@ Flashing an application to the SEGGER-TRB-STM32F407
|
||||||
Connect the J-Trace/J-Link USB dongle to your host computer and to the JTAG
|
Connect the J-Trace/J-Link USB dongle to your host computer and to the JTAG
|
||||||
port of the SEGGER-TRB-STM32F407 board. Then build and flash an application.
|
port of the SEGGER-TRB-STM32F407 board. Then build and flash an application.
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -121,7 +121,7 @@ After resetting the board, you should see LED0 blink with a 1 second interval.
|
||||||
Debugging
|
Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -87,7 +87,7 @@ can be entered by quickly tapping the reset button twice.
|
||||||
Flashing
|
Flashing
|
||||||
========
|
========
|
||||||
|
|
||||||
#. Build the Zephyr kernel and the :ref:`blinky-sample` sample application:
|
#. Build the Zephyr kernel and the :zephyr:code-sample:`blinky` sample application:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -137,8 +137,8 @@ Testing the LEDs and buttons on the nRF9160 Thing Plus
|
||||||
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
|
||||||
the board are working properly with Zephyr:
|
the board are working properly with Zephyr:
|
||||||
|
|
||||||
* :ref:`blinky-sample`
|
* :zephyr:code-sample:`blinky`
|
||||||
* :ref:`button-sample`
|
* :zephyr:code-sample:`button`
|
||||||
|
|
||||||
You can build and flash the examples to make sure Zephyr is running correctly on
|
You can build and flash the examples to make sure Zephyr is running correctly on
|
||||||
your board. The button and LED definitions can be found in
|
your board. The button and LED definitions can be found in
|
||||||
|
|
|
@ -125,7 +125,7 @@ Flashing an application to STM3210C-EVAL
|
||||||
Connect the STM3210C-EVAL to your host computer using the USB port, then build
|
Connect the STM3210C-EVAL to your host computer using the USB port, then build
|
||||||
and flash an application in the usual way.
|
and flash an application in the usual way.
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -126,7 +126,7 @@ This interface is supported by the openocd version included in Zephyr SDK.
|
||||||
Flashing an application to STM32373C-EVAL
|
Flashing an application to STM32373C-EVAL
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -139,7 +139,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -161,7 +161,7 @@ built and flashed in the usual way (see :ref:`build_an_application` and
|
||||||
Flashing
|
Flashing
|
||||||
========
|
========
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -87,7 +87,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to STM32F030 DEMO BOARD
|
Flashing an application to STM32F030 DEMO BOARD
|
||||||
-----------------------------------------------
|
-----------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -100,7 +100,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -156,7 +156,7 @@ This interface is supported by the openocd version included in Zephyr SDK.
|
||||||
Flashing an application to STM32F072-EVAL
|
Flashing an application to STM32F072-EVAL
|
||||||
-------------------------------------------
|
-------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -169,7 +169,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -107,7 +107,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application to Nucleo F030R8
|
Flashing an application to Nucleo F030R8
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -120,7 +120,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -133,7 +133,7 @@ pattern, which can be triggered by using the BOOT0 pin.
|
||||||
Flashing an application to stm32f103 mini
|
Flashing an application to stm32f103 mini
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -146,7 +146,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -141,7 +141,7 @@ Flashing an application to STM32F411E-DISCO
|
||||||
Connect the STM32F411E-DISCO Discovery kit to your host computer using the
|
Connect the STM32F411E-DISCO Discovery kit to your host computer using the
|
||||||
USB port. Then build and flash an application.
|
USB port. Then build and flash an application.
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -162,7 +162,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug applications in the usual way. Here is an example for
|
You can debug applications in the usual way. Here is an example for
|
||||||
the :ref:`blinky-sample` application.
|
the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -169,7 +169,7 @@ This interface is supported by the openocd version included in Zephyr SDK.
|
||||||
Flashing an application to STM32F4DISCOVERY
|
Flashing an application to STM32F4DISCOVERY
|
||||||
-------------------------------------------
|
-------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
Run a serial host program to connect with your board:
|
Run a serial host program to connect with your board:
|
||||||
|
|
||||||
|
|
|
@ -100,7 +100,7 @@ the following pyocd command:
|
||||||
Flashing an application to the STM32G0316-DISCO
|
Flashing an application to the STM32G0316-DISCO
|
||||||
-----------------------------------------------
|
-----------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -130,7 +130,7 @@ The STM32G071B Discovery board includes an ST-LINK/V2-1 embedded debug tool inte
|
||||||
Flashing an application to the STM32G071B_DISCO
|
Flashing an application to the STM32G071B_DISCO
|
||||||
-----------------------------------------------
|
-----------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -168,7 +168,7 @@ The STM32G081B Evaluation board includes an ST-LINK/V2-1 embedded debug tool int
|
||||||
Flashing an application to the STM32G081B_EVAL
|
Flashing an application to the STM32G081B_EVAL
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -258,7 +258,7 @@ You should see the following message on the console:
|
||||||
Similarly, you can build and flash samples on the M4 target. For this, please
|
Similarly, you can build and flash samples on the M4 target. For this, please
|
||||||
take care of the resource sharing (UART port used for console for instance).
|
take care of the resource sharing (UART port used for console for instance).
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application on M4 core.
|
Here is an example for the :zephyr:code-sample:`blinky` application on M4 core.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -143,7 +143,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application
|
Flashing an application
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -156,7 +156,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -137,7 +137,7 @@ This interface is supported by the openocd version included in the Zephyr SDK.
|
||||||
Flashing an application
|
Flashing an application
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
Here is an example for the :ref:`blinky-sample` application.
|
Here is an example for the :zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
@ -150,7 +150,7 @@ Debugging
|
||||||
=========
|
=========
|
||||||
|
|
||||||
You can debug an application in the usual way. Here is an example for the
|
You can debug an application in the usual way. Here is an example for the
|
||||||
:ref:`blinky-sample` application.
|
:zephyr:code-sample:`blinky` application.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -362,7 +362,7 @@ debugger. A development board with a Debug out connector such as the
|
||||||
Testing board features
|
Testing board features
|
||||||
**********************
|
**********************
|
||||||
|
|
||||||
The green lightwell LED can be tested with the :ref:`blinky-sample` example.
|
The green lightwell LED can be tested with the :zephyr:code-sample:`blinky` example.
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/basic/blinky
|
:zephyr-app: samples/basic/blinky
|
||||||
|
|
|
@ -72,7 +72,7 @@ Programming
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Use this configuration to build basic Zephyr applications and kernel tests in the
|
Use this configuration to build basic Zephyr applications and kernel tests in the
|
||||||
ARM FVP emulated environment, for example, with the :ref:`synchronization_sample`:
|
ARM FVP emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -86,7 +86,7 @@ Programming
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Use this configuration to build basic Zephyr applications and kernel tests in the
|
Use this configuration to build basic Zephyr applications and kernel tests in the
|
||||||
Arm FVP emulated environment, for example, with the :ref:`synchronization_sample`:
|
Arm FVP emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -92,7 +92,7 @@ Or kick SMP zephyr.bin:
|
||||||
|
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests,
|
Use this configuration to run basic Zephyr applications and kernel tests,
|
||||||
for example, with the :ref:`synchronization_sample`:
|
for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -92,7 +92,7 @@ Or kick SMP zephyr.bin:
|
||||||
|
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests,
|
Use this configuration to run basic Zephyr applications and kernel tests,
|
||||||
for example, with the :ref:`synchronization_sample`:
|
for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -91,7 +91,7 @@ Or kick SMP zephyr.bin:
|
||||||
mw 303d0518 f 1; fatload mmc 1:1 0xc0000000 zephyr.bin; dcache flush; icache flush; dcache off; icache off; cpu 2 release 0xc0000000
|
mw 303d0518 f 1; fatload mmc 1:1 0xc0000000 zephyr.bin; dcache flush; icache flush; dcache off; icache off; cpu 2 release 0xc0000000
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests,
|
Use this configuration to run basic Zephyr applications and kernel tests,
|
||||||
for example, with the :ref:`synchronization_sample`:
|
for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -97,7 +97,7 @@ Or use the following command to kick zephyr.bin to Cortex-A55 Core0:
|
||||||
|
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests,
|
Use this configuration to run basic Zephyr applications and kernel tests,
|
||||||
for example, with the :ref:`synchronization_sample`:
|
for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
|
@ -84,7 +84,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use the following configuration to run basic Zephyr applications and
|
Use the following configuration to run basic Zephyr applications and
|
||||||
kernel tests on LS1046A RDB board. For example, with the :ref:`synchronization_sample`:
|
kernel tests on LS1046A RDB board. For example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
1. Non-SMP mode
|
1. Non-SMP mode
|
||||||
|
|
||||||
|
|
|
@ -60,7 +60,7 @@ Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
Use this configuration to run basic Zephyr applications and kernel tests in the QEMU
|
||||||
emulated environment, for example, with the :ref:`synchronization_sample`:
|
emulated environment, for example, with the :zephyr:code-sample:`synchronization` sample:
|
||||||
|
|
||||||
.. zephyr-app-commands::
|
.. zephyr-app-commands::
|
||||||
:zephyr-app: samples/synchronization
|
:zephyr-app: samples/synchronization
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue