Skip to content

Commit

Permalink
Update chip-tool pairing documentation to match current behavior. (pr…
Browse files Browse the repository at this point in the history
  • Loading branch information
bzbarsky-apple authored Oct 7, 2021
1 parent c0ba6b1 commit 664a671
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
6 changes: 5 additions & 1 deletion docs/QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ controller.

#### IP Pairing

`chip-tool pairing onnetwork 34567890` will use PASE over IP to pair a device.
`chip-tool pairing onnetwork 20202021` will use PASE over IP to pair a device.

NOTE: On Linux, if the device is actually running after unit tests ran you have
to use `chip-tool pairing onnetwork 34567890`, because the unit tests change the
device configuration.

NOTE: to run both the Node and Controller as separate processes on the same
Linux or Mac machine, build the all-clusters-app with BLE disabled as follows:
Expand Down
16 changes: 13 additions & 3 deletions examples/chip-tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,20 @@ or equivalently:

#### Pair a device over IP

The command below will pair to a localhost device (`::1`) running the
`all-clusters-app` on the default port (`5540`) over IPv6:
The command below will discover devices and try to pair with the first one it
discovers using the provided setup code.

$ chip-tool pairing onnetwork 0 20202021 3840 ::1 5540
$ chip-tool pairing onnetwork 20202021

The command below will discover devices with long discriminator 3840 and try to
pair with the first one it discovers using the provided setup code.

$ chip-tool pairing onnetwork-long 20202021 3840

The command below will discover devices based on the given QR code (which
devices log when they start up) and try to pair with the first one it discovers.

$ chip-tool pairing qrcode MT:#######

### Forget the currently-commissioned device

Expand Down
2 changes: 1 addition & 1 deletion examples/ota-requestor-app/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In one terminal:
In a second terminal:

```
./chip-tool pairing onnetwork 0 20202021 3840 ::1 5540
./chip-tool pairing onnetwork-long 20202021 3840
./chip-ota-requestor-app [-p <provider node id>]
```

Expand Down

0 comments on commit 664a671

Please sign in to comment.