From 913aca036e08e544460db263041f4e9781709fa3 Mon Sep 17 00:00:00 2001 From: cpagravel Date: Mon, 4 Apr 2022 17:53:15 -0700 Subject: [PATCH] Update rpc_console docs for building and running (#16801) * Update rpc_console docs for building and running * Restyled by prettier-markdown Co-authored-by: Restyled.io --- examples/common/pigweed/rpc_console/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/examples/common/pigweed/rpc_console/README.md b/examples/common/pigweed/rpc_console/README.md index 202d02b4ab68a5..7ba3a4117294b8 100644 --- a/examples/common/pigweed/rpc_console/README.md +++ b/examples/common/pigweed/rpc_console/README.md @@ -18,14 +18,15 @@ 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 /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 /scripts/activate.sh The python console is built and installed in the venv using gn: + $ cd /examples/common/pigweed/rpc_console $ gn gen out/debug $ ninja -C out/debug @@ -33,6 +34,7 @@ files required for CHIP. (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 /examples/common/pigweed/rpc_console/out/debug $ pip install chip_rpc_console_wheels/*.whl ## Running @@ -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()