Skip to content

Commit

Permalink
Restyled by prettier-markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
restyled-commits authored and greg-fer committed Mar 24, 2023
1 parent 4f5fb9a commit 1c02604
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions docs/guides/chip_tool_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,15 +257,15 @@ Alternatively, you can also use a QR code payload.
##### Commissioning with setup PIN code
To discover devices and try to pair with the first available discovered device using the
provided setup code, use the following command pattern:
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:
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.
- _<pin_code\>_ is device specific _setup PIN code_ determined in the
Expand All @@ -274,15 +274,16 @@ In this command:
##### Commissioning with long discriminator
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:
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:
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.
- _<pin_code\>_ and _<discriminator\>_ are device specific keys determined in
Expand All @@ -294,15 +295,15 @@ 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 available discovered device, use the following command
pattern:
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:
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.
- _<qrcode_payload-or-manual_code\>_ is the QR code payload ID, for example
Expand Down Expand Up @@ -413,12 +414,14 @@ 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).
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.
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 1c02604

Please sign in to comment.