Skip to content

Commit a55bd75

Browse files
authored
Merge branch 'main' into fix_more_links
2 parents b05afdb + 2fbd0b0 commit a55bd75

File tree

122 files changed

+105
-2749
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+105
-2749
lines changed

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ python-git-info==0.8.3
1111
sphinxcontrib-mermaid==0.9.2
1212
sphinx-hoverxref==1.3.0
1313
sphinxext-rediraffe==0.2.7
14-
git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=linkcheckdiff
14+
sphinx-notfound-page==1.1.0
15+
git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=linkcheckdiff

docs/source/404.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. meta::
2+
:title: Page not found
3+
:description: The official home of FIRST Tech Challenge Documentation.
4+
:orphan:
5+
6+
Page not found
7+
==============
8+
9+
Unfortunately we couldn't find the content you were looking for. Try using the sidebar menu links or search box.
10+
11+
TensorFlow and the *FIRST* Machine Learning Toolchain content has been moved to the `FTC Docs Archive <https://ftc-docs.firstinspires.org/projects/ftcdocs-archive/en/latest/index.html>`__.
12+
13+

docs/source/apriltag/vision_portal/apriltag_intro/apriltag-intro.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ several resources:
2525
image processing library
2626
- myBlocks: custom Blocks created in OnBot Java (OBJ)
2727

28-
Now these three areas are provided, or bundled, in the new *FIRST* **Tech Challenge
29-
Software Development Kit (SDK), version 8.2**.
28+
Now these three areas are provided, or bundled, in the *FIRST* **Tech Challenge
29+
Software Development Kit (SDK), starting with version 8.2**.
3030

3131
Namely, key capabilities of **AprilTag** and **EasyOpenCV** are
3232
available to the Robot Controller (RC) and Driver Station (DS) apps,
3333
without special downloads. And AprilTag features are included in **FTC
3434
Blocks**, without needing custom myBlocks.
3535

36-
The AprilTag features work on Android RC phone cameras, and on webcams.
37-
A single OpMode can use AprilTag and TensorFlow Object Detection (TFOD).
36+
The AprilTag features work on webcams and on Android RC phone cameras.
37+
A single OpMode can use AprilTag and Color Processing.
3838

3939
In *FIRST* Tech Challenge, AprilTag is ready for the spotlight!
4040

@@ -66,7 +66,7 @@ containing information and designed for easy recognition.
6666
The above samples represent different formats, or **families**. A
6767
project typically uses a single AprilTag family.
6868

69-
This year, *FIRST* Tech Challenge uses a common family called **36h11**. A PDF
69+
*FIRST* Tech Challenge uses a common family called **36h11**. A PDF
7070
showing the numbers 0 through 20 from the 36h11 family can be downloaded here:
7171

7272
- :download:`AprilTag PDF 0-20 <files/AprilTag_0-20_family36h11.pdf>`
@@ -175,17 +175,17 @@ remains within the camera’s field of view. Namely, an OpMode “**while() loop
175175
should regularly read the updated pose data, to guide the robot’s driving
176176
actions.
177177

178-
The new SDK supports **multiple cameras**, switchable or simultaneous. This
178+
The SDK supports **multiple cameras**, switchable or simultaneous. This
179179
can help if the robot changes direction, or you wish to navigate using another
180-
AprilTag (or TensorFlow object).
180+
AprilTag (or Color Processing).
181181

182182
Other sensors can also be used for navigation, such as drive motor encoders,
183183
REV Hub IMU, deadwheel encoders, color/distance sensors, ultrasonic sensors,
184184
and more.
185185

186186
It’s also possible to evaluate **non-AprilTag images** from the same camera
187187
and/or a second camera. For example, the SDK can estimate the horizontal angle
188-
(or Bearing) of an object detected with **TensorFlow**, another vision
188+
(or Bearing) of an object detected with **Color Processing**, another vision
189189
technology employed in *FIRST* Tech Challenge. Advanced teams might consider
190190
active camera pointing control, to keep an AprilTag or other object in view.
191191

@@ -215,7 +215,7 @@ tags are **not** annotated by default with a colored border.
215215

216216
Note: **Camera Stream** displays a snapshot of the camera’s view, on the Driver
217217
Station device. It’s available only during the INIT phase of an OpMode, and
218-
also shows any AprilTag (or TFOD) annotations. Instructions are posted here:
218+
also shows any AprilTag (or Color Processing) annotations. Instructions are posted here:
219219

220220
- :ref:`Camera Stream Image Preview Documentation <hardware_and_software_configuration/configuring/configuring_external_webcam/configuring-external-webcam:image preview>`
221221

@@ -301,12 +301,12 @@ pose data in real-time to navigate to the desired location on the field.
301301
Vision processing can consume significant **CPU resources** and USB
302302
communications **bandwidth**. *FIRST* Tech Challenge teams may balance the
303303
benefits of higher resolution and speed (frames-per-second) against the risk of
304-
overloading CPU and bandwidth resources. The 8.2 SDK provides numerous tools to
304+
overloading CPU and bandwidth resources. The SDK 8.2 or later provides numerous tools to
305305
manage this balance:
306306

307307
- select the camera resolution
308308
- disable and enable the RC preview (called LiveView)
309-
- disable and enable the AprilTag (or TFOD) processor
309+
- disable and enable the AprilTag (or Color Processing) processor
310310
- close the camera stream
311311
- select a compressed video streaming format
312312
- measure frames-per-second
@@ -315,18 +315,18 @@ manage this balance:
315315

316316
**Option 3**
317317

318-
Clearer camera images can improve AprilTag (and TFOD) vision processing.
318+
Clearer camera images can improve AprilTag (and Color Processing) vision processing.
319319
The SDK offers powerful **webcam controls** (Exposure, Gain, Focus,
320-
and more), now available in FTC Blocks! These controls can be applied
320+
and more), also available in FTC Blocks! These controls can be applied
321321
under various lighting conditions.
322322

323-
Exposure and Gain are adjusted together. The new SDK offers Java Sample
323+
Exposure and Gain are adjusted together. The SDK offers Java Sample
324324
OpMode ``ConceptAprilTagOptimizeExposure.java``.
325325

326326
**Option 4**
327327

328328
The frame of reference described above in **AprilTag Axes** is
329-
calculated and provided by default in the new 8.2 SDK. Advanced teams
329+
calculated and provided by default in the 8.2 SDK or later. Advanced teams
330330
may prefer to perform their own pose calculations, based on **raw
331331
values** from the AprilTag/EasyOpenCV pipeline.
332332

@@ -381,7 +381,7 @@ Summary
381381
AprilTag is a popular camera-based technology, using a scanned image
382382
similar to a QR Code.
383383

384-
The new SDK version 8.2 now includes key capabilities of AprilTag and
384+
The SDK version 8.2 or later includes key capabilities of AprilTag and
385385
EasyOpenCV, a *FIRST* Tech Challenge-optimized interface with OpenCV for image
386386
processing. These methods are packaged for convenient use by **Java and Blocks
387387
programmers**.
@@ -399,8 +399,8 @@ Each camera requires **calibration data**, for a specific resolution, to
399399
provide good pose estimates.
400400

401401
Multiple cameras are supported, and a single OpMode can use AprilTag and
402-
TensorFlow Object Detection (TFOD). AprilTag detection is improved with
403-
webcam Camera Controls, now available also in FTC Blocks.
402+
Color Processing. AprilTag detection is improved with
403+
webcam Camera Controls, available also in FTC Blocks.
404404

405405
**In** *FIRST* **Tech Challenge, AprilTag is ready to take CENTERSTAGE!**
406406

docs/source/booklets/advanced.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
:titlesonly:
1414

1515
/programming_resources/vision/vision_overview/vision-overview
16-
/programming_resources/vision/tensorflow_pp_2022/tensorflow_pp_2022
17-
/programming_resources/vision/blocks_tfod_opmode/blocks-tfod-opmode
18-
/programming_resources/vision/java_tfod_opmode/java-tfod-opmode
19-
/programming_resources/vision/tensorflow_ff_2021/tensorflow-ff-2021
2016
/programming_resources/vision/webcam_controls/index
2117
Camera Calibration </programming_resources/vision/camera_calibration/camera-calibration>
2218

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
'sphinxcontrib.mermaid',
3232
'hoverxref.extension',
3333
"sphinxext.rediraffe",
34+
'notfound.extension',
3435
"ftcdocs_linkcheckdiff",
3536
]
3637

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ and :doc:`gracious_professionalism/gp` to see why.
112112
faq/faqs
113113
Team Complimentary Software<sponsors/software/software>
114114
Team Discounts<sponsors/discounts/discounts>
115+
team_resources/team_resources
115116

116117
.. toctree::
117118
:caption: FTC Docs

docs/source/programming_resources/index.rst

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. meta::
22
:title: Programming Resources, FTC Docs
33
:description: Official Programming Resources for FIRST Tech Challenge
4-
:keywords: Blocks, FTC, FIRST Tech Challenge, On Bot Java, Android Studios, Control Hub, Robot Controller, Driver Station, FTC Control System, Programming Resources
4+
:keywords: Blocks, FTC, FIRST Tech Challenge, On Bot Java, Android Studio, Control Hub, Robot Controller, Driver Station, FTC Control System, Programming Resources
55

66
Programming Resources
77
=====================
@@ -83,23 +83,6 @@ Topics for programming with AprilTags
8383
AprilTag Test Images <../apriltag/opmode_test_images/opmode-test-images>
8484
../apriltag/apriltag_tips/decode_apriltag/decode-apriltag
8585

86-
TensorFlow Programming
87-
~~~~~~~~~~~~~~~~~~~~~~
88-
89-
Topics for programming with TensorFlow Object Detection (TFOD)
90-
91-
.. toctree::
92-
:maxdepth: 1
93-
:titlesonly:
94-
95-
vision/tensorflow_cs_2023/tensorflow-cs-2023
96-
vision/tensorflow_pp_2022/tensorflow_pp_2022
97-
vision/tensorflow_ff_2021/tensorflow-ff-2021
98-
vision/blocks_tfod_opmode/blocks-tfod-opmode
99-
vision/blocks_tfod_opmode_custom/blocks-tfod-opmode-custom
100-
vision/java_tfod_opmode/java-tfod-opmode
101-
vision/java_tfod_opmode_custom/java-tfod-opmode-custom
102-
10386
Vision Programming
10487
~~~~~~~~~~~~~~~~~~~
10588

@@ -152,5 +135,5 @@ Advanced Topics for Programmers
152135
Additional *FIRST* Website Resources
153136
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154137

155-
- `FIRST Website Programming Resources Link <https://www.firstinspires.org/resource-library/ftc/technology-information-and-resources>`__
138+
- `FIRST Website Programming Resources Link <https://www.firstinspires.org/resources/library/ffc/programming-resources>`__
156139

docs/source/programming_resources/shared/auto_load_opmode/auto-load-opmode.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,15 @@ translucent and have no text adjacent to it, indicating the feature is
2020
inactive.
2121

2222

23+
.. figure:: images/translucentPreselectLandscape.png
24+
:align: center
25+
26+
The preselect button will appear once an autonomous OpMode has been selected in landscape mode.
27+
2328
.. figure:: images/translucentPreselect.png
2429
:align: center
2530

26-
The preselect button will appear once an autonomous op mode has been selected.
31+
The preselect button will appear once an autonomous OpMode has been selected in portrait mode.
2732

2833

2934
Note that in order for the preselect button to be visible, the selected
@@ -43,10 +48,15 @@ mode. The button will then become fully opaque and the name of the
4348
preselected op mode will appear adjacent to the button. This indicates
4449
the feature is active.
4550

51+
.. figure:: images/selectTeleOpLandscape.png
52+
:align: center
53+
54+
The driver controlled OpMode to be auto-loaded in landscape mode.
55+
4656
.. figure:: images/selectTeleOp.png
4757
:align: center
4858

49-
The driver controlled op mode to be auto-loaded.
59+
The driver controlled OpMode to be auto-loaded in portrait mode.
5060

5161
Should you then wish to disable it, simply long press the preselect
5262
button. It will become translucent again and the text adjacent to it
@@ -90,11 +100,17 @@ automatically load the preselected teleop op mode. If the “Op Mode Auto
90100
Queue” option is disabled, a team can still select a teleop op mode by
91101
using the preselect button on the main Driver Station activity.
92102

103+
.. figure:: images/AutoQueueEnabledLandscape.png
104+
:align: center
105+
106+
If the OpMode Auto Queue option is enabled, the Driver Station will
107+
automatically load the preselectTeleOp op mode in landscape mode.
108+
93109
.. figure:: images/AutoQueueEnabled.png
94110
:align: center
95111

96112
If the OpMode Auto Queue option is enabled, the Driver Station will
97-
automatically load the preselectTeleOp op mode.
113+
automatically load the preselectTeleOp op mode in portrait mode.
98114

99115
.. raw:: html
100116

132 KB
Loading
260 KB
Loading

0 commit comments

Comments
 (0)