Skip to content

Commit

Permalink
doc: chip_tool: clarify some parts
Browse files Browse the repository at this point in the history
Edited sections that were in need of updates after the previous review.
These edits change the meaning of existing doc in the parts related to
the interactive mode vs single-command mode, and in the part about
commissioning commands.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer committed Mar 24, 2023
1 parent a4a407b commit 4f5fb9a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/guides/chip_tool_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,14 @@ Alternatively, you can also use a QR code payload.
##### Commissioning with setup PIN code
To discover devices and try to pair with the first discovered device using the
To discover devices and try to pair with the first available discovered device using the
provided setup code, use the following command pattern:
```
$ ./chip-tool pairing onnetwork <node_id> <pin_code>
```
The command keeps trying devices until pairing with one of them succeeds or until it runs out of pairing possibilities.
In this command:
- _<node_id\>_ is the user-defined ID of the node being commissioned.
Expand All @@ -273,13 +274,14 @@ In this command:
##### Commissioning with long discriminator
To discover devices with a long discriminator and try to pair with the first
discovered one using the provided setup code, use the following command pattern:
To discover devices with a long discriminator and try to pair with the first available discovered device
using the provided setup code, use the following command pattern:
```
$ ./chip-tool pairing onnetwork-long <node_id> <pin_code> <discriminator>
```
The command keeps trying devices until pairing with one of them succeeds or until it runs out of pairing possibilities.
In this command:
- _<node_id\>_ is the user-defined ID of the node being commissioned.
Expand All @@ -292,13 +294,14 @@ In this command:
Matter devices log the QR code payload and manual pairing code when they boot.
To discover devices based on the given QR code payload or manual pairing code
and try to pair with the first discovered one, use the following command
and try to pair with the first available discovered device, use the following command
pattern:
```
$ ./chip-tool pairing code <node_id> <qrcode_payload-or-manual_code>
```
The command keeps trying devices until pairing with one of them succeeds or until it runs out of pairing possibilities.
In this command:
- _<node_id\>_ is the user-defined ID of the node being commissioned.
Expand Down Expand Up @@ -410,10 +413,12 @@ The CHIP Tool can run in one of the following modes:
[1650992689511] [32397:1415601] CHIP: [TOO] Run command failure: ../../../examples/chip-tool/commands/common/CHIPCommand.cpp:392: CHIP Error 0x00000032: Timeout
```
Moreover, when using the single-command mode, the CHIP Tool will establish a new CASE session with every command sent (and close the existing one).
- Interactive mode - In this mode, a command will terminate with an error if
it does not complete within the timeout period. However, the CHIP Tool will
not be terminated and it will not terminate processes that previous commands
have started.
Moreover, when using the interactive mode, the CHIP Tool will establish a CASE session only on the first command sent.
#### Modifying timeout duration in single-command mode
Expand Down

0 comments on commit 4f5fb9a

Please sign in to comment.