Add List of VisionPortal Supported Webcams

docs/source/apriltag/vision_portal/visionportal_webcams/visionportal-webcams.rst

@@ -0,0 +1,208 @@
+Webcams for Vision Portal
+=========================
+
+This is a short list of common webcams that are known to work with the
+:ref:`FTC VisionPortal <apriltag/vision_portal/visionportal_overview/visionportal-overview:visionportal overview>`
+and the 
+:ref:`FTC Camera Controls <apriltag/vision_portal/visionportal_camera_controls/visionportal-camera-controls:visionportal camera controls>`.
+
+VisionPortal is a comprehensive new interface for FTC vision processing,
+including AprilTag and TensorFlow Object Detection (TFOD).
+
+Many more webcams can work with the FTC VisionPortal; this is a short
+list of models with built-in calibrations suitable for AprilTag 
+:ref:`pose estimation <apriltag/vision_portal/apriltag_pose/apriltag-pose:aprilTag pose>`.
+
+Logitech C270
+-------------
+
+.. figure:: images/010-C270.png
+   :align: center
+   :width: 55%
+   :alt: C270 Camera
+
+   Logitech C270 Camera
+
+The `Logitech C270 <https://www.logitech.com/en-us/products/webcams/c270-hd-webcam.960-000694.html>`__
+is available at the FIRST Storefront for new FTC teams, and at many
+online retailers.
+
+**Supported Resolutions:** 160x120, 176x144, 320x176, 320x240, 352x288,
+432x240, 544x288, 640x360, 640x480, 752x416, 800x448, 800x600, 864x480,
+960x544, 960x720, 1024x576, 1184x656, 1280x720
+
+The FTC SDK provides **built-in calibration values** for the FTC
+VisionPortal default resolution of 640x480, and no others. Learn more at
+:ref:`AprilTag Camera Calibration <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+
+
+Logitech C920
+-------------
+
+.. figure:: images/020-C920.png
+   :align: center
+   :width: 55%
+   :alt: C920 Camera
+
+   Logitech C920 Camera
+
+The `Logitech C920 <https://www.logitech.com/en-us/products/webcams/c920s-pro-hd-webcam.960-001257.html>`__
+is available at many online retailers.
+
+**Supported Resolutions:** 160x90, 160x120, 176x144, 320x180, 320x240,
+352x288, 432x240, 640x360, 640x480, 800x448, 800x600, 864x480, 960x720,
+1024x576, 1280x720, 1600x896, 1920x1080, 2304x1296, 2304x1536.
+
+The FTC SDK provides **built-in calibration values** for the FTC
+VisionPortal default resolution of 640x480, and five others: 640x360,
+800x448, 800x600, 864x480, and 1920x1080. Learn more at
+:ref:`AprilTag Camera Calibration <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+
+Logitech C310
+-------------
+
+.. figure:: images/030-C310.png
+   :align: center
+   :width: 55%
+   :alt: C310 Camera
+
+   Logitech C310 Camera
+
+The `Logitech C310 <https://www.logitech.com/en-us/products/webcams/c310-hd-webcam.960-000585.html>`__
+is available at some online retailers.
+
+**Supported Resolutions:** not published; probably similar to Logitech C270.
+
+The FTC SDK provides **built-in calibration values** for the FTC
+VisionPortal default resolution of 640x480, and for 640x360. Learn more at
+:ref:`AprilTag Camera Calibration <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+
+Microsoft LifeCam HD-3000 v1/v2
+-------------------------------
+
+.. figure:: images/040-LifeCam-3000.png
+   :align: center
+   :width: 55%
+   :alt: LifeCam-3000 Camera
+
+   Microsoft LifeCam HD-3000 v1/v2
+
+The `Microsoft LifeCam HD-3000 <https://www.microsoft.com/en/accessories/products/webcams/lifecam-hd-3000>`__
+is available at some online retailers.
+
+**Supported Resolutions:** not published; up to 1280x720.
+
+For v1 and v2 of this webcam, the FTC SDK provides **built-in
+calibration values** for the FTC VisionPortal default resolution of
+640x480, and no others. Learn more at
+:ref:`AprilTag Camera Calibration <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+
+Other Webcams
+-------------
+
+Many other webcams are available online, with and without published `UVC
+compatibility <https://en.wikipedia.org/wiki/List_of_USB_video_class_devices>`__.
+The FTC SDK supports **only** UVC compatible webcams. Many modern
+webcams are UVC compatible without specifically advertising it; often
+indicated by “no drivers needed”.
+
+In general, other webcams (not listed above) will require user-provided
+:ref:`Camera Calibration Values <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+for AprilTag 
+:ref:`pose estimation <apriltag/vision_portal/apriltag_pose/apriltag-pose:apriltag pose>`.
+
+A digital camera opens its shutter to allow light (“the image”) to reach
+the detector’s array of small sensors (pixels). (Webcam shutters are
+typically electronic, not mechanical.) Most webcams use a **“rolling
+shutter”**, where the the image data is read **one pixel row at a
+time**.
+
+Another type of webcam, called **“global shutter”**, reads all pixels at
+the same time. This can help when the webcam (robot) is moving fast.
+Teams are encouraged to research the characteristics of rolling shutter
+vs. global shutter.
+
+One difference is that many global shutter cameras use a compressed
+video format called **MJPEG**. This saves bandwidth, to offset a higher
+frame rate (frames per second or FPS). The FTC VisionPortal uses a
+default (uncompressed) video format called **YUY2**, but does allow
+specifying MJPEG.
+
+Below is one example of a global shutter webcam, tested to work with the
+FTC VisionPortal.
+
+Arducam Global Shutter 120 FPS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: images/050-Arducam.png
+   :align: center
+   :width: 55%
+   :alt: Arducam GS 120 Camera
+
+   Arducam GS 120 Camera
+
+The `Arducam Global Shutter 120
+FPS <https://www.arducam.com/product/arducam-120fps-global-shutter-usb-camera-board-1mp-720p-ov9281-uvc-webcam-module-with-low-distortion-m12-lens-without-microphones-for-computer-laptop-android-device-and-raspberry-pi/>`__
+is available at some online retailers, including
+`Amazon <https://www.amazon.com/Arducam-Distortion-Microphones-Computer-Raspberry/dp/B096M5DKY6>`__.
+
+**Supported Resolutions** in YUY2 format: 1280x720, 1280x800. Note frame
+rate limitations.
+
+**Supported Resolutions** in MJPEG format: 320x240, 640x480, 800x600,
+1280x720, 1280x800.
+
+The FTC SDK provides **no** built-in calibration values for this webcam.
+Learn more at
+:ref:`AprilTag Camera Calibration <apriltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration:apriltag camera calibration>`.
+
+Other Global Shutter Cameras
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Two other tested global shutter webcams (offering different resolutions
+than the Arducam) are from
+
+* `Kayeton <https://www.aliexpress.us/item/3256804287066234.html>`__ 
+* `ELP <https://www.aliexpress.us/item/2251832829079715.html>`__ 
+
+both of these are available from AliExpress and other online retailers.
+
+Quick Summary
+-------------
+
+This below table summarizes the most common and known-supported cameras with
+the *FIRST* Tech Challenge SDK, including resolutions with built-in
+calibrations and those without calibrations.
+
+.. list-table:: Cameras and Supported Resolutions
+   :widths: 33 33 33
+   :header-rows: 1
+
+   * - Camera
+     - Resolutions with Built-In Calibrations
+     - Resolutions without Calibrations
+   * - `Logitech C270`_
+     - 640x480
+     - 160x120, 176x144, 320x176, 320x240, 352x288, 432x240, 544x288, 640x360, 752x416, 800x448, 800x600, 864x480, 960x544, 960x720, 1024x576, 1184x656, 1280x720
+   * - `Logitech C920`_
+     - 640x480, 640x360, 800x448, 800x600, 864x480, 1920x1080
+     - 160x90, 160x120, 176x144, 320x180, 320x240, 352x288, 432x240, 960x720, 1024x576, 1280x720, 1600x896, 2304x1296, 2304x1536
+   * - `Logitech C310`_
+     - 640x480, 640x360
+     - All other resolutions
+   * - `Microsoft LifeCam HD-3000 v1/v2`_
+     - 640x480
+     - All other resolutions
+   * - `Arducam Global Shutter 120 FPS`_
+     - No Built-In Calibrations
+     - MJPEG: 320x240, 640x480, 800x600, 1280x720, 1280x800; YUY2: 1280x720, 1280x800
+   * - Kayeton Global Shutter (`Other Global Shutter Cameras`_)
+     - No Built-In Calibrations
+     - All resolutions
+   * - ELP Global Shutter (`Other Global Shutter Cameras`_)
+     - No Built-In Calibrations
+     - All resolutions
+
+============
+
+Questions, comments and corrections to [email protected]

docs/source/index.rst

@@ -78,6 +78,7 @@ to see why.
 
    AprilTag Introduction </apriltag/vision_portal/apriltag_intro/apriltag-intro>
    VisionPortal Overview </apriltag/vision_portal/visionportal_overview/visionportal-overview>
+   Webcams for VisionPortal </apriltag/vision_portal/visionportal_webcams/visionportal-webcams>
    Understanding AprilTag Values </apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values>
    AprilTag Test Images </apriltag/opmode_test_images/opmode-test-images>