diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index 52a89772ea0fb6..bdc52346378150 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -5,15 +5,16 @@ control. --- -- [CHIP ESP32 All Clusters Example](#chip-esp32-all-clusters-example) - - [Supported Devices](#supported-devices) - - [Building the Example Application](#building-the-example-application) - - [Commissioning and cluster control](#commissioning-and-cluster-control) - - [Setting up Python Controller](#setting-up-python-controller) - - [Commissioning over BLE](#commissioning-over-ble) - - [Cluster control](#cluster-control) - - [Flashing app using script](#flashing-app-using-script) - - [Note](#note) +- [CHIP ESP32 All Clusters Example](#chip-esp32-all-clusters-example) + - [Supported Devices](#supported-devices) + - [Building the Example Application](#building-the-example-application) + - [Commissioning and cluster control](#commissioning-and-cluster-control) + - [Setting up Python Controller](#setting-up-python-controller) + - [Commissioning over BLE](#commissioning-over-ble) + - [Cluster control](#cluster-control) + - [Flashing app using script](#flashing-app-using-script) + - [Note](#note) + - [Using the RPC console](#using-the-rpc-console) --- @@ -260,13 +261,30 @@ actual effect of the commands. ## Using the RPC console -Enable RPCs in the build using menuconfig: +You can use the rpc default config to setup everything correctly for RPCs: - $ idf.py menuconfig + $ export SDKCONFIG_DEFAULTS=$PROJECT_ROOT/examples/all-clusters-app/esp32/sdkconfig_m5stack_rpc.defaults + $ rm sdkconfig + $ idf.py fullclean -Enable the RPC library: +Alternatively, Enable RPCs in the build using menuconfig: - Component config → CHIP Core → General Options → Enable Pigweed PRC library + - Enable the RPC library and Disable ENABLE_CHIP_SHELL + + Component config → CHIP Core → General Options → Enable Pigweed PRC library + Component config → CHIP Core → General Options → Disabe CHIP Shell + + - Ensure the UART is correctly configured for your board, for m5stack: + + PW RPC Debug channel → UART port number → 0 + PW RPC Debug channel → UART communication speed → 115200 + PW RPC Debug channel → UART RXD pin number → 3 + PW RPC Debug channel → UART TXD pin number → 1 + +After configuring you can build and flash normally: + + $ idf.py build + $ idf.py flash After flashing a build with RPCs enabled you can use the rpc console to send commands to the device.