zephyr/samples/net/wpan_serial/README.rst
Gerson Fernando Budke e393a26270 samples: wpan_serial: Update doc with build instructions
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>
2020-01-18 12:28:24 +02:00

87 lines
2.5 KiB
ReStructuredText

.. _wpan_serial-sample:
802.15.4 "serial-radio" sample
##############################
Overview
********
The wpan_serial sample shows how to use hardware with 802.15.4 radio and USB
controller as a "serial-radio" device for Contiki-based border routers.
Requirements
************
The sample assumes that 802.15.4 radio and USB controller are supported on
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
********************
#. Before building and running this sample, be sure your Linux system's
ModemManager is disabled, otherwise, it can interfere with serial
port communication:
.. code-block:: console
$ sudo systemctl disable ModemManager.service
#. 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:
.. code-block:: console
$ cd examples/ipv6/native-border-router
$ make
$ sudo ./border-router.native -v5 -s ttyACM0 fd01::1/64
Now you have a Contiki native board router. You can access its web-based
interface with your browser using the server address printed in the
border-router output.
.. code-block:: console
...
Server IPv6 addresses:
0x62c5c0: =>fd01::212:4b00:531f:113a
...
Use your browser to access ``http://[fd01::212:4b00:531f:113a]/`` and you'll
see available neighbors and routes.