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

Document AStop #2816

Merged
merged 6 commits into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
21 changes: 20 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ modern-sphinx-version-warning = "==1.1.6"
sphinxcontrib-htmlhelp = "==2.1.0"
sphinxcontrib-serializinghtml = "==2.0.0"
sphinxcontrib-svg2pdfconverter = "==1.2.2"
sphinxcontrib-video = "==0.2.1"
sphinxext-delta = "==0.2.0"
sphinxext-mimic = "==0.1.1"
sphinxext-opengraph = "==0.9.0"
Expand Down
9 changes: 9 additions & 0 deletions source/_static/css/frc-rtd.css
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@
width: 320px;
}

/*
* Prevent video containers from spilling over the edges of the main panel.
* This matches the built-in style for `.rst-content img`
*/
.rst-content video {
max-width: 100%;
height: auto;
}

.document img {
margin-bottom: 10px;
}
Expand Down
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
"sphinxcontrib.rsvgconverter",
"sphinxcontrib.video",
"sphinxext.delta",
"sphinxext.opengraph",
"sphinxext.photofinish",
Expand Down
2 changes: 2 additions & 0 deletions source/docs/beta/tasks/task-4-new-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The purpose of this task is to test any newly developed or heavily modified feat

**All languages**

- Use the new A-Stop functionality built into the :doc:`Driver Station's Practice mode </docs/software/driverstation/driver-station>`.

**LabVIEW**

**Java**
Expand Down
15 changes: 15 additions & 0 deletions source/docs/software/driverstation/driver-station.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ The FRC Driver Station can be launched by double-clicking the icon on the Deskto
* :kbd:`[` + :kbd:`]` + :kbd:`\\` - Enable the robot (the 3 keys above Enter on most keyboards)
* :kbd:`Enter` - Disable the Robot
* :kbd:`Space` - Emergency Stop the robot. After an emergency stop is triggered the roboRIO will need to be rebooted before the robot can be enabled again.
* :kbd:`Backspace` - "A-Stop" the robot when in Practice Mode - Autonomous Enabled. The robot will be disabled until the Practice Mode reaches Teleop then will be automatically re-enabled. While disabled, the application background will flash orange indicating the robot will re-enable automatically.

.. only:: html

.. video:: images/driver-station/ds-astop.mp4
:loop:
:width: 900
:autoplay:
:muted:
:alt: Driver Station flashing yellow in A-Stop mode

.. only:: not html

.. image:: images/driver-station/ds-astop.png
:alt: Driver Station flashing yellow in A-Stop mode
Kevin-OConnor marked this conversation as resolved.
Show resolved Hide resolved

.. note:: Space bar will E-Stop the robot regardless of if the Driver Station window has focus or not

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.13
sphinxcontrib-qthelp==2.0.0 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-serializinghtml==2.0.0 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-svg2pdfconverter==1.2.2 ; python_version >= "3.9" and python_version < "3.13"
sphinxcontrib-video==0.2.1 ; python_version >= "3.9" and python_version < "3.13"
sphinxext-delta==0.2.0 ; python_version >= "3.9" and python_version < "3.13"
sphinxext-mimic==0.1.1 ; python_version >= "3.9" and python_version < "3.13"
sphinxext-opengraph==0.9.0 ; python_version >= "3.9" and python_version < "3.13"
Expand Down