Add build docs for Fabric-Admin and Fabric-Bridge-App (#34122)
* 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>
diff --git a/docs/examples/index.md b/docs/examples/index.md
index 6e7a0b4..446c94f 100644
--- a/docs/examples/index.md
+++ b/docs/examples/index.md
@@ -85,6 +85,15 @@
energy-management-app/**/README
```
+## Fabric Admin example
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+fabric-admin/README
+```
+
## Fabric Bridge example
```{toctree}
diff --git a/examples/fabric-admin/README.md b/examples/fabric-admin/README.md
new file mode 100644
index 0000000..da2a4d6
--- /dev/null
+++ b/examples/fabric-admin/README.md
@@ -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
+```
diff --git a/examples/fabric-bridge-app/linux/README.md b/examples/fabric-bridge-app/linux/README.md
index 212f696..6d830cd 100644
--- a/examples/fabric-bridge-app/linux/README.md
+++ b/examples/fabric-bridge-app/linux/README.md
@@ -88,12 +88,45 @@
- 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:
@@ -116,4 +149,4 @@
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.