-
Notifications
You must be signed in to change notification settings - Fork 804
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'doc/usb' into 'master'
usb translated(English) docs See merge request ae_group/esp-iot-solution!892
- Loading branch information
Showing
20 changed files
with
397 additions
and
380 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
|
|
||
| USB Device 方案 | ||
| --------------- | ||
| USB Device Solution | ||
| -------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| USB Class Drivers | ||
| ********************* | ||
|
|
||
| :link_to_translation:`zh_CN:[中文]` | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| USB Host UVC/UAC <usb_stream> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,135 @@ | ||
|
|
||
| USB Host 方案 | ||
| ------------- | ||
| USB Host Solution | ||
| ------------------ | ||
|
|
||
| ESP32-S2/S3 等芯片内置 USB-OTG 外设，支持通过 USB 接口连接多种多样的 USB 设备。以下介绍了 ESP32-S2/S3 芯片支持的 USB Host 解决方案。 | ||
| ESP32-S2/S3 and similar chips come with built-in USB-OTG peripherals, supporting the connection of various type of USB devices through the USB interface. The following provides an overview of the USB Host solutions supported by the ESP32-S2/S3 chips. | ||
|
|
||
| ESP USB Camera 视频方案 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ | ||
| ESP USB Camera Video Solution | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 支持通过 USB 接口连接摄像头模组，实现 MJPEG 格式视频流获取和传输，最高可支持 480*800@15fps。适用于猫眼门铃、智能门锁、内窥镜、倒车影像等场景。 | ||
| Supports the connection of a camera module through the USB interface, enabling the acquisition and transmission of MJPEG format video streams, with a maximum resolution of 480*800@15fps. Ideal for applications such as cat's eye doorbells, smart door locks, endoscopes, rearview cameras, and other scenarios. | ||
|
|
||
| 特性: | ||
| ~~~~~ | ||
| Features: | ||
| ~~~~~~~~~~ | ||
|
|
||
|
|
||
| * 快速启动 | ||
| * 支持热插拔 | ||
| * 支持 UVC1.1/1.5 规范的摄像头 | ||
| * 支持自动解析描述符 | ||
| * 支持动态配置分辨率 | ||
| * 支持 MJPEG 视频流传输 | ||
| * 支持批量和同步两种传输模式 | ||
| * Quick Start | ||
| * Hot Plug Support | ||
| * Cameras that support UVC1.1/1.5 Specifications | ||
| * Automatic Descriptor Parsing | ||
| * Dynamic Resolution Configuration | ||
| * MJPEG Video Stream Transmission | ||
| * Bulk or Isochronous Transfer Modes | ||
|
|
||
| 硬件: | ||
| ~~~~~ | ||
| Hardware: | ||
| ~~~~~~~~~~ | ||
|
|
||
|
|
||
| * 芯片： ESP32-S2，ESP32-S3 | ||
| * 外设：USB-OTG | ||
| * USB 摄像头：支持 MJPEG 格式，批量传输模式下 800*480@15fps，同步传输模式下 480*320@15fps，摄像头限制详见 `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_ | ||
| * Chips: ESP32-S2, ESP32-S3 | ||
| * Peripherals: USB-OTG | ||
| * USB Camera: Supports MJPEG format, with a bulk transfer mode of 800*480@15fps, or an isochronous transfer mode of 480*320@15fps. For camera limitations, refer to the `usb_stream API documentation <https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html>`_. | ||
|
|
||
| 链接: | ||
| ~~~~~ | ||
| links: | ||
| ~~~~~~~ | ||
|
|
||
| * `usb_stream 组件 <https://components.espressif.com/components/espressif/usb_stream>`_ | ||
| * `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_ | ||
| * `USB Camera Demo 视频 <https://www.bilibili.com/video/BV18841137qT>`_ | ||
| * 示例代码: USB 摄像头 + WiFi 图传 :example:`usb/host/usb_camera_mic_spk` | ||
| * 示例代码: USB 摄像头 + LCD 本地刷屏 :example:`usb/host/usb_camera_lcd_display` | ||
| * `usb_stream component <https://components.espressif.com/components/espressif/usb_stream>`_ | ||
| * `usb_stream API reference <https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html>`_ | ||
| * `USB Camera Demo video <https://www.bilibili.com/video/BV18841137qT>`_ | ||
| * Example Code: USB Camera + WiFi Image Transmission: :example:`usb/host/usb_camera_mic_spk` | ||
| * Example Code: USB Camera + Local Screen Display with LCD: :example:`usb/host/usb_camera_lcd_display` | ||
|
|
||
|
|
||
| ESP USB Audio 音频方案 | ||
| ^^^^^^^^^^^^^^^^^^^^^^ | ||
| ESP USB Audio Solution | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 支持通过 USB 接口连接 USB 音频设备，实现 PCM 格式音频流获取和传输，可同时支持多路 48KHz 16bit 扬声器和多路 48KHz 16bit 马克风。支持 Type-C 接口耳机，适用于音频播放器等场景。支持和 UVC 同时工作，适用于门铃对讲等场景。 | ||
| Supports connecting USB audio devices through the USB interface, enabling PCM format audio stream acquisition and transmission. It can simultaneously support multiple channels of 48KHz 16bit speakers and multiple channels of 48KHz 16bit microphones. Also supports Type-C interface headphones, suitable for audio playback scenarios. It can operate simultaneously with UVC, making it suitable for scenarios such as doorbell intercoms. | ||
|
|
||
| 特性: | ||
| ~~~~~ | ||
| Features: | ||
| ~~~~~~~~~~ | ||
|
|
||
|
|
||
| * 快速启动 | ||
| * 支持热插拔 | ||
| * 支持自动解析描述符 | ||
| * 支持 PCM 音频流传输 | ||
| * 支持动态修改采样率 | ||
| * 支持多通道扬声器 | ||
| * 支持多通道麦克风 | ||
| * 支持音量、静音控制 | ||
| * 支持和 USB Camera 同时工作 | ||
| * Quick Start | ||
| * Hot Swap | ||
| * Automatic Parsing Descriptors | ||
| * PCM Audio Format | ||
| * Dynamic Modification of Sampling Rate | ||
| * Multi-Channel Speakers | ||
| * Multi-Channel Microphone | ||
| * Support Volume and Mute Control | ||
| * Support Simultaneous Work with USB Camera | ||
|
|
||
| 硬件: | ||
| ~~~~~ | ||
| Hardware: | ||
| ~~~~~~~~~~ | ||
|
|
||
| * 芯片： ESP32-S2，ESP32-S3 | ||
| * 外设：USB-OTG | ||
| * USB 音频设备：支持 PCM 格式 | ||
| * Chips: ESP32-S2, ESP32-S3 | ||
| * Peripherals: USB-OTG | ||
| * USB Audio Devices: Supports PCM format | ||
|
|
||
| 链接: | ||
| ~~~~~ | ||
| Links: | ||
| ~~~~~~~~ | ||
|
|
||
| * `usb_stream 组件 <https://components.espressif.com/components/espressif/usb_stream>`_ | ||
| * `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_ | ||
| * `USB Audio Demo 视频 <https://www.bilibili.com/video/BV1LP411975W>`_ | ||
| * 示例代码: MP3 音乐播放器 + USB 耳机 :example:`usb/host/usb_audio_player` | ||
| * `usb_stream components <https://components.espressif.com/components/espressif/usb_stream>`_ | ||
| * `usb_stream API reference <https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html>`_ | ||
| * `USB Audio Demo video <https://www.bilibili.com/video/BV1LP411975W>`_ | ||
| * Example Code: MP3 Music Player + USB Headphones: :example:`usb/host/usb_audio_player` | ||
|
|
||
| ESP USB 4G 联网方案 | ||
| ^^^^^^^^^^^^^^^^^^^ | ||
| ESP USB 4G Networking Solutions | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 支持通过 USB 接口连接 4G Cat.1，Cat.4 模组，实现 PPP 拨号上网。支持通过 Wi-Fi SoftAP 热点共享互联网给其它设备。适用于物联网网关、MiFi 移动热点、智慧储能、广告灯箱等场景。 | ||
| Supports connecting 4G Cat.1 or Cat.4 modules via the USB interface, enabling PPP dial-up for internet access. It also supports sharing the internet via Wi-Fi SoftAP hotspot for other devices. Suitable for IoT gateways, MiFi mobile hotspots, smart energy storage, advertising lightboxes, and other scenarios. | ||
|
|
||
| 特性: | ||
| ~~~~~ | ||
| Features: | ||
| ~~~~~~~~~~ | ||
|
|
||
| * 快速启动 | ||
| * 支持热插拔 | ||
| * 支持 Modem+AT 双接口（需要模组支持） | ||
| * 支持 PPP 标准协议 （大部分 4G 模组均支持） | ||
| * 支持 4G 转 Wi-Fi 热点 | ||
| * 支持 NAPT 网络地址转换 | ||
| * 支持电源管理 | ||
| * 支持网络自动恢复 | ||
| * 支持卡检测、信号质量检测 | ||
| * 支持网页配置界面 | ||
| * Quick Start | ||
| * Hot Plug | ||
| * Modem+AT Dual Interface | ||
| * PPP Standard Protocol | ||
| * 4G to Wi-Fi Hotspot Support | ||
| * NAPT (Network Address and Port Translation) Support | ||
| * Power Management Support | ||
| * Automatic Network Recovery | ||
| * SIM Card Detection and Signal Quality Monitoring | ||
| * Web-based Configuration Interface | ||
|
|
||
| 硬件: | ||
| ~~~~~ | ||
| Hardware: | ||
| ~~~~~~~~~~ | ||
|
|
||
| * 芯片： ESP32-S2，ESP32-S3 | ||
| * 外设：USB-OTG | ||
| * 4G 模组：支持 Cat.1 Cat.4 等网络制式 4G 模组，需要模组支持 PPP 协议 | ||
| * Chips: ESP32-S2, ESP32-S3 | ||
| * Peripherals: USB-OTG | ||
| * 4G Modules: Supports Cat.1, Cat.4, and other network standard 4G modules, requiring module support for the PPP protocol. | ||
|
|
||
| 链接: | ||
| ~~~~~ | ||
| Links: | ||
| ~~~~~~~ | ||
|
|
||
| * `USB 4G Demo 视频 <https://www.bilibili.com/video/BV1fj411K7bW>`_ | ||
| * `iot_usbh_modem 组件 <https://components.espressif.com/components/espressif/iot_usbh_modem>`_ | ||
| * 示例代码: 4G Wi-Fi 路由器 :example:`usb/host/usb_cdc_4g_module` | ||
| * `USB 4G Demo video <https://www.bilibili.com/video/BV1fj411K7bW>`_ | ||
| * `iot_usbh_modem component <https://components.espressif.com/components/espressif/iot_usbh_modem>`_ | ||
| * Example Code: 4G Wi-Fi Router: :example:`usb/host/usb_cdc_4g_module` | ||
|
|
||
| ESP USB 存储方案 | ||
| ^^^^^^^^^^^^^^^^ | ||
| ESP USB Storage Solution | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 支持通过 USB 接口连接标准 U 盘设备（兼容 USB3.1/3.0/2.0 协议 U 盘），支持将 U 盘挂载到 FatFS 文件系统，实现文件的读写。适用于户外广告灯牌、考勤机、移动音响、记录仪等应用场景。 | ||
| Supports connecting standard USB flash drives via the USB interface (compatible with USB 3.1/3.0/2.0 protocols), and can mount the USB flash drive to the FatFS file system for file read and write operations. Suitable for outdoor advertising billboards, attendance machines, mobile speakers, recorders, and other application scenarios. | ||
|
|
||
| 特性: | ||
| ~~~~~ | ||
| Features: | ||
| ~~~~~~~~~~ | ||
|
|
||
| * 兼容 USB3.1/3.0/2.0 U 盘 | ||
| * 默认支持最大 32G | ||
| * 支持热插拔 | ||
| * 支持 Fat32/exFat 格式 | ||
| * 支持文件系统读写 | ||
| * 支持 U 盘 OTA | ||
| * Compatible with USB 3.1/3.0/2.0 Flash Drives | ||
| * Default Support for Up to 32GB | ||
| * Hot Plug | ||
| * Support for Fat32/exFAT Formats | ||
| * File System Read and Write | ||
| * USB Flash Drive Over-The-Air (OTA) Update | ||
|
|
||
| 硬件: | ||
| ~~~~~ | ||
| Hardware: | ||
| ~~~~~~~~~~ | ||
|
|
||
| * 芯片： ESP32-S2，ESP32-S3 | ||
| * 外设：USB-OTG | ||
| * U 盘：格式化为 Fat32 格式，默认支持 32GB 以内 U 盘。大于 32GB 需要在文件系统开启 exFat | ||
| * Chips: ESP32-S2, ESP32-S3 | ||
| * Peripherals: USB-OTG | ||
| * USB Flash Drive: Formatted as Fat32 by default, with support for USB drives up to 32GB. Drives larger than 32GB require exFAT file system support. | ||
|
|
||
| 链接: | ||
| ~~~~~ | ||
| Links: | ||
| ~~~~~~~ | ||
|
|
||
| * `usb_host_msc 组件 <https://components.espressif.com/components/espressif/usb_host_msc>`_ | ||
| * `示例代码: 挂载 U 盘 + 文件系统访问 <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/usb/host/msc>`_ | ||
| * `usb_host_msc component <https://components.espressif.com/components/espressif/usb_host_msc>`_ | ||
| * Example Code: Mounting USB Flash Drive + File System Access `here <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/usb/host/msc>`_ |
Oops, something went wrong.