Skip to content

Commit 491c958

Browse files
committed
adjust some images, acronyms and other formatting to stop images being too big or stretched in PDF format
1 parent 2577ef8 commit 491c958

File tree

8 files changed

+42
-25
lines changed

8 files changed

+42
-25
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Control Hub Ports
22
=================
33

44
.. figure:: images/CH-HUB.png
5+
:align: center
56
:alt: REV Control Hub
67

78
Part number REV-31-1595
@@ -10,6 +11,7 @@ Control Hub Ports
1011

1112

1213
.. figure:: images/CH-HUB-FRONT.png
14+
:align: center
1315
:alt: The ports from left to right are: USB 2.0, USB 3.0, USB C, USB Mini (below the USB C port), HDMI, and Micro SD.
1416

1517
Control Hub Front Ports
@@ -33,7 +35,7 @@ USB 2.0
3335

3436
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.
3537

36-
.. warning:: An ESD event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
38+
.. warning:: An electrostatic discharge (ESD) event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
3739

3840
The REV Control Hub has a
3941
`known ESD issue <https://docs.revrobotics.com/duo-control/troubleshooting-the-control-system/troubleshooting-the-control-system#esd-mitigation-techniques>`_
@@ -62,7 +64,7 @@ to the device.
6264
HDMI
6365
-----
6466

65-
The Control Hub lacks a display of its own even though it is an
67+
The Control Hub lacks a display of its own even though it is a fully-fledged
6668
Android device. The Control Hub has an HDMI port that provides video output for
6769
the device; this HDMI port can be used to connect to an external display.
6870

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ compatible camera. This device can be connected directly to
88
the REV Control Hub or to the Robot Control system via a USB hub.
99

1010
.. figure:: images/C270.jpg
11-
:width: 25%
11+
:width: 33%
12+
:align: center
1213
:class: no-scaled-link
1314
:alt: Example UVC camera
1415

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Introduction
55
------------
66

77
The Competition Manual allows the use of USB Video Class (UVC) compatible
8-
cameras for computer vision-related tasks. See rule R715 for the full details.
8+
cameras for computer vision-related tasks.
99
If you are using a REV Robotics Control Hub, then
1010
you will need to use an external webcam, since the Control Hub does not
1111
include a built-in camera. This document describes how to connect,
@@ -46,7 +46,7 @@ powered USB hub.
4646
.. image:: images/USB-camera-Control-Hub.jpg
4747
:alt: Control Hub with UVC camera connected.
4848

49-
.. warning:: An ESD event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
49+
.. warning:: An electrostatic discharge (ESD) event on the USB 2.0 port on the Control Hub can cause Wi-Fi disconnects.
5050

5151
The REV Control Hub has a
5252
`known ESD issue <https://docs.revrobotics.com/duo-control/troubleshooting-the-control-system/troubleshooting-the-control-system#esd-mitigation-techniques>`_
@@ -156,7 +156,7 @@ to install and run scrcpy on your computer.
156156
**Important Note:** While scrcpy is a great way to view the camera output
157157
outside of competitions, the Competition Manual does not allow teams to
158158
have any devices other than the DRIVER STATION connected to your Control
159-
Hub during a match. See rule R708 for the full details.
159+
Hub during a match.
160160

161161
External HDMI Monitor
162162
---------------------
@@ -199,7 +199,7 @@ This device has its own processor on board and one drawback of this is that the
199199
By adding a powered USB hub the Limelight will not drain your robot's battery.
200200

201201
One suitable powered USB hub is the Acer ODK350 5-IN-1 USB 3.0 Hub.
202-
It provides USB 3.0 data speeds to all ports and it has a USB C port that can supply power to all connected devices.
202+
It has a USB C port that can supply power to all connected devices.
203203

204204
.. note:: At the time this was written, the Acer ODK350 hub was not listed on Acer's website, but was available on Amazon's website.
205205

docs/source/hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Introduction
55
------------
66

77
The Competition Manual allows the use of USB Video Class (UVC) compatible
8-
cameras for computer vision-related tasks. See rule R715 for the full details.
8+
cameras for computer vision-related tasks.
99
Teams who are using an Android smartphone as their ROBOT CONTROLLER have the
1010
option of using an externally connected camera instead of the built-in camera
1111
for computer vision tasks.
@@ -23,7 +23,7 @@ run properly.
2323
What type of External Camera can be Used?
2424
-----------------------------------------
2525

26-
The system supports a UVC cameras.
26+
The system supports UVC cameras.
2727
Theoretically, if a camera is UVC compliant, then it should work with
2828
the system. However, there are a couple of recommended web cameras that
2929
have been tested with the *FIRST* Tech Challenge software and have been
@@ -66,12 +66,12 @@ used for this task since its data transfer speed is not fast enough to
6666
work with the USB-connected webcam.
6767

6868
Also note that the Competition Manual permits the use of a powered USB
69-
hub to make this connection. See rule R617 for the full details. If a
69+
hub to make this connection. If a
7070
team uses a powered USB hub, the power to operate the USB hub can only
7171
come from either of the following sources:
7272

73-
1. An externally connected COTS USB Battery Pack in compliance with the
74-
Competition Manual. See rule R602 for the full details.
73+
1. An externally connected commercially available off-the-shelf (COTS) USB Battery Pack in compliance with the
74+
Competition Manual.
7575
2. The 5V DC Aux power port of a REV Robotics Expansion Hub (note that
7676
this requires advanced skills to implement).
7777

-123 KB
Loading
-15.6 KB
Loading
-28.5 KB
Loading

docs/source/hardware_and_software_configuration/configuring/managing_esd/managing-esd.rst

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ or oppositely charged object.
3939

4040
.. figure:: images/positivelyChargedRobot.png
4141
:alt: A positively charged robot touching a neutral field wall.
42-
42+
:align: center
43+
4344
Example of an ESD event, current will flow from the robot to the field wall.
4445

4546
How Robots Become Charged
@@ -55,7 +56,8 @@ is called the triboelectric effect.
5556

5657
.. figure:: images/triboelectric.png
5758
:alt: Illustration of a wheel on a floor with a close up portion showing how electrons in the floor can become attached to the wheel.
58-
59+
:align: center
60+
5961
Robots become charged due to the triboelectric effect.
6062

6163
A robot’s wheels moving on field tiles build charge on the robot frame just
@@ -92,7 +94,8 @@ electrostatic arcs.
9294

9395
.. figure:: images/discharging.png
9496
:alt: Illustration showing two circles and the current flow from positive to negative.
95-
97+
:align: center
98+
9699
Electric arc between two spheres of opposite charge.
97100

98101
What Steps can be Taken to Mitigate the Risk of an ESD Disruption?
@@ -107,8 +110,9 @@ anti-static spray. Anti-static spray increases electrical conductivity
107110
of the surface of the tiles. This helps prevent the build-up of
108111
electrostatic charge on the robots as the move across the tile floor.
109112

110-
.. figure:: images/heavydutystaticide.jpg
113+
.. image:: images/heavydutystaticide.jpg
111114
:alt: A gallon jug and a quart spray bottle of ACL Heavy Duty Staticide.
115+
:align: center
112116

113117
*FIRST* recommends the use of `ACL Heavy Duty
114118
Staticide <https://www.aclstaticide.com/products/heavy-duty-staticide>`__
@@ -131,6 +135,7 @@ a shock.
131135

132136
.. image:: images/ferritechoke.jpg
133137
:alt: A snap-on ferrite choke.
138+
:align: center
134139

135140
Using ferrite chokes can be a very effective method for mitigating the
136141
effects of ESD:
@@ -167,6 +172,7 @@ and strain relieving.
167172

168173
.. figure:: images/mountonplywood.jpg
169174
:alt: An expansion hub mounted on a plywood sheet.
175+
:align: center
170176

171177
The plywood sheet has holes drilled in it and wires are secured with cable ties to the plywood.
172178

@@ -178,8 +184,9 @@ are poorly insulated. If these parts are placed too close to the metal
178184
frame, a shock can occur if a charge accumulates on the frame.
179185

180186
.. figure:: images/poorlyinsulated.jpg
181-
:alt: A sensor with 4-wire connector and a servo wire extension connection.
182-
187+
:alt: A sensor with 4-wire connector and a servo wire extension connection, the 4-wire connector and extension connection are are circled in red.
188+
:align: center
189+
183190
Electrostatic shocks can occur at poorly insulated or exposed portions
184191
of the electronics.
185192

@@ -189,7 +196,7 @@ charge accumulates on the metal frame of the robot, and the end of
189196
sensor cable is placed close to the frame, a shock can occur and this
190197
shock can disrupt or even damage the I2C port of an Expansion Hub.
191198

192-
Similarly, some servo extension cables (see figure above) have exposed
199+
Similarly, some servo extension cables have exposed
193200
portions of metal that could be vulnerable to ESD unless properly
194201
isolated or insulated.
195202

@@ -198,15 +205,17 @@ frame (with an air gap greater than 3/8” or 10mm) can help reduce the
198205
risk of an ESD disruption.
199206

200207
.. figure:: images/keepawayfromframe.jpg
201-
:alt: A sensor with an air gap between the frame and the 4-wireconnector.
202-
208+
:alt: A sensor with an air gap between the frame and the 4-wire connector.
209+
:align: center
210+
203211
Keep exposed portions of the electronics away from the frame.
204212

205213
Using electrical tape to insulate these areas can be equally effective and may be easier to implement.
206214

207215
.. figure:: images/tapepoorlyinsulated.jpg
208216
:alt: A servo wire extension connection wrapped in electrical tape and a sensor mounted on a frame where the frame is wrapped in electrical tape.
209-
217+
:align: center
218+
210219
Electrical tape can be used to insulate exposed or poorly insulated
211220
metal.
212221

@@ -216,6 +225,7 @@ Using electrical tape to insulate these areas can be equally effective and may b
216225
`known ESD issue <https://docs.revrobotics.com/duo-control/troubleshooting-the-control-system/troubleshooting-the-control-system#esd-mitigation-techniques>`_
217226
with devices plugged into the USB 2.0 port.
218227
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).
228+
219229
Ensure that you plug USB devices, such as a Camera, into the USB 3.0 Port on your Control Hub.
220230

221231
Step 3: Covering Exterior Metal Features with Electrically Insulated Material
@@ -230,7 +240,8 @@ electrical tape, and other non-conductive coatings are all effective.
230240

231241
.. figure:: images/coverwithtape.jpg
232242
:alt: A robot claw mechanism where the metal claws are wrapped in electrical tape.
233-
243+
:align: center
244+
234245
Insulating portions of the robot that touch other metallic objects on
235246
the field can help.
236247

@@ -248,6 +259,7 @@ occur between the frame of a robot and the Control System electronics.
248259

249260
.. figure:: images/REV-31-1269-ResistiveGroundingStrap.jpg
250261
:alt: The REV Resistive Grounding Strap has a XT30 connection on one end and an eye loop connector on the other end.
262+
:align: center
251263

252264
The REV Resistive Grounding Strap (REV-31-1269) is an approved grounding
253265
cable.
@@ -270,7 +282,8 @@ conjunction with REV Robotics’ Resistive Grounding Strap:
270282

271283
.. figure:: images/REV-31-1385-AndersonPowerPoleToXT30.png
272284
:alt: REV Robotics Anderson Powerpole to XT30 Adapter cable
273-
285+
:align: center
286+
274287
The REV-31-1385 adapter is approved for use with REV’s Resistive
275288
Grounding Strap.
276289

@@ -280,7 +293,8 @@ end using a conductive (i.e., metal) bolt to the frame of the robot.
280293

281294
.. figure:: images/groundtheelectronics.png
282295
:alt: An expansion hub with a grounding cable connected to the XT30 port and bolted to the metal frame of the robot.
283-
296+
:align: center
297+
284298
Ground the electronics to the frame using a FIRST-approved cable.
285299

286300
It might initially seem contradictory to both insulate the electronic

0 commit comments

Comments
 (0)