Skip to content

Remove content for removed features in 2027 #3040

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Jun 25, 2025
Merged

Remove content for removed features in 2027 #3040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f8808d3
(WIP) Remove links and references to old tools and Labview
Gold856 May 27, 2025
f64d335
Remove ultrasonic docs
Gold856 May 27, 2025
14aea9b
Remove Sendable docs
Gold856 Jun 20, 2025
14a9cc7
Remove Labview articles
Gold856 Jun 20, 2025
b533341
Remove Shuffleboard, SmartDashboard, RobotBuilder, and PathWeaver
Gold856 Jun 20, 2025
c86e0bf
Remove RTNS
Gold856 Jun 21, 2025
547f9a1
Remove more references to old hardware
Gold856 Jun 21, 2025
6faa968
Update Inspector excludes
Gold856 Jun 21, 2025
4b4e207
Lint fix
Gold856 Jun 21, 2025
8fc0bac
Add link to old LabVIEW docs
Gold856 Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 1 addition & 4 deletions .github/workflows/inspector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,15 @@
"source/docs/software/hardware-apis/pneumatics/solenoids.rst",
"source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst",
"source/docs/software/commandbased/subsystems.rst",
"source/docs/software/telemetry/writing-sendable-classes.rst",
"source/docs/software/advanced-controls/trajectories/troubleshooting.rst",
"source/docs/software/hardware-apis/motors/wpi-drive-classes.rst",
"source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst",
"source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst",
"source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst",
"source/docs/software/convenience-features/event-based.rst",
"source/docs/software/dashboards/glass/field2d-widget.rst",
"source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst",
"source/docs/software/hardware-apis/sensors/analog-inputs-software.rst",
"source/docs/software/hardware-apis/sensors/digital-inputs-software.rst",
"source/docs/software/hardware-apis/sensors/encoders-software.rst",
"source/docs/software/hardware-apis/sensors/ultrasonics-software.rst"
"source/docs/software/hardware-apis/sensors/encoders-software.rst"
]
}
8 changes: 4 additions & 4 deletions source/docs/contributing/frc-docs/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This document contains the various MD and RST/Sphinx specific guidelines for the

Use only lowercase alphanumeric characters and ``-`` (minus) symbol.

For documents that will have an identical software/hardware name, append "Hardware" or "Software" to the end of the document name. IE, ``ultrasonics-hardware.rst``
For documents that will have an identical software/hardware name, append "Hardware" or "Software" to the end of the document name. IE, ``encoders-hardware.rst``

Suffix filenames with the ``.rst`` extension.

Expand Down Expand Up @@ -181,13 +181,13 @@ Internal Links will be auto-generated based on the ReStructuredText filename and

For example, here are several ways to link to sections and documents.

Use this format to reference a document section. You must use the absolute path of the document. ``:ref:`docs/software/hardware-apis/sensors/ultrasonics-software:Analog ultrasonics``` renders to :ref:`docs/software/hardware-apis/sensors/ultrasonics-software:Analog ultrasonics`.
Use this format to reference a document section. You must use the absolute path of the document. ``:ref:`docs/hardware/sensors/encoders-hardware:Quadrature Encoders``` renders to :ref:`docs/hardware/sensors/encoders-hardware:Quadrature Encoders`.

Use this format to reference a section of the same document. Note the single underscore. ```Images`_`` renders to `Images`_.

Use this format to reference the top-level of a document. You can use relative paths ``:doc:`build-instructions``` renders to :doc:`build-instructions` Or to use absolute paths, put a forward slash at the beginning of the path ``:doc:`/docs/software/hardware-apis/sensors/ultrasonics-software``` renders to :doc:`/docs/software/hardware-apis/sensors/ultrasonics-software`. Note that the text rendered is the main section title of the target page regardless of the target filename.
Use this format to reference the top-level of a document. You can use relative paths ``:doc:`build-instructions``` renders to :doc:`build-instructions` Or to use absolute paths, put a forward slash at the beginning of the path ``:doc:`/docs/hardware/sensors/encoders-hardware``` renders to :doc:`/docs/hardware/sensors/encoders-hardware`. Note that the text rendered is the main section title of the target page regardless of the target filename.

When using ``:ref:`` or ``:doc:`` you may customize the displayed text by surrounding the actual link with angle brackets ``<>`` and adding the custom text between the first backtick ````` and the first angle bracket ``<``. For example ``:ref:`custom text <docs/software/hardware-apis/sensors/ultrasonics-software:Analog ultrasonics>``` renders to :ref:`custom text <docs/software/hardware-apis/sensors/ultrasonics-software:Analog ultrasonics>`.
When using ``:ref:`` or ``:doc:`` you may customize the displayed text by surrounding the actual link with angle brackets ``<>`` and adding the custom text between the first backtick ````` and the first angle bracket ``<``. For example ``:ref:`custom text <docs/hardware/sensors/encoders-hardware:Quadrature Encoders>``` renders to :ref:`custom text <docs/hardware/sensors/encoders-hardware:Quadrature Encoders>`.

### External Links

Expand Down
12 changes: 1 addition & 11 deletions source/docs/controls-overviews/control-system-hardware.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,16 +313,6 @@ The [Koors 40 Brushed DC Motor Controller](https://www.andymark.com/products/koo

The SD540B and SD540C Motor Controllers from Mindsensors are controlled using PWM. CAN control is no longer available for the SD540C due to lack of manufacturer support. Limit switches may be wired directly to the SD540 to limit motor travel in one or both directions. For more information see the [Mindsensors FRC page](http://www.mindsensors.com/68-frc)

## Spike H-Bridge Relay

.. image:: images/control-system-hardware/spike-relay.png
:alt: Spike H-Bridge Relay
:width: 300

.. warning:: While this relay is still legal for FRC use, the manufacturer has discontinued this product.

The Spike H-Bridge Relay from VEX Robotics is a device used for controlling power to motors or other custom robot electronics. When connected to a motor, the Spike provides On/Off control in both the forward and reverse directions. The Spike outputs are independently controlled so it can also be used to provide power to up to 2 custom electronic circuits. The Spike H-Bridge Relay should be connected to a relay output of the roboRIO and powered from the Power Distribution Panel. For more information, see the [Spike User’s Guide](https://content.vexrobotics.com/docs/spike-blue-guide-sep05.pdf).

## Servo Hub

.. image:: images/control-system-hardware/servo-hub.png
Expand All @@ -349,4 +339,4 @@ The Microsoft Lifecam HD3000 is a USB webcam that can be plugged directly into t

## Image Credits

Image of roboRIO courtesy of National Instruments. Image of DMC-60 courtesy of Digilent. Image of SD540 courtesy of Mindsensors. Images of Jaguar Motor Controller, Talon SRX, Victor 888, Victor SP, Victor SPX, and Spike H-Bridge Relay courtesy of VEX Robotics, Inc. Image of SPARK MAX, SPARK Flex, Servo Hub, ATO Breakers, Power Distribution Hub, and Pneumatic Hub courtesy of REV Robotics. Images of TalonFX, TalonFXS, and Power Distribution Panel 2.0 courtesy of Cross The Road Electronics, LLC. Image of Thrifty Nova courtesy of The Thrifty Bot. Lifecam, PDP, PCM, SPARK, and VRM photos courtesy of *FIRST*\ |reg|. Image of the VH-109 radio courtesy of Vivid-Hosting. All other photos courtesy of AndyMark Inc.
Image of roboRIO courtesy of National Instruments. Image of DMC-60 courtesy of Digilent. Image of SD540 courtesy of Mindsensors. Images of Jaguar Motor Controller, Talon SRX, Victor 888, Victor SP, and Victor SPX courtesy of VEX Robotics, Inc. Image of SPARK MAX, SPARK Flex, Servo Hub, ATO Breakers, Power Distribution Hub, and Pneumatic Hub courtesy of REV Robotics. Images of TalonFX, TalonFXS, and Power Distribution Panel 2.0 courtesy of Cross The Road Electronics, LLC. Image of Thrifty Nova courtesy of The Thrifty Bot. Lifecam, PDP, PCM, SPARK, and VRM photos courtesy of *FIRST*\ |reg|. Image of the VH-109 radio courtesy of Vivid-Hosting. All other photos courtesy of AndyMark Inc.
65 changes: 1 addition & 64 deletions source/docs/controls-overviews/control-system-software.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ The primary supported OS for FRC components is Windows. All required FRC softwar

Many of the tools for C++/Java/Python programming are also supported and tested on macOS and Linux. Teams programming in C++/Java/Python should be able to develop using these systems, using a Windows system for the Windows-only operations such as the Driver Station and roboRIO Imaging Tool.

## LabVIEW FRC (Windows Only)

.. image:: /docs/zero-to-robot/step-4/images/creating-test-program-labview/creating-a-project.png
:alt: LabVIEW FRC Getting Started screen.

LabVIEW FRC, based on a recent version of LabVIEW Professional, is one of the three officially supported languages for programming an FRC robot. LabVIEW is a graphical, dataflow-driven language. LabVIEW programs consist of a collection of icons, called VIs, wired together with wires which pass data between the VIs. The LabVIEW FRC installer is distributed on a DVD found in the Kickoff Kit of Parts and is also available for download. A guide to getting started with the LabVIEW FRC software, including installation instructions can be found :ref:`here <docs/zero-to-robot/step-2/labview-setup:Installing LabVIEW for FRC (LabVIEW only)>`.

## Visual Studio Code

.. image:: images/control-system-software/visual-studio-code.png
Expand All @@ -40,20 +33,6 @@ This is the only software allowed to be used for the purpose of controlling the

The LabVIEW Dashboard is automatically launched by the FRC Driver Station by default. The purpose of the Dashboard is to provide feedback about the operation of the robot using tabbed display with a variety of built in features. More information about the FRC Default Dashboard software can be found :ref:`here <docs/software/dashboards/labview-dashboard/driver-station-labview-dashboard:FRC LabVIEW Dashboard>`.

### SmartDashboard

.. image:: images/control-system-software/smartdashboard.png
:alt: SmartDashboard with 3 widgets added.

SmartDashboard allows you to view your robot data by automatically creating customizable indicators specifically for each piece of data sent from your robot. Additional documentation on SmartDashboard can be found :ref:`here <docs/software/dashboards/smartdashboard/index:SmartDashboard>`.

### Shuffleboard

.. image:: images/control-system-software/shuffleboard.png
:alt: Shuffleboard with 3 widgets from their NetworkTables entries added.

Shuffleboard has the same features as SmartDashboard. It also improves on the setup and visualization of your data with new features and a modern design at the cost of being less resource efficient. Additional documentation on Shuffleboard can be found :ref:`here <docs/software/dashboards/shuffleboard/index:Shuffleboard>`.

### Glass

.. image:: images/control-system-software/glass.png
Expand All @@ -75,55 +54,20 @@ AdvantageScope is a data visualization tool for :ref:`NetworkTables <docs/softwa

Elastic is a simple and modern dashboard made by Team 353. It is meant to serve as a dashboard for competition but can also be used for testing. It was built with the goal of being a drag & drop dashboard with an easy setup and elegant UI designed for a high pressure competition environment. For more information see the :doc:`Elastic section </docs/software/dashboards/elastic>`.

## LiveWindow

.. image:: images/control-system-software/livewindow-smartdashboard.png
:alt: LiveWindow showing two different subsystems.

LiveWindow is a feature of SmartDashboard and Shuffleboard, designed for use with the Test Mode of the Driver Station. LiveWindow allows the user to see feedback from sensors on the robot and control actuators independent of the written user code. More information about LiveWindow can be found :ref:`here <docs/software/dashboards/smartdashboard/test-mode-and-live-window/index:SmartDashboard: Test Mode and Live Window>`.

## FRC roboRIO Imaging Tool (Windows Only)

.. image:: /docs/zero-to-robot/step-3/images/imaging-your-roborio/roborio-imaging-tool.png
:alt: roboRIO Imaging Tool after it has found a connected roboRIO.

This tool is used to format and setup a roboRIO for use in FRC. Installation instructions can be found :ref:`here <docs/zero-to-robot/step-2/frc-game-tools:Installing the FRC Game Tools>`. Additional instructions on imaging your roboRIO using this tool can be found :doc:`here </docs/zero-to-robot/step-3/imaging-your-roborio>`.

## FRC Driver Station Log Viewer (Windows Only)

.. image:: images/control-system-software/frc-log-viewer.png
:alt: Driver Station Log Viewer showing a logged practice session.

The FRC Driver Station Log Viewer is used to view logs created by the FRC Driver Station. These logs contain a variety of information important for understanding what happened during a practice session or FRC match. More information about the FRC Driver Station Log Viewer and understanding the logs can be found :ref:`here <docs/software/driverstation/driver-station-log-viewer:Driver Station Log File Viewer>`

## RobotBuilder

.. image:: images/control-system-software/robot-builder.png
:alt: RobotBuilder building a robot with two subsystems.

RobotBuilder is a tool designed to aid in setup and structuring of a Command Based robot project for C++ or Java (Python not currently supported). RobotBuilder allows you to enter in the various components of your robot subsystems and operator interface and define what your commands are in a graphical tree structure. RobotBuilder will then generate structural template code to get you started. More information about RobotBuilder can be found :ref:`here <docs/software/wpilib-tools/robotbuilder/index:RobotBuilder>`. More information about the Command Based programming architecture can be found :ref:`here <docs/software/commandbased/index:Command-Based Programming>`.

## Robot Simulation

.. image:: images/control-system-software/sim-gui.png
:alt: The Simulation GUI similar to Glass but also has Joysticks and control over the robot state and a few other features.

Robot Simulation offers a way for Java, C++, and Python teams to verify their actual robot code is working in a simulated environment. This simulation can be launched directly from VS Code and includes a 2D field that users can visualize their robot's movement on. For more information see the :ref:`Robot Simulation section <docs/software/wpilib-tools/robot-simulation/introduction:Introduction to Robot Simulation>`.

## FRC LabVIEW Robot Simulator (Windows Only)

.. image:: images/control-system-software/robot-simulator.png
:alt: FRC LabVIEW Robot Simulator

The FRC Robot Simulator is a component of the LabVIEW programming environment that allows you to operate a predefined robot in a simulated environment to test code and/or Driver Station functions. Information on using the FRC Robot Simulator can be found [here](https://forums.ni.com/t5/FIRST-Robotics-Competition/LabVIEW-Tutorial-10-Robot-Simulation/ta-p/3739702?profile.language=en) or by opening the Robot Simulation Readme.html file in the LabVIEW Project Explorer.

## PathWeaver

.. image:: images/control-system-software/pathweaver.png
:alt: PathWeaver UI with a project for FRC Deep Space plotting a trajectory to the back of the rocket.

PathWeaver allows teams to quickly generate and configure paths for advanced autonomous routines for differential drivetrains. These paths have smooth curves allowing the team to quickly navigate their robot between points on the field. For more information see the :ref:`PathWeaver section <docs/software/pathplanning/pathweaver/introduction:Introduction to PathWeaver>`.

## System Identification

.. image:: images/control-system-software/sysid.png
Expand All @@ -136,14 +80,7 @@ This tool helps teams automatically calculate constants that can be used to desc
.. image:: images/control-system-software/outline-viewer.png
:alt: OutlineViewer with the preferences dialog box.

OutlineViewer is a utility used to view, modify, and add to all of the contents of the NetworkTables for debugging purposes. LabVIEW teams can use the Variables tab of the LabVIEW Dashboard to accomplish this functionality. For more information see the :ref:`Outline Viewer section <docs/software/wpilib-tools/outlineviewer/index:OutlineViewer>`.

## roboRIO Team Number Setter

.. image:: /docs/software/wpilib-tools/roborio-team-number-setter/images/roborioteamnumbersetter.png
:alt: roboRIO Team Number Setter tool.

The roboRIO Team Number Setter is a cross-platform utility that can be used to set the team number on the roboRIO. It is an alternative to the roboRIO imaging tool for setting the team number. For more information see the :ref:`roboRIO Team Number Setter section <docs/software/wpilib-tools/roborio-team-number-setter/index:roboRIO Team Number Setter>`.
OutlineViewer is a utility used to view, modify, and add to all of the contents of the NetworkTables for debugging purposes. For more information see the :ref:`Outline Viewer section <docs/software/wpilib-tools/outlineviewer/index:OutlineViewer>`.

## WPIcal

Expand Down
Binary file removed source/docs/controls-overviews/images/control-system-hardware/spike-relay.png
View file
Open in desktop
Binary file not shown.
Binary file removed source/docs/hardware/hardware-basics/images/status-lights/spikeRelay1Light.png
View file
Open in desktop
Binary file not shown.
Binary file removed source/docs/hardware/hardware-basics/images/status-lights/spikeRelay2Light.png
View file
Open in desktop
Binary file not shown.
42 changes: 0 additions & 42 deletions source/docs/hardware/hardware-basics/status-lights-ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,48 +598,6 @@ Each channel has a corresponding status LED that will indicate the sensed state

- 6V Power LED off, dim, or flickering with power applied = Over-current shutdown

## Spike relay configured as a motor, light, or solenoid switch

.. image:: images/status-lights/spikeRelay1Light.png
:alt: Single LED in the corner.
:width: 600

+-----------------------------------------+-----------------+---------------+-------------------------------------+
| **Inputs** | **Outputs** | **Indicator** | **Motor Function** |
+---------------------+-------------------+--------+--------+ | |
| **Forward (White)** | **Reverse (Red)** | **M+** | **M-** | | |
+---------------------+-------------------+--------+--------+---------------+-------------------------------------+
| Off | Off | GND | GND | Orange | Off/Brake Condition (default) |
+---------------------+-------------------+--------+--------+---------------+-------------------------------------+
| On | Off | +12v | GND | Green | Motor rotates in one direction |
+---------------------+-------------------+--------+--------+---------------+-------------------------------------+
| Off | On | GND | +12v | Red | Motor rotates in opposite direction |
+---------------------+-------------------+--------+--------+---------------+-------------------------------------+
| On | On | +12v | +12v | Off | Off/Brake Condition |
+---------------------+-------------------+--------+--------+---------------+-------------------------------------+

.. note:: 'Brake Condition' refers to the dynamic stopping of the motor due to the shorting of the motor inputs. This condition is not optional when going to an off state.

## Spike relay configured as for one or two solenoids

.. image:: images/status-lights/spikeRelay2Light.png
:alt: Single LED in the corner.
:width: 600

+-----------------------------------------+-----------------+---------------+--------------------------------+
| **Inputs** | **Outputs** | **Indicator** | **Motor Function** |
+---------------------+-------------------+--------+--------+ | |
| **Forward (White)** | **Reverse (Red)** | **M+** | **M-** | | |
+---------------------+-------------------+--------+--------+---------------+--------------------------------+
| Off | Off | GND | GND | Orange | Both Solenoids Off (default) |
+---------------------+-------------------+--------+--------+---------------+--------------------------------+
| On | Off | +12v | GND | Green | Solenoid connected to M+ is ON |
+---------------------+-------------------+--------+--------+---------------+--------------------------------+
| Off | On | GND | +12v | Red | Solenoid connected to M- is ON |
+---------------------+-------------------+--------+--------+---------------+--------------------------------+
| On | On | +12v | +12v | Off | Both Solenoids ON |
+---------------------+-------------------+--------+--------+---------------+--------------------------------+

## CANCoder Encoder

.. image:: images/status-lights/cancoder-status-lights.png
Expand Down
Loading