Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/_templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
<p><a href="{{ pathto('tos/tos') }}">Terms of Service</a></p>
</div>
<div>
<p><a class="external" href="https://www.firstinspires.org/about/privacy-policy">Privacy Policy</a></p>
<p><a class="external" href="https://www.firstinspires.org/privacy-policy">Privacy Policy</a></p>
</div>
<div>
<p><a href="https://www.firstinspires.org/report">Report an Incident</a></p>
<p><a class="external" href="https://www.firstinspires.org/programs/youth-protection-program">Report an Incident</a></p>
</div>

<div>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contrib/style_guide/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,13 @@ RST Code:

.. code:: rest

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

Which looks like:

.. list-table::

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

Generally in FTC Docs we link to file to enable them to be downloaded for printing or offline viewing.
In that case, the user is downloading the file, which is an action, so a button is appropriate.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ images can be local images (saved/stored in the repository) or remote
images (using HTTP links). We're going to use both in our document, but
we need an image to use. I downloaded this file locally:

`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>`_
https://ftc-docs.firstinspires.org/en/latest/_images/HoustonMatchPlay.jpg

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Android Device

.. figure:: images/REV-31-1596.png
:align: center
:alt: REV-31-1596
:alt: REV Driver Hub
:width: 75 %

+++
Expand All @@ -34,7 +34,7 @@ Android Device

.. figure:: images/motoe5.png
:align: center
:alt: MotoE5
:alt: Moto E5
:width: 50 %

+++
Expand Down Expand Up @@ -82,7 +82,7 @@ USB-OTG Adapter / Hubs

.. figure:: images/usbhub.png
:align: center
:alt: USBHub
:alt: Anker USB Hub
:width: 100 %

+++
Expand All @@ -99,7 +99,7 @@ USB-OTG Adapter / Hubs

.. figure:: images/REV-31-1592.png
:align: center
:alt: REV-31-1592
:alt: REV UltraUSB
:width: 50 %

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

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

.. figure:: images/ankerbattery.png
:align: center
:alt: REV-31-1387
:alt: Anker Battery Pack
:width: 50 %

+++
Expand Down Expand Up @@ -162,7 +162,7 @@ Gamepads

.. figure:: images/f310.png
:align: center
:alt: LogitechF310
:alt: Logitech F310
:width: 75 %

+++
Expand Down Expand Up @@ -196,7 +196,7 @@ Gamepads

.. figure:: images/dualshock.png
:align: center
:alt: DualShock4
:alt: Dual Shock 4
:width: 75 %

+++
Expand Down Expand Up @@ -247,7 +247,7 @@ Gamepads

.. figure:: images/quadstick.png
:align: center
:alt: quadstick
:alt: Quadstick
:width: 75 %

+++
Expand Down
2 changes: 1 addition & 1 deletion docs/source/devices/huskylens/huskylens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Introduction

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

.. figure:: images/020-HuskyLens-dual.png
Expand Down
12 changes: 6 additions & 6 deletions docs/source/faq/faqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ Competition FAQs

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

It depends on which inspection station you're visiting and how your event is configured.
The inspectors at Field Inspection like to see the Drive Team, Human Player (if there is
one), and Drive Coach. The inspectors at Robot Inspection really just want to see team
members who have the best idea of what's going on with the robot (mechanically and
electrically). Look at your inspection sheets, you can generally determine what you're
doing based on the checklist.
At least one student must be present during inspection per the Competition Manual.
However, inspectors will ask questions about the mechanical and electrical components of your robot.
Ideally, you have one or more team members who can answer such questions.
In addition, you may need to turn your robot and driver station on and demonstrate your robot complies with a particular rule like sizing.
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.
Look at the self inspection checklist, you can generally determine what you're doing based on the checklist.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/ftc_sdk/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ specifically defined:
upcoming season.

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


SDK Release Notes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ Connecting a Motor to the Hub

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

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

|

Expand All @@ -33,13 +33,18 @@ the Powerpole end of the Anderson to JST VH adapter cable.

.. image:: images/ConnectingMotorStep1.jpg
:align: center
:alt: Connecting the adapter cable

|

2. Connect the other end of the Anderson to JST VH adapter cable into
the motor port labeled "0" on the Hub.
.. note:: Motors from different vendors can have different cabling requirments.
Adjust this as needed for your motor.
One end needs to be a JST VH two pin connector (white).

2. Connect the JST VH white connector into the motor port labeled "0" on the Hub.

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

|
|
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ relates to FTC rules for the control system.
These rules are described in the Competition Manual which can be found on the
`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.

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

There is also a `Inspection Quick Reference (PDF) <https://ftc-resources.firstinspires.org/ftc/event/inspection-reference>`_
with some examples of legal and illegal parts (though it is not a substitute for the Competition Manual).

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

Field Inspection
Robot Inspection
----------------

Field inspection is concerned with software app versions and configuration, as will as robot operation on the field.
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.

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.
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)
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.
With the robot and driver station turned on and connected the inspector may go through the **Inspection Checklist** form (on paper or a tablet).
They will check both the **Driver Station Inspection Report** and the **Robot Controller Inspection Report**, both of which can be displayed from the DS.
Many FTC events will scan the QR Code that is displayed on the RC Inspection Report.

Version Information
-------------------

The Competition Manual lists the minimum recommended versions of firmware, Android Operating System, and FTC Apps.
Teams may choose to run older versions without affecting their ROBOT inspection status.
The Competition Manual lists the minimum recommended versions of device firmware, Android operating system, and FTC Apps.
Teams may choose to run older versions without affecting their ROBOT inspection status.
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.

.. note::
The images in this page show Version 10.3 of the FTC apps.
The images in this page show Version 10.3 or newer of the FTC apps.
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.
See the :doc:`old self-inspect<self-inspect>` page for screen images for app versions 10.2 or earlier.

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

Teams may choose to run older versions without affecting their ROBOT inspection status.

.. caution::
Some FTC App versions have a different robot communication protocol and are unable to connect with each other.

FIELD STAFF will not be able to provide comprehensive support to teams with software older than the recommended version.

Driver Station Self Inspection Report
Expand Down Expand Up @@ -92,6 +96,7 @@ The following is a screen shot of a DS Self Inspection Report with the Driver Hu
- Item 9 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
- 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.
- Item 11 shows the ``Driver Station Name`` meets FTC format requirements. It should be your team number plus -DS, example 99999-DS.
If a spare device is configured, a letter designator may be added <team number>-<letter>-DS (e.g., 12345-A-DS, 12345-B-DS).
See the Competition Manual for device naming rules.
- 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.
It does not check whether the RC name matches FTC format requirements. See the Robot Controller Self Inspection Report.
Expand Down Expand Up @@ -159,22 +164,23 @@ FYI - if you connect an external monitor to the Control Hub's HDMI port and a mo
- Item 9 ``RC Password`` appears only in RC Self Inspect. This inspection item has failed the FTC requirement for a Control Hub
password different than the factory default (“password”). Go to the Program and Manage page, select Manage and then update the RC password.
You will have to re-pair the DS to the RC and enter the new password to reconnect.
- Item 10 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
- Item 10 ``Wi-Fi Enabled`` must be **Yes** as it means the control hub’s Wi-Fi radio is **ON**.
- Item 11 ``Standard Wi-Fi Connected`` must be **Yes**.
- Item 12 shows the ``Robot Controller Name`` meets FTC format requirements. It should be your team number plus -RC, example 99999-RC.
If a spare device is configured, a letter designator may be added <team number>-<letter>-RC (e.g., 12345-A-RC, 12345-B-RC).
See the Competition Manual for device naming rules.
- 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.
- Item 14 ``Matches DS Version`` should be **Yes**, though a minor version difference is probably OK such as 10.1 vs 10.2.
- 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.
- 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.
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.
- 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.
- 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.

.. figure:: images/newRcQrCode.png
:align: center
:width: 85%
:alt: Self Inspect QR code

The field inspector may scan the QR Code during field inspection
The robot inspector may scan the QR Code during inspection

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ relates to FTC rules for the control system.
These rules are described in the Competition Manual which can be found on the
`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.

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

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/overview/ftcoverview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ option for up to 24 students.

Continue on to learn about the |text2|_

.. _text2: https://www.firstinspires.org/robotics/ftc/start-a-team
.. _text2: https://www.firstinspires.org/programs/ftc/get-started
.. |text2| replace:: essential steps to starting a *FIRST* Tech Challenge Team!

About *FIRST* Tech Challenge Kahoot
Expand Down
Loading