Skip to content

Commit

Permalink
Add build docs for Fabric-Admin and Fabric-Bridge-App (#34122)
Browse files Browse the repository at this point in the history
* Add build doc for Fabric-Admin and Fabric-Bridge-App

* Update examples/fabric-admin/README.md

Co-authored-by: saurabhst <s.kumar9@samsung.com>

---------

Co-authored-by: saurabhst <s.kumar9@samsung.com>
Co-authored-by: Andrei Litvin <andy314@gmail.com>
  • Loading branch information
3 people authored and pull[bot] committed Oct 15, 2024
1 parent fad3b29 commit 1459232
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 7 deletions.
9 changes: 9 additions & 0 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ darwin-framework-tool/README
energy-management-app/**/README
```

## Fabric Admin example

```{toctree}
:glob:
:maxdepth: 1
fabric-admin/README
```

## Fabric Bridge example

```{toctree}
Expand Down
53 changes: 53 additions & 0 deletions examples/fabric-admin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Matter Fabric Administrator Example

An example application that supports synchronization of devices across fabrics
fabrics.

---

- [Building the Example Application](#building-the-example-application)

---

## Building the Example Application

For Linux host example:

```
./scripts/examples/gn_build_example.sh examples/fabric-admin out/debug/standalone chip_config_network_layer_ble=false 'import("//with_pw_rpc.gni")'
```

For Raspberry Pi 4 example:

### Pull Docker Images

```
docker pull connectedhomeip/chip-build-vscode:latest
```

### Run docker

```
docker run -it -v ~/connectedhomeip:/var/connectedhomeip connectedhomeip/chip-build-vscode:latest /bin/bash
```

### Build

```
cd /var/connectedhomeip
git config --global --add safe.directory /var/connectedhomeip
git config --global --add safe.directory /var/connectedhomeip/third_party/pigweed/repo
git config --global --add safe.directory /var/connectedhomeip/examples/common/QRCode/repo
./scripts/run_in_build_env.sh \
"./scripts/build/build_examples.py \
--target linux-arm64-fabric-admin-clang-rpc \
build"
```

### Transfer the fabric-admin binary to a Raspberry Pi

```
scp ./fabric-admin ubuntu@xxx.xxx.xxx.xxx:/home/ubuntu
```
47 changes: 40 additions & 7 deletions examples/fabric-bridge-app/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,45 @@ defined:

- Build the example application:

```sh
cd ~/connectedhomeip/examples/fabric-bridge-app/linux
git submodule update --init
source third_party/connectedhomeip/scripts/activate.sh
gn gen out/debug
ninja -C out/debug
### For Linux host example:

```
./scripts/examples/gn_build_example.sh examples/fabric-bridge-app/linux out/debug/standalone chip_config_network_layer_ble=false 'import("//with_pw_rpc.gni")'
```

### For Raspberry Pi 4 example:

Pull Docker Images

```
docker pull connectedhomeip/chip-build-vscode:latest
```

Run docker

```
docker run -it -v ~/connectedhomeip:/var/connectedhomeip connectedhomeip/chip-build-vscode:latest /bin/bash
```

Build

```
cd /var/connectedhomeip

git config --global --add safe.directory /var/connectedhomeip
git config --global --add safe.directory /var/connectedhomeip/third_party/pigweed/repo
git config --global --add safe.directory /var/connectedhomeip/examples/common/QRCode/repo

./scripts/run_in_build_env.sh \
"./scripts/build/build_examples.py \
--target linux-arm64-fabric-bridge-no-ble-clang-rpc \
build"
```

Transfer the fabric-bridge-app binary to a Raspberry Pi

```
scp ./fabric-bridge-app ubuntu@xxx.xxx.xxx.xxx:/home/ubuntu
```

- To delete generated executable, libraries and object files use:
Expand All @@ -116,4 +149,4 @@ defined:
sudo out/debug/fabric-bridge-app
```

- Test the device using ChipDeviceController on your laptop / workstation etc.
- Test the device using FabricAdmin on your laptop / workstation etc.

0 comments on commit 1459232

Please sign in to comment.