Skip to content

Commit

Permalink
Add basic docs for the docker container
Browse files Browse the repository at this point in the history
  • Loading branch information
felipejfc committed Jul 15, 2024
1 parent 7645fbb commit 3f0e6c7
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/using_zigbee_home_container.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 3f0e6c7

Please sign in to comment.