Merge branch 'feat/add_usb_uvc_example' into 'master'

feat(usb_uvc): add a example support open two usb cam with hub

See merge request ae_group/esp-iot-solution!1197

Author: lijunru-hub

.gitlab/ci/build.yml

@@ -933,6 +933,16 @@ build_example_usb_host_usb_cdc_basic:
   variables:
     EXAMPLE_DIR: examples/usb/host/usb_cdc_basic
 
+build_example_usb_host_usb_hub_dual_camera:
+  extends:
+    - .build_examples_template
+    - .rules:build:example_usb_host_usb_hub_dual_camera
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v5.4
+  variables:
+    EXAMPLE_DIR: examples/usb/host/usb_hub_dual_camera
+
 build_example_usb_host_usb_msc_ota:
   extends:
     - .build_examples_template

.gitlab/ci/deploy.yml

@@ -131,6 +131,7 @@ pack-upload_files:
     - job: "build_example_usb_host_usb_camera_mic_spk: [espressif/idf:release-v5.1]"
     - job: "build_example_usb_host_usb_cdc_4g_module: [espressif/idf:release-v5.1]"
     - job: "build_example_usb_host_usb_cdc_basic: [espressif/idf:release-v5.1]"
+    - job: "build_example_usb_host_usb_hub_dual_camera: [espressif/idf:release-v5.4]"
     - job: "build_example_usb_host_usb_msc_ota: [espressif/idf:release-v5.1]"
     - job: "build_example_vision_opencv_color_tracker: [espressif/idf:release-v5.4]"
 

.gitlab/ci/rules.yml

@@ -612,6 +612,9 @@
 .patterns-example_usb_host_usb_cdc_basic: &patterns-example_usb_host_usb_cdc_basic
   - "examples/usb/host/usb_cdc_basic/**/*"
 
+.patterns-example_usb_host_usb_hub_dual_camera: &patterns-example_usb_host_usb_hub_dual_camera
+  - "examples/usb/host/usb_hub_dual_camera/**/*"
+
 .patterns-example_usb_host_usb_msc_ota: &patterns-example_usb_host_usb_msc_ota
   - "examples/usb/host/usb_msc_ota/**/*"
 
@@ -1551,6 +1554,16 @@
     - <<: *if-dev-push
       changes: *patterns-example_usb_host_usb_cdc_basic
 
+.rules:build:example_usb_host_usb_hub_dual_camera:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-trigger-job
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-example_usb_host_usb_hub_dual_camera
+
 .rules:build:example_usb_host_usb_msc_ota:
   rules:
     - <<: *if-protected

.pre-commit-config.yaml

@@ -93,4 +93,4 @@ repos:
     rev: v2.3.0
     hooks:
     - id: codespell
-      args: [-w, "--ignore-words=codespell-ignore-list"]
+      args: [-w, "--ignore-words=codespell-ignore-list", "--skip=*.js,*.vue,*/pnpm-lock.yaml,*/package-lock.json,*/yarn.lock"]

examples/.build-rules.yml

@@ -408,6 +408,10 @@ examples/usb/host/usb_cdc_basic:
   enable:
     - if: IDF_TARGET in ["esp32s2","esp32s3"]
 
+examples/usb/host/usb_hub_dual_camera:
+  enable:
+    - if: IDF_TARGET in ["esp32s2", "esp32s3","esp32p4"]
+
 examples/usb/host/usb_msc_ota:
   enable:
     - if: SOC_USB_OTG_SUPPORTED == 1

examples/usb/host/usb_hub_dual_camera/CMakeLists.txt

@@ -0,0 +1,6 @@
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(usb_hub_dual_camera)

examples/usb/host/usb_hub_dual_camera/README.md

@@ -0,0 +1,80 @@
+# USB Hub Dual Camera Example
+
+This example demonstrates how to use the [usb_host_uvc](https://components.espressif.com/components/espressif/usb_host_uvc) component to connect USB cameras and preview camera images via an HTTP server.
+
+* Supports previewing MJPEG format images only.
+* Supports USB Hub, allowing up to two cameras to be connected.
+* Web interface allows saving the current frame.
+
+## How to Use
+
+### Hardware Requirements
+
+* Development Board
+
+    Any `ESP32-S2`, `ESP32-S3`, or `ESP32-P4` development board.
+
+    By default, the ESP32-P4 uses the [ESP32-P4-Function-EV-Board](https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32p4/esp32-p4-function-ev-board/user_guide.html#getting-started) development board.
+
+* Connection
+
+    |             | USB_DP | USB_DM |
+    | ----------- | ------ | ------ |
+    | ESP32-S2/S3 | GPIO20 | GPIO19 |
+    | ESP32-P4    | GPIO50 | GPIO49 |
+
+### Build and Flash
+
+Build the project and flash it to the board, then run the monitor tool to view the serial output:
+
+* Run `. ./export.sh` to set IDF environment
+* Run `idf.py set-target esp32s3` to set target chip
+* Run `pip install "idf-component-manager~=2.1.0"` to upgrade your component manager if any error happens during last step
+* Run `idf.py -p PORT flash monitor` to build, flash and monitor the project
+
+(To exit the serial monitor, type `Ctrl-]`.)
+
+See the Getting Started Guide for all the steps to configure and use the ESP-IDF to build projects.
+
+### Preview camera image
+
+* Connect with ESP32S2 through Wi-Fi, SSID: `ESP-USB-UVC-Demo` with no password by default.
+
+* Input `192.168.4.1` in your browser,  you can find a file list of the disk.
+
+Note: Safari browser is not recommended.
+
+![demo](https://dl.espressif.com/AE/esp-iot-solution/uvc_dual_hub_camera_1.gif)
+
+<p align="center">
+  <img src="https://dl.espressif.com/AE/esp-iot-solution/uvc_dual_hub_camera_2.gif" alt="demo2">
+</p>
+
+### Frontend Source Files
+
+Please refer to the [frontend source files](./frontend_source).
+
+## Example Output
+
+```
+I (4108) main_task: Returned from app_main()
+W (31940) uvc: USB device with addr(1) is not UVC device
+I (32025) uvc: Device connected
+I (32026) uvc: Cam[0] uvc_stream_index = 0
+I (32026) uvc: Pick Cam[0] FORMAT_MJPEG 1280*[email protected]
+I (32026) uvc: Pick Cam[0] FORMAT_MJPEG 800*[email protected]
+I (32031) uvc: Pick Cam[0] FORMAT_MJPEG 640*[email protected]
+I (32036) uvc: Pick Cam[0] FORMAT_MJPEG 480*[email protected]
+I (32041) uvc: Pick Cam[0] FORMAT_MJPEG 320*[email protected]
+I (32109) uvc: Device connected
+I (32110) uvc: Cam[1] uvc_stream_index = 0
+I (32110) uvc: Pick Cam[1] FORMAT_MJPEG 1280*[email protected]
+I (32110) uvc: Pick Cam[1] FORMAT_MJPEG 800*[email protected]
+I (32115) uvc: Pick Cam[1] FORMAT_MJPEG 640*[email protected]
+I (32120) uvc: Pick Cam[1] FORMAT_MJPEG 480*[email protected]
+I (32125) uvc: Pick Cam[1] FORMAT_MJPEG 320*[email protected]
+I (32246) uvc: Opening the UVC[0]...
+I (32246) uvc: frame_size.advanced.frame_size: 40000
+I (32330) uvc: Opening the UVC[1]...
+I (32330) uvc: frame_size.advanced.frame_size: 40000
+```

examples/usb/host/usb_hub_dual_camera/frontend_source/.browserslistrc

@@ -0,0 +1,4 @@
+> 1%
+last 2 versions
+not dead
+not ie 11

examples/usb/host/usb_hub_dual_camera/frontend_source/.eslintrc-auto-import.json

@@ -0,0 +1,76 @@
+{
+  "globals": {
+    "Component": true,
+    "ComponentPublicInstance": true,
+    "ComputedRef": true,
+    "EffectScope": true,
+    "ExtractDefaultPropTypes": true,
+    "ExtractPropTypes": true,
+    "ExtractPublicPropTypes": true,
+    "InjectionKey": true,
+    "PropType": true,
+    "Ref": true,
+    "VNode": true,
+    "WritableComputedRef": true,
+    "computed": true,
+    "createApp": true,
+    "customRef": true,
+    "defineAsyncComponent": true,
+    "defineComponent": true,
+    "effectScope": true,
+    "getCurrentInstance": true,
+    "getCurrentScope": true,
+    "h": true,
+    "inject": true,
+    "isProxy": true,
+    "isReactive": true,
+    "isReadonly": true,
+    "isRef": true,
+    "markRaw": true,
+    "nextTick": true,
+    "onActivated": true,
+    "onBeforeMount": true,
+    "onBeforeUnmount": true,
+    "onBeforeUpdate": true,
+    "onDeactivated": true,
+    "onErrorCaptured": true,
+    "onMounted": true,
+    "onRenderTracked": true,
+    "onRenderTriggered": true,
+    "onScopeDispose": true,
+    "onServerPrefetch": true,
+    "onUnmounted": true,
+    "onUpdated": true,
+    "provide": true,
+    "reactive": true,
+    "readonly": true,
+    "ref": true,
+    "resolveComponent": true,
+    "shallowReactive": true,
+    "shallowReadonly": true,
+    "shallowRef": true,
+    "toRaw": true,
+    "toRef": true,
+    "toRefs": true,
+    "toValue": true,
+    "triggerRef": true,
+    "unref": true,
+    "useAttrs": true,
+    "useCssModule": true,
+    "useCssVars": true,
+    "useRoute": true,
+    "useRouter": true,
+    "useSlots": true,
+    "watch": true,
+    "watchEffect": true,
+    "watchPostEffect": true,
+    "watchSyncEffect": true,
+    "DirectiveBinding": true,
+    "MaybeRef": true,
+    "MaybeRefOrGetter": true,
+    "onWatcherCleanup": true,
+    "useId": true,
+    "useModel": true,
+    "useTemplateRef": true
+  }
+}

examples/usb/host/usb_hub_dual_camera/frontend_source/.gitignore

@@ -0,0 +1,22 @@
+.DS_Store
+node_modules
+/dist
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?