Merge branch 'main' into 2027

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogaccelerometer/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogaccelerometer;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogaccelerometer/Robot.java

@@ -0,0 +1,31 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogaccelerometer;
+
+import edu.wpi.first.wpilibj.AnalogAccelerometer;
+import edu.wpi.first.wpilibj.TimedRobot;
+
+/**
+ * AnalogAccelerometer snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
+ */
+public class Robot extends TimedRobot {
+  // Creates an analog accelerometer on analog input 0
+  AnalogAccelerometer m_accelerometer = new AnalogAccelerometer(0);
+
+  /** Called once at the beginning of the robot program. */
+  public Robot() {
+    // Sets the sensitivity of the accelerometer to 1 volt per G
+    m_accelerometer.setSensitivity(1);
+    // Sets the zero voltage of the accelerometer to 3 volts
+    m_accelerometer.setZero(3);
+  }
+
+  @Override
+  public void teleopPeriodic() {
+    // Gets the current acceleration
+    m_accelerometer.getAcceleration();
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogencoder/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogencoder;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogencoder/Robot.java

@@ -0,0 +1,33 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogencoder;
+
+import edu.wpi.first.wpilibj.AnalogEncoder;
+import edu.wpi.first.wpilibj.TimedRobot;
+
+/**
+ * AnalogEncoder snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
+ */
+public class Robot extends TimedRobot {
+  // Initializes an analog encoder on Analog Input pin 0
+  AnalogEncoder m_encoder = new AnalogEncoder(0);
+
+  // Initializes an analog encoder on DIO pins 0 to return a value of 4 for
+  // a full rotation, with the encoder reporting 0 half way through rotation (2
+  // out of 4)
+  AnalogEncoder m_encoderFR = new AnalogEncoder(0, 4.0, 2.0);
+
+  /** Called once at the beginning of the robot program. */
+  public Robot() {}
+
+  @Override
+  public void teleopPeriodic() {
+    // Gets the rotation
+    m_encoder.get();
+
+    m_encoderFR.get();
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analoginput/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analoginput;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analoginput/Robot.java

@@ -0,0 +1,49 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analoginput;
+
+import edu.wpi.first.wpilibj.AnalogInput;
+import edu.wpi.first.wpilibj.TimedRobot;
+
+/**
+ * AnalogInput snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-inputs-software.html
+ */
+public class Robot extends TimedRobot {
+  // Initializes an AnalogInput on port 0
+  AnalogInput m_analog = new AnalogInput(0);
+
+  /** Called once at the beginning of the robot program. */
+  public Robot() {
+    // Sets the AnalogInput to 4-bit oversampling.  16 samples will be added together.
+    // Thus, the reported values will increase by about a factor of 16, and the update
+    // rate will decrease by a similar amount.
+    m_analog.setOversampleBits(4);
+
+    // Sets the AnalogInput to 4-bit averaging.  16 samples will be averaged together.
+    // The update rate will decrease by a factor of 16.
+    m_analog.setAverageBits(4);
+  }
+
+  @Override
+  public void teleopPeriodic() {
+    // Gets the raw instantaneous measured value from the analog input, without
+    // applying any calibration and ignoring oversampling and averaging
+    // settings.
+    m_analog.getValue();
+
+    // Gets the instantaneous measured voltage from the analog input.
+    // Oversampling and averaging settings are ignored
+    m_analog.getVoltage();
+
+    // Gets the averaged value from the analog input.  The value is not
+    // rescaled, but oversampling and averaging are both applied.
+    m_analog.getAverageValue();
+
+    // Gets the averaged voltage from the analog input.  Rescaling,
+    // oversampling, and averaging are all applied.
+    m_analog.getAverageVoltage();
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogpotentiometer/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogpotentiometer;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/analogpotentiometer/Robot.java

@@ -0,0 +1,45 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.analogpotentiometer;
+
+import edu.wpi.first.wpilibj.AnalogInput;
+import edu.wpi.first.wpilibj.AnalogPotentiometer;
+import edu.wpi.first.wpilibj.TimedRobot;
+
+/**
+ * AnalogPotentiometer snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-poteniometers-software.html
+ */
+public class Robot extends TimedRobot {
+  // Initializes an AnalogPotentiometer on analog port 0
+  // The full range of motion (in meaningful external units) is 0-180 (this could be degrees, for
+  // instance)
+  // The "starting point" of the motion, i.e. where the mechanism is located when the potentiometer
+  // reads 0v, is 30.
+  AnalogPotentiometer m_pot = new AnalogPotentiometer(0, 180, 30);
+
+  // Initializes an AnalogInput on port 1
+  AnalogInput m_input = new AnalogInput(0);
+  // Initializes an AnalogPotentiometer with the given AnalogInput
+  // The full range of motion (in meaningful external units) is 0-180 (this could be degrees, for
+  // instance)
+  // The "starting point" of the motion, i.e. where the mechanism is located when the potentiometer
+  // reads 0v, is 30.
+  AnalogPotentiometer m_pot1 = new AnalogPotentiometer(m_input, 180, 30);
+
+  /** Called once at the beginning of the robot program. */
+  public Robot() {
+    // Set averaging bits to 2
+    m_input.setAverageBits(2);
+  }
+
+  @Override
+  public void teleopPeriodic() {
+    // Get the value of the potentiometer
+    m_pot.get();
+
+    m_pot1.get();
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/digitalinput/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.digitalinput;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/digitalinput/Robot.java

@@ -0,0 +1,23 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.digitalinput;
+
+import edu.wpi.first.wpilibj.DigitalInput;
+import edu.wpi.first.wpilibj.TimedRobot;
+
+/**
+ * DigitalInput snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/digital-inputs-software.html
+ */
+public class Robot extends TimedRobot {
+  // Initializes a DigitalInput on DIO 0
+  DigitalInput m_input = new DigitalInput(0);
+
+  @Override
+  public void teleopPeriodic() {
+    // Gets the value of the digital input.  Returns true if the circuit is open.
+    m_input.get();
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/encoderdrive/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.encoderdrive;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/encoderdrive/Robot.java

@@ -0,0 +1,48 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.encoderdrive;
+
+import edu.wpi.first.wpilibj.Encoder;
+import edu.wpi.first.wpilibj.TimedRobot;
+import edu.wpi.first.wpilibj.drive.DifferentialDrive;
+import edu.wpi.first.wpilibj.motorcontrol.Spark;
+
+/**
+ * Encoder drive to distance snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
+ */
+public class Robot extends TimedRobot {
+  // Creates an encoder on DIO ports 0 and 1
+  Encoder m_encoder = new Encoder(0, 1);
+  // Initialize motor controllers and drive
+  Spark m_leftLeader = new Spark(0);
+  Spark m_leftFollower = new Spark(1);
+  Spark m_rightLeader = new Spark(2);
+  Spark m_rightFollower = new Spark(3);
+  DifferentialDrive m_drive = new DifferentialDrive(m_leftLeader::set, m_rightLeader::set);
+
+  /** Called once at the beginning of the robot program. */
+  public Robot() {
+    // Configures the encoder's distance-per-pulse
+    // The robot moves forward 1 foot per encoder rotation
+    // There are 256 pulses per encoder rotation
+    m_encoder.setDistancePerPulse(1.0 / 256.0);
+    // Invert the right side of the drivetrain. You might have to invert the other side
+    m_rightLeader.setInverted(true);
+    // Configure the followers to follow the leaders
+    m_leftLeader.addFollower(m_leftFollower);
+    m_rightLeader.addFollower(m_rightFollower);
+  }
+
+  /** Drives forward at half speed until the robot has moved 5 feet, then stops. */
+  @Override
+  public void autonomousPeriodic() {
+    if (m_encoder.getDistance() < 5.0) {
+      m_drive.tankDrive(0.5, 0.5);
+    } else {
+      m_drive.tankDrive(0.0, 0.0);
+    }
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/encoderhoming/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.encoderhoming;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/encoderhoming/Robot.java

@@ -0,0 +1,35 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.encoderhoming;
+
+import edu.wpi.first.wpilibj.DigitalInput;
+import edu.wpi.first.wpilibj.Encoder;
+import edu.wpi.first.wpilibj.TimedRobot;
+import edu.wpi.first.wpilibj.motorcontrol.Spark;
+
+/**
+ * Encoder mechanism homing snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
+ */
+public class Robot extends TimedRobot {
+  Encoder m_encoder = new Encoder(0, 1);
+  Spark m_spark = new Spark(0);
+  // Limit switch on DIO 2
+  DigitalInput m_limit = new DigitalInput(2);
+
+  /**
+   * Runs the motor backwards at half speed until the limit switch is pressed then turn off the
+   * motor and reset the encoder.
+   */
+  @Override
+  public void autonomousPeriodic() {
+    if (!m_limit.get()) {
+      m_spark.set(-0.5);
+    } else {
+      m_spark.set(0.0);
+      m_encoder.reset();
+    }
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/limitswitch/Main.java

@@ -0,0 +1,25 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.limitswitch;
+
+import edu.wpi.first.wpilibj.RobotBase;
+
+/**
+ * Do NOT add any static variables to this class, or any initialization at all. Unless you know what
+ * you are doing, do not modify this file except to change the parameter class to the startRobot
+ * call.
+ */
+public final class Main {
+  private Main() {}
+
+  /**
+   * Main initialization function. Do not perform any initialization here.
+   *
+   * <p>If you change your main robot class, change the parameter type.
+   */
+  public static void main(String... args) {
+    RobotBase.startRobot(Robot::new);
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/limitswitch/Robot.java

@@ -0,0 +1,51 @@
+// Copyright (c) FIRST and other WPILib contributors.
+// Open Source Software; you can modify and/or share it under the terms of
+// the WPILib BSD license file in the root directory of this project.
+
+package edu.wpi.first.wpilibj.snippets.limitswitch;
+
+import edu.wpi.first.wpilibj.DigitalInput;
+import edu.wpi.first.wpilibj.Joystick;
+import edu.wpi.first.wpilibj.TimedRobot;
+import edu.wpi.first.wpilibj.motorcontrol.PWMVictorSPX;
+
+/**
+ * Limit Switch snippets for frc-docs.
+ * https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/limit-switch.html
+ */
+public class Robot extends TimedRobot {
+  DigitalInput m_toplimitSwitch = new DigitalInput(0);
+  DigitalInput m_bottomlimitSwitch = new DigitalInput(1);
+  PWMVictorSPX m_motor = new PWMVictorSPX(0);
+  Joystick m_joystick = new Joystick(0);
+
+  @Override
+  public void teleopPeriodic() {
+    setMotorSpeed(m_joystick.getRawAxis(2));
+  }
+
+  /**
+   * Sets the motor speed based on joystick input while respecting limit switches.
+   *
+   * @param speed the desired speed of the motor, positive for up and negative for down
+   */
+  public void setMotorSpeed(double speed) {
+    if (speed > 0) {
+      if (m_toplimitSwitch.get()) {
+        // We are going up and top limit is tripped so stop
+        m_motor.set(0);
+      } else {
+        // We are going up but top limit is not tripped so go at commanded speed
+        m_motor.set(speed);
+      }
+    } else {
+      if (m_bottomlimitSwitch.get()) {
+        // We are going down and bottom limit is tripped so stop
+        m_motor.set(0);
+      } else {
+        // We are going down but bottom limit is not tripped so go at commanded speed
+        m_motor.set(speed);
+      }
+    }
+  }
+}

wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/snippets/snippets.json

@@ -21,5 +21,97 @@
     "foldername": "dutycycleencoder",
     "gradlebase": "java",
     "mainclass": "Main"
+  },
+  {
+    "name": "AnalogEncoder",
+    "description": "Snippets of AnalogEncoder class usage for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Encoder",
+      "Analog"
+    ],
+    "foldername": "analogencoder",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "EncoderDrive",
+    "description": "Snippets of driving to a distance for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Encoder",
+      "Differential Drive"
+    ],
+    "foldername": "encoderdrive",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "EncoderHoming",
+    "description": "Snippets of homing a mechanism for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Encoder",
+      "Digital Input"
+    ],
+    "foldername": "encoderhoming",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "LimitSwitch",
+    "description": "Snippets of Limit Switch for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Digital Input"
+    ],
+    "foldername": "limitswitch",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "DigitalInput",
+    "description": "Snippets of Digital Input for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Digital Input"
+    ],
+    "foldername": "digitalinput",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "AnalogInput",
+    "description": "Snippets of Analog Input for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Analog"
+    ],
+    "foldername": "analoginput",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "AnalogPotentiometer",
+    "description": "Snippets of Analog Potentiometer for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Analog"
+    ],
+    "foldername": "analogpotentiometer",
+    "gradlebase": "java",
+    "mainclass": "Main"
+  },
+  {
+    "name": "AnalogAccelerometer",
+    "description": "Snippets of Analog Accelerometer for frc-docs.",
+    "tags": [
+      "Hardware",
+      "Analog",
+      "Accelerometer"
+    ],
+    "foldername": "analogaccelerometer",
+    "gradlebase": "java",
+    "mainclass": "Main"
   }
 ]