From 55c7723d065977ba116fff4013bd1e088dec2e4e Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Sat, 5 Feb 2022 20:36:03 -0500 Subject: [PATCH 01/10] Add docker build instructions --- src/nrf52840/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index cf8a3043..59af9d4a 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -60,6 +60,28 @@ After a successful build, the `elf` files can be found in ` $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ``` +### Alternative build using Docker + +Alternatively, it's possible to build using a Docker image. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for the nRF52840 dongle: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52840 USB_trans -DOT_BOOTLOADER=USB -DOT_THREAD_VERSION=1.2 +``` + +Then `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + ### USB CDC ACM support You can build the libraries with support for the native USB CDC ACM as a serial transport. To do so, build the firmware with the following parameter: From cd94f25dd0d9820080cd083f76516e24d1af7d22 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:16:16 -0500 Subject: [PATCH 02/10] Change docker build title Co-authored-by: Wille Backman --- src/nrf52840/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index 59af9d4a..135b1079 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -60,7 +60,7 @@ After a successful build, the `elf` files can be found in ` $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ``` -### Alternative build using Docker +### Building using Docker Alternatively, it's possible to build using a Docker image. From c1742cb0e3147532d2b44b4ac7e36fe77bfbb8a5 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:25:15 -0500 Subject: [PATCH 03/10] Use a more precise description Co-authored-by: Wille Backman --- src/nrf52840/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index 135b1079..fbb947aa 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -62,7 +62,7 @@ $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ### Building using Docker -Alternatively, it's possible to build using a Docker image. +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. This can be useful in case of CI/CD builds or to build locally without installing the dependencies. From 1218cb4b5a25e8dd8bbfe22f44aba1dd6232c81b Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:25:54 -0500 Subject: [PATCH 04/10] Match the normal build's wording Co-authored-by: Wille Backman --- src/nrf52840/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index fbb947aa..b4ba7fbd 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -73,7 +73,7 @@ cd docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52840 USB_trans -DOT_BOOTLOADER=USB -DOT_THREAD_VERSION=1.2 ``` -Then `elf` files can be converted through the same container image. +After a successful build, the `elf` files can be converted through the same container image. For example: From c83baab00340ab4d4f1a752c832c441f606fb5a5 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:40:58 -0500 Subject: [PATCH 05/10] Link to Nordic's docker build guide --- src/nrf52840/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index b4ba7fbd..66276433 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -82,6 +82,9 @@ cd docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex ``` +General instructions on using this Docker image to build an nRF Connect SDK based application can be found through this link: +https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### USB CDC ACM support You can build the libraries with support for the native USB CDC ACM as a serial transport. To do so, build the firmware with the following parameter: From 0b678ce71e612682265bd135540a7979a9728bc5 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:50:27 -0500 Subject: [PATCH 06/10] Change how the NCS link is provided Co-authored-by: Wille Backman --- src/nrf52840/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index 66276433..5357a8ae 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -82,7 +82,9 @@ cd docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex ``` -General instructions on using this Docker image to build an nRF Connect SDK based application can be found through this link: +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker ### USB CDC ACM support From 44361565cb3355c0eeb431affb3515c991e5a3e0 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 08:54:20 -0500 Subject: [PATCH 07/10] Remove link duplicate Co-authored-by: Wille Backman --- src/nrf52840/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index 5357a8ae..0ec6ac79 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -85,7 +85,6 @@ docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw- See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. [build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker -https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker ### USB CDC ACM support From 50ac2a231cfb07f65a0685ec4a3ab36343aff745 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 09:17:43 -0500 Subject: [PATCH 08/10] Add docker build instructions to nrf52811 and nrf52833 --- src/nrf52811/README.md | 26 ++++++++++++++++++++++++++ src/nrf52833/README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) diff --git a/src/nrf52811/README.md b/src/nrf52811/README.md index ab5d2bbe..a3ed352b 100644 --- a/src/nrf52811/README.md +++ b/src/nrf52811/README.md @@ -100,6 +100,32 @@ The default SPI Slave pin configuration for nRF52811 is defined in `examples/pla [spi-hdlc-adapter]: https://github.com/openthread/openthread/tree/main/tools/spi-hdlc-adapter +### Building using Docker + +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for building the firmware with UART support: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52811 USB_trans -DOT_THREAD_VERSION=1.2 +``` + +After a successful build, the `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### IEEE EUI-64 address When the Thread device is configured to obtain the Thread Network security credentials with either Thread Commissioning or an out-of-band method, the extended MAC address should be constructed out of the globally unique IEEE EUI-64. diff --git a/src/nrf52833/README.md b/src/nrf52833/README.md index f9ddf0c4..7e8013e4 100644 --- a/src/nrf52833/README.md +++ b/src/nrf52833/README.md @@ -55,6 +55,32 @@ After a successful build, the `elf` files can be found in ` $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ``` +### Building using Docker + +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for building the firmware with UART support: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52833 USB_trans -DOT_THREAD_VERSION=1.2 +``` + +After a successful build, the `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### USB CDC ACM support You can build the libraries with support for the native USB CDC ACM as a serial transport. To do so, build the firmware with the following parameter: From c84e4957e3452478b34f3be267831b6cb42fbb9a Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 09:33:13 -0500 Subject: [PATCH 09/10] Change incorrect build target Co-authored-by: Eduardo Montoya --- src/nrf52811/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nrf52811/README.md b/src/nrf52811/README.md index a3ed352b..4e33a941 100644 --- a/src/nrf52811/README.md +++ b/src/nrf52811/README.md @@ -110,7 +110,7 @@ Example for building the firmware with UART support: ```bash cd -docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52811 USB_trans -DOT_THREAD_VERSION=1.2 +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52811 UART_trans -DOT_THREAD_VERSION=1.2 ``` After a successful build, the `elf` files can be converted through the same container image. From 12504c1a126999790f21c77a319792a838bc2e88 Mon Sep 17 00:00:00 2001 From: Francois Gervais Date: Wed, 9 Feb 2022 09:35:20 -0500 Subject: [PATCH 10/10] Change text to match command --- src/nrf52833/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nrf52833/README.md b/src/nrf52833/README.md index 7e8013e4..0b275cf6 100644 --- a/src/nrf52833/README.md +++ b/src/nrf52833/README.md @@ -61,7 +61,7 @@ Alternatively, you can build using a Docker image instead of nRF Command Line To This can be useful in case of CI/CD builds or to build locally without installing the dependencies. -Example for building the firmware with UART support: +Example for building the firmware with USB CDC ACM support: ```bash cd