samples: wpan_serial: Update README

Update README and reformat it to rst.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2018-07-17 14:41:18 +03:00 committed by Anas Nashif
commit f4f9dc6005
2 changed files with 53 additions and 28 deletions

View file

@ -1,28 +0,0 @@
Application implementing 802.15.4 "serial-radio" protocol.
How to use:
1. Build and flash Zephyr application to Quark board with 802.15.4 radio,
at the moment CC2520 radio is supported.
2. Connect board to Linux PC, /dev/ttyACM[number] should appear
3. Run Contiki-based native border router (6lbr, native-router, etc)
Example for Contiki:
$ cd examples/ipv6/native-border-router
$ make
$ sudo ./border-router.native -v5 -s ttyACM0 fd01::1/64
Now you have Contiki native border router, simple web server should show some
802.15.4 devices. Web server address is printed in the border-router output
screen:
...
Server IPv6 addresses:
0x62c5c0: =>fd01::212:4b00:531f:113a
...
Go to http://[fd01::212:4b00:531f:113a]/
It shall show you Neighbors and Routes.
PS: Make sure your disto ModemManager is disabled, otherwise it sends AT commands
to our device ;)
$ sudo systemctl disable ModemManager.service

View file

@ -0,0 +1,53 @@
.. _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.
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 and flash the sample Zephyr application to a board
with a 802.15.4 radio and USB controller
#. 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.