Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update rpc_console docs for building and running #16801

Merged
merged 2 commits into from
Apr 5, 2022
Merged

Update rpc_console docs for building and running #16801

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a59e60
Update rpc_console docs for building and running
cpagravel Mar 29, 2022
ab94ebc
Restyled by prettier-markdown
restyled-commits Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions examples/common/pigweed/rpc_console/README.md
View file
Open in desktop
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()