Merge branch 'docs/add_box3b_pcb' into 'master'

docs: Added some PCB sections and additional information for ESP-BOX-3B

See merge request ae_group/esp-box!103

.github/workflows/build-examples-gh-pages-on-push.yml

@@ -49,6 +49,11 @@ jobs:
           'usb_headset',
           'watering_demo']
         boards: ['sdkconfig.ci.box', 'sdkconfig.ci.box-lite', 'sdkconfig.ci.box-3']
+        exclude:
+          - boards: sdkconfig.ci.box-lite
+            build-dir: usb_camera_lcd_display
+          - boards: sdkconfig.ci.box
+            build-dir: usb_camera_lcd_display
     steps:
       - uses: actions/checkout@v3
         with:
@@ -58,47 +63,24 @@ jobs:
         shell: bash
         run: |
           . $IDF_PATH/export.sh
-          cd $GITHUB_WORKSPACE/examples/${{matrix.build-dir}}
-          if [ -e "${{matrix.boards}}" ]; then
-            rm -rf sdkconfig build sdkconfig.defaults
-            cp ${{matrix.boards}} sdkconfig.defaults
-            # idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults;${{matrix.boards}}" reconfigure
-          fi
+          pip install --upgrade idf-component-manager
+          pip install "idf_build_apps<2.0"
 
-          if [[ ${{matrix.build-dir}} == usb_camera_lcd_display ]]; then
-            if [[ ${{matrix.boards}} == sdkconfig.ci.box-3 ]]; then
-              idf.py build
-              cd build
-              esptool.py --chip esp32s3 merge_bin -o "$GITHUB_WORKSPACE/images/${{matrix.build-dir}}_${{matrix.boards}}.bin" @flash_args
-            else
-              echo "Skipping build for ${{matrix.build-dir}} with ${{matrix.boards}}"
-            fi
-          elif [[ ${{matrix.build-dir}} == chatgpt_demo ]]; then
-            idf.py build
+          cd $GITHUB_WORKSPACE/examples/${{matrix.build-dir}}
+          # diff sdkconfig.defaults ${{matrix.boards}} | grep '^>' | sed 's/^> *//' | grep -v '^#' | sed 's/.*/\n&/' >> sdkconfig.defaults
+          comm -23 <(grep -v '^#' ${{matrix.boards}} | sort) <(grep -v '^#' sdkconfig.defaults | sort) | sed 's/.*/\n&/' >> sdkconfig.defaults
 
+          if [[ ${{matrix.build-dir}} == chatgpt_demo ]]; then
             cd factory_nvs
-            rm -rf sdkconfig build sdkconfig.defaults
-            cp ${{matrix.boards}} sdkconfig.defaults
-            # idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults;${{matrix.boards}}" reconfigure
+            comm -23 <(grep -v '^#' ${{matrix.boards}} | sort) <(grep -v '^#' sdkconfig.defaults | sort) | sed 's/.*/\n&/' >> sdkconfig.defaults
             idf.py build
-
             cd ../
-            esptool.py --chip ESP32-S3 merge_bin \
-            -o "$GITHUB_WORKSPACE/images/${{matrix.build-dir}}_${{matrix.boards}}.bin" \
-            --flash_mode dio --flash_freq 80m --flash_size 16MB \
-            0x0 build/bootloader/bootloader.bin \
-            0x8000 build/partition_table/partition-table.bin \
-            0xd000 build/ota_data_initial.bin \
-            0x10000 build/chatgpt_demo.bin \
-            0x900000 build/storage.bin \
-            0xb00000 build/srmodels/srmodels.bin \
-            0x700000 factory_nvs/build/factory_nvs.bin
-          else
-            idf.py build
-            cd build
-            esptool.py --chip esp32s3 merge_bin -o "$GITHUB_WORKSPACE/images/${{matrix.build-dir}}_${{matrix.boards}}.bin" @flash_args
           fi
 
+          idf.py build
+          cd build
+          esptool.py --chip esp32s3 merge_bin -o "$GITHUB_WORKSPACE/images/${{matrix.build-dir}}_${{matrix.boards}}.bin" @flash_args
+
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:
@@ -107,7 +89,7 @@ jobs:
 
   job2:
     runs-on: ubuntu-latest
-    container: espressif/esp-matter:latest
+    container: espressif/esp-matter:latest_idf_v5.1.1
     strategy:
       matrix:
         build-dir: ['matter_switch']
@@ -122,11 +104,12 @@ jobs:
         run: |
           . $IDF_PATH/export.sh
           . $ESP_MATTER_PATH/export.sh
+          pip install --upgrade idf-component-manager
+          pip install "idf_build_apps<2.0"
+
           cd $GITHUB_WORKSPACE/examples/${{matrix.build-dir}}
+          comm -23 <(grep -v '^#' ${{matrix.boards}} | sort) <(grep -v '^#' sdkconfig.defaults | sort) | sed 's/.*/\n&/' >> sdkconfig.defaults
 
-          rm -rf sdkconfig build sdkconfig.defaults
-          cp ${{matrix.boards}} sdkconfig.defaults
-          # idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults;${{matrix.boards}}" reconfigure
           idf.py set-target esp32s3 build
           cd build
           esptool.py --chip esp32s3 merge_bin -o "$GITHUB_WORKSPACE/images/${{matrix.build-dir}}_${{matrix.boards}}.bin" @flash_args
@@ -162,7 +145,7 @@ jobs:
           ls
           $GITHUB_WORKSPACE/tools/launchpad/rename.sh $GITHUB_WORKSPACE
           ls
-          $GITHUB_WORKSPACE/tools/launchpad/generate_launchpad_config.sh
+          $GITHUB_WORKSPACE/tools/launchpad/generate_launchpad_config.sh $GITHUB_REPOSITORY
 
       - name: Setup Pages
         uses: actions/configure-pages@v2

.gitlab/ci/build.yml

@@ -62,6 +62,11 @@ build_example_chatgpt_demo:
       - IMAGE: espressif/idf:latest
   variables:
     EXAMPLE_DIR: examples/chatgpt_demo
+    NVS_DIR: examples/chatgpt_demo/factory_nvs
+  before_script:
+    - pwd
+    - mkdir ${NVS_DIR}/build
+    - touch ${NVS_DIR}/build/factory_nvs.bin
 
 build_example_chatgpt_demo_factory_nvs:
   extends:

docs/firmware_update.md

@@ -29,7 +29,7 @@ For the latest firmware, please go to https://github.com/espressif/esp-box/relea
 
 Please follow the link below corresponding to your OS to update the firmware.
 
-| [<center> ESP Launchpad </center>](#Updating-Firmware-with-ESP-Launchpad) | [<center> Windows </center>](#Updating-Firmware-for-Windows) | [<center> Linux </center>](#Updating-Firmware-for-Linux) | [<center> macOS </center>](#Updating-Firmware-for-macOS) |
+| [<center> ESP Launchpad </center>](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-box/launchpad.toml) | [<center> Windows </center>](#Updating-Firmware-for-Windows) | [<center> Linux </center>](#Updating-Firmware-for-Linux) | [<center> macOS </center>](#Updating-Firmware-for-macOS) |
 |:----:|:----:|:----:|:----:|
 |<img alt="Try it with ESP Launchpad" src="https://espressif.github.io/esp-launchpad/assets/try_with_launchpad.png" width="200" height="56"> | [<img src="_static/windows-logo.png" width="40" align="center" />](#Updating-Firmware-for-Windows) | [<img src="_static/linux-logo.png" width="40"  align="center" />](#Updating-Firmware-for-Linux) | [<img src="_static/macos-logo.jpg" width="40" align="center" />](#Updating-Firmware-for-macOS) |
 
@@ -45,7 +45,7 @@ ESP Launchpad is a web based tool, available for flashing firmware application t
    <img src="_static/launchpad_en.png" width="580">
    </div>
 
-### Updating Firmware for Windows 
+### Updating Firmware for Windows
 
 We recommend using `Windows 10` and above. Under `Windows 10` system, the driver of `USB-Serial-Jtag` will be downloaded automatically. If you use `Windows 7`, please download and install [USB-Serial-JTAG drive](https://dl.espressif.com/dl/idf-driver/idf-driver-esp32-usb-jtag-2021-07-15.zip) manually.
 
@@ -79,7 +79,7 @@ We recommend using `Windows 10` and above. Under `Windows 10` system, the driver
    <img src="_static/dl_tool_windows_3.png" width="300">
    </div>
 
-### Updating Firmware for Linux 
+### Updating Firmware for Linux
 
 1. [Download the latest firmware](#latest-firmware-download).
 2. Connect your development board to the computer through a USB Type-C cable. There is no need to install the driver of `USB-Serial-Jtag` under Linux system.
@@ -99,7 +99,7 @@ We recommend using `Windows 10` and above. Under `Windows 10` system, the driver
     python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin
     ```
 
-   1. `0x0` is the fixed flash address. 
+   1. `0x0` is the fixed flash address.
    2. `download_path/test_bin.bin` should be replaced with your firmware path and name.
 
 5. After the firmware is updated, the download tool will prompt `Hash of data verified`. Next, **please press the `Reset` button to run the new firmware!**

docs/firmware_update_cn.md

@@ -27,7 +27,7 @@ BOX 系列开发板支持使用 USB 接口更新固件，您仅需要准备：
 
 不同操作系统的固件更新方法，请参考以下链接：
 
-| [<center> ESP Launchpad </center>](#ESP-Launchpad-更新固件说明) | [<center> Windows </center>](#windows-系统更新固件说明) | [<center> Linux </center>](#linux-系统更新固件说明) | [<center> macOS </center>](#macos-系统更新固件说明) |
+| [<center> ESP Launchpad </center>](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-box/launchpad.toml) | [<center> Windows </center>](#windows-系统更新固件说明) | [<center> Linux </center>](#linux-系统更新固件说明) | [<center> macOS </center>](#macos-系统更新固件说明) |
 |:----:|:----:|:----:|:----:|
 |[<img alt="Try it with ESP Launchpad" src="https://espressif.github.io/esp-launchpad/assets/try_with_launchpad.png" width="200" height="56">](#ESP-Launchpad-更新固件说明) | [<img src="_static/windows-logo.png" width="40" align="center" />](#windows-系统更新固件说明) | [<img src="_static/linux-logo.png" width="40"  align="center" />](#linux-系统更新固件说明) | [<img src="_static/macos-logo.jpg" width="40" align="center" />](#macos-系统更新固件说明) |
 
@@ -64,7 +64,7 @@ ESP Launchpad 是一个基于 web 的 ESP32 固件下载工具，用户可以通
 
 6. 请按照下图指示配置下载工具：
    1. 首先选择 `xxxx.bin` 路径，将地址设置为 `0x0`。
-   2. 选择下载端口 COMX，此电脑为 `COM2`。 
+   2. 选择下载端口 COMX，此电脑为 `COM2`。
    3. 点击 `START` 开始固件下载。
 
    <div align="center">

docs/getting_started.md

@@ -34,6 +34,7 @@ The target group for this product includes individuals and organizations engaged
 # Getting Started
 
 ## Contents of the Kit
+### ESP32-S3-BOX-3 Kit
 <div align="center">
 <img src="./_static/_get_started_static/ESP32_S3_BOX_3_KitFigure.png" width="700px">
 </div>
@@ -46,6 +47,21 @@ The target group for this product includes individuals and organizations engaged
 - A USB-C Power Cable
 - An RGB LED module and Dupont wires for testing
 
+### ESP32-S3-BOX-3B Kit
+<div align="center">
+<img src="./_static/_get_started_static/ESP32_S3_BOX_3B_KitFigure.png" width="700px">
+</div>
+
+- ESP32-S3-BOX-3, a main unit that can work on its own
+- ESP32-S3-BOX-3-DOCK, a functional accessory serving as a stand for the main box
+- A USB-C Power Cable
+- An RGB LED module and Dupont wires for testing
+
+## Variant Description
+The ESP32-S3-BOX-3 offers two different versions: ESP32-S3-BOX-3 and ESP32-S3-BOX-3B. The ESP32-S3-BOX-3 represents the standard edition with four blue accessories, the ESP32-S3-BOX-3B provides fewer accessories to meet starters who don’t need much unnecessary hardware. Here are the distinctions between the two versions:
+<div align="center">
+<img src="./_static/_get_started_static/ESP32_S3_BOX_3_Compare.jpg" width="700px">
+</div>
 
 ## Power on Your Device
 1. Power on your device using the USB-C cable.

docs/getting_started_cn.md

@@ -32,6 +32,7 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
 
 # 开始使用
 ## 套件内容
+###  ESP32-S3-BOX-3 套件
 <div align="center">
 <img src="./_static/_get_started_static/ESP32_S3_BOX_3_KitFigure.png" width="700px">
 </div>
@@ -44,6 +45,21 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
 - 一根 USB-C 数据线
 - 一个 RGB LED 模块和杜邦线，用于测试
 
+###  ESP32-S3-BOX-3B 套件
+<div align="center">
+<img src="./_static/_get_started_static/ESP32_S3_BOX_3B_KitFigure.png" width="700px">
+</div>
+
+- ESP32-S3-BOX-3，独立工作的主模块
+- ESP32-S3-BOX-3-DOCK，功能配件，可作为主机的座子
+- 一根 USB-C 数据线
+- 一个 RGB LED 模块和杜邦线，用于测试
+
+## 变体说明
+ESP32-S3-BOX-3 提供两款不同配置的套件：分别命名为 ESP32-S3-BOX-3 和 ESP32-S3-BOX-3B。ESP32-S3-BOX-3 代表标准版本，配备四款蓝色配件，而 ESP32-S3-BOX-3B 代表基础版，仅提供了一款配件，适用于不需要太多不必要硬件的初学者。以下是两个版本之间的区别
+<div align="center">
+<img src="./_static/_get_started_static/ESP32_S3_BOX_3_Compare.jpg" width="700px">
+</div>
 
 ## 给设备供电
 1. 使用 USB-C 数据线给设备供电。

docs/hardware_overview/esp32_s3_box/hardware_overview_for_box.md

@@ -2,7 +2,7 @@
 
 ## Hardware Overview
 
-![esp_box_hardware](../../_static/esp32_s3_box_hardware.svg)
+![esp_box_hardware](../../_static/esp32_s3_box_hardware.png)
 
 ### Hardware Source Files
 

docs/hardware_overview/esp32_s3_box/hardware_overview_for_box_cn.md

@@ -2,7 +2,7 @@
 
 ## 硬件总览
 
-![esp_box_hardware](../../_static/esp32_s3_box_hardware.svg)
+![esp_box_hardware](../../_static/esp32_s3_box_hardware.png)
 
 ### 硬件开源资料
 

docs/hardware_overview/esp32_s3_box_lite/hardware_overview_for_lite.md

@@ -2,7 +2,7 @@
 
 ## Hardware Overview
 
-![esp_box_hardware](../../_static/esp_box_lite_hardware.svg)
+![esp_box_hardware](../../_static/esp_box_lite_hardware.png)
 
 ### Hardware Source Files
 

docs/hardware_overview/esp32_s3_box_lite/hardware_overview_for_lite_cn.md

@@ -2,7 +2,7 @@
 
 ## 硬件总览
 
-![esp_box_hardware](../../_static/esp_box_lite_hardware.svg)
+![esp_box_hardware](../../_static/esp_box_lite_hardware.png)
 
 ### 硬件开源资料
 

examples/chatgpt_demo/CMakeLists.txt

@@ -10,3 +10,4 @@ set(EXTRA_COMPONENT_DIRS
     )
 add_compile_options(-fdiagnostics-color=always -Wno-ignored-qualifiers)
 project(chatgpt_demo)
+

examples/chatgpt_demo/README.md

@@ -88,7 +88,7 @@ idf.py build
 **8. Flash**
 
 ```bash
-python -m esptool -p /dev/ttyACM0 --chip esp32s3 -b 460800 --before default_reset --after hard_reset write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin 0xd000 build/ota_data_initial.bin 0x10000 build/chatgpt_demo.bin 0x900000 build/storage.bin 0xb00000 build/srmodels/srmodels.bin 0x700000 factory_nvs/build/factory_nvs.bin
+idf.py -p PORT flash
 
 ```
 

examples/chatgpt_demo/factory_nvs/main/main.c

@@ -36,8 +36,8 @@ static void uf2_nvs_modified_cb()
 
 void app_main(void)
 {
-    const esp_partition_t *update_partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_OTA_0, NULL);
-    ESP_LOGI(TAG, "Switch to partition OTA_0");
+    const esp_partition_t *update_partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_FACTORY, NULL);
+    ESP_LOGI(TAG, "Switch to partition factory");
     esp_ota_set_boot_partition(update_partition);
     esp_err_t err = ESP_OK;
 

examples/chatgpt_demo/factory_nvs/partitions.csv

@@ -1,7 +1,6 @@
 # Name,   Type, SubType, Offset,  Size, Flags
 # Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap
 nvs,      data,   nvs,    0x9000,   0x4000,
-otadata,  data,   ota,    0xd000,   0x2000,
-phy_init, data,   phy,    0xf000,   0x1000,
-ota_0,    app,    ota_0,  0x10000,  6M,
-uf2,    app,    factory,  0x700000, 2M,
+otadata,    data,   ota,        0xd000,     0x2000,
+phy_init,   data,   phy,        0xf000,     0x1000,
+ota_0,      app,    ota_0,      0x700000,   2M,

examples/chatgpt_demo/factory_nvs/sdkconfig.ci.box

@@ -1,35 +1,2 @@
-# This file was generated using idf.py save-defconfig. It can be edited manually.
-# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
-#
-CONFIG_IDF_TARGET="esp32s3"
-CONFIG_ESPTOOLPY_FLASHMODE_QIO=y
-CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y
-CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_BSP_BOARD_ESP32_S3_BOX=y
-CONFIG_COMPILER_OPTIMIZATION_PERF=y
-CONFIG_SPIRAM=y
-CONFIG_SPIRAM_MODE_OCT=y
-CONFIG_SPIRAM_FETCH_INSTRUCTIONS=y
-CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL=1024
-CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL=8192
-CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
-CONFIG_ESP32S3_DATA_CACHE_64KB=y
-CONFIG_ESP32S3_DATA_CACHE_LINE_64B=y
-CONFIG_FREERTOS_HZ=1000
-CONFIG_MBEDTLS_DYNAMIC_BUFFER=y
-CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA=y
-CONFIG_LV_COLOR_16_SWAP=y
-CONFIG_LV_MEM_CUSTOM=y
-CONFIG_LV_MEMCPY_MEMSET_STD=y
-CONFIG_LV_FONT_FMT_TXT_LARGE=y
-CONFIG_IDF_EXPERIMENTAL_FEATURES=y
-CONFIG_SPIRAM_SPEED_80M=y
-CONFIG_SPIRAM_SPEED=80
-CONFIG_ENABLE_UF2_USB_CONSOLE=y
-CONFIG_ESPTOOLPY_FLASHFREQ_80M=y
-CONFIG_ESPTOOLPY_FLASHFREQ="80m"
-CONFIG_UF2_VOLUME_LABEL="ESP-BOX"
-CONFIG_TUSB_MANUFACTURER="Espressif"
-CONFIG_TUSB_PRODUCT="ESP32-S3-BOX"
-CONFIG_UF2_SERIAL_NUM="12345678"
+# BSP
 CONFIG_BSP_BOARD_ESP32_S3_BOX=y

examples/chatgpt_demo/factory_nvs/sdkconfig.ci.box-3

@@ -1,35 +1,2 @@
-# This file was generated using idf.py save-defconfig. It can be edited manually.
-# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
-#
-CONFIG_IDF_TARGET="esp32s3"
-CONFIG_ESPTOOLPY_FLASHMODE_QIO=y
-CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y
-CONFIG_PARTITION_TABLE_CUSTOM=y
-CONFIG_BSP_BOARD_ESP32_S3_BOX=y
-CONFIG_COMPILER_OPTIMIZATION_PERF=y
-CONFIG_SPIRAM=y
-CONFIG_SPIRAM_MODE_OCT=y
-CONFIG_SPIRAM_FETCH_INSTRUCTIONS=y
-CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL=1024
-CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL=8192
-CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
-CONFIG_ESP32S3_DATA_CACHE_64KB=y
-CONFIG_ESP32S3_DATA_CACHE_LINE_64B=y
-CONFIG_FREERTOS_HZ=1000
-CONFIG_MBEDTLS_DYNAMIC_BUFFER=y
-CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA=y
-CONFIG_LV_COLOR_16_SWAP=y
-CONFIG_LV_MEM_CUSTOM=y
-CONFIG_LV_MEMCPY_MEMSET_STD=y
-CONFIG_LV_FONT_FMT_TXT_LARGE=y
-CONFIG_IDF_EXPERIMENTAL_FEATURES=y
-CONFIG_SPIRAM_SPEED_80M=y
-CONFIG_SPIRAM_SPEED=80
-CONFIG_ENABLE_UF2_USB_CONSOLE=y
-CONFIG_ESPTOOLPY_FLASHFREQ_80M=y
-CONFIG_ESPTOOLPY_FLASHFREQ="80m"
-CONFIG_UF2_VOLUME_LABEL="ESP-BOX"
-CONFIG_TUSB_MANUFACTURER="Espressif"
-CONFIG_TUSB_PRODUCT="ESP32-S3-BOX"
-CONFIG_UF2_SERIAL_NUM="12345678"
+# BSP
 CONFIG_BSP_BOARD_ESP32_S3_BOX_3=y