From 3f0e6c7f0d29bf96729f78d48f4a3cb32ff94694 Mon Sep 17 00:00:00 2001 From: Felipe Cavalcanti Date: Mon, 15 Jul 2024 15:39:30 -0300 Subject: [PATCH] Add basic docs for the docker container --- docs/using_zigbee_home_container.md | 39 +++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/using_zigbee_home_container.md diff --git a/docs/using_zigbee_home_container.md b/docs/using_zigbee_home_container.md new file mode 100644 index 0000000..9cf4313 --- /dev/null +++ b/docs/using_zigbee_home_container.md @@ -0,0 +1,39 @@ +# Using Zigbee Home Container + +## Building the Docker Image + +To build the Docker image, use the following command: +```sh +docker buildx build -t ncs-builder . +``` + +### For Mac M1 Users + +If you are using a Mac with an M1 chip, use this command to build the image for the appropriate platform: +```sh +docker buildx build --platform=linux/amd64 -t ncs-builder . +``` + +### Custom Toolchain or Zigbee Home Versions + +If you need to specify custom toolchain or Zigbee Home versions, use the following command: +```sh +docker buildx build --platform=linux/amd64 --build-arg toolchain_version=v2.6.1 --build-arg sdk_nrf_branch=v2.6.1 -t ncs-builder:v2.6.1 --build-arg zigbee_home_version=develop . +``` + +## Building an Example Using the Docker Image + +1. Navigate to the examples folder: + ```sh + cd examples + ``` + +2. Run the Docker container: + ```sh + docker run --rm -v .:/workdir/examples -ti --platform linux/amd64 ncs-builder + ``` + +3. The container will start an interactive shell. Use it to navigate to the desired example and then run: + ```sh + zigbee_home firmware build + ```