Skip to content

Commit

Permalink
Add documentation about the usage of the --storage-directory flag. (p…
Browse files Browse the repository at this point in the history
  • Loading branch information
RJ030 authored Dec 22, 2023
1 parent 1939c35 commit 83c1b73
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/guides/chip_tool_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ directory.
> `/tmp/chip_tool_config.ini` file. Deleting this and other `.ini` files in the
> `/tmp` directory can sometimes resolve issues related to stale configuration.
> **Note:** To make the configuration persistent (since `/tmp` directory might
> be flushed at each reboot) you can change the directory where CHIP Tool caches
> its configuration by using the option `--storage-directory`
<hr>

## Building and running the CHIP Tool
Expand Down Expand Up @@ -676,6 +680,30 @@ The following flags are available:

<hr>

##### Changing storage directory

By default, CHIP Tool stores its configuration into the `/tmp` directory. You
can change the storage directory by using the `--storage-directory` flag.

Usage:

```
--storage-directory <directory>
```

Here, _<directory\>_ is the path to the directory where the configuration is
stored.

**Example of usage:**

```
$ ./chip-tool pairing ble-wifi <node_id> <ssid> <password> <pin_code> <discriminator> --storage-directory <directory>
$ ./chip-tool temperaturemeasurement read measured-value <node_id> <endpoint_id> --storage-directory <directory>
```

<hr>

### Commissioner name and ID flags

All CHIP Tool commands can be used together with the following
Expand Down

0 comments on commit 83c1b73

Please sign in to comment.