:mod:`esp_usb` ---  USB OTG
===============================================

.. module:: esp_usb
   :synopsis: USB OTG

这个模块用于USB OTG(目前仅支持ESP32_S2开发板)。

.. image:: https://docs.01studio.cc/data/picture/30W_USB_CAM.png
    :alt: 01Studio STM32 OV2640 Module picture
    :width: 700px

.. _esp_usb.CAM:

CAM 对象
--------------

CAM 类提供一个USB摄像头控制接口，通过构建该对象可以轻松实现USB摄像头的应用。 

示例::

    import esp_usb

    cam = esp_usb.CAM(framesize = esp_usb.CAM.QVGA) #构建摄像头对象。
    cam.snapshot('/test.jpg')  #拍照并保存
    cam.display()  #液晶屏实时显示摄像头图像


构造函数
------------

.. class:: CAM(framesize = esp_usb.CAM.QVGA) 

    构建一个USB摄像头对象。
	
	- ``framesize`` 帧尺寸大小，默认QVGA，320x240分辨率：
	
		- ``esp_usb.CAM.QQVGA`` - 160x120；		
		- ``esp_usb.CAM.QVGA`` - 320x240；
		- ``esp_usb.CAM.VGA`` -  640x480；	
	
使用方法
--------------

.. method:: CAM.snapshot(filename)

   拍摄照片并保存，支持格式 JPG：

	- ``filename`` 路径+名称，如："/flash/1.jpg"。(ESP32-S2路径格式:"/1.jpg")

.. method:: CAM.display()

   LCD实时显示摄像头采集图像。执行该函数需要初始化LCD。

.. method:: CAM.display_stop()

   关闭摄像头采集图像LCD实时显示。

.. method:: CAM.stream()

   摄像头网络图传。开发板联网后在同一局域网下的PC或手机浏览器输入开发板的IP地址即可（目前只支持ESP32-S3平台）。

.. method:: CAM.deinit()

   注销对象。