Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions THIRD_PARTY_LICENSES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ For ESP Component Registry entries, `Registry license` is the API value for the
- SPDX: `Apache-2.0`
- Copyright/notice: https://github.com/esp-mosaico/esp-mosaico-bsp/blob/392860b1d1a123c3377947074b2af1f600e86c5d/LICENSE

## `usb_hs_console`

- Version: `9ea326da1f2a017ba81f1d391862f977b355a03e`
- Source: https://github.com/esp-mosaico/esp-mosaico-claw/tree/9ea326da1f2a017ba81f1d391862f977b355a03e/boards/esp_mosaico/components/usb_hs_console
- SPDX: `Apache-2.0`
- Copyright/notice: [LICENSE](firmware/components/usb_hs_console/LICENSE)
- Local integration: [UPSTREAM.md](firmware/components/usb_hs_console/UPSTREAM.md)

## `esp_desktop_buddy`

- Version: `b6bac05db208717676e70180e5269d79f32b2d68`
Expand Down Expand Up @@ -167,6 +175,20 @@ For ESP Component Registry entries, `Registry license` is the API value for the

- ESP-Mosaico version: `1.3.2~1`; source: https://components.espressif.com/components/espressif/zlib/versions/1.3.2~1; copyright/notice: https://components.espressif.com/components/espressif/zlib/versions/1.3.2~1/license

## `espressif/esp_tinyusb`

- Version: `2.2.1`
- Source: https://components.espressif.com/components/espressif/esp_tinyusb/versions/2.2.1
- SPDX: `Apache-2.0`
- Copyright/notice: https://github.com/espressif/esp-usb/blob/8e779566ef71d43928cbf7e125e8eb54bab3f542/device/esp_tinyusb/LICENSE

## `espressif/tinyusb`

- Version: `0.21.0~1`
- Source: https://components.espressif.com/components/espressif/tinyusb/versions/0.21.0~1
- SPDX: `MIT`
- Copyright/notice: https://github.com/espressif/tinyusb/blob/7049c58a0e895acc92c6407574b05b5536eddfc8/LICENSE

## `espressif/usb`

- Version: `1.3.0`
Expand Down
46 changes: 43 additions & 3 deletions docs/validation/mosaico-gestures.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,54 @@ eim run "idf.py -C firmware/targets/esp_mosaico build" v6.1

## 有线烧录

按住 BOOT 再开机进入 ROM 下载模式。整段擦写大应用可能断连,应用按 1 MiB 分段烧录,不直接使用 `idf.py flash` 或未拆分的 `@flash_args`。
首次安装、应用无法启动或 USB CDC 初始化失败时,按住 BOOT 再开机进入 ROM 下载模式。已安装支持 CDC 自动下载的固件且应用正常运行时,可通过 Type-C 触发下载,无需按键。

地址从目标应用槽起点逐段递增。使用 ESP-IDF v6.1 环境中的 esptool,参数为 `--chip esp32s31 --no-stub`、460800 波特率、DIO/80 MHz/16 MB,并指定 `--after no-reset`。烧录前核对分段拼接内容与构建应用一致,烧录后确认每段设备哈希校验成功,再通过 POWER 关机重启。
先关闭占用串口的监视器,再列出端口:

```sh
eim run "python -m serial.tools.list_ports -v" v6.1
```

确认产品为 `QuotaFrame Mosaico`、USB VID:PID 为 `303A:1001` 的应用端口。以下 macOS/Linux shell 示例使用 esptool 的复位序列;该流程已在 macOS 验证。将 `APP_PORT` 替换为刚确认的端口:

```sh
cat > /tmp/mosaico-enter-download.py <<'PYTHON'
import sys
import serial
from esptool.reset import USBJTAGSerialReset

port = serial.Serial(port=None, baudrate=115200, timeout=0.2)
port.dtr = True
port.rts = True
port.port = sys.argv[1]
port.open()
try:
USBJTAGSerialReset(port).reset()
except (OSError, serial.SerialException) as error:
print(f"CDC reset interrupted: {error}; verify the ROM port below.")
finally:
port.close()
PYTHON
eim run "python /tmp/mosaico-enter-download.py APP_PORT" v6.1
eim run "python -m serial.tools.list_ports -v" v6.1
```

等待设备重新枚举,确认 `303A:0020` 的 ESP32-S31 ROM 端口后,将它用于后续烧录。端口名称可能变化,不能继续沿用应用端口;若未出现 ROM 端口,应停止烧录并检查连接,必要时使用 BOOT 恢复。复位期间的串口断开提示本身不代表已进入下载模式。

整段擦写大应用可能断连,应用按 1 MiB 分段烧录,不直接使用 `idf.py flash` 或未拆分的 `@flash_args`。

地址从目标应用槽起点逐段递增。使用 ESP-IDF v6.1 环境中的 esptool,参数为 `--chip esp32s31 --no-stub`、460800 波特率、DIO/80 MHz/16 MB,并指定 `--after no-reset`。烧录前核对分段拼接内容与构建应用一致,烧录后确认每段设备哈希校验成功,再执行以下命令读取芯片标识并通过看门狗复位返回应用。将 `ROM_PORT` 替换为重新枚举后的 ROM 端口:

```sh
eim run "python -m esptool --chip esp32s31 --port ROM_PORT --no-stub --before no-reset --after hard-reset chip-id" v6.1
```

应用 CDC 会再次枚举,查看日志前重新确认端口。软件复位失败时,可通过 POWER 关机重启。

仅更新当前应用时,不写入 NVS、分区表或初始 OTA 元数据。完整安装使用构建产物匹配的 bootloader、分区表及初始化数据,应用仍分段写入。整片擦除或写入包含填充区域的合并镜像会影响已保存的配对和设置。

## 维护入口

应用日志从 UART0 输出:右侧排针 H1 的 15 脚 TX0 / GPIO58,或底板背面 TX 调试焊盘,115200 波特率。Type-C 口使用 USB OTG 下载,摄像头占用的 USB Serial/JTAG 引脚位于左侧排针。日志包含手部坐标、置信度、动作和运行耗时,不包含图像。
应用启动 USB CDC 后,日志通过 Type-C USB OTG 串口输出;连接监视器时使用 `monitor --no-reset` 可避免重启。启动早期的 UART0 输出可从右侧排针 H1 的 15 脚 TX0 / GPIO58,或底板背面 TX 调试焊盘读取,波特率为 115200。摄像头占用的 USB Serial/JTAG 引脚位于左侧排针,与 Type-C USB OTG 独立。日志包含手部坐标、置信度、动作和运行耗时,不包含图像。

代码结构、识别参数见[手势设计](../design/mosaico-gesture-input.md);固定依赖、模型摘要和引脚所有权见[摄像头依赖说明](../../firmware/targets/esp_mosaico/CAMERA_UPSTREAM.md)。
12 changes: 12 additions & 0 deletions firmware/components/usb_hs_console/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
idf_component_register(
SRC_DIRS "."
INCLUDE_DIRS "."
PRIV_REQUIRES esp_system esp_timer esp_rom soc
)

if(CONFIG_USB_HS_CONSOLE_USB_CDC_AUTO_INIT)
target_link_libraries(${COMPONENT_LIB} INTERFACE
"-Wl,--wrap=app_main"
"-u __wrap_app_main"
)
endif()
19 changes: 19 additions & 0 deletions firmware/components/usb_hs_console/Kconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

menu "USB HS Console Config"

config USB_HS_CONSOLE_USB_CDC_AUTO_DOWNLOAD
bool "Enable custom USB CDC auto-download reset"
depends on TINYUSB_CDC_ENABLED
depends on !ESP_CONSOLE_USB_CDC
default n
help
Enable USB-Serial/JTAG-compatible DTR/RTS reset handling for the
custom USB CDC console.

config USB_HS_CONSOLE_USB_CDC_AUTO_INIT
bool "Automatically initialize custom USB CDC console"
depends on USB_HS_CONSOLE_USB_CDC_AUTO_DOWNLOAD
default n
help
Initialize the custom USB CDC console before app_main() starts.
endmenu
202 changes: 202 additions & 0 deletions firmware/components/usb_hs_console/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
25 changes: 25 additions & 0 deletions firmware/components/usb_hs_console/UPSTREAM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Upstream source

- Repository: https://github.com/esp-mosaico/esp-mosaico-claw
- Path: `boards/esp_mosaico/components/usb_hs_console`
- Commit: `9ea326da1f2a017ba81f1d391862f977b355a03e`
- License: Apache-2.0 (see `LICENSE` and source SPDX headers).

This component initializes a TinyUSB CDC console on the Mosaico Type-C USB
OTG port. It implements the USB Serial/JTAG DTR/RTS reset protocol in software;
it does not expose hardware JTAG. Only the ESP-Mosaico target includes it.

## Local modifications

- Declare the ESP-IDF system, timer, ROM and SoC dependencies explicitly.
- Require ESP-IDF >=6.1 and constrain esp_tinyusb to the compatible 2.x API;
the target lockfile records the resolved version.
- Include the ROM print declaration and correct obsolete Kconfig names in the
public header; document initialization errors, serialized access and port
re-enumeration. Clarify the stdio buffering comment.
- Continue application startup with a warning if USB console initialization
fails, preserving the display and BLE recovery path.

The reset state machine and USB descriptor are retained from upstream.
Software download requires a running application; BOOT plus power-on remains
necessary for recovery when USB initialization or application startup fails.
3 changes: 3 additions & 0 deletions firmware/components/usb_hs_console/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies:
idf: ">=6.1"
espressif/esp_tinyusb: "^2.0.1~1"
Loading
Loading