diff --git a/README_cn.md b/README_cn.md index a46a7cc..a61c14b 100644 --- a/README_cn.md +++ b/README_cn.md @@ -4,7 +4,7 @@ * [English Version](./README.md) * [Gitee 镜像仓库](https://gitee.com/EspressifSystems/esp-box) - +* [宣传视频](https://www.bilibili.com/video/BV11N4y197Qu/?spm_id_from=333.337.search-card.all.click) # ESP-BOX AIoT 开发框架

diff --git a/docs/_static/_get_started_static/LED_pin_defination.png b/docs/_static/_get_started_static/LED_pin_defination.png index 686c1cb..4a9e64b 100644 Binary files a/docs/_static/_get_started_static/LED_pin_defination.png and b/docs/_static/_get_started_static/LED_pin_defination.png differ diff --git a/docs/_static/box_3_back.png b/docs/_static/box_3_back.png new file mode 100644 index 0000000..84e75d6 Binary files /dev/null and b/docs/_static/box_3_back.png differ diff --git a/docs/_static/box_3_hardware_overview/sepc_for_box_3_sensor.png b/docs/_static/box_3_hardware_overview/sepc_for_box_3_sensor.png index 5772f0f..37bfb10 100644 Binary files a/docs/_static/box_3_hardware_overview/sepc_for_box_3_sensor.png and b/docs/_static/box_3_hardware_overview/sepc_for_box_3_sensor.png differ diff --git a/docs/_static/disassembly_pictures_3/disassembly_overview.jpg b/docs/_static/disassembly_pictures_3/disassembly_overview.jpg new file mode 100755 index 0000000..03c56de Binary files /dev/null and b/docs/_static/disassembly_pictures_3/disassembly_overview.jpg differ diff --git a/docs/_static/disassembly_pictures_3/exploded_view.PNG b/docs/_static/disassembly_pictures_3/exploded_view.PNG new file mode 100755 index 0000000..86ea10d Binary files /dev/null and b/docs/_static/disassembly_pictures_3/exploded_view.PNG differ diff --git a/docs/_static/disassembly_pictures_3/figure_01.jpg b/docs/_static/disassembly_pictures_3/figure_01.jpg new file mode 100755 index 0000000..0a89666 Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_01.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_02.jpg b/docs/_static/disassembly_pictures_3/figure_02.jpg new file mode 100755 index 0000000..1f58e05 Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_02.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_03.jpg b/docs/_static/disassembly_pictures_3/figure_03.jpg new file mode 100755 index 0000000..4bdc8ab Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_03.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_04.jpg b/docs/_static/disassembly_pictures_3/figure_04.jpg new file mode 100755 index 0000000..10b110e Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_04.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_05.jpg b/docs/_static/disassembly_pictures_3/figure_05.jpg new file mode 100755 index 0000000..a8dc58b Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_05.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_06.jpg b/docs/_static/disassembly_pictures_3/figure_06.jpg new file mode 100755 index 0000000..77fc619 Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_06.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_07.jpg b/docs/_static/disassembly_pictures_3/figure_07.jpg new file mode 100755 index 0000000..b29e4db Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_07.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_08.jpg b/docs/_static/disassembly_pictures_3/figure_08.jpg new file mode 100755 index 0000000..71e08df Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_08.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_09.jpg b/docs/_static/disassembly_pictures_3/figure_09.jpg new file mode 100755 index 0000000..027e736 Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_09.jpg differ diff --git a/docs/_static/disassembly_pictures_3/figure_10.jpg b/docs/_static/disassembly_pictures_3/figure_10.jpg new file mode 100755 index 0000000..b8841ab Binary files /dev/null and b/docs/_static/disassembly_pictures_3/figure_10.jpg differ diff --git a/docs/disassembly_tutorial.md b/docs/disassembly_tutorial.md index 4a0a947..e1e5b55 100644 --- a/docs/disassembly_tutorial.md +++ b/docs/disassembly_tutorial.md @@ -1,9 +1,10 @@ -# ESP32-S3-BOX Disassembly Tutorial - -The case of the BOX series products have three different versions. Please match the corresponding disassembly tutorial according to the appearance of your product. - -| Version | Tutorial |Note| -| :-----: | :---------------------: |:---------------------: | -| ESP32-S3-BOX V1 | [Disassembly Tutorial for ESP32-S3-BOX V1](hardware_overview/esp32_s3_box/disassembly_tutorial_v1.md) | Not available | -| ESP32-S3-BOX V2 | [Disassembly Tutorial for ESP32-S3-BOX V2](hardware_overview/esp32_s3_box/disassembly_tutorial_v2.md) |Not available| -| ESP32-S3-BOX-Lite | Please refer to ESP32-S3-BOX V2 as they are similar in structure.|On sale now| \ No newline at end of file +# ESP32-S3-BOX Disassembly Tutorial + +The case of the BOX series products have three different versions. Please match the corresponding disassembly tutorial according to the appearance of your product. + +| Version | Tutorial |Note| +| :-----: | :---------------------: |:---------------------: | +| ESP32-S3-BOX V1 | [Disassembly Tutorial for ESP32-S3-BOX V1](hardware_overview/esp32_s3_box/disassembly_tutorial_v1.md) | Not available | +| ESP32-S3-BOX V2 | [Disassembly Tutorial for ESP32-S3-BOX V2](hardware_overview/esp32_s3_box/disassembly_tutorial_v2.md) |Not available| +| ESP32-S3-BOX-Lite | Please refer to ESP32-S3-BOX V2 as they are similar in structure.|On sale now| +| ESP32-S3-BOX-3 |[Disassembly Tutorial for ESP32-S3-BOX-3](hardware_overview/esp32_s3_box_3/disassembly_tutorial_3.md)|On sale now| diff --git a/docs/getting_started.md b/docs/getting_started.md index bc711c2..887bec0 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -103,7 +103,7 @@ The target group for this product includes individuals and organizations engaged ## Sensor Monitor - This feature needs ESP32-S3-BOX-3 is mounted to the ESP32-S3-BOX-3-SENSOR dock. ESP32-S3-BOX-3-SENSOR is a versatile accessory, which integrates a Temp&Hum Sensor, a pair of IR Emitter and Receiver, and a Radar Sensor. It empowers user to create sensor network and other sensor applications with ease. The built-in firmware provides a real-time environment Temp&Hum display, a demonstration of human presence monitoring through a 2.4 GHz radar Additionally, it offers an IR learning interface, allowing users to use the ESP-BOX for IR learning of their air conditioning controller, thereby enabling control over the air conditioner. This learning capability also extends to other in-house IR controllers, such as Fan, TV, projector, providing a truly engaging experience. + This feature needs ESP32-S3-BOX-3 is mounted to the ESP32-S3-BOX-3-SENSOR dock. ESP32-S3-BOX-3-SENSOR is a versatile accessory, which integrates a Temp&Hum Sensor, a pair of IR Emitter and Receiver, and a Radar Sensor. It empowers user to create sensor network and other sensor applications with ease. The built-in firmware provides a real-time environment Temp&Hum display, a demonstration of human presence monitoring through a 2.4 GHz radar. Additionally, it offers an IR learning interface, allowing users to use the ESP-BOX for IR learning of their air conditioning controller, thereby enabling control over the air conditioner. This learning capability also extends to other in-house IR controllers, such as Fan, TV, projector, providing a truly engaging experience. diff --git a/docs/hardware_overview/esp32_s3_box_3/disassembly_tutorial_3.md b/docs/hardware_overview/esp32_s3_box_3/disassembly_tutorial_3.md new file mode 100644 index 0000000..9a21aba --- /dev/null +++ b/docs/hardware_overview/esp32_s3_box_3/disassembly_tutorial_3.md @@ -0,0 +1,104 @@ +# ESP32-S3-BOX-3 Disassembly Tutorial + +## Exploded View + +The figure below depicts an exploded view of the ESP32-S3-BOX-3, which shows the order of assembly of various parts and how they fit together. The projection of the ESP32-S3-BOX main unit has 10 layers, beginning from the top layer and arranging in descending order as shown in the picture below. + +
+ +
+ +> **Warning**: Disassembling the ESP32-S3–BOX-3 may damage the hardware structure. Espressif will not be responsible for any damages resulting from the disassembling. + +## Disassembly Tutorial + +### What Do You Need + +- Size #1 Phillips-Head Screwdriver + +### Components Overview + +The following tutorial will guide you to disassemble the development board step-by-step. Once you have dissembled the development board, there will be six main components as shown below. This tutorial will not cover how to disassemble the layer 1, 5, 7 and 9 as they are held with permanent adhesives. Please keep them well. + +
+ +
+ +### Step-by-step Guide + +- Use the “Phillips-Head Screwdriver” to remove the four screws from the bottom case. + +
+ +
+ +- Gently move the bottom case out, as per arrow, to separate the bottom case and the top case. Avoid tugging onto the LCD FPC cables and speaker cable. + +
+ +
+ +- Observe that the microphone sub-board is connected to the main board through a 6 pin FPC cable. Unlatch the FPC connector and unplug the FPC cable. + +
+ +
+ +- Move the top case and bottom case apart carefully to expose the main board. Observe that the LCD, touch panel, and speaker is connected to the main board by a 20 pin FPC cable, 8 pin FPC cable, and JST connector respectively. Unlock the two FPC connectors, and disconnect the speaker to separate the top case and bottom case. + +
+ + +
+ +- With this, you will have the top case with LCD, touch screen , speaker and microphone sub-board, as well as the bottom case with main board. + +
+ +
+ +- Unscrew the two screws on the microphone sub-board and remove the sub-board completely. + +- The dust covers are located on the microphone of the sub-board. It is NOT recommended to remove them as they are glued to the top case. + +
+ +
+ +- The touch screen is glued to the top case. It is NOT recommended to disassemble it as there is a risk of damaging the FPC cable and the glass cover of the touch screen. + +- The speaker is located on the inside of the top case. It is NOT recommended to remove it as it is glued to the top case. + +
+ +
+ +- Unscrew the last two screws on the main board and take out the board. + +
+ +
+ +- Note the 6 pin FPC cable connector on the other side of the main board, unlock the connector and take off the FPC cable. You have completed the disassembly. + +
+ +
+ +## Assembly Tips + +Assembly is as simple as reversing the above disassembly tutorial but to facilitate a smoother assembly experience, this section will cover some of the assembly issues and things to take note before assembly. + +### Things to note +- Ensure that the speaker wire is not covering the screw holes of the main board PCBA before screwing in the screws. +- When placing the bottom case onto the top case, do so by aligning the side with the PMOD first, before putting the case together. +- When placing the bottom case onto the top case, Ensure that the snap fits near the PMOD are fully in place before screwing in the last 2 screws. + +
+ +
+ + + + + diff --git a/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3.md b/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3.md index 9d0bedb..bb8aff9 100644 --- a/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3.md +++ b/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3.md @@ -60,7 +60,7 @@ ESP32-S3-BOX-3-SENSOR is a versatile accessory, which integrates Temp&Hum Sensor -ESP32-S3-BOX-3-BRACKET can be utilized to help ESP32-S3-BOX-3 mount to other devices, opens up a multitude of possibilities for transforming non-smart devices into smart ones. By leveraging its two Pmod™ compatible headers, user can effectively integrate wireless connectivity, voice control and screen control capabilities. The ESP32-S3-BOX-3-BRACKET adapter empowers you to unleash the full potential of your non-smart devices. +ESP32-S3-BOX-3-BRACKET can be utilized to help ESP32-S3-BOX-3 mount to other devices, opens up a multitude of possibilities for transforming non-smart devices into smart ones. Installation of ESP32-S3-BOX-3-BRACKET is straightforward, simply prepare 2 mounting holes and a slot using our template [HERE](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF). By leveraging its two Pmod™ compatible headers, user can effectively integrate wireless connectivity, voice control and screen control capabilities. The ESP32-S3-BOX-3-BRACKET adapter empowers you to unleash the full potential of your non-smart devices. #### Orthographic View
@@ -92,4 +92,5 @@ ESP32-S3-BOX-3-BREAD is an adapter that enables easy connection of the ESP32-S3- ## Hardware Source Files * [ESP32-S3-BOX-3 Kit PCB](../../../hardware/PCB_ESP32-S3-BOX-3_V1.0) * [ESP32-S3-BOX-3 Kit Schematic](../../../hardware/SCH_ESP32-S3-BOX-3_V1.0) -* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl) \ No newline at end of file +* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl) +* [ESP32-S3-BOX-3 Bracket Mounting Template](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF) \ No newline at end of file diff --git a/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3_cn.md b/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3_cn.md index d864ed5..688ea1f 100644 --- a/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3_cn.md +++ b/docs/hardware_overview/esp32_s3_box_3/hardware_overview_for_box_3_cn.md @@ -63,7 +63,7 @@ ESP32-S3-BOX-3-SENSOR 是一个多功能配件，集成了温湿度传感器、
-ESP32-S3-BOX-3-BRACKET 可用于帮助 ESP32-S3-BOX-3 安装到其他设备上，为将非智能设备转变为智能设备开启了多种可能性。通过利用其两个 Pmod™ 兼容的引脚，用户可以有效地为非智能设备集成无线连接、语音控制和屏幕控制功能。ESP32-S3-BOX-3-BRACKET 转接配件使您能够充分发挥非智能设备的潜力。 +ESP32-S3-BOX-3-BRACKET 可用于帮助 ESP32-S3-BOX-3 安装到其他设备上，为将非智能设备转变为智能设备开启了多种可能性。ESP32-S3-BOX-3-BRACKET 的安装非常简单，只需使用[模板](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF)准备 2 个孔和一个槽即可。通过利用其两个 Pmod™ 兼容的引脚，用户可以有效地为非智能设备集成无线连接、语音控制和屏幕控制功能。ESP32-S3-BOX-3-BRACKET 转接配件使您能够充分发挥非智能设备的潜力。 #### 正视图
@@ -97,4 +97,5 @@ ESP32-S3-BOX-3-BREAD 是一个转接板，方便用户轻松连接 ESP32-S3-BOX- * [ESP32-S3-BOX-3 Kit PCB](../../../hardware/PCB_ESP32-S3-BOX-3_V1.0) * [ESP32-S3-BOX-3 Kit Schematic](../../../hardware/SCH_ESP32-S3-BOX-3_V1.0) -* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl) \ No newline at end of file +* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl) +* [ESP32-S3-BOX-3 Bracket Mounting Template](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF) diff --git a/examples/chatgpt_demo/README.md b/examples/chatgpt_demo/README.md index 1092459..9fdebe4 100644 --- a/examples/chatgpt_demo/README.md +++ b/examples/chatgpt_demo/README.md @@ -4,7 +4,7 @@ | ----------------- | -------------- | | ESP32-S3-BOX | YES | | ESP32-S3-BOX-Lite | YES | -| ESP32-S3-BOX-3 | NO | +| ESP32-S3-BOX-3 | YES | In this example, we are utilizing the OpenAI API in conjunction with an ESP-BOX to create a voice-based chatbot. The ESP-BOX is a device or system that incorporates an ESP32-S3 microcontroller. The purpose of this implementation is to enable users to communicate with the chatbot using spoken language. The process involves capturing audio input from the user, sending it to the OpenAI API for processing, and receiving a response that is then converted into speech and played back to the user. diff --git a/hardware/ESP32-S3-BOX-3-BRACKET_template.PDF b/hardware/ESP32-S3-BOX-3-BRACKET_template.PDF new file mode 100755 index 0000000..2a828ca Binary files /dev/null and b/hardware/ESP32-S3-BOX-3-BRACKET_template.PDF differ