PWMVictorSPX.h

Go to the documentation of this file.

// 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.
 
// THIS FILE WAS AUTO-GENERATED BY ./wpilibc/generate_pwm_motor_controllers.py. DO NOT MODIFY
 
#pragma once
 
#include "frc/motorcontrol/PWMMotorController.h"
 
namespace frc {
 
/**
 * Cross the Road Electronics (CTRE) Victor SPX Motor Controller with PWM control.
 *
 * Note that the Victor SPX uses the following bounds for PWM values. These
 * values should work reasonably well for most controllers, but if users
 * experience issues such as asymmetric behavior around the deadband or
 * inability to saturate the controller in either direction, calibration is
 * recommended. The calibration procedure can be found in the Victor SPX User
 * Manual available from Cross the Road Electronics (CTRE).
 *
 * \li 2.004ms = full "forward"
 * \li 1.520ms = the "high end" of the deadband range
 * \li 1.500ms = center of the deadband range (off)
 * \li 1.480ms = the "low end" of the deadband range
 * \li 0.997ms = full "reverse"
 */
class PWMVictorSPX : public PWMMotorController {
 public:
  /**
   * Constructor for a Victor SPX connected via PWM.
   *
   * @param channel The PWM channel that the Victor SPX is attached to. 0-9 are
   *                on-board, 10-19 are on the MXP port
   */
  explicit PWMVictorSPX(int channel);
 
  PWMVictorSPX(PWMVictorSPX&&) = default;
  PWMVictorSPX& operator=(PWMVictorSPX&&) = default;
};
 
}  // namespace frc