Skip to content

Commit 5870112

Browse files
authored
Various ftc-docs backlog of update changes (#370)
* Various ftc-docs backlog of update changes
1 parent eb05669 commit 5870112

File tree

18 files changed

+107
-141
lines changed

18 files changed

+107
-141
lines changed

docs/source/control_hard_compon/ds_components/components/components.rst

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,13 @@ Android Device
4141

4242
Moto E5
4343

44-
The heart of the Driver Station is the Android Device that runs the
45-
Driver Station App. This Android Device requirement can be fulfilled
46-
either through the use of a
47-
`REV Driver Hub <https://www.revrobotics.com/rev-31-1596/>`_
48-
or one of the approved Android Smartphones listed in
49-
:doc:`Game Manual 1 <../../../manuals/game_manuals/game_manuals>`. It is of
50-
vital importance that the Driver Station App be updated to a version
51-
that meets or exceeds the minimum Driver Station App version as
52-
defined in :doc:`Game Manual 1 <../../../manuals/game_manuals/game_manuals>`.
44+
The heart of the Driver Station is the Android Device that runs the Driver
45+
Station App. This Android Device requirement can be fulfilled either through
46+
the use of a `REV Driver Hub <https://www.revrobotics.com/rev-31-1596/>`_ or
47+
one of the approved Android Smartphones listed in the Competition Manual. It is
48+
of vital importance that the Driver Station App be updated to a version that
49+
meets or exceeds the minimum Driver Station App version as defined in the
50+
Competition Manual.
5351

5452
USB-OTG Adapter / Hubs
5553
----------------------
@@ -144,10 +142,9 @@ Comercial USB Battery Pack
144142
Anker Battery Pack
145143

146144
A commercial USB battery pack is an auxiliary power source that can be used in
147-
specific situations in accordance with the
148-
:ref:`Game Manuals<manuals/game_manuals/game_manuals:game manuals>`. A USB
149-
battery pack is permitted to be used to charge your Android Device. Only the
150-
REV Driver Hub can be charged while in use, through its USB-C port.
145+
specific situations in accordance with the Competition Manual. A USB battery
146+
pack is permitted to be used to charge your Android Device. Only the REV Driver
147+
Hub can be charged while in use, through its USB-C port.
151148

152149
Gamepads
153150
--------
@@ -257,10 +254,10 @@ Gamepads
257254

258255
Quadstick FPS
259256

260-
:ref:`Game Manual 1 <manuals/game_manuals/game_manuals:game manuals>` defines
261-
the gamepads that are allowed in competition play. Up to two gamepads, in any
262-
combination, of the allowed types of gamepads may be used. All gamepads MUST be
263-
used in wired mode only, no wireless of any kind is allowed. Special features of
264-
some gamepads (Rumble, Lighting) may be programmed and used by teams for
265-
notifications and signaling to the drivers of the robot.
257+
The Competition Manual defines the gamepads that are allowed in competition
258+
play. Up to two gamepads, in any combination, of the allowed types of gamepads
259+
may be used. All gamepads MUST be used in wired mode only, no wireless of any
260+
kind is allowed. Special features of some gamepads (Rumble, Lighting) may be
261+
programmed and used by teams for notifications and signaling to the drivers of
262+
the robot.
266263

docs/source/control_hard_compon/ds_components/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ way represent the only possible way of connecting these components. These
1414
images also do not represent using a
1515
`Driver Station Carrier <https://www.thingiverse.com/thing:3386378>`_,
1616
which is recommended for teams to use for component management and
17-
transportation. See rule ``DS07`` in
18-
:doc:`Game Manual 1 <../../manuals/game_manuals/game_manuals>` for more information
19-
on Driver Station Carriers.
17+
transportation. See the Competition Manual for more information
18+
on *OPERATOR CONSOLES*.
2019

2120
.. tab-set::
2221

docs/source/control_hard_compon/rc_components/motors/motors.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,9 @@ Motors
8989

9090
REV Robotics Core Hex 12V DC Motor
9191

92-
Motors are the primary drivers of a robot. All motors are 12v brushed DC motors and are enumerated in
93-
:ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. They may only be controlled
94-
via a REV Expansion Hub, REV Control Hub, REV SPARKmini Motor Controller, or VEX Motor
95-
Controller 29. ``<RE09>``
92+
Motors are the primary drivers of a robot. All motors are 12v brushed DC motors
93+
and are enumerated in the Competition Manual. They may only be controlled via a
94+
REV Expansion Hub, REV Control Hub, or REV SPARKmini Motor Controller.
9695

9796
Additional Resources
9897
---------------------

docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst

Lines changed: 45 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,11 @@ Robot Main Battery
5858

5959
REV Robotics (REV-31-1302)
6060

61-
The main power of a robot comes from one 12v battery. The battery may be one of
62-
the batteries shown above. Refer to section ``<RE03>`` in the
63-
:ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
64-
for exact information on allowed batteries. Note that it is typically allowed
65-
by ``<RE15>`` to replace the connector on the batteries, provided the in-line
66-
fuse on the battery is preserved.
61+
The main power of a robot comes from one 12v battery. The batterys above are
62+
samples of these batteries, check the Competition Manual for the full list of
63+
batteries. Note that it is typically allowed to replace the connector on the
64+
batteries, provided the in-line fuse on the battery is preserved, again check
65+
the Competition Manual for full details.
6766

6867
.. warning::
6968
Be sure to remove the 20A fuse from the in-line fuse holder prior to cutting
@@ -145,12 +144,9 @@ Main Power Switch
145144

146145

147146

148-
One Main Power Switch must control all power provided by the Main Battery. It
149-
along with its label should be placed in accordance to
150-
:ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`.
151-
The legal power switches are shown above. ``<RE01>``
152-
153-
:download:`Power Switch Label <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/power-button-labels.pdf>`
147+
One Main Power Switch must control all power provided by the Main Battery. The
148+
legal power switches above are representative examples, check the Competition
149+
Manual for the full list.
154150

155151
Power Distribution Block
156152
-------------------------
@@ -194,10 +190,9 @@ Power Distribution Block
194190
goBILDA (SKU: 3108-2833-0801)
195191

196192
Power Distribution Blocks help to distribute the power to devices such as
197-
Control Hubs, SPARKminis, and more.
198-
See :ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
199-
for a description of legal Power Distribution methods. The Power
200-
Distribution Blocks shown are not the only legal devices for power distribution.
193+
Control Hubs, SPARKminis, and more. See the Competition Manual for a
194+
description of legal Power Distribution methods. The Power Distribution Blocks
195+
shown are not the only legal devices for power distribution.
201196

202197
REV Servo Power Module
203198
----------------------
@@ -222,11 +217,13 @@ REV Servo Power Module
222217

223218
REV (REV-11-1144)
224219

225-
This is an electronic device that boosts the power supplied to 3-wire servos. A REV
226-
Servo Power Module has 6 input servo ports and 6 matching output ports. It
227-
draws power from a 12V source and provides 6V power to each output servo port.
228-
A REV Servo Power Module can provide up to 15A of current across all output
229-
servo ports for a total of 90 Watts of power per module.
220+
This is an electronic device (also known as a Servo Power Injector) that boosts
221+
the power supplied to 3-wire servos. A REV Servo Power Module has 6 input servo
222+
ports and 6 matching output ports. It draws power from a 12V source and
223+
provides 6V power to each output servo port. A REV Servo Power Module can
224+
provide up to 15A of current across all output servo ports for a total of 90
225+
Watts of power per module. There are more Servo Power Injectors allowed by the
226+
Competition Manual.
230227

231228
COTS USB Battery Pack
232229
---------------------
@@ -252,13 +249,12 @@ COTS USB Battery Pack
252249
Anker Battery Pack
253250

254251
A Commercial Off The Shelf (COTS) USB battery pack is an auxiliary power source
255-
that can be used in specific situations in accordance with the :ref:`Game
256-
Manuals<manuals/game_manuals/game_manuals:game manuals>`. In the 2023-2024
257-
season, these batteries were deemed permissible to power LEDs (per
258-
``<RE12>f.ii``) and, by extension, COTS light controller sources like the `REV
259-
Blinkin <https://www.revrobotics.com/rev-11-1105/>`__ (per ``<RE12>e``).
260-
However, having a COTS USB External Battery on the Robot carries additional
261-
considerations. All teams must ensure their COTS USB Battery Pack:
252+
that can be used in specific situations in accordance with the Competition
253+
Manual. In the 2023-2024 season, these batteries were deemed permissible to
254+
power LEDs and, by extension, COTS light controller sources like the `REV
255+
Blinkin <https://www.revrobotics.com/rev-11-1105/>`__. However, having a COTS
256+
USB External Battery on the Robot carries additional considerations. All teams
257+
must ensure their COTS USB Battery Pack:
262258

263259
- Is manufactured by a reputable brand.
264260
- Is within allowed Watt-hour capacity limits.
@@ -370,8 +366,9 @@ excessive heat, fire, or explosion and all reasonable efforts should be taken
370366
to prevent them.
371367

372368
.. warning::
373-
Never get a COTS USB Battery Pack wet. If it gets wet, follow the manufacturer's
374-
recommended procedure to clean and dry the battery before continuing use.
369+
Never get a COTS USB Battery Pack wet. If it gets wet, follow the
370+
manufacturer's recommended procedure to clean and dry the battery before
371+
continuing use.
375372

376373
Charge COTS USB Battery Packs properly
377374
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -400,27 +397,27 @@ to protect and package the battery cell(s) within. Therefore it can be
400397
difficult to determine if the battery is showing signs of failure and distress.
401398
Here are several tips for identifying a failing battery:
402399

403-
- Check for Leaking Power Cells. Similar to an acid leak in an alkaline battery,
404-
check to see if there are any signs of corrosion or acid leak from the
405-
battery pack. This might be difficult to determine, so stay vigilent. If signs
406-
of acid or corrosion are present, dispose of the battery per the manufacturer's
407-
recommendations immediately with extreme prejudice.
408-
- Look for bulging within the battery casing. When Lithium batteries fail, often
409-
they will begin to bulge like a balloon. If the case of the battery shows any
410-
signs of pressure from within, dispose of the battery per the manufacturer's
411-
recommendations immediately with extreme prejudice.
400+
- Check for Leaking Power Cells. Similar to an acid leak in an alkaline
401+
battery, check to see if there are any signs of corrosion or acid leak from
402+
the battery pack. This might be difficult to determine, so stay vigilent. If
403+
signs of acid or corrosion are present, dispose of the battery per the
404+
manufacturer's recommendations immediately with extreme prejudice.
405+
- Look for bulging within the battery casing. When Lithium batteries fail,
406+
often they will begin to bulge like a balloon. If the case of the battery
407+
shows any signs of pressure from within, dispose of the battery per the
408+
manufacturer's recommendations immediately with extreme prejudice.
412409
- Test the battery pack for any non-functional ports. Sometimes non-functional
413-
ports can be an early sign of internal damage. DO NOT use batteries that
414-
are suspected of being damaged - dispose of the battery per the manufacturer's
410+
ports can be an early sign of internal damage. DO NOT use batteries that are
411+
suspected of being damaged - dispose of the battery per the manufacturer's
415412
recommendations immediately.
416413

417414
Isolate COTS USB Battery Packs from the Robot Power
418415
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
419416

420-
Great care must be take to NEVER allow the COTS USB Battery Pack to be connected
421-
to the main (or any) power system in use by the robot. The COTS USB Battery Pack
422-
and connected devices must be completely isolated from the robot electrical system,
423-
with the exception of controlling signals provided by the Game Manual
424-
(per rule ``<RE12>.d``). When using a COTS USB Battery Pack, controlling signals
425-
for LEDs powered by the Pack should ONLY connect to compatible devices listed in
426-
rule ``<RE12>.e``.
417+
Great care must be take to NEVER allow the COTS USB Battery Pack to be
418+
connected to the main (or any) power system in use by the robot. The COTS USB
419+
Battery Pack and connected devices must be completely isolated from the robot
420+
electrical system, with the exception of controlling signals provided by the
421+
Competition Manual. When using a COTS USB Battery Pack, controlling signals
422+
for LEDs powered by the Pack should ONLY connect to allowed compatible devices.
423+

docs/source/control_hard_compon/rc_components/sensors/sensors.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
Sensors
22
=========
33

4-
.. note::
5-
As per :ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
6-
a UVC Webcam is not considered a sensor.
7-
8-
Listed below are some examples of common robot sensors. This is not
9-
intended to limit or extend in any way the scope of sensors as established in
10-
``<RE12>``. While the *FIRST* Tech Challenge SDK supports many sensors not all
11-
are natively supported.
4+
Listed below are some examples of common robot sensors. While the *FIRST* Tech
5+
Challenge SDK supports many sensors not all are natively supported.
126

137
Examples
148
----------

docs/source/devices/huskylens/huskylens.rst

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ This tutorial does **not** cover the (many) ways to:
4949
- crimped connectors
5050
- lever nuts (example below)
5151

52-
FTC `Game Manual 1 <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__
53-
allows this work, but teams must ensure high quality for robot competition all
54-
season.
52+
FTC Competition Manual allows this work, but teams must ensure high quality for
53+
robot competition all season.
5554

5655
.. figure:: images/060-adapter.png
5756
:align: center
@@ -405,8 +404,7 @@ Competition Notes
405404
~~~~~~~~~~~~
406405

407406
Now you are ready to experiment with color recognition of an actual Team
408-
Prop, also called a Team Game Element. Study `Game Manual
409-
1 <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__
407+
Prop, also called a Team Game Element. Study the Competition Manual
410408
and the `FTC Q&A <https://ftc-qa.firstinspires.org/>`__ for the Team
411409
Prop requirements. Choose your shades of “red” and “blue” (see note
412410
below), and follow the same steps as above.
@@ -418,19 +416,9 @@ The above trained **blue object** is not the same shade of blue as the
418416
blue Spike Mark. This difference increases the chance of a distinct and
419417
correct recognition of the object color.
420418

421-
`Game Manual
422-
1 <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__
423-
(Rule TE2) specifically allows the Team Prop to be a different shade of
424-
Red or Blue, compared to the official tape color of Spike Marks:
425-
426-
*“The Team Game Element may include multiple shades of the assigned
427-
color.”*
428-
429-
…and emphasized in the `FTC
430-
Q&A <https://ftc-qa.firstinspires.org/qa/15>`__:
431-
432-
*“Light blue and pink are acceptable colors providing it is obvious to
433-
the field personnel which alliance the Team Prop belongs to.”*
419+
In this game, the Competition Manual specifically allowed the Team Prop to be a
420+
different shade of Red or Blue, compared to the official tape color of Spike
421+
Marks.
434422

435423
3. Lighting
436424
~~~~~~~~~~~

docs/source/ftc_sdk/overview/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ no longer necessary.
137137
Updating SDK Software
138138
---------------------
139139

140-
It is important for teams to update the SDK software. Updates
141-
mid-season may not be required. Teams can check the minimum software version
142-
required for a game in Game Manual 1. It is recommended to use the REV Hardware
143-
Client to update hardware, if a 64-bit Windows computer is available. If not, then alternate
144-
methods provided can be used to update the software.
140+
It is important for teams to update the SDK software. Updates mid-season may
141+
not be required. Teams can check the minimum software version required for a
142+
game in the Competition Manual. It is recommended to use the REV Hardware
143+
Client to update hardware, if a 64-bit Windows computer is available. If not,
144+
then alternate methods provided can be used to update the software.
145145

146146
- :doc:`Updating the REV Hardware Client </ftc_sdk/updating/hardware_client/Updating-REV-Hardware-Client>`
147147
- :doc:`Updating the Driver Station App </ftc_sdk/updating/ds_app/Updating-the-DS-App>`

docs/source/game_specific_resources/ftcqa/ftcqa.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ FIRST Tech Challenge Game Q&A
88
The `Game Q&A <https://ftc-qa.firstinspires.org/>`_ is a forum/tool that
99
provides teams an opportunity to receive clarifications from the Game Design
1010
Committee about the current season's challenge. Rulings on the Q&A are final
11-
and binding, so all teams must make sure to check back and review the Q&A
12-
often. Game rulings made within the Q&A system are NOT guaranteed to be
13-
reflected in the appropriate Game Manual.
11+
and binding, and will be reflected in the Competition Manual.
1412

1513
How to Ask Questions
1614
~~~~~~~~~~~~~~~~~~~~

docs/source/hardware_and_software_configuration/configuring/configuring_dual_hubs/configuring-dual-hubs.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ports.
1313
This document describes how to connect and configure an additional Expansion
1414
Hub for use in the FIRST Tech Challenge. Note that the FIRST Tech Challenge
1515
Competition Manual limits the maximum number of Control or Expansion Hubs on
16-
a single robot to two. See rule R701 for the full details.
16+
a single robot to two.
1717

1818
Equipment Needed
1919
~~~~~~~~~~~~~~~~
@@ -39,8 +39,7 @@ need the following items:
3939
- .. figure:: images/TamiyaAdapter.jpg
4040

4141
* - FIRST-approved 12V Battery (such as Tetrix W39057). For a list of
42-
FIRST-approved 12V batteries, refer to the current Competition Manual,
43-
rule R601.
42+
FIRST-approved 12V batteries, refer to the current Competition Manual.
4443
- .. figure:: images/Battery.jpg
4544

4645
* - REV Robotics Control Hub (REV-31-1595).
@@ -142,7 +141,7 @@ using a Control Hub on their robot.
142141

143142
* - A FIRST-approved Android smartphone with the FTC Robot Controller
144143
app installed. For a list of FIRST-approved Android smartphones,
145-
refer to the current Competition Manual, rule R704.
144+
refer to the current Competition Manual.
146145
- .. figure:: images/oneAndroidPhone.jpg
147146

148147
* - USB Type A male to type mini-B male cable.

docs/source/hardware_and_software_configuration/self_inspect/self-inspect.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ DS Self Inspect 3, on Driver Hub paired to RC phone
219219

220220
- Item 4 appears only on the Driver Hub. The check-mark indicates the
221221
Operating System meets the minimum version requirement in the FTC
222-
Game Manual.
222+
Competition Manual.
223223
- Note that ``Airplane Mode`` has been omitted from the DS inspection,
224224
only for Driver Hub. FTC rules exclude the Driver Hub and Control Hub
225225
from the Airplane Mode requirement.

0 commit comments

Comments
 (0)