001// Copyright (c) FIRST and other WPILib contributors.
002// Open Source Software; you can modify and/or share it under the terms of
003// the WPILib BSD license file in the root directory of this project.
004
005// THIS FILE WAS AUTO-GENERATED BY ./wpilibj/generate_pwm_motor_controllers.py. DO NOT MODIFY
006
007package edu.wpi.first.wpilibj.motorcontrol;
008
009import edu.wpi.first.hal.FRCNetComm.tResourceType;
010import edu.wpi.first.hal.HAL;
011import edu.wpi.first.wpilibj.PWM;
012
013/**
014 * REV Robotics SPARK MAX Motor Controller.
015 *
016 * <p>Note that the SPARK MAX uses the following bounds for PWM values. These values should work
017 * reasonably well for most controllers, but if users experience issues such as asymmetric behavior
018 * around the deadband or inability to saturate the controller in either direction, calibration is
019 * recommended. The calibration procedure can be found in the SPARK MAX User Manual available from
020 * REV Robotics.
021 *
022 * <ul>
023 *   <li>2.003ms = full "forward"
024 *   <li>1.550ms = the "high end" of the deadband range
025 *   <li>1.500ms = center of the deadband range (off)
026 *   <li>1.460ms = the "low end" of the deadband range
027 *   <li>0.999ms = full "reverse"
028 * </ul>
029 */
030public class PWMSparkMax extends PWMMotorController {
031  /**
032   * Constructor.
033   *
034   * @param channel The PWM channel that the SPARK MAX is attached to. 0-9 are on-board, 10-19
035   *     are on the MXP port
036   */
037  @SuppressWarnings("this-escape")
038  public PWMSparkMax(final int channel) {
039    super("PWMSparkMax", channel);
040
041    m_pwm.setBoundsMicroseconds(2003, 1550, 1500, 1460, 999);
042    m_pwm.setPeriodMultiplier(PWM.PeriodMultiplier.k1X);
043    m_pwm.setSpeed(0.0);
044    m_pwm.setZeroLatch();
045
046    HAL.report(tResourceType.kResourceType_RevSparkMaxPWM, getChannel() + 1);
047  }
048}