samples: minor documentation tweaks
Change-Id: I9efe25dbc808c635d895ffe2893afb68f4088ad1 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
fc6137001b
commit
a1d7794647
|
@ -7,3 +7,31 @@ Overview
|
|||
The Blinky example shows how to configure GPIO pins as outputs which can also be
|
||||
used to drive LEDs on the hardware usually delivered as "User LEDs" on many of
|
||||
the supported boards in Zephyr.
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
The demo assumes that an LED is connected to one of GPIO lines. The
|
||||
sample code is configured to work on boards with user defined buttons and that
|
||||
have defined the LED0\_* variables in :file:`board.h`.
|
||||
|
||||
The :file:`board.h` must define the following variables:
|
||||
|
||||
- LED0_GPIO_PORT
|
||||
- LED0_GPIO_PIN
|
||||
|
||||
|
||||
Building and Running
|
||||
====================
|
||||
|
||||
This samples does not output anything to the console. It can be built and
|
||||
flashed to a board as follows:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd samples/basic/blinky
|
||||
$ make BOARD=arduino_101
|
||||
$ make BOARD=arduino_101 flash
|
||||
|
||||
After flashing the image to the board, the user LED on the board should start to
|
||||
blink.
|
||||
|
|
|
@ -41,7 +41,8 @@ for the nucleo_f103rb board:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make BOARD=nucleo_f103rb
|
||||
$ cd samples/basic/button
|
||||
$ make BOARD=nucleo_f103rb
|
||||
|
||||
|
||||
After startup, the program looks up a predefined GPIO device, and configures the
|
||||
|
|
|
@ -47,16 +47,16 @@ Modify the src/main.c file and set:
|
|||
Building and Running
|
||||
=====================
|
||||
|
||||
After startup, the program looks up a predefined GPIO device defined
|
||||
by 'PORT', and configures pins 'LED1' and 'LED2' in output mode.
|
||||
During each iteration of the main loop, the state of GPIO lines will
|
||||
be changed so that one of the lines is in high state, while the other
|
||||
is in low, thus switching the LEDs on and off in an alternating
|
||||
pattern.
|
||||
After startup, the program looks up a predefined GPIO device defined by 'PORT',
|
||||
and configures pins 'LED1' and 'LED2' in output mode. During each iteration of
|
||||
the main loop, the state of GPIO lines will be changed so that one of the lines
|
||||
is in high state, while the other is in low, thus switching the LEDs on and off
|
||||
in an alternating pattern.
|
||||
|
||||
This project does not output to the serial console, but instead
|
||||
causes two LEDs connected to the GPIO device to blink in an
|
||||
alternating pattern.
|
||||
This project does not output to the serial console, but instead causes two LEDs
|
||||
connected to the GPIO device to blink in an alternating pattern.
|
||||
|
||||
The sample can be found here: :file:`samples/basic/disco`.
|
||||
|
||||
Nucleo F103RB
|
||||
-------------
|
||||
|
@ -77,5 +77,5 @@ Arduino 101
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make pristine && make BOARD=arduino_101
|
||||
$ make pristine && make BOARD=arduino_101
|
||||
|
||||
|
|
|
@ -110,6 +110,8 @@ The sample provide a single :file:`Makefile` that builds both images, simple run
|
|||
make in the top level directory of the application and flash either using JTAG
|
||||
or using DFU. (DFU is preferred).
|
||||
|
||||
The sample can be found here: :file:`samples/environmental_sensing` in the
|
||||
Zephyr project tree.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|
|
|
@ -17,7 +17,8 @@ on QEMU as follows:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make qemu
|
||||
$ cd samples/hello_world
|
||||
$ make qemu
|
||||
|
||||
|
||||
To build the single thread version, use the supplied configuration file for
|
||||
|
@ -25,7 +26,7 @@ single thread: :file:`prj_single.conf`:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make CONF_FILE=prj_single.conf qemu
|
||||
$ make CONF_FILE=prj_single.conf qemu
|
||||
|
||||
Sample Output
|
||||
-------------
|
||||
|
|
|
@ -26,7 +26,8 @@ on QEMU as follows:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make qemu
|
||||
$ cd samples/philosophers
|
||||
$ make qemu
|
||||
|
||||
Sample Output
|
||||
-------------
|
||||
|
|
|
@ -18,7 +18,8 @@ on QEMU as follows:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
make qemu
|
||||
$ cd samples/synchronization
|
||||
$ make qemu
|
||||
|
||||
Sample Output
|
||||
-------------
|
||||
|
|
Loading…
Reference in a new issue