[ESP32] Moved the redundent documentation to common place (#21674)

* [ESP32] Moved the redundent documentation to common place

* restyle

* addressed review comments

.github/.wordlist.txt

@@ -560,6 +560,7 @@ GenericThreadStackManagerImpl
 GenericWiFiConfigurationManagerImpl
 GetDeviceId
 GetDeviceInfo
+DeviceInstanceInfoProvider
 GetDns
 GetIP
 getManualTests

docs/guides/esp32/README.md

@@ -0,0 +1,12 @@
+## ESP32 Guides
+
+---
+
+-   [Setup ESP-IDF and CHIP Environment](setup_idf_chip.md)
+-   [Using factory data from NVS](factory_data.md)
+-   [Building and commissioning the application](build_app_and_commission.md)
+-   [Flash and NVS encryption for securing factory data](flash_nvs_encryption.md)
+-   [RPC Console and Device Tracing](rpc_console.md)
+-   [Matter OTA](ota.md)
+
+---

docs/guides/esp32/build_app_and_commission.md

@@ -0,0 +1,220 @@
+# ESP32 Application Usage Guide
+
+Below guide mentions the details about how to build, flash, monitor, commission
+the esp32 application.
+
+---
+
+-   [Supported target chips](#supported-target-chips)
+-   [Building an example application](#building-an-example-application)
+-   [Set up the environment variables](#set-up-the-environment-variables)
+-   [Build, flash and monitor an example](#build-flash-and-monitor-an-example)
+-   [Commissioning](#commissioning)
+    -   [Building Standalone chip-tool](#building-standalone-chip-tool)
+    -   [Commissioning the WiFi devices](#commissioning-the-wifi-devices-esp32-esp32c3-esp32s3)
+    -   [Commissioning the Thread device](#commissioning-the-thread-device-esp32h2)
+    -   [Commissioning Parameters](#commissioning-parameters)
+-   [Flashing app using script](#flashing-app-using-script)
+
+---
+
+## Supported target chips
+
+All the CHIP demo application is intended to work on: the
+[ESP32-DevKitC](https://www.espressif.com/en/products/hardware/esp32-devkitc/overview),
+the
+[ESP32-WROVER-KIT_V4.1](https://www.espressif.com/en/products/hardware/esp-wrover-kit/overview),
+the [M5Stack](http://m5stack.com), the
+[ESP32C3-DevKitM](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/hw-reference/esp32c3/user-guide-devkitm-1.html),
+and the ESP32S3.
+
+All the applications support variants of ESP32, ESP32C3, ESP32S3 chips.
+
+ESP32H2 is only supported and tested with lighting-app.
+
+Note: M5Stack Core 2 display is not supported in the tft component, while other
+functionality can still work fine.
+
+## Building an example application
+
+### Set up the environment variables
+
+-   ESP-IDF
+
+    Tools path SHALL be added to the PATH environment variable to make the tools
+    usable from the command line. ESP-IDF provides another script which does
+    that.
+
+    ```
+    $ cd path/to/esp-idf
+    $ source export.sh
+    ```
+
+-   CHIP
+
+    Before running any other build command, the scripts/activate.sh environment
+    setup script should be sourced at the top level. This script set up a Python
+    environment with libraries used to build and test.
+
+    ```
+    $ cd path/to/connectedhomeip
+    $ source scripts/activate.sh
+    ```
+
+-   Ccache
+
+    Enable Ccache for faster IDF builds. It is recommended to have Ccache
+    installed for faster builds.
+
+    ```
+    $ export IDF_CCACHE_ENABLE=1
+    ```
+
+### Build, flash and monitor an example
+
+-   Change to example application directory
+
+    ```
+    $ cd examples/<app-name>/esp32
+    ```
+
+-   Set the chip target to build
+
+    ```
+    $ idf.py set-target (CHIP)
+    ```
+
+    All the example applications supports target chips: esp32, esp32s3, esp32c3
+
+    ESP32H2 is only supported in lighting-app, to set it as target
+
+    ```
+    idf.py --preview set-target esp32h2
+    ```
+
+-   Configuration Options
+
+    To build the default configuration (`sdkconfig.defaults`) skip this step.
+
+    To build a specific configuration (example `m5stack`):
+
+    ```
+    $ rm sdkconfig
+    $ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig_m5stack.defaults' build
+    ```
+
+    Note: If using a specific device configuration, it is highly recommended to
+    start off with one of the defaults and customize on top of that. Certain
+    configurations have different constraints that are customized within the
+    device specific configuration (eg: main app stack size).
+
+    To customize the configuration, run menuconfig:
+
+    ```
+    $ idf.py menuconfig
+    ```
+
+-   Build the application
+
+    ```
+    idf.py build
+    ```
+
+-   Flash the application
+
+    After building the application, to flash it connect your device via USB.
+    Then run the following command to erase the whole flash, flash the demo
+    application onto the device and then monitor its output.
+
+    Note that sometimes you might have to press and hold the boot button on the
+    device while it's trying to connect before flashing. For ESP32-DevKitC
+    devices this is labeled in the
+    [functional description diagram](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-devkitc.html#functional-description)
+
+    ```
+    $ idf.py -p (PORT) erase_flash
+    $ idf.py -p (PORT) flash monitor
+    ```
+
+    Please replace `(PORT)` with the correct USB device name for your system
+    (like `/dev/ttyUSB0` on Linux or `/dev/tty.usbserial-101` on Mac).
+
+    Note: Some users might have to install the
+    [VCP driver](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
+    before the device shows up on /dev/tty.
+
+-   Quit the monitor by pressing `Ctrl+]`. Note: You can see a menu of various
+    monitor commands by hitting Ctrl+t Ctrl+h while the monitor is running.
+
+## Commissioning
+
+Below apps can be used for commissioning the application running on ESP32:
+
+-   [Python Based Device Controller](https://github.com/project-chip/connectedhomeip/tree/master/src/controller/python)
+-   [Standalone chip-tool](https://github.com/project-chip/connectedhomeip/tree/master/examples/chip-tool)
+-   [iOS chip-tool App](https://github.com/project-chip/connectedhomeip/tree/master/src/darwin/CHIPTool)
+-   [Android chip-tool App](https://github.com/project-chip/connectedhomeip/tree/master/src/android/CHIPTool)
+
+### Building Standalone chip-tool
+
+```
+cd path/to/connectedhomeip
+scripts/examples/gn_build_example.sh examples/chip-tool out/debug
+```
+
+Run the built executable and pass it the discriminator and pairing code of the
+remote device, as well as the network credentials to use.
+
+#### Commissioning the WiFi devices (ESP32, ESP32C3, ESP32S3)
+
+```
+$ out/debug/chip-tool pairing ble-wifi 12345 MY_SSID MY_PASSWORD 20202021 3840
+```
+
+#### Commissioning the Thread device (ESP32H2)
+
+-   For ESP32-H2, firstly start OpenThread Border Router, you can either use
+    [Raspberry Pi OpenThread Border Router](https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/openthread_border_router_pi.md)
+    OR
+    [ESP32 OpenThread Border Router](https://github.com/espressif/esp-idf/tree/master/examples/openthread/ot_br)
+
+-   Get the active operational dataset.
+
+    ```
+    $ ot-ctl> dataset active -x
+    ```
+
+-   Commissioning the Thread device
+
+    ```
+     $ ./out/debug/chip-tool pairing ble-thread 12345 hex:<operational-dataset> 20202021 3840
+    ```
+
+#### Commissioning Parameters
+
+-   Node Id : 12345 (you can assign any node id)
+-   Discriminator : 3840 (Test discriminator)
+-   Setup Pin Code : 20202021 (Test setup pin code)
+
+If you want to use different values for discriminator and setup pin code please
+follow [Using ESP32 Factory Data Provider guide](factory_data.md)
+
+## Flashing app using script
+
+-   Follow these steps to use `${app_name}.flash.py`.
+
+    -   First set IDF target, run set-target with one of the commands.
+
+        ```
+        $ idf.py set-target esp32
+        $ idf.py set-target esp32c3
+        ```
+
+    -   Execute below sequence of commands
+
+        ```
+        $ export ESPPORT=/dev/tty.SLAB_USBtoUART
+        $ idf.py build
+        $ idf.py flashing_script
+        $ python ${app_name}.flash.py
+        ```

docs/guides/esp32/factory_data.md

@@ -0,0 +1,109 @@
+## Using ESP32 Factory Data Provider
+
+By default applications uses test-mode or default commissionable data provider,
+device attestation credentials provider, and device instance info provider.
+
+To use different values for them you can use the ESP32 Factory Data Provider.
+
+### Configuration Options
+
+Enable config option `CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER` to use ESP32
+specific implementation of CommissionableDataProvider and
+DeviceAttestationCredentialsProvider.
+
+[Component config → CHIP Device Layer → Commissioning options → Use ESP32
+Factory Data Provider]
+
+Enable config option `CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER` to use ESP32
+specific implementation of DeviceInstanceInfoProvider.
+
+[Component config → CHIP Device Layer → Commissioning options → Use ESP32 Device
+Instance Info Provider]
+
+ESP32 implementation reads factory data from nvs partition, chip-factory data
+must be flashed into the configured nvs partition. Factory partition can be
+configured using `CONFIG_CHIP_FACTORY_NAMESPACE_PARTITION_LABEL` option, default
+is "nvs".
+
+### Generate NVS Binary Image
+
+`scripts/tools/generate_esp32_chip_factory_bin.py` script generates the
+chip-factory NVS binary image `partition.bin`.
+
+#### Supported data
+
+Script supports adding following data to the NVS binary image:
+
+-   Commissionable data
+
+    -   Discriminator
+    -   Spake2p verifier, salt, and iteration count
+
+-   Device attestation data
+
+    -   Device attestation key and certificate
+    -   Product attestation intermediate certificate
+    -   Certificate declaration
+
+-   Device instance information
+    -   Vendor id and name
+    -   Product id and name
+    -   Hardware version and version string
+    -   Serial Number
+    -   Unique identifier
+
+Please check help for available options,
+`scripts/tools/generate_esp32_chip_factory_bin.py`
+
+#### Dependency
+
+Script has dependency on
+[spake2p](https://github.com/project-chip/connectedhomeip/tree/master/src/tools/spake2p)
+for generating spake2p parameters.
+
+Build spake2p:
+
+```
+cd path/to/connectedhomeip
+gn gen out/host
+ninja -C out/host
+cd -
+```
+
+Add spake2p to \$PATH environment variable
+
+```
+export PATH=$PATH:path/to/connectedhomeip/out/host
+```
+
+#### Usage
+
+Below mentioned command generates the nvs image with test DAC with VID:0xFFF2
+and PID:8000 and some examples values for other fields.
+
+```
+./generate_esp32_chip_factory_bin.py -d 3434 -p 99663300 \
+                                    --product-name ESP-lighting-app --product-id 0x8000 \
+                                    --vendor-name Test-vendor --vendor-id 0xFFF2 \
+                                    --hw-ver 1 --hw-ver-str DevKit \
+                                    --dac-cert path/to/connectedhomeip/credentials/test/attestation/Chip-Test-DAC-FFF2-8001-0008-Cert.der \
+                                    --dac-key path/to/connectedhomeip/credentials/test/attestation/Chip-Test-DAC-FFF2-8001-0008-Key.der \
+                                    --pai-cert path/to/connectedhomeip/credentials/test/attestation/Chip-Test-PAI-FFF2-8001-Cert.der \
+                                    --cd path/to/connectedhomeip/credentials/test/certification-declaration/Chip-Test-CD-FFF2-8001.der \
+```
+
+#### Flashing the generated NVS image
+
+Use the following command to flash the NVS image. `0x9000` is default address
+for `nvs` partition.
+
+```
+esptool.py -p <port> write_flash 0x9000 factory_partition.bin
+```
+
+NOTE: Above command uses the default NVS address, please flash the NVS image at
+appropriate address.
+
+### Securing NVS binary image with NVS Encryption
+
+Please check [Flash and NVS encryption guide](flash_nvs_encryption.md)