Skip to content

Commit d8ededa

Browse files
Update the readme of fabric-sync app based on the latest update (project-chip#36540)
* Update the readme of fabric-sync app based on the latest update * Restyled by prettier-markdown * Remove extra comma --------- Co-authored-by: Restyled.io <commits@restyled.io>
1 parent c56d0f0 commit d8ededa

File tree

2 files changed

+60
-10
lines changed

2 files changed

+60
-10
lines changed

examples/fabric-admin/rpc/RpcServer.cpp

-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,6 @@ class FabricAdmin final : public rpc::FabricAdmin, public admin::PairingDelegate
174174
if (error == CHIP_NO_ERROR)
175175
{
176176
mNodeId = DeviceManager::Instance().GetNextAvailableNodeId();
177-
;
178177

179178
// After responding with RequestCommissioningApproval to the node where the client initiated the
180179
// RequestCommissioningApproval, you need to wait for it to open a commissioning window on its bridge.

examples/fabric-sync/README.md

+60-9
Original file line numberDiff line numberDiff line change
@@ -80,30 +80,30 @@ defined:
8080

8181
## Building
8282

83-
### For Linux host example:
83+
- For Linux host example:
8484

85-
```
85+
```sh
8686
source scripts/activate.sh
8787
./scripts/build/build_examples.py --target linux-x64-fabric-sync-no-ble build
8888
```
8989

90-
### For Raspberry Pi 4 example:
90+
- For Raspberry Pi 4 example:
9191

9292
Pull Docker Images
9393

94-
```
94+
```sh
9595
docker pull ghcr.io/project-chip/chip-build-crosscompile:90
9696
```
9797

9898
Run docker
9999

100-
```
100+
```sh
101101
docker run -it -v ~/connectedhomeip:/var/connectedhomeip ghcr.io/project-chip/chip-build-crosscompile:90 /bin/bash
102102
```
103103

104104
Build
105105

106-
```
106+
```sh
107107
cd /var/connectedhomeip
108108
109109
git config --global --add safe.directory /var/connectedhomeip
@@ -116,7 +116,7 @@ defined:
116116

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

119-
```
119+
```sh
120120
scp ./fabric-sync ubuntu@xxx.xxx.xxx.xxx:/home/ubuntu
121121
```
122122

@@ -126,9 +126,60 @@ defined:
126126

127127
Follow [Building](#building) section of this document.
128128

129-
- Run Linux Fabric Sync Example App
129+
- Run Linux Fabric Sync Example App on two Linux machine E1 and E2
130130

131131
```sh
132+
sudo rm -rf /tmp/chip_*
132133
cd ~/connectedhomeip/
133-
sudo out/debug/fabric-sync
134+
out/debug/fabric-sync
135+
```
136+
137+
- Initiate the FS Setup Process from E1 to E2
138+
139+
```sh
140+
> app add-bridge 1 20202021 192.168.86.246 5540
141+
Done
142+
> New device with Node ID: 0000000000000001 has been successfully added.
143+
A new device has been added on Endpoint: 2.
144+
```
145+
146+
- Verify Reverse Commissioning of the Fabric-Bridge from E1 on E2
147+
148+
```sh
149+
> New device with Node ID: 0000000000000002 has been successfully added.
150+
```
151+
152+
- Pair Light Example to E2
153+
154+
Since Fabric-Bridge also functions as a Matter server, running it alongside
155+
the Light Example app on the same machine would cause conflicts. Therefore,
156+
you need to run the Matter Light Example app on a separate physical machine
157+
from the one hosting Fabric-Sync.
158+
159+
```sh
160+
> app add-device 3 <setup-pin-code> <device-remote-ip> <device-remote-port>
161+
```
162+
163+
After the device is successfully added, you will observe the following
164+
message on E2 with the newly assigned Node ID:
165+
166+
```sh
167+
> New device with Node ID: 0x3 has been successfully added.
168+
```
169+
170+
Additionally, you should also get notified when a new device is added to E2
171+
from the E1:
172+
173+
```sh
174+
> A new device is added on Endpoint 3.
175+
```
176+
177+
- Synchronize Light Example to E1
178+
179+
After the Light Example is successfully paired in E2, we can start to
180+
synchronize the light device to E1 using the new assigned dynamic endpointid
181+
on Ecosystem 2.
182+
183+
```sh
184+
> app sync-device <endpointid>
134185
```

0 commit comments

Comments
 (0)