Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

De-emphasizing phones #294

Open
wants to merge 47 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
2d2abb5
De-emphasized phones for app updates
miriamsr Aug 2, 2024
3f1453e
Merge branch 'main' into android
miriamsr Aug 3, 2024
a0d2b2c
Merge branch 'main' into android
uvidyadharan Aug 7, 2024
c9284f4
Merge branch 'main' into android
miriamsr Aug 21, 2024
7aa6655
Added references to the Control Hub for the color sensors config
miriamsr Sep 2, 2024
a4f907c
Added references to the Control Hub for sensors in blocks
miriamsr Sep 2, 2024
a630dc3
Added links to documentation for Control and Driver hubs
miriamsr Sep 2, 2024
94e1a80
Added references to the Control Hub for OBJ and AS sensor pages
miriamsr Sep 2, 2024
4c3e740
Added references to the Control Hub in PID/PIDF pages
miriamsr Sep 2, 2024
9484ad4
Fixed a typo
miriamsr Sep 2, 2024
bfc405c
Swapped the control hub and phone sections for creating a config
miriamsr Sep 3, 2024
fa96499
Merge branch 'main' into android
miriamsr Sep 17, 2024
50d33de
Updated the webcam page for phones
miriamsr Sep 18, 2024
3037fab
Merge branch 'main' into android
miriamsr Sep 18, 2024
c5e9833
Merge branch 'main' into android
miriamsr Sep 25, 2024
cd9d5fa
Added Driver Hubs when talking about using Android
miriamsr Sep 30, 2024
a091203
Merge branch 'main' into android
miriamsr Oct 6, 2024
b387c12
Updated webcam page for Control Hubs
miriamsr Oct 6, 2024
638ceb1
Merge branch 'android' of https://github.com/miriamsr/ftcdocs into an…
miriamsr Oct 6, 2024
978d3ab
Reduced file size on image
miriamsr Oct 6, 2024
d1b28c0
Fixed typo
miriamsr Oct 6, 2024
c81cc39
Merge branch 'main' into android
miriamsr Oct 22, 2024
3f1604c
Started the updates for adding an Expansion Hub to a Control Hub
miriamsr Oct 22, 2024
75141d9
Merge branch 'main' into android
miriamsr Oct 22, 2024
af9c618
Merge branch 'main' into android
miriamsr Oct 24, 2024
9533b5f
Updated required materials
miriamsr Nov 3, 2024
cc4ff05
Merge branch 'main' into android
miriamsr Dec 11, 2024
4843ed6
Used DH screenshots on the saving config page
miriamsr Dec 11, 2024
752eebd
Merge branch 'android' of https://github.com/miriamsr/ftcdocs into an…
miriamsr Dec 11, 2024
ff37bd1
Updated instructions for configuring android
miriamsr Dec 12, 2024
38fa810
Merge branch 'main' into android
miriamsr Dec 12, 2024
5e8924d
Updated blocks instruction for running OpModes
miriamsr Dec 14, 2024
d42b295
Updated OpMode instructions for OBJ
miriamsr Dec 14, 2024
894e0e7
Updated OpMode instructions in AS
miriamsr Dec 14, 2024
63919aa
Addressed comments from Chris on 12, 13, 16, 18, 19, 25
miriamsr Jan 21, 2025
5bae088
Removed MR and Hitechnic
miriamsr Jan 22, 2025
dba9758
Moved ESD to its own section
miriamsr Jan 22, 2025
3f9ca84
Merge branch 'main' into android
miriamsr Jan 22, 2025
2e7187c
Added a booklet for ESD
miriamsr Jan 23, 2025
e778a18
Updated the control system intro page
miriamsr Jan 24, 2025
280e608
Resolved PR comments
miriamsr Jan 24, 2025
0428a8e
Converted DH image to PNG
miriamsr Jan 24, 2025
3583349
Converted CH image to PNG
miriamsr Jan 24, 2025
0bb54aa
Converted required materials DH image to PNG
miriamsr Jan 24, 2025
54fc3fc
Fixed image check errors
miriamsr Jan 25, 2025
9ad548a
Fixed a typo
miriamsr Jan 25, 2025
cef3cc6
Merge branch 'main' into android
miriamsr Jan 27, 2025
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
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
(Photo courtesy of Dan Donovan, ©2017 Dan Donovan / www.dandonovan.com)

AUTO vs. TELEOP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~

A *FIRST* Tech Challenge match has an AUTO phase and a
TELEOP phase. In the AUTO phase
Expand All @@ -40,67 +40,65 @@
|

One Android device is mounted onto the robot and is called the *Robot
Controller*. The Robot Controller acts as the “brains” of the robot. It
does all of the thinking for the robot and tells the robot what to do.
It consists of an Android device running a Robot Controller app.
There are two hardware options currently being used: REV Robotics
Expansion Hub or the REV Robotics Control Hub.
Controller*. In most cases, the ROBOT CONTROLLER is integrated into the
REV Robotics Control Hub. The Robot Controller acts as the “brains” of the
robot. It does all of the thinking for the robot and tells the robot what
to do. It consists of an Android device running a Robot Controller app. Many
Teams will also connect a REV Robotics Expansion Hub for additional ports to
connect motors, servos, and sensors to the ROBOT.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think generally ftc-docs does not use the Oxford comma.


A second Android device sits with the team drivers and has one or two
gamepads connected. This second device is known as the DRIVER STATION.
The DRIVER STATION is sort of like a remote control that you might use
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest omitting "sort of", for more consistent language/tone of ftc-docs.

to control your television. The DRIVER STATION allows a team to
communicate remotely (using a secure, wireless connection) to the Robot
Controller and to issue commands to the Robot Controller. The DRIVER STATION consists of an Android device running an Driver Station app.
Controller and to issue commands to the Robot Controller. The DRIVER STATION
consists of an Android device running an Driver Station app. Most teams use
a REV Robotics Driver Hub, but select Android smartphones are also supported.

REV Robotics Expansion Hub
~~~~~~~~~~~~~~~~~~~~~~~~~~
REV Robotics Control Hub and Expansion Hub
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The REV Robotics Expansion Hub is the electronic input/output (or “I/O”)
The REV Robotics Control Hub or Expansion Hub is the electronic input/output (or “I/O”)
module that lets the Robot Controller talk to the robot’s motors,
servos, and sensors. The Robot Controller communicates with the
servos, and sensors. The Robot Controller is integrated into the Control Hub, and communicates with the
Expansion Hub through a serial connection. For the situation where an
Android smartphone is used as the Robot Controller, a USB cable is used
to establish the serial connection. For the situation where a REV
Robotics Control Hub is used, an internal serial connection exists
between the built-in Android device and the Expansion Hub.
to establish the serial connection.

The Expansion Hub is also connected to a 12V battery which is used to
power the Expansion Hub, the motors, the servos and sensors. If an
The Control Hub and Expansion Hub are also connected to a 12V battery which is used to
power the Control Hub, the Expansion Hub, the motors, the servos and sensors. If an
Android smartphone is used as the Robot Controller, then the smartphone
will have its own independent battery. If a REV Robotics Control Hub is
used as the Robot Controller, then the Control Hub will use the main 12V
battery to power its internal Android device.
will have its own independent battery.

.. image:: images/REVExpansionHubLayout.jpg
.. image:: images/REVControlHubLayout.png
:align: center

|

REV Robotics Control Hub
~~~~~~~~~~~~~~~~~~~~~~~~
Android Smartphones
~~~~~~~~~~~~~~~~~~~

The REV Robotics Control Hub is an integrated version of the Robot Controller.
It combines an Android device built into the same case as a REV Robotics
Expansion Hub.
While not reccomended, teams may opt to use an Android smartphone as either their

Check failure on line 82 in docs/source/programming_resources/shared/control_system_intro/The-FTC-Control-System.rst

View workflow job for this annotation

GitHub Actions / spelling-check

[misspell] reported by reviewdog 🐶 "reccomended" is a misspelling of "recommended" Raw Output: ./docs/source/programming_resources/shared/control_system_intro/The-FTC-Control-System.rst:82:10: "reccomended" is a misspelling of "recommended"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"recommended" is misspelled, but anyway I suggest omitting that opening phrase. The actual status of smartphones is that they are optional, covered by "Teams may opt to...". Some teams have a legitimate need or preference for smartphones.

DRIVER STATION or ROBOT CONTROLLER. DRIVER STATION phones should have the FTC Driver
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest changing "either...or" to just "or". As an alternate, add ", or both" after ROBOT CONTROLLER.

Station app installed, and will need an OTG adaptor USB hub to connect gamepads.

.. image:: images/ControlHubEquals.jpg
:align: center

|

The Control Hub, which has its built-in Android device connected
directly to the Expansion Hub using an internal serial bus, eliminates
the need for an external USB connection between the Android Robot
Controller and the I/O module.
Teams who use an Android smartphone as their ROBOT CONTROLLER will want an additional
REV Robotics Expansion Hub to connect motors, servos and sensors. The smartphone is
connected to the Expansion Hub via a USB-A to USB-Mini cable and an OTG adaptor.

.. image:: images/REVControlHubLayout.jpg
.. image:: images/REVExpansionHubLayout.jpg
:align: center

|

What’s an Op Mode?
~~~~~~~~~~~~~~~~~~
What’s an OpMode?
~~~~~~~~~~~~~~~~~

During a typical *FIRST* Tech Challenge match, a team’s robot has to
perform a variety of tasks in an effort to score points. For example, a
Expand All @@ -109,14 +107,14 @@
autonomously during a match. Teams write “op modes” (which stand for
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"OpModes"

“operational modes”) to specify the behavior for their robot.

*Op modes* are computer programs that are used to customize the behavior
*OpModes* are computer programs that are used to customize the behavior
of a competition robot. The Robot Controller can *execute* a selected op
mode to perform certain tasks during a match.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpMode


Teams who are participating in *FIRST* Tech Challenge have a variety
of programming tools that they can use to create their own op modes.
of programming tools that they can use to create their own OpModes.
Teams can use a visual (“drag and drop”) programming tool called the
*Blocks Programming Tool* to create their op modes. Teams can also
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpModes

use a text-based Java tool known as the *OnBot Java Programming
Tool* or Google’s *Android Studio* integrated development environment
(also known as an “IDE”) to create their op modes.
(also known as an “IDE”) to create their OpModes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading