michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: wpan_serial: Update doc with build instructions

Browse source 
This add details how build and flash the application. This diferentiate
between SoC and transceivers to help understand what user need to do to
build and flash successfully.

Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
This commit is contained in:
Gerson Fernando Budke 2019-12-21 21:25:32 -03:00 • committed by Jukka Rissanen
commit e393a26270
1 changed files with 36 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

39
samples/net/wpan_serial/README.rst
View file

@ -13,7 +13,9 @@ Requirements
************
The sample assumes that 802.15.4 radio and USB controller are supported on
a board.
a board. You can pick, for example, a transceiver such as a CC2520 or RF2xx
using overlays, or by using an SoC with a built-in radio, such as a kw41z,
nrf5, or samr21.
Building and Running
********************
@ -26,8 +28,39 @@ Building and Running
$ sudo systemctl disable ModemManager.service
#. Build and flash the sample Zephyr application to a board
with a 802.15.4 radio and USB controller
#. Build the sample Zephyr application to a board with a 802.15.4 radio
and USB controller. There are configuration files for various setups
in the ``samples/net/wpan_serial`` directory:
- :file:`prj.conf`
This is the standard default config. This can be used by itself for
hardware which has native 802.15.4 support.
- :file:`overlay-cc2520.conf`
This overlay enables support for CC2520 transceiver
- :file:`overlay-rf2xx.conf`
This overlay enables support for RF2XX transceiver
To build the wpan_serial sample:
.. zephyr-app-commands::
:zephyr-app: samples/net/wpan_serial
:board: <board name>
:conf: "prj.conf [overlay-<RADIO>.conf]"
:goals: build
:compact:
Here's how to build and flash the sample for the Atmel SAM R21
Xplained Pro Development Kit. Note that for this SoC, you don't
need to include ``overlay-rf2xx.conf``.
.. zephyr-app-commands::
:zephyr-app: samples/net/wpan_serial
:board: atsamr21_xpro
:goals: build flash
:compact:
#. Connect board to Linux PC, /dev/ttyACM[number] should appear.
#. Run Contiki-based native border router (6lbr, native-router, etc)
Example for Contiki: