diff --git a/source/docs/software/examples-tutorials/wpilib-examples.rst b/source/docs/software/examples-tutorials/wpilib-examples.rst index c6039dc28c..dd3a1320c1 100644 --- a/source/docs/software/examples-tutorials/wpilib-examples.rst +++ b/source/docs/software/examples-tutorials/wpilib-examples.rst @@ -90,19 +90,19 @@ These examples demonstrate miscellaneous WPILib functionality that does not fit These examples demonstrate a single item. -* **Addressable LED** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/addressableled), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/AddressableLED), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/AddressableLED)): Demonstrates the use of the ``AddressableLED`` class to control RGB LEDs for robot decoration and/or driver feedback. -* **AprilTagsVision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/apriltagsvision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/AprilTagsVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/AprilTagsVision)): Demonstrates on-roboRIO detection of AprilTags using an attached USB camera. -* **Digital Communication** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/digitalcommunication), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/DigitalCommunication), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/DigitalCommunication)): This is a sample program demonstrating how to communicate to a light controller from the robot code using the roboRIO's DIO ports. -* **DutyCycleInput** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/dutycycleinput), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/DutyCycleInput), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/DutyCycleInput)): Demonstrates the use of the ``DutyCycleInput`` class to read the frequency and fractional duty cycle of a :term:`PWM` input. +* **Addressable LED** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/addressableled), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/AddressableLED), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/AddressableLED)): Demonstrates the use of the ``AddressableLED`` class to control RGB LEDs for robot decoration and/or driver feedback. +* **AprilTagsVision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/apriltagsvision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/AprilTagsVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/AprilTagsVision)): Demonstrates on-roboRIO detection of AprilTags using an attached USB camera. +* **Digital Communication** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/digitalcommunication), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/DigitalCommunication), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/DigitalCommunication)): This is a sample program demonstrating how to communicate to a light controller from the robot code using the roboRIO's DIO ports. +* **DutyCycleInput** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/dutycycleinput), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/DutyCycleInput), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/DutyCycleInput)): Demonstrates the use of the ``DutyCycleInput`` class to read the frequency and fractional duty cycle of a :term:`PWM` input. * **EventLoop** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/eventloop), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/EventLoop/cpp)): Demonstrates the use of the ``EventLoop`` class that allows code to be called based on a boolean condition in the event-driven programming style. -* **Flywheel Bang-Bang Controller** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/flywheelbangbangcontroller), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/FlywheelBangBangController/cpp), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/FlywheelBangBangController)): Uses the ``BangBangController`` class to simply yet effectively control a flywheel. +* **Flywheel Bang-Bang Controller** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/flywheelbangbangcontroller), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/FlywheelBangBangController/cpp), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/FlywheelBangBangController )): Uses the ``BangBangController`` class to simply yet effectively control a flywheel. * **HTTP Camera** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/httpcamera), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/HttpCamera)): Demonstrates the use of OpenCV and a HTTP Camera to overlay a rectangle on a captured video feed and stream it to the dashboard. -* **I2C Communication** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/i2ccommunication), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/I2CCommunication), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/I2CCommunication)): This is a sample program demonstrating how to communicate to a light controller from the robot code using the roboRIO's I2C port. -* **Intermediate Vision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/intermediatevision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/IntermediateVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/IntermediateVision)): Demonstrates the use of OpenCV and a USB camera to overlay a rectangle on a captured video feed and stream it to the dashboard. -* **Motor Controller** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/motorcontrol), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/MotorControl), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/MotorControl)): Demonstrates how to control the output of a motor with a joystick with an encoder to read motor position. -* **Power Distribution CAN Monitoring** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/canpdp), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/CANPDP), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/CANPDP)): Demonstrates obtaining sensor information from a Power Distribution module over CAN using the ``PowerDistribution`` class. -* **Select Command Example** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/selectcommand), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/SelectCommand), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/SelectCommand)): Demonstrates the use of the ``SelectCommand`` class to run one of a selection of commands depending on a runtime-evaluated condition. -* **Simple Vision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/quickvision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/QuickVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/QuickVision)): Demonstrates how to stream video from a USB camera to the dashboard. -* **Solenoids** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/solenoid), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/Solenoid), [Python](https://github.com/robotpy/mostrobotpy/tree/main/examples/robot/Solenoid)): Demonstrates the use of the ``Solenoid`` and ``DoubleSolenoid`` classes to control solenoid outputs with a set of joystick buttons. +* **I2C Communication** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/i2ccommunication), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/I2CCommunication), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/I2CCommunication)): This is a sample program demonstrating how to communicate to a light controller from the robot code using the roboRIO's I2C port. +* **Intermediate Vision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/intermediatevision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/IntermediateVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/IntermediateVision)): Demonstrates the use of OpenCV and a USB camera to overlay a rectangle on a captured video feed and stream it to the dashboard. +* **Motor Controller** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/motorcontrol), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/MotorControl), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/MotorControl)): Demonstrates how to control the output of a motor with a joystick with an encoder to read motor position. +* **Power Distribution CAN Monitoring** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/canpdp), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/CANPDP), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/CANPDP)): Demonstrates obtaining sensor information from a Power Distribution module over CAN using the ``PowerDistribution`` class. +* **Select Command Example** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/selectcommand), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/SelectCommand), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/SelectCommand)): Demonstrates the use of the ``SelectCommand`` class to run one of a selection of commands depending on a runtime-evaluated condition. +* **Simple Vision** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/quickvision), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/QuickVision), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/QuickVision)): Demonstrates how to stream video from a USB camera to the dashboard. +* **Solenoids** ([Java](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibjExamples/src/main/java/org/wpilib/snippets/solenoid), [C++](https://github.com/wpilibsuite/allwpilib/tree/v2027.0.0-alpha-6/wpilibcExamples/src/main/cpp/snippets/Solenoid), [Python](https://github.com/robotpy/mostrobotpy/tree/main/snippets/robot/Solenoid)): Demonstrates the use of the ``Solenoid`` and ``DoubleSolenoid`` classes to control solenoid outputs with a set of joystick buttons.