From 3d7f194de074ff383021c98c56e9a531765dbc6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Duda?= Date: Tue, 14 Mar 2017 19:13:11 +0100 Subject: [PATCH] Update nRF52840 platform's README.md (#1461) --- examples/platforms/nrf52840/README.md | 32 ++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/examples/platforms/nrf52840/README.md b/examples/platforms/nrf52840/README.md index aa736dd83..712b8e368 100644 --- a/examples/platforms/nrf52840/README.md +++ b/examples/platforms/nrf52840/README.md @@ -4,6 +4,10 @@ This directory contains example platform drivers for [Nordic Semiconductor nRF52 [nRF52840]: https://www.nordicsemi.com/eng/Products/nRF52840 +To facilitate Thread products development with the nRF52840 platform, Nordic Semiconductor provides nRF5 SDK for Thread. See [Nordic Semiconductor's nRF5 SDK for Thread][nRF5-SDK-section] section for more details. + +[nRF5-SDK-section]: #nordic-semiconductors-nrf5-sdk-for-thread + ## Toolchain Download and install [GNU toolchain for ARM Cortex-M][gnu-toolchain]. @@ -48,7 +52,7 @@ $ nrfjprog -f nrf52 -r - No parity - HW flow control: RTS/CTS - On Linux system a port name should be called e.g. `/dev/ttyACM0` and `/dev/ttyACM1`. + On Linux system a port name should be called e.g. `/dev/ttyACM0` or `/dev/ttyACM1`. 3. Open a terminal connection on the first board and start a new Thread network. ```bash @@ -122,7 +126,7 @@ The intended log level can be set using `OPENTHREAD_CONFIG_LOG_LEVEL` define. ## Radio driver documentation The radio driver comes with documentation that describes the operation of state -machines in this the module. To open the `*.uml` sequence diagrams, use [PlantUML][PlantUML-url]. +machines in this module. To open the `*.uml` sequence diagrams, use [PlantUML][PlantUML-url]. [PlantUML-url]: http://plantuml.com/ @@ -132,4 +136,26 @@ The following toolchains have been used for testing and verification: - gcc version 4.9.3 - gcc version 6.2.0 -The nRF52840 example has been verified by Nordic Semiconductor with commit `50db58d`. +The nRF52840 example has been verified by Nordic Semiconductor with following commits: + - `de48acf` - 02.03.2017 (the newest checked) + - `50db58d` - 23.01.2017 + +# Nordic Semiconductor's nRF5 SDK for Thread + +The [nRF5 Software Development Kit (SDK) for Thread][nRF5-SDK-Thread] helps you when developing Thread products with Nordic Semiconductor's advanced nRF52840 System on Chip (SoC). + +The nRF5 SDK for Thread includes: + - a pre-built OpenThread stack for the Nordic nRF52840 SoC with ARM® CryptoCell-310 support, + - unique support for DFU-over-Thread (Device Firmware Upgrade), + - examples to demonstrate interactions between nodes performing different Thread roles with the use of OpenThread and built-in CoAP protocol, + - support for an OpenThread Network Co-Processor (NCP), + - Border Router and cloud connectivity example, + - Thread native commissioning with NFC example, + - range of PC tools including a Thread Topology Monitor, + - software modules inherited from the nRF5 SDK e.g. peripheral drivers, NFC libraries etc. + +#### Important notice + +Due to legal restrictions support for hardware-accelerated cryptography utilizing ARM CryptoCell-310 is only available in mbedTLS library (libmbedcrypto.a) provided with the nRF5 SDK for Thread. The library available in OpenThread repository does not support hardware acceleration. You can still use it, but the commissioning procedure takes much more time in such case. For the best performance and user experience, use the library provided with the SDK. + +[nRF5-SDK-Thread]: http://www.nordicsemi.com/eng/Products/nRF5-SDK-for-Thread