mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-20 00:51:42 +00:00
52408e2658
Update documentation for existing classes to better describe what they control Change-Id: I1932b39a3f082c2eb57f41edb4ba55c73cce2938
123 lines
4.2 KiB
C++
123 lines
4.2 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) FIRST 2014. 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 $(WIND_BASE)/WPILib. */
|
|
/*----------------------------------------------------------------------------*/
|
|
#pragma once
|
|
|
|
#include "SafePWM.h"
|
|
#include "CANSpeedController.h"
|
|
#include "PIDOutput.h"
|
|
#include "MotorSafetyHelper.h"
|
|
|
|
class CanTalonSRX;
|
|
|
|
/**
|
|
* CTRE Talon SRX Speed Controller with CAN Control
|
|
*/
|
|
class CANTalon : public MotorSafety,
|
|
public CANSpeedController,
|
|
public ErrorBase
|
|
{
|
|
public:
|
|
enum FeedbackDevice {
|
|
QuadEncoder=0,
|
|
AnalogPot=2,
|
|
AnalogEncoder=3,
|
|
EncRising=4,
|
|
EncFalling=5
|
|
};
|
|
explicit CANTalon(int deviceNumber);
|
|
virtual ~CANTalon();
|
|
|
|
// PIDController interface
|
|
virtual void PIDWrite(float output) override;
|
|
|
|
// MotorSafety interface
|
|
virtual void SetExpiration(float timeout) override;
|
|
virtual float GetExpiration() override;
|
|
virtual bool IsAlive() override;
|
|
virtual void StopMotor() override;
|
|
virtual void SetSafetyEnabled(bool enabled) override;
|
|
virtual bool IsSafetyEnabled() override;
|
|
virtual void GetDescription(char *desc) override;
|
|
|
|
// CANSpeedController interface
|
|
virtual float Get() override;
|
|
virtual void Set(float value, uint8_t syncGroup=0) override;
|
|
virtual void Disable() override;
|
|
virtual void EnableControl();
|
|
virtual void SetP(double p) override;
|
|
virtual void SetI(double i) override;
|
|
virtual void SetD(double d) override;
|
|
void SetF(double f);
|
|
virtual void SetPID(double p, double i, double d) override;
|
|
void SetPID(double p, double i, double d, double f);
|
|
virtual double GetP() override;
|
|
virtual double GetI() override;
|
|
virtual double GetD() override;
|
|
double GetF();
|
|
virtual float GetBusVoltage() override;
|
|
virtual float GetOutputVoltage() override;
|
|
virtual float GetOutputCurrent() override;
|
|
virtual float GetTemperature() override;
|
|
void SetPosition(double pos);
|
|
virtual double GetPosition() override;
|
|
virtual double GetSpeed() override;
|
|
virtual int GetClosedLoopError();
|
|
virtual int GetAnalogIn();
|
|
virtual int GetAnalogInVel();
|
|
virtual int GetEncPosition();
|
|
virtual int GetEncVel();
|
|
int GetPinStateQuadA();
|
|
int GetPinStateQuadB();
|
|
int GetPinStateQuadIdx();
|
|
int IsFwdLimitSwitchClosed();
|
|
int IsRevLimitSwitchClosed();
|
|
int GetNumberOfQuadIdxRises();
|
|
void SetNumberOfQuadIdxRises(int rises);
|
|
virtual bool GetForwardLimitOK() override;
|
|
virtual bool GetReverseLimitOK() override;
|
|
virtual uint16_t GetFaults() override;
|
|
uint16_t GetStickyFaults();
|
|
void ClearStickyFaults();
|
|
virtual void SetVoltageRampRate(double rampRate) override;
|
|
virtual uint32_t GetFirmwareVersion() override;
|
|
virtual void ConfigNeutralMode(NeutralMode mode) override;
|
|
virtual void ConfigEncoderCodesPerRev(uint16_t codesPerRev) override;
|
|
virtual void ConfigPotentiometerTurns(uint16_t turns) override;
|
|
virtual void ConfigSoftPositionLimits(double forwardLimitPosition, double reverseLimitPosition) override;
|
|
virtual void DisableSoftPositionLimits() override;
|
|
virtual void ConfigLimitMode(LimitMode mode) override;
|
|
virtual void ConfigForwardLimit(double forwardLimitPosition) override;
|
|
virtual void ConfigReverseLimit(double reverseLimitPosition) override;
|
|
virtual void ConfigMaxOutputVoltage(double voltage) override;
|
|
virtual void ConfigFaultTime(float faultTime) override;
|
|
virtual void SetControlMode(ControlMode mode);
|
|
void SetFeedbackDevice(FeedbackDevice device);
|
|
virtual ControlMode GetControlMode();
|
|
void SetSensorDirection(bool reverseSensor);
|
|
void SetCloseLoopRampRate(double rampRate);
|
|
void SelectProfileSlot(int slotIdx);
|
|
double GetIzone();
|
|
private:
|
|
// Values for various modes as is sent in the CAN packets for the Talon.
|
|
enum TalonControlMode {
|
|
kThrottle=0,
|
|
kFollowerMode=5,
|
|
kVoltageMode=4,
|
|
kPositionMode=1,
|
|
kSpeedMode=2,
|
|
kCurrentMode=3,
|
|
kDisabled=15
|
|
};
|
|
|
|
int m_deviceNumber;
|
|
CanTalonSRX *m_impl;
|
|
MotorSafetyHelper *m_safetyHelper;
|
|
int m_profile; // Profile from CANTalon to use. Set to zero until we can actually test this.
|
|
|
|
bool m_controlEnabled;
|
|
ControlMode m_controlMode;
|
|
};
|