Skip to content

Commit fdb71dc

Browse files
yufengwangcasaurabhstandy31415
authored
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>
1 parent ea235fd commit fdb71dc

File tree

3 files changed

+102
-7
lines changed

3 files changed

+102
-7
lines changed

docs/examples/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,15 @@ darwin-framework-tool/README
8585
energy-management-app/**/README
8686
```
8787

88+
## Fabric Admin example
89+
90+
```{toctree}
91+
:glob:
92+
:maxdepth: 1
93+
94+
fabric-admin/README
95+
```
96+
8897
## Fabric Bridge example
8998

9099
```{toctree}

examples/fabric-admin/README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Matter Fabric Administrator Example
2+
3+
An example application that supports synchronization of devices across fabrics
4+
fabrics.
5+
6+
---
7+
8+
- [Building the Example Application](#building-the-example-application)
9+
10+
---
11+
12+
## Building the Example Application
13+
14+
For Linux host example:
15+
16+
```
17+
./scripts/examples/gn_build_example.sh examples/fabric-admin out/debug/standalone chip_config_network_layer_ble=false 'import("//with_pw_rpc.gni")'
18+
```
19+
20+
For Raspberry Pi 4 example:
21+
22+
### Pull Docker Images
23+
24+
```
25+
docker pull connectedhomeip/chip-build-vscode:latest
26+
```
27+
28+
### Run docker
29+
30+
```
31+
docker run -it -v ~/connectedhomeip:/var/connectedhomeip connectedhomeip/chip-build-vscode:latest /bin/bash
32+
```
33+
34+
### Build
35+
36+
```
37+
cd /var/connectedhomeip
38+
39+
git config --global --add safe.directory /var/connectedhomeip
40+
git config --global --add safe.directory /var/connectedhomeip/third_party/pigweed/repo
41+
git config --global --add safe.directory /var/connectedhomeip/examples/common/QRCode/repo
42+
43+
./scripts/run_in_build_env.sh \
44+
"./scripts/build/build_examples.py \
45+
--target linux-arm64-fabric-admin-clang-rpc \
46+
build"
47+
```
48+
49+
### Transfer the fabric-admin binary to a Raspberry Pi
50+
51+
```
52+
scp ./fabric-admin ubuntu@xxx.xxx.xxx.xxx:/home/ubuntu
53+
```

examples/fabric-bridge-app/linux/README.md

+40-7
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,45 @@ defined:
8888

8989
- Build the example application:
9090

91-
```sh
92-
cd ~/connectedhomeip/examples/fabric-bridge-app/linux
93-
git submodule update --init
94-
source third_party/connectedhomeip/scripts/activate.sh
95-
gn gen out/debug
96-
ninja -C out/debug
91+
### For Linux host example:
92+
93+
```
94+
./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")'
95+
```
96+
97+
### For Raspberry Pi 4 example:
98+
99+
Pull Docker Images
100+
101+
```
102+
docker pull connectedhomeip/chip-build-vscode:latest
103+
```
104+
105+
Run docker
106+
107+
```
108+
docker run -it -v ~/connectedhomeip:/var/connectedhomeip connectedhomeip/chip-build-vscode:latest /bin/bash
109+
```
110+
111+
Build
112+
113+
```
114+
cd /var/connectedhomeip
115+
116+
git config --global --add safe.directory /var/connectedhomeip
117+
git config --global --add safe.directory /var/connectedhomeip/third_party/pigweed/repo
118+
git config --global --add safe.directory /var/connectedhomeip/examples/common/QRCode/repo
119+
120+
./scripts/run_in_build_env.sh \
121+
"./scripts/build/build_examples.py \
122+
--target linux-arm64-fabric-bridge-no-ble-clang-rpc \
123+
build"
124+
```
125+
126+
Transfer the fabric-bridge-app binary to a Raspberry Pi
127+
128+
```
129+
scp ./fabric-bridge-app ubuntu@xxx.xxx.xxx.xxx:/home/ubuntu
97130
```
98131

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

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

0 commit comments

Comments
 (0)