Skip to content
Draft
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
19 changes: 4 additions & 15 deletions docs/source/ftc_sdk/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ specifically defined:
- **Update / Patch Releases** - These are typically released during the
*FIRST* Tech Challenge season, when critical issues or helpful features are
available for teams. Update/Patch releases aren't generally required for
competition unless a critical patch or bugfix is issued.
- **Offseason Release** - Offseason releases are used to prepare teams for
competition unless a critical patch or bug fix is issued.
- **Off season Release** - Off season releases are used to prepare teams for
breaking changes or to provide a technology preview for new features in the
upcoming season.

Expand Down Expand Up @@ -137,17 +137,6 @@ no longer necessary.
Updating SDK Software
---------------------

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

- :doc:`Updating the REV Hardware Client </ftc_sdk/updating/hardware_client/Updating-REV-Hardware-Client>`
- :doc:`Updating the Driver Station App </ftc_sdk/updating/ds_app/Updating-the-DS-App>`
- :doc:`Updating the Robot Controller App </ftc_sdk/updating/rc_app/Updating-the-RC-App>`
- :doc:`Updating the Driver Hub OS </ftc_sdk/updating/driverhub_os/Updating-the-Driver-Hub-OS>`
- :doc:`Updating the Control Hub OS </ftc_sdk/updating/controlhub_os/Updating-the-Control-Hub-OS>`
- :doc:`Updating the Hub Firmware </ftc_sdk/updating/hub_firmware/Updating-Hub-Firmware>`

It is important for teams to update the SDK software.
Details can be found on the :doc:`Updating Components of the Control System </ftc_sdk/updating/index>` page.

Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Installing and Updating the REV Hardware Client
===============================================

The REV Hardware Client is a desktop app, or software tool, that simplifies
The REV Hardware Client (RHC) is a desktop app, or software tool, that simplifies
updating software on devices used in *FIRST* Tech Challenge. Unfortunately the
REV Hardware Client is currently Windows-only, Apple/Mac users must use
alternate methods of updating software. In this tutorial, some steps ask to
download software and updates - doing this is not required, but will save time
during updates.

To install, use the following steps on a **64-bit** PC or laptop running
Windows 7 or newer.
Windows 10 or newer.

**Apple/Mac users should skip these steps.**

Expand All @@ -22,8 +22,8 @@ Installing the RHC

1. Connect the computer to the internet, and download RHC
`from the REV RHC download page <https://docs.revrobotics.com/rev-hardware-client/>`__. Just
click the orange Download button and choose your computer’s Downloads
folder to store the file.
click the orange REV Hardware Client button and choose your computer’s Downloads
folder to store the file (if that is an option your browser supports).

.. figure:: images/010-download.png
:alt: Downloading REV Hardware Client
Expand All @@ -34,27 +34,29 @@ Installing the RHC

|

2. See the downloaded file shown at lower left (green arrow). Click that
2. The file is likely named **REV-Hardware-Client-Setup.exe** with a version number.
Your browser may allow you to run that program after it is downloaded. If needed,
find that file in your browser's downloads folder. Click that
filename to begin installing the RHC app; then follow the prompts.
When that’s complete, the RHC icon will appear on your computer’s
desktop.

If the computer is **not** 64-bit, RHC installation will fail with an
appropriate error message.

Downloading Initial Updates
---------------------------

Open the RHC app. This is a good time to **pre-download** various
pieces of software you might need soon.
These are the firmware, operating system and App files that the RHC
can install on your devices.

Why download now? Later, this computer might be connected via Wi-Fi to a
Robot Controller, not to the internet. Or a good internet connection
might not be available when urgently needed (Murphy’s Law).

Click on the Downloads tab (top left). Under “Available Files” is a list
of software for *FIRST* Tech Challenge and other software for a different program called
*FIRST* Robotics Competition.
of software for *FIRST* Tech Challenge.
You can ignore the Pneumatic Hub Firmware, the Power Distribution Firmware,
and the SPARK MAX Firmware as these are for the *FIRST* Robotics Competition program.

.. figure:: images/020-RHC-available-files.png
:alt: Available Files
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 80 additions & 3 deletions docs/source/ftc_sdk/updating/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,60 @@
Updating Components of the Control System
=========================================

Certain components of the *FIRST* Tech Challenge Control System will
periodically receive updates. Teams should make sure to update each component
of the Control System to the latest released version.
Components of the *FIRST* Tech Challenge Control System will
periodically receive updates.
It is recommended teams update each component of the Control System
to the latest released version of firmware, operating system and applications.

The Robot Controller App and the Driver Station App have an update schedule based on the game season.
The season Kickoff SDK Release each year will include new game specific assets such as
:doc:`AprilTags </apriltag/vision_portal/apriltag_intro/apriltag-intro>`.

.. note::
The most recent versions of FTC software have the
latest bugfixes and updates. Teams are encouraged to update their
software to the most recent version. FIELD STAFF at an FTC Event may not be able to
provide comprehensive support to teams using older software.

A **Robot Controller** should be using the most recent Robot Controller App.
At the start of a new FTC season this should be the Kickoff SDK Release
which normally comes out a few weeks after kickoff.

A **Driver Station** should be using the most recent Driver Station App.

Regardless of the App versions selected, it is highly recommended that the installed
Robot Controller App and Driver Station App versions match major and minor values
to ensure compatibility as not all software versions are compatible with each other.
e.g. if the Robot Controller App is version 11.1, the the Driver Hub should be
using Driver Station App 11.1.

Teams may choose to run older versions of software without affecting their
robot inspection status at an event. This is not recommended, but allowed.

Teams may also use Android phones as their Robot Controller or Driver Station.
Please see the Competition Manual for permitted devices and the procedure for requesting exceptions.

.. caution::
Due to unpredictable variations in Android software across different
manufacturers and updates, the REV Control Hub is the only officially supported
Robot Controller.

The REV Driver Hub is the only officially supported Driver Station device.
Not all phones have hardware driver support for the gamepads that are used in a driver station.

Teams choosing to use an Android phone are responsible for testing and verifying its
compatibility, functionality, and performance.

Update Instructions
-------------------

.. tip::
It is recommended to use the
`REV Hardware Client <https://docs.revrobotics.com/rev-hardware-client/>`__
to update devices if a Windows computer is available.
The REV Hardware Client is able to update all control system device software.
Alternate methods can be used to update devices, see the detailed
instructions linked to below.

.. toctree::
:maxdepth: 1
Expand All @@ -20,3 +70,30 @@ of the Control System to the latest released version.
Updating Driver Hub OS <driverhub_os/Updating-the-Driver-Hub-OS>
Updating Control Hub OS <controlhub_os/Updating-the-Control-Hub-OS>
Updating Hub Firmware <hub_firmware/Updating-Hub-Firmware>

The REV Servo Hub (REV-11-1855) has firmware that can be
`updated <https://docs.revrobotics.com/rev-hardware-client/crossover/servo-hub#update-tab>`__
using the REV Hardware Client. Instructions at the REV website.

For those teams not using the REV Hardware Client the following table has links
to the Change Log or Release Notes for each component that can be used to determine the current version.
Then use the alternate update methods mentioned in the instructions in the above links.

.. list-table:: Component Changes
:widths: 50 50
:header-rows: 1

* - Device
- Change Log or Release Notes
* - REV Control Hub
- `Hub Firmware <https://docs.revrobotics.com/duo-control/managing-the-control-system/updating-firmware/firmware-changelog>`__
and `Control Hub OS <https://docs.revrobotics.com/duo-control/managing-the-control-system/updating-operating-system/operating-system-changelog>`__
and `Robot Controller App <https://github.com/FIRST-Tech-Challenge/FtcRobotController/releases>`__
* - REV Driver Hub
- `Driver Hub OS <https://software-metadata.revrobotics.com/releasenotes/driverhubos/#driver-hub-os-release-notes>`__
and `Driver Station App <https://github.com/FIRST-Tech-Challenge/FtcRobotController/releases>`__
* - REV Expansion Hub
- `Hub Firmware <https://docs.revrobotics.com/duo-control/managing-the-control-system/updating-firmware/firmware-changelog>`__
* - REV Servo Hub
- `REV Servo Hub Firmware <https://docs.revrobotics.com/rev-crossover-products/servo/servo-hub/servo-hub-firmware-changelog>`__

Loading