Skip to content

Commit af5910d

Browse files
committed
add USB 2.0 webcam warning to uvc and configuring-external-webcam pages
1 parent a1897d2 commit af5910d

File tree

4 files changed

+45
-17
lines changed

4 files changed

+45
-17
lines changed

docs/source/control_hard_compon/rc_components/hub/ports/ch-ports.rst

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,24 @@ Control Hub Ports
1414

1515
Control Hub Front Ports
1616

17+
USB Ports
18+
---------
1719

18-
USB 2.0 Port
19-
------------
20+
Universal Serial Bus (USB) is an industry standard that allows data exchange and delivery of power between many types of electronics.
21+
The control hub has four USB ports described below.
2022

21-
This is a female USB A port that can be used for connecting USB devices as allowed for in the Competition Manual.
23+
USB 2.0 and USB 3.0 refer to the USB specifications that relate to data exchange rate and power delivery.
24+
25+
USB Type-A and USB-C and USB Mini-B refer to the type of connector.
26+
27+
- USB Type-A is a larger rectangular connector.
28+
- USB-C is a smaller oval connector.
29+
- USB Mini-B is a smaller rectagular connector with a beveled edge.
30+
31+
USB 2.0
32+
^^^^^^^
33+
34+
This is a female USB Type-A port that implements USB 2.0 and can be used for connecting USB devices as allowed for in the Competition Manual.
2235

2336
.. warning:: An ESD event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
2437

@@ -28,20 +41,21 @@ This is a female USB A port that can be used for connecting USB devices as allow
2841
Using the USB 2.0 Port may cause ESD to affect your Control Hub's Wi-Fi Chip (causing Wi-Fi disconnects with the driver hub).
2942
Ensure that you plug USB devices, such as a Camera, into the USB 3.0 Port on your Control Hub.
3043

31-
USB 3.0 Port
44+
USB 3.0
45+
^^^^^^^
3246

33-
This is a female USB A port that is primarily used for connecting USB video device class (UVC) cameras (webcams).
47+
This is a female USB Type-A port that implements USB 3.0 and is primarily used for connecting USB video device class (UVC) cameras (webcams).
3448

35-
USB-C Port
36-
----------
49+
USB C
50+
^^^^^
3751

38-
A Control Hub has a USB-C port. This is primarily used for connecting to a
52+
A Control Hub has a female USB-C port that implements USB 2.0. This is primarily used for connecting to a
3953
laptop for loading the SDK but can also be used with a UVC Camera.
4054

41-
Mini-USB Port
42-
-------------
55+
MINI USB
56+
^^^^^^^^
4357

44-
This is a female USB Mini-B port is used only to communicate directly to
58+
This is a female USB Mini-B port that implements USB 2.0. Iis used only to communicate directly to
4559
the I/O system. In this case, it is only for the purpose of uploading firmware
4660
to the device.
4761

@@ -52,7 +66,7 @@ The Control Hub lacks a display of its own even though it is a fully-fledged
5266
Android device. The Control Hub has an HDMI port that provides video output for
5367
the device; this HDMI port can be used to connect to an external display.
5468

55-
Micro SD
69+
MICRO SD
5670
--------
5771

58-
This is a port for a Micro SD memory card. It is not normally used.
72+
This is a port for a Micro SD memory card. It is not normally used.
271 KB
Loading

docs/source/control_hard_compon/rc_components/uvc/uvc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ Additional Resources
5252

5353
- :ref:`Connecting UVC Camera via Powered USB Hub <hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera:configuring an external uvc camera and a powered usb hub>`
5454
- :ref:`Connecting UVC Camera directly to REV Control Hub <hardware_and_software_configuration/configuring/configuring_external_webcam/configuring-external-webcam:configuring an external webcam with a control hub>`
55-
- :ref:`USB Port Overview <control_hard_compon/rc_components/hub/ports/ch-ports:USB-A Ports>`
55+
- :ref:`USB Port Overview <control_hard_compon/rc_components/hub/ports/ch-ports:USB Ports>`
5656
- :ref:`Vision in FIRST Tech Challenge <programming_resources/index:vision programming>`

docs/source/hardware_and_software_configuration/configuring/configuring_external_webcam/configuring-external-webcam.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,20 @@ for an online copy of the file).
3939
Connecting the Camera
4040
---------------------
4141

42-
The UVC camera plugs directly into the USB 2.0 port on the REV Control
42+
The UVC camera can plug directly into the USB 3.0 port on the REV Control
4343
Hub. Unlike the REV Expansion Hub, there is no need for an external
4444
powered USB hub.
4545

4646
.. image:: images/USB-camera-Control-Hub.jpg
47+
:alt: Control Hub with UVC camera connected.
48+
49+
.. warning:: An ESD event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
50+
51+
The REV Control Hub has a
52+
`known ESD issue <https://docs.revrobotics.com/duo-control/troubleshooting-the-control-system/troubleshooting-the-control-system#esd-mitigation-techniques>`_
53+
with devices plugged into the USB 2.0 port.
54+
Using the USB 2.0 Port may cause ESD to affect your Control Hub's Wi-Fi Chip (causing Wi-Fi disconnects with the driver hub).
55+
Ensure that you plug USB devices, such as a Camera, into the USB 3.0 Port on your Control Hub.
4756

4857
Camera Configuration
4958
--------------------
@@ -58,6 +67,7 @@ activity should detect the webcam and give it a default name of “Webcam
5867
1”.
5968

6069
.. image:: images/webcam-config-CH.jpg
70+
:alt: Screen shot showing the Scan button circled in yellow and the resulting USB device listed as Webcam 1.
6171

6272
You can keep this default name (the sample Op Modes reference this name)
6373
or change it. If you change the webcam name, make sure your Op Modes
@@ -95,12 +105,14 @@ at this time, during which the game pads and START button are disabled
95105
for safety.
96106

97107
.. image:: images/DS-webcam-preview-CH-1.jpg
108+
:alt: Driver Station screen shot showing the menu with the Camera Stream option circled in yellow.
98109

99110
The camera image will appear on the DRIVER STATION screen. Manually
100111
touch the image to refresh it. To preserve bandwidth, only one frame is
101112
sent at a time.
102113

103114
.. image:: images/DS-webcam-preview-CH-2.jpg
115+
:alt: Driver Station screen shot showing the camera image.
104116

105117
This option may be used to adjust the camera, with frequent manual image
106118
refreshing as needed. When finished, open the main menu and select
@@ -109,13 +121,14 @@ close, the game pads will be enabled, and the START button may be
109121
pressed to continue running the Op Mode.
110122

111123
.. image:: images/DS-webcam-preview-CH-3.jpg
124+
:alt: Driver Station screen shot showing the menu with the Camera Stream option circled in yellow.
112125

113126
**Important Note:** Because the Camera Stream feature is only available
114127
during the INIT phase of an Op Mode, you must ensure that the VisionPortal
115128
is activated in your Op Mode **before** the waitForStart command:
116129

117130
.. image:: images/activateBeforeWaitForStart.png
118-
:alt: The init code for the webcam must be called before waitForStart.
131+
:alt: Blocks code showing the INIT code for the webcam is called before wait for start.
119132

120133
If you do not see the Camera Stream option in your main menu on your
121134
DRIVER STATION, then verify that the VisionPortal is activated
@@ -136,7 +149,7 @@ Once connected, use `these instructions <https://github.com/Genymobile/scrcpy?ta
136149
to install and run scrcpy on your computer.
137150

138151
.. image:: images/webcamWithScrcpy.jpg
139-
:alt: The camera output viewed with scrcpy.
152+
:alt: Screen shot showing the camera output viewed with scrcpy.
140153

141154
**Important Note:** While scrcpy is a great way to view the camera output
142155
outside of competitions, the Competition Manual does not allow teams to
@@ -150,6 +163,7 @@ Alternatively, camera output can be viewed on a display monitor or other
150163
device plugged into the HDMI port on the REV Control Hub.
151164

152165
.. image:: images/HDMIMonitor.jpg
166+
:alt: Photo showing an external HDMI monitor displaying the camera output from a connected control hub.
153167

154168
**Important Note:** While a portable display monitor can be used to view
155169
or troubleshoot the camera stream on your Control Hub, teams are not

0 commit comments

Comments
 (0)