mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-23 01:21:42 +00:00
94843adb8f
Some were in constructor docs, some in init function docs, and some inline in code. Move them all to class docs.
49 lines
1.8 KiB
C++
49 lines
1.8 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in the root directory of */
|
|
/* the project. */
|
|
/*----------------------------------------------------------------------------*/
|
|
|
|
#pragma once
|
|
|
|
#include "frc/PWMSpeedController.h"
|
|
|
|
namespace frc {
|
|
|
|
/**
|
|
* Vex Robotics Victor 888 Speed Controller.
|
|
*
|
|
* The Vex Robotics Victor 884 Speed Controller can also be used with this
|
|
* class but may need to be calibrated per the Victor 884 user manual.
|
|
*
|
|
* Note that the Victor uses the following bounds for PWM values. These
|
|
* values were determined empirically and optimized for the Victor 888. These
|
|
* values should work reasonably well for Victor 884 controllers as well 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 884 User
|
|
* Manual available from Vex.
|
|
*
|
|
* \li 2.027ms = full "forward"
|
|
* \li 1.525ms = the "high end" of the deadband range
|
|
* \li 1.507ms = center of the deadband range (off)
|
|
* \li 1.490ms = the "low end" of the deadband range
|
|
* \li 1.026ms = full "reverse"
|
|
*/
|
|
class Victor : public PWMSpeedController {
|
|
public:
|
|
/**
|
|
* Constructor for a Victor.
|
|
*
|
|
* @param channel The PWM channel number that the Victor is attached to. 0-9
|
|
* are on-board, 10-19 are on the MXP port
|
|
*/
|
|
explicit Victor(int channel);
|
|
|
|
Victor(Victor&&) = default;
|
|
Victor& operator=(Victor&&) = default;
|
|
};
|
|
|
|
} // namespace frc
|