Skip to content

Commit 6096eaf

Browse files
authored
replace Field Inspection with Robot Inspection. (#368)
* replace Field Inspection with Robot Inspection.
1 parent 1ff1ddf commit 6096eaf

File tree

15 files changed

+85
-75
lines changed

15 files changed

+85
-75
lines changed

docs/source/_templates/footer.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232
<p><a href="{{ pathto('tos/tos') }}">Terms of Service</a></p>
3333
</div>
3434
<div>
35-
<p><a class="external" href="https://www.firstinspires.org/about/privacy-policy">Privacy Policy</a></p>
35+
<p><a class="external" href="https://www.firstinspires.org/privacy-policy">Privacy Policy</a></p>
3636
</div>
3737
<div>
38-
<p><a href="https://www.firstinspires.org/report">Report an Incident</a></p>
38+
<p><a class="external" href="https://www.firstinspires.org/programs/youth-protection-program">Report an Incident</a></p>
3939
</div>
4040

4141
<div>

docs/source/contrib/style_guide/style-guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,13 +270,13 @@ RST Code:
270270

271271
.. code:: rest
272272
273-
`Field Setup Guide (PDF, 4.5 MB) <https://ftc-resources.firstinspires.org/file/ftc/game/fieldguide>`__
273+
`Field Setup Guide (PDF) <https://ftc-resources.firstinspires.org/ftc/field/eventfieldguide>`__
274274
275275
Which looks like:
276276

277277
.. list-table::
278278

279-
* - `Field Setup Guide (PDF, 4.5 MB) <https://ftc-resources.firstinspires.org/file/ftc/game/fieldguide>`__
279+
* - `Field Setup Guide (PDF) <https://ftc-resources.firstinspires.org/ftc/field/eventfieldguide>`__
280280

281281
Generally in FTC Docs we link to file to enable them to be downloaded for printing or offline viewing.
282282
In that case, the user is downloading the file, which is an action, so a button is appropriate.

docs/source/contrib/tutorials/make_rst/creating_rst/creating-rst.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ images can be local images (saved/stored in the repository) or remote
300300
images (using HTTP links). We're going to use both in our document, but
301301
we need an image to use. I downloaded this file locally:
302302

303-
`https://www.firstinspires.org/sites/all/themes/first/assets/images/2020/ftc/event-experience.jpg <https://www.firstinspires.org/sites/all/themes/first/assets/images/2020/ftc/event-experience.jpg>`_
303+
https://ftc-docs.firstinspires.org/en/latest/_images/HoustonMatchPlay.jpg
304304

305305
#. Navigate to the folder you created in the previous step.
306306

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Android Device
1717

1818
.. figure:: images/REV-31-1596.png
1919
:align: center
20-
:alt: REV-31-1596
20+
:alt: REV Driver Hub
2121
:width: 75 %
2222

2323
+++
@@ -34,7 +34,7 @@ Android Device
3434

3535
.. figure:: images/motoe5.png
3636
:align: center
37-
:alt: MotoE5
37+
:alt: Moto E5
3838
:width: 50 %
3939

4040
+++
@@ -82,7 +82,7 @@ USB-OTG Adapter / Hubs
8282

8383
.. figure:: images/usbhub.png
8484
:align: center
85-
:alt: USBHub
85+
:alt: Anker USB Hub
8686
:width: 100 %
8787

8888
+++
@@ -99,7 +99,7 @@ USB-OTG Adapter / Hubs
9999

100100
.. figure:: images/REV-31-1592.png
101101
:align: center
102-
:alt: REV-31-1592
102+
:alt: REV UltraUSB
103103
:width: 50 %
104104

105105
+++
@@ -112,7 +112,7 @@ USB devices with the Android Smartphone, like a gamepad, a USB-OTG Adapter
112112
Cable must be used. This cable provides a USB Type A port for the Gamepad or peripherals
113113
(like a USB Hub, to allow more than one Gamepad to be used). If available, it
114114
is instead recommended to use a USB Hub with OTG cable built in, like the
115-
`REV UltraUSB (REV-31-1592) <https://www.revrobotics.com/rev-31-1592/>`_ -
115+
`REV UltraUSB (REV-31-1592) <https://www.revrobotics.com/UltraUSB-Hub-and-Cables/>`_ -
116116
this reduces the number of connections and failure points in the system.
117117

118118
When using a REV Driver Hub, no OTG adapters are necessary - gamepads may
@@ -134,7 +134,7 @@ Comercial USB Battery Pack
134134

135135
.. figure:: images/ankerbattery.png
136136
:align: center
137-
:alt: REV-31-1387
137+
:alt: Anker Battery Pack
138138
:width: 50 %
139139

140140
+++
@@ -162,7 +162,7 @@ Gamepads
162162

163163
.. figure:: images/f310.png
164164
:align: center
165-
:alt: LogitechF310
165+
:alt: Logitech F310
166166
:width: 75 %
167167

168168
+++
@@ -196,7 +196,7 @@ Gamepads
196196

197197
.. figure:: images/dualshock.png
198198
:align: center
199-
:alt: DualShock4
199+
:alt: Dual Shock 4
200200
:width: 75 %
201201

202202
+++
@@ -247,7 +247,7 @@ Gamepads
247247

248248
.. figure:: images/quadstick.png
249249
:align: center
250-
:alt: quadstick
250+
:alt: Quadstick
251251
:width: 75 %
252252

253253
+++

docs/source/devices/huskylens/huskylens.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Introduction
66

77
This is a simple tutorial to introduce the use of
88
`HuskyLens <https://www.dfrobot.com/product-1922.html>`__ in *FIRST* Tech
9-
Challenge (`FTC <https://www.firstinspires.org/robotics/ftc>`__), for
9+
Challenge, for
1010
teams that **already decided** to explore its potential.
1111

1212
.. figure:: images/020-HuskyLens-dual.png

docs/source/faq/faqs.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@ Competition FAQs
7070

7171
.. grid-item-card:: Who on my team needs to be with the robot for inspection?
7272

73-
It depends on which inspection station you're visiting and how your event is configured.
74-
The inspectors at Field Inspection like to see the Drive Team, Human Player (if there is
75-
one), and Drive Coach. The inspectors at Robot Inspection really just want to see team
76-
members who have the best idea of what's going on with the robot (mechanically and
77-
electrically). Look at your inspection sheets, you can generally determine what you're
78-
doing based on the checklist.
73+
At least one student must be present during inspection per the Competition Manual.
74+
However, inspectors will ask questions about the mechanical and electrical components of your robot.
75+
Ideally, you have one or more team members who can answer such questions.
76+
In addition, you may need to turn your robot and driver station on and demonstrate your robot complies with a particular rule like sizing.
77+
That may involve someone from the drive team if you need to use a gamepad to operate a mechanism or place the robot in its starting configuration.
78+
Look at the self inspection checklist, you can generally determine what you're doing based on the checklist.
7979

8080
.. grid-item-card:: Why aren’t you going to replay that match?
8181

docs/source/ftc_sdk/overview/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ specifically defined:
9595
upcoming season.
9696

9797
Software SDK updates are announced via the `FIRST Tech Challenge Blog <https://community.firstinspires.org/topic/ftc>`__ and
98-
`Team Email Blasts <https://www.firstinspires.org/resource-library/ftc/team-blast-archive>`__ .
98+
`Team Email Blasts <https://www.firstinspires.org/resources/library/ftc/team-email-blast-archive>`__ .
9999

100100

101101
SDK Release Notes

docs/source/hardware_and_software_configuration/connecting_devices/connecting_motor/connecting-motor.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ Connecting a Motor to the Hub
33

44
The Hub can drive up to four (4) 12V DC motors per Hub. The Hub uses a
55
type of electrical connector known as a 2-pin JST VH connector. Many of
6-
the FIRST-approved 12V DC motors are equipped with Anderson Powerpole
6+
the *FIRST* approved 12V DC motors are equipped with Anderson Powerpole
77
connectors. An adapter cable can be used to connect the Anderson
88
Powerpole connectors to the Hub motor port (see `FIRST Tech Challenge
9-
Robot Wiring
10-
Guide <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/robot-wiring-guide.pdf>`__
9+
Robot Wiring Guide (PDF) <https://ftc-resources.firstinspires.org/ftc/team/robot-wires>`__
1110
for more information).
1211

1312
.. image:: images/MotorRig.jpg
1413
:align: center
14+
:alt: Simple test rig with motor mounted to some Tetrix channel
1515

1616
|
1717
@@ -33,13 +33,18 @@ the Powerpole end of the Anderson to JST VH adapter cable.
3333

3434
.. image:: images/ConnectingMotorStep1.jpg
3535
:align: center
36+
:alt: Connecting the adapter cable
3637

3738
|
3839
39-
2. Connect the other end of the Anderson to JST VH adapter cable into
40-
the motor port labeled "0" on the Hub.
40+
.. note:: Motors from different vendors can have different cabling requirments.
41+
Adjust this as needed for your motor.
42+
One end needs to be a JST VH two pin connector (white).
43+
44+
2. Connect the JST VH white connector into the motor port labeled "0" on the Hub.
4145

4246
.. image:: images/ConnectingMotorStep2.jpg
4347
:align: center
48+
:alt: Shows the JST VH white connector of the cable plugged into the Control Hub
4449

45-
|
50+
|

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

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ relates to FTC rules for the control system.
1212
These rules are described in the Competition Manual which can be found on the
1313
`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.
1414

15-
.. tip:: An `Inspection Checklist PDF <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/inspection-checklist.pdf>`_
15+
.. tip:: An `Inspection Checklist (PDF) <https://ftc-resources.firstinspires.org/ftc/event/inspection-check>`_
1616
is available to help teams self-inspect their ROBOT before their event. Teams are strongly encouraged to self-inspect prior to their event.
17+
18+
There is also a `Inspection Quick Reference (PDF) <https://ftc-resources.firstinspires.org/ftc/event/inspection-reference>`_
19+
with some examples of legal and illegal parts (though it is not a substitute for the Competition Manual).
1720

1821
The Self Inspect screen is provided only as a quick, handy reference to
1922
help teams confirm that certain control system elements are up-to-date
@@ -26,26 +29,23 @@ The challenge is to maximize useful information in a small screen. The
2629
Self Inspect layout and graphics evolve with FTC requirements; this page
2730
clarifies some of the brief but meaningful captions.
2831

29-
Field Inspection
32+
Robot Inspection
3033
----------------
3134

32-
Field inspection is concerned with software app versions and configuration, as will as robot operation on the field.
33-
Teams must bring both their driver station (with gamepads) and robot (with battery) to field inspection and be prepared to turn them on, connect the devices, and operate the robot on a field.
34-
35-
The Self Inspection reports may be reviewed in Field Inspection at an FTC tournament, but is **not** a comprehensive or official standard of compliance with FTC rules.
36-
With the robot and driver station turned on and connected the field inspector will likely go through the **Inspection Checklist** form (on paper or a tablet)
35+
The Self Inspection reports may be reviewed in Robot Inspection at an FTC tournament, but is **not** a comprehensive or official standard of compliance with FTC rules.
36+
With the robot and driver station turned on and connected the inspector may go through the **Inspection Checklist** form (on paper or a tablet).
3737
They will check both the **Driver Station Inspection Report** and the **Robot Controller Inspection Report**, both of which can be displayed from the DS.
3838
Many FTC events will scan the QR Code that is displayed on the RC Inspection Report.
3939

4040
Version Information
4141
-------------------
4242

43-
The Competition Manual lists the minimum recommended versions of firmware, Android Operating System, and FTC Apps.
44-
Teams may choose to run older versions without affecting their ROBOT inspection status.
43+
The Competition Manual lists the minimum recommended versions of device firmware, Android operating system, and FTC Apps.
44+
Teams may choose to run older versions without affecting their ROBOT inspection status.
4545
This avoids the situation of trying to upgrade a device at a competition at the last minute where a mistake might leave the robot inoperable.
4646

4747
.. note::
48-
The images in this page show Version 10.3 of the FTC apps.
48+
The images in this page show Version 10.3 or newer of the FTC apps.
4949
This page only shows a Driver Hub paired with a Control Hub, there may be slight differences if a phone is used as a driver station or robot controller.
5050
See the :doc:`old self-inspect<self-inspect>` page for screen images for app versions 10.2 or earlier.
5151

@@ -60,7 +60,11 @@ Regardless of the versions selected, it is highly recommended that the installed
6060
App and DRIVER STATION App versions match major and minor values to ensure compatibility as not
6161
all software versions are compatible with each other.
6262

63+
Teams may choose to run older versions without affecting their ROBOT inspection status.
64+
6365
.. caution::
66+
Some FTC App versions have a different robot communication protocol and are unable to connect with each other.
67+
6468
FIELD STAFF will not be able to provide comprehensive support to teams with software older than the recommended version.
6569

6670
Driver Station Self Inspection Report
@@ -92,6 +96,7 @@ The following is a screen shot of a DS Self Inspection Report with the Driver Hu
9296
- Item 9 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
9397
- Item 10 ``Standard Wi-Fi Connected`` must be **Yes** to indicate the Driver Hub is connected to a standard Wi-Fi source, such as a Control Hub.
9498
- Item 11 shows the ``Driver Station Name`` meets FTC format requirements. It should be your team number plus -DS, example 99999-DS.
99+
If a spare device is configured, a letter designator may be added <team number>-<letter>-DS (e.g., 12345-A-DS, 12345-B-DS).
95100
See the Competition Manual for device naming rules.
96101
- Item 12 shows the ``Robot Controller Name``. It will show **None** if not connected. It will show an error if team number portion of the Robot Controller and Driver Station names do not match.
97102
It does not check whether the RC name matches FTC format requirements. See the Robot Controller Self Inspection Report.
@@ -159,22 +164,23 @@ FYI - if you connect an external monitor to the Control Hub's HDMI port and a mo
159164
- Item 9 ``RC Password`` appears only in RC Self Inspect. This inspection item has failed the FTC requirement for a Control Hub
160165
password different than the factory default (“password”). Go to the Program and Manage page, select Manage and then update the RC password.
161166
You will have to re-pair the DS to the RC and enter the new password to reconnect.
162-
- Item 10 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
167+
- Item 10 ``Wi-Fi Enabled`` must be **Yes** as it means the control hub’s Wi-Fi radio is **ON**.
163168
- Item 11 ``Standard Wi-Fi Connected`` must be **Yes**.
164169
- Item 12 shows the ``Robot Controller Name`` meets FTC format requirements. It should be your team number plus -RC, example 99999-RC.
170+
If a spare device is configured, a letter designator may be added <team number>-<letter>-RC (e.g., 12345-A-RC, 12345-B-RC).
165171
See the Competition Manual for device naming rules.
166172
- Item 13 Apps Installed ``Robot Controller`` should show the RC app version. *FIRST* recommends but does not require that teams use the currently available version.
167-
- Item 14 ``Matches DS Version`` should be **Yes**, though a minor version difference is probably OK such as 10.1 vs 10.2.
173+
- Item 14 ``Matches DS Version`` should be **Yes**. A **No** can show up here and is likely due to a point mismatch e.g. 10.0 and 10.1, mismatches are now allowed, but not recommended.
168174
- Item 15 Apps Installed ``Driver Station`` should be **Not installed**, this verifies that the Robot Controller device does **not** also have a Driver Station app installed.
169175
Only one FTC app should be installed on each device. It's possible to accidentally install both apps, but this usually causes the apps to not work properly.
170-
- Item 16 At the bottom of the RC inspection report is a QR Code that can be scanned during field inspection to fill in many of the field inspection checklist items.
176+
- Item 16 At the bottom of the RC inspection report is a QR Code that can be scanned during inspection to fill in many of the inspection checklist items if the inspector is using a tablet.
171177

172178
.. figure:: images/newRcQrCode.png
173179
:align: center
174180
:width: 85%
175181
:alt: Self Inspect QR code
176182

177-
The field inspector may scan the QR Code during field inspection
183+
The robot inspector may scan the QR Code during inspection
178184

179185
Summary
180186
-------
@@ -183,7 +189,7 @@ The Self Inspect screen is a quick, handy reference to help teams
183189
confirm that certain control system elements are up-to-date and properly
184190
configured.
185191

186-
Self Inspect may be reviewed in Field Inspection at an FTC tournament,
192+
Self Inspect may be reviewed in Robot Inspection at an FTC tournament,
187193
but is **not** a comprehensive or official standard of compliance with
188194
FTC rules.
189195

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ relates to FTC rules for the control system.
1313
These rules are described in the Competition Manual which can be found on the
1414
`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.
1515

16-
.. tip:: An `Inspection Checklist PDF <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/inspection-checklist.pdf>`_
16+
.. tip:: An `Inspection Checklist PDF <https://ftc-resources.firstinspires.org/ftc/event/inspection-check>`_
1717
is available to help teams self-inspect their ROBOT before their event. Teams are strongly encouraged to self-inspect prior to their event.
1818

1919
The Self Inspect screen is provided only as a quick, handy reference to
2020
help teams confirm that certain control system elements are up-to-date
21-
and properly configured. Self Inspect may be reviewed in Field
21+
and properly configured. Self Inspect may be reviewed in Robot
2222
Inspection at an FTC tournament, but is **not** a comprehensive or
2323
official standard of compliance with FTC rules.
2424

@@ -205,7 +205,7 @@ except:
205205
device (Control Hub) and has a correctly formatted name. This does **not**
206206
check that the DS and RC names match (team number). In fact, this phone is
207207
2468-A-DS and this Control Hub is 9999-A-RC, an **illegal combination** to be
208-
flagged by the FTC team or the Field Inspector.
208+
flagged by the FTC team or the Robot Inspector.
209209

210210
DS Self Inspect 3, on Driver Hub paired to RC phone
211211
---------------------------------------------------
@@ -284,7 +284,7 @@ DS Self Inspect 4, on Driver Hub paired to Control Hub
284284
formatted name. This does **not** check that the DS and RC names
285285
match (team number). In fact, this Driver Hub is 1234-A-DS and this
286286
Control Hub is 9999-A-RC, an **illegal combination** to be flagged by
287-
the FTC team or the Field Inspector.
287+
the FTC team or the Robot Inspector.
288288

289289
.. figure:: images/tDS-4a.png
290290
:align: center
@@ -448,7 +448,7 @@ differences. In this example, the robot is configured with **two** Hubs.
448448
the AP has a correctly formatted FTC name. This does **not** check
449449
that the DS and RC names match (team number). In fact, this DS phone
450450
is 2468-A-DS and this Control Hub is 9999-A-RC, an **illegal
451-
combination** to be flagged by the FTC team or the Field Inspector.
451+
combination** to be flagged by the FTC team or the Robot Inspector.
452452
- Item 14 appears only on DS displays of RC Self Inspect. Here is the
453453
check for matching versions of DS app and RC app; in this case both
454454
apps are version 7.0. Any “Point mismatch” (e.g. 7.0 vs. 7.0.1) is
@@ -494,7 +494,7 @@ The Self Inspect screen is a quick, handy reference to help teams
494494
confirm that certain control system elements are up-to-date and properly
495495
configured.
496496

497-
Self Inspect may be reviewed in Field Inspection at an FTC tournament,
497+
Self Inspect may be reviewed in Robot Inspection at an FTC tournament,
498498
but is **not** a comprehensive or official standard of compliance with
499499
FTC rules.
500500

0 commit comments

Comments
 (0)