Skip to content

Commit d882307

Browse files
committed
spelling corrections, removal of old game manual references, etc.
1 parent af5910d commit d882307

File tree

4 files changed

+44
-62
lines changed

4 files changed

+44
-62
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ USB Type-A and USB-C and USB Mini-B refer to the type of connector.
2626

2727
- USB Type-A is a larger rectangular connector.
2828
- USB-C is a smaller oval connector.
29-
- USB Mini-B is a smaller rectagular connector with a beveled edge.
29+
- USB Mini-B is a smaller rectangular connector with a bevelled edge.
3030

3131
USB 2.0
3232
^^^^^^^
@@ -55,14 +55,14 @@ laptop for loading the SDK but can also be used with a UVC Camera.
5555
MINI USB
5656
^^^^^^^^
5757

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

6262
HDMI
6363
-----
6464

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

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

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,18 @@ Battery Ports
77

88
These `XT-30 <https://docs.revrobotics.com/duo-control/control-system-overview/cables-and-connectors/xt-30-power-cable>`_
99
connectors are used to power your REV Hub as well as all the devices connected to it.
10-
As the connector is known for its fragility it is highly recommended you be careful when using it.
11-
It is also recommended that you expand your connector prongs periodically. For more information on this
12-
process please watch this `video <https://www.youtube.com/watch?v=UYXTiSeVmB0>`_. While this video features an XT60, a larger version
13-
of the XT-30, and a drone the advice is much the same. This port may also be used
14-
to connect a grounding strap. For more information on legal grounding straps see ``<RE15>``,
15-
:ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. For more information on this port please see
10+
For more information on this port please see the
1611
`REV Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#input-power-specifications>`_.
12+
This port may also be used to connect a grounding strap. For more information on legal grounding straps see
13+
the Power Distribution section of the `Competition Manual <https://ftc-resources.firstinspires.org/file/ftc/game/manual>`_.
14+
15+
As the XT30 connector is known for its fragility it is highly recommended you be careful when using it.
16+
It is also recommended that you expand your connector prongs periodically.
17+
REV has a `troubleshooting article <https://docs.revrobotics.com/duo-control/troubleshooting-the-control-system/control-hub-troubleshooting#xt30-pins-are-compressed>`_
18+
specific to expanding the pins on the XT30 connector.
19+
For more information on this
20+
process please watch this `video <https://www.youtube.com/watch?v=UYXTiSeVmB0>`_. While this video features an XT60, a larger version
21+
of the XT-30, and a drone, the advice is much the same.
1722

1823
Motor Ports
1924
-------------
@@ -45,26 +50,27 @@ Servo Ports
4550

4651
These 0.1” Header pins are used to power and control your servos. There are 6 ports on each hub and they are numbered from 0-5.
4752
Be mindful of matching the polarity of the device attached to this port as it is possible to flip the connector.
48-
For increasing the power supplied to these servos it is possible to use a Servo Power Module that is in compliance with
49-
``<RE05>``, :ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. For more information on this port
53+
For increasing the power supplied to these servos it is possible to use a Servo Power Module.
54+
See the Motors & Actuators section of the `Competition Manual <https://ftc-resources.firstinspires.org/file/ftc/game/manual>`_ for approved servo power devices.
55+
For more information on this port
5056
please see `REV Servo Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#servo-port-specifications>`_.
5157

5258
+5V Power Ports
5359
---------------
5460

5561
These 0.1” Header pins are used to power and control various appliances. There
5662
are two ports on each hub. These connectors can be used for a limited range of
57-
applications in FIRST Tech Challenge, such as powering powered USB hubs. For more
63+
applications in *FIRST* Tech Challenge, such as powering powered USB hubs. For more
5864
information on this port please see
5965
`REV +5V Power Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#id-5v-power-port-specifications>`_ and
60-
:ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`.
66+
the Power Distribution section of the `Competition Manual <https://ftc-resources.firstinspires.org/file/ftc/game/manual>`_.
6167

6268
Analog Ports
6369
--------------
6470

6571
These 4-pin `JST-PH <https://docs.revrobotics.com/duo-control/control-system-overview/cables-and-connectors/jst-ph-sensors-and-rs485>`_
6672
style connectors are used for your analog inputs. There are 2 of these ports on each hub. These ports
67-
have 4 channels labeled from 0-4. This port can be used to connect to a standalone analog sensor. A common example of an
73+
have 4 channels labelled from 0-4. This port can be used to connect to a standalone analog sensor. A common example of an
6874
analog sensor is a `potentiometer <https://www.revrobotics.com/rev-31-1155/>`_. An analog sensor is one that outputs a range
6975
of values rather than digital which alternates between one of two states. For more information on this port please see
7076
`REV Analog Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#analog-port-specifications>`_.
@@ -73,7 +79,7 @@ Digital Ports
7379
---------------
7480

7581
These 4-pin `JST-PH <https://docs.revrobotics.com/duo-control/control-system-overview/cables-and-connectors/jst-ph-sensors-and-rs485>`_
76-
style connectors are used for your digital inputs. There are 4 of these ports on each hub with a total of 8 channels labeled from `0-7`.
82+
style connectors are used for your digital inputs. There are 4 of these ports on each hub with a total of 8 channels labelled from `0-7`.
7783
A device attached to a digital port alternates between one of two states (e.g., on and off). One such device would be a button. It is important
7884
to note that each port has two channels and devices such as the `REV Touch Sensor <https://www.revrobotics.com/rev-31-1425/>`_ will only operate on one channel (N+1).
7985

@@ -87,8 +93,8 @@ I2C Ports
8793

8894
These 4-pin `JST-PH <https://docs.revrobotics.com/duo-control/control-system-overview/cables-and-connectors/jst-ph-sensors-and-rs485>`_
8995
style connectors are used for connecting I2C sensors. Each port is a single I2C bus where multiple sensors can be
90-
attached. Using sensors with identical addresses on the same bus can cause problems. The range of I2C sensors that can be connected is limited
91-
by :ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. While it is possible to use a large range of
96+
attached. Using sensors with identical addresses on the same bus can cause problems.
97+
While it is possible to use a large range of
9298
sensors, the vast majority of I2C sensors do not have drivers built into the SDK. It is possible to use community drivers
9399
or create your own. For more information on this port please see
94100
`REV I2C Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#i2c-port-specifications>`_.
@@ -106,5 +112,5 @@ UART
106112
-----
107113

108114
This connector is used only for **Developer** (non end user) debugging. Its use is not supported
109-
by FIRST.
115+
by *FIRST*.
110116

Lines changed: 18 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,32 @@
11
UVC Webcam
22
===========
33

4-
.. grid:: 1 2 2 2
5-
:gutter: 2
6-
7-
.. grid-item-card::
8-
:class-header: sd-bg-dark font-weight-bold sd-text-white
9-
:class-body: sd-text-left body
10-
11-
Logitech C270
12-
13-
^^^
14-
15-
.. figure:: images/C270.jpg
16-
:align: center
17-
:width: 50 %
18-
:alt: C270
19-
20-
+++
21-
22-
Logitech C270
23-
24-
.. grid-item-card::
25-
:class-header: sd-bg-dark font-weight-bold sd-text-white
26-
:class-body: sd-text-left body
27-
28-
Logitech C920
4+
A webcam is a device that provides visual images of the surrounding
5+
environment. For use as part of *FIRST* Tech Challenge teams must use a commercially available off-the-shelf (COTS)
6+
USB Video Class `(UVC) <https://www.usb.org/document-library/video-class-v15-document-set>`_
7+
compatible camera. This device can be connected directly to
8+
the REV Control Hub or to the Robot Control system via a USB hub.
299

30-
^^^
10+
.. figure:: images/C270.jpg
11+
:width: 25%
12+
:class: no-scaled-link
13+
:alt: Example UVC camera
14+
15+
Logitech C270 Webcam
3116

32-
.. figure:: images/C920.jpg
33-
:align: center
34-
:width: 50 %
35-
:alt: C920
36-
37-
+++
17+
Webcams are intended to be used in computer vision related tasks.
18+
Example use cases for a webcam are:
3819

39-
Logitech C920
40-
41-
A webcam is a device that provides visual images of the surrounding
42-
environment. For use as part of *FIRST* Tech Challenge teams must use a COTS
43-
`UVC <https://www.usb.org/document-library/video-class-v15-document-set>`_
44-
(USB Video Class) Compatible Camera. This device can be connected directly to
45-
the REV Control Hub or to the Robot Control system via a powered USB hub
46-
``<RE14>``. This device is intended to be used in vision related tasks. An
47-
example use case of a webcam is reading the state of the barcode after
48-
randomization, a vision task in *Freight Frenzy*, 2021-2022.
20+
- :doc:`detecting <../../../apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values>` an AprilTag,
21+
- determining where the robot is :doc:`located <../../../apriltag/vision_portal/apriltag_localization/apriltag-localization>` on the field,
22+
- using OpenCV to :doc:`detect colours or shapes <../../../color_processing/index>` of game elements.
4923

5024
Additional Resources
5125
--------------------
5226

27+
- A :doc:`list of webcams <../../../apriltag/vision_portal/visionportal_webcams/visionportal-webcams>` known to be compatible with VisionPortal.
5328
- :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>`
5429
- :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>`
5530
- :ref:`USB Port Overview <control_hard_compon/rc_components/hub/ports/ch-ports:USB Ports>`
5631
- :ref:`Vision in FIRST Tech Challenge <programming_resources/index:vision programming>`
32+

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ is activated in your Op Mode **before** the waitForStart command:
133133
If you do not see the Camera Stream option in your main menu on your
134134
DRIVER STATION, then verify that the VisionPortal is activated
135135
before the waitForStart command in your Op Mode. Also make sure you’ve
136-
given the system enough time to initialize the Vuforia software before
136+
given the system enough time to initialize the VisionPortal software before
137137
you check to see if Camera Stream is available.
138138

139139
Scrcpy
@@ -142,7 +142,7 @@ Scrcpy
142142
To view the camera output from a computer while an OpMode is running, you
143143
can use `scrcpy <https://github.com/Genymobile/scrcpy>`__. To do this,
144144
you will first need to obtain an ADB connection with your Control Hub.
145-
This can be done by connecting a USB-A - USB-C cable to the USB-C port
145+
This can be done by connecting a USB-A to USB-C cable to the USB-C port
146146
on your Control Hub. If on Windows, you may also connect to your Control
147147
Hub WiFi network and open the `REV Hardware Client <https://docs.revrobotics.com/rev-hardware-client/gs/install>`__.
148148
Once connected, use `these instructions <https://github.com/Genymobile/scrcpy?tab=readme-ov-file#get-the-app>`__

0 commit comments

Comments
 (0)