Skip to content

Commit

Permalink
Update rpc_console docs for building and running
Browse files Browse the repository at this point in the history
  • Loading branch information
cpagravel committed Mar 31, 2022
1 parent e8c3452 commit 1a59e60
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions examples/common/pigweed/rpc_console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,23 @@ files required for CHIP.
If this is the first time using the checkout the environment must first be
bootstrapped to install all dependencies.

$ source ./scripts/bootstrap.sh
$ source <project_root>/scripts/bootstrap.sh

If bootstrap has previously be run simply activate.
If bootstrap has previously been run, then simply activate.

$ source ./scripts/activate.sh
$ source <project_root>/scripts/activate.sh

The python console is built and installed in the venv using gn:

$ cd <project_root>/examples/common/pigweed/rpc_console
$ gn gen out/debug
$ ninja -C out/debug

After building the output directory also contains a folder
(chip_rpc_console_wheels), with all the wheels required for the tool. These
can be used to install the console without needing the sdk. Simply install
all the wheels in the folder:
$ cd <project_root>/examples/common/pigweed/rpc_console/out/debug
$ pip install chip_rpc_console_wheels/*.whl

## Running
Expand All @@ -41,6 +43,9 @@ To start the console provide the path to the device, for example:

$ chip-console --device /dev/ttyUSB0

Note that `chip-console` is an entry point for chip_rpc.console and could also be run with
`python -m chip_rpc.console`.

An example RPC command:

$ rpcs.chip.rpc.DeviceCommon.GetDeviceInfo()
$ rpcs.chip.rpc.Device.GetDeviceInfo()

0 comments on commit 1a59e60

Please sign in to comment.