allwpilib/wpilibjIntegrationTests/src/main/java/edu/wpi/first/wpilibj/PIDTest.java

// 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;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import edu.wpi.first.math.controller.PIDController;
import edu.wpi.first.networktables.NetworkTable;
import edu.wpi.first.networktables.NetworkTableInstance;
import edu.wpi.first.wpilibj.fixtures.MotorEncoderFixture;
import edu.wpi.first.wpilibj.smartdashboard.SendableBuilderImpl;
import edu.wpi.first.wpilibj.test.AbstractComsSetup;
import edu.wpi.first.wpilibj.test.TestBench;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.logging.Logger;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

/** Test that covers the {@link PIDController}. */
@RunWith(Parameterized.class)
public class PIDTest extends AbstractComsSetup {
  private static final Logger logger = Logger.getLogger(PIDTest.class.getName());
  private NetworkTable m_table;
  private SendableBuilderImpl m_builder;

  private static final double absoluteTolerance = 50;
  private static final double integratorRange = 0.25;

  private PIDController m_controller = null;
  private static MotorEncoderFixture<?> me = null;

  private final Double m_p;
  private final Double m_i;
  private final Double m_d;

  @Override
  protected Logger getClassLogger() {
    return logger;
  }

  /**
   * PIDTest constructor.
   *
   * @param p P gain.
   * @param i I gain.
   * @param d D gain.
   * @param mef Motor encoder fixture.
   */
  public PIDTest(Double p, Double i, Double d, MotorEncoderFixture<?> mef) {
    logger.fine("Constructor with: " + mef.getType());
    if (PIDTest.me != null && !PIDTest.me.equals(mef)) {
      PIDTest.me.teardown();
    }
    PIDTest.me = mef;
    this.m_p = p;
    this.m_i = i;
    this.m_d = d;
  }

  @Parameters
  public static Collection<Object[]> generateData() {
    // logger.fine("Loading the MotorList");
    Collection<Object[]> data = new ArrayList<Object[]>();
    double kp = 0.001;
    double ki = 0.0005;
    double kd = 0.0;
    for (int i = 0; i < 1; i++) {
      data.addAll(
          Arrays.asList(
              new Object[][] {
                {kp, ki, kd, TestBench.getTalonPair()},
                {kp, ki, kd, TestBench.getVictorPair()},
                {kp, ki, kd, TestBench.getJaguarPair()}
              }));
    }
    return data;
  }

  @BeforeClass
  public static void setUpBeforeClass() {}

  @AfterClass
  public static void tearDownAfterClass() {
    logger.fine("TearDownAfterClass: " + me.getType());
    me.teardown();
    me = null;
  }

  @Before
  public void setUp() {
    logger.fine("Setup: " + me.getType());
    me.setup();
    m_table = NetworkTableInstance.getDefault().getTable("TEST_PID");
    m_builder = new SendableBuilderImpl();
    m_builder.setTable(m_table);
    m_controller = new PIDController(m_p, m_i, m_d);
    m_controller.initSendable(m_builder);
  }

  @After
  public void tearDown() {
    logger.fine("Teardown: " + me.getType());
    m_controller = null;
    me.reset();
  }

  private void setupTolerance() {
    m_controller.setTolerance(absoluteTolerance);
  }

  private void setupIntegratorRange() {
    m_controller.setIntegratorRange(-integratorRange, integratorRange);
  }

  @Test
  public void testInitialSettings() {
    setupTolerance();
    setupIntegratorRange();
    double reference = 2500.0;
    m_controller.setSetpoint(reference);
    assertEquals(
        "PID.getPositionError() did not start at " + reference,
        reference,
        m_controller.getPositionError(),
        0);
    m_builder.update();
    assertEquals(m_p, m_table.getEntry("Kp").getDouble(9999999), 0);
    assertEquals(m_i, m_table.getEntry("Ki").getDouble(9999999), 0);
    assertEquals(m_d, m_table.getEntry("Kd").getDouble(9999999), 0);
    assertEquals(reference, m_table.getEntry("reference").getDouble(9999999), 0);
    assertFalse(m_table.getEntry("enabled").getBoolean(true));
  }

  @Test
  public void testSetSetpoint() {
    setupTolerance();
    setupIntegratorRange();
    double reference = 2500.0;
    m_controller.setSetpoint(reference);
    assertEquals("Did not correctly set reference", reference, m_controller.getSetpoint(), 1e-3);
  }

  @Test(timeout = 10000)
  public void testRotateToTarget() {
    setupTolerance();
    setupIntegratorRange();
    double reference = 1000.0;
    assertEquals(pidData() + "did not start at 0", 0, me.getMotor().get(), 0);
    m_controller.setSetpoint(reference);
    assertEquals(
        pidData() + "did not have an error of " + reference,
        reference,
        m_controller.getPositionError(),
        0);
    Notifier pidRunner =
        new Notifier(
            () -> me.getMotor().set(m_controller.calculate(me.getEncoder().getDistance())));
    pidRunner.startPeriodic(m_controller.getPeriod());
    Timer.delay(5);
    pidRunner.stop();
    assertTrue(
        pidData() + "Was not on Target. Controller Error: " + m_controller.getPositionError(),
        m_controller.atSetpoint());

    pidRunner.close();
  }

  private String pidData() {
    return me.getType()
        + " PID {P:"
        + m_controller.getP()
        + " I:"
        + m_controller.getI()
        + " D:"
        + m_controller.getD()
        + "} ";
  }

  @Test(expected = RuntimeException.class)
  public void testOnTargetNoToleranceSet() {
    setupIntegratorRange();
    assertFalse(m_controller.atSetpoint());
  }
}