YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
A301Wrapper.hpp
Go to the documentation of this file.
1// Copyright (c) 2026 Yet Another Software Suite
2// SPDX-License-Identifier: LGPL-3.0-or-later
3
4#pragma once
5
6#include <first/A301.h>
7
8#include <optional>
9#include <string>
10#include <wpi/simulation/DCMotorSim.hpp>
11#include <wpi/util/Alert.hpp>
12
16
18
71 public:
72 // Expose SetVelocity(velocity, feedforwardForce) from the base class alongside the overrides.
74
81 A301Wrapper(first::a301::A301* a301, SmartMotorControllerConfig* config);
83
84 // ---- Configuration ------------------------------------------------------
86 bool ApplyConfig(const SmartMotorControllerConfig& config) override;
87
88 // ---- Simulation ---------------------------------------------------------
90 void SetupSimulation() override;
92 void SimIterate() override;
93
94 // ---- Encoder sync -------------------------------------------------------
96 void SeedRelativeEncoder() override;
99
100 // ---- Open-loop outputs --------------------------------------------------
102 void SetDutyCycle(double dutyCycle) override;
104 double GetDutyCycle() override;
106 void SetVoltage(wpi::units::volt_t voltage) override;
108 wpi::units::volt_t GetVoltage() override;
109
110 // ---- Closed-loop setpoints ----------------------------------------------
112 void SetPosition(wpi::units::turn_t angle) override;
114 void SetPosition(wpi::units::meter_t distance) override;
116 void SetVelocity(wpi::units::turns_per_second_t velocity) override;
124 void SetVelocity(wpi::units::turns_per_second_t velocity,
125 wpi::units::newton_t feedforwardForce) override;
127 void SetVelocity(wpi::units::meters_per_second_t velocity) override;
128
129 // ---- Encoder writes -----------------------------------------------------
131 void SetEncoderPosition(wpi::units::turn_t angle) override;
133 void SetEncoderPosition(wpi::units::meter_t distance) override;
140 void SetEncoderVelocity(wpi::units::turns_per_second_t velocity) override;
147 void SetEncoderVelocity(wpi::units::meters_per_second_t velocity) override;
148
149 // ---- Encoder reads ------------------------------------------------------
151 wpi::units::turn_t GetMechanismPosition() override;
156 wpi::units::turns_per_second_t GetMechanismVelocity() override;
158 wpi::units::turn_t GetRelativeMechanismPosition() override;
160 wpi::units::turns_per_second_t GetRelativeMechanismVelocity() override;
162 wpi::units::turns_per_second_squared_t GetMechanismAcceleration() override;
164 wpi::units::turn_t GetRotorPosition() override;
166 wpi::units::turns_per_second_t GetRotorVelocity() override;
168 wpi::units::meter_t GetMeasurementPosition() override;
170 wpi::units::meters_per_second_t GetMeasurementVelocity() override;
172 wpi::units::meters_per_second_squared_t GetMeasurementAcceleration() override;
174 std::optional<wpi::units::turn_t> GetExternalEncoderMechanismPosition() override;
179 std::optional<wpi::units::turns_per_second_t> GetExternalEncoderMechanismVelocity() override;
180
181 // ---- Motor status -------------------------------------------------------
183 std::optional<wpi::units::ampere_t> GetSupplyCurrent() override;
185 wpi::units::ampere_t GetStatorCurrent() override;
187 wpi::units::celsius_t GetTemperature() override;
189 wpi::math::DCMotor GetDCMotor() override;
190
191 // ---- Configuration setters (live tuning) --------------------------------
193 void SetZeroPower(MotorMode mode) override;
195 void SetMotorInverted(bool inverted) override;
197 void SetEncoderInverted(bool inverted) override;
199 void SetKp(double kP) override;
201 void SetKi(double kI) override;
203 void SetKd(double kD) override;
205 void SetFeedback(double kP, double kI, double kD) override;
207 void SetKs(double kS) override;
209 void SetKv(double kV) override;
211 void SetKa(double kA) override;
213 void SetKg(double kG) override;
215 void SetFeedforward(double kS, double kV, double kA, double kG) override;
217 void SetStatorCurrentLimit(wpi::units::ampere_t currentLimit) override;
219 void SetSupplyCurrentLimit(wpi::units::ampere_t currentLimit) override;
221 void SetClosedLoopRampRate(wpi::units::second_t rampRate) override;
223 void SetOpenLoopRampRate(wpi::units::second_t rampRate) override;
225 void SetMechanismUpperLimit(wpi::units::turn_t upperLimit) override;
227 void SetMechanismLowerLimit(wpi::units::turn_t lowerLimit) override;
229 void SetMechanismLimits(wpi::units::turn_t lower, wpi::units::turn_t upper) override;
231 void SetMechanismLimitsEnabled(bool enabled) override;
233 void SetMeasurementUpperLimit(wpi::units::meter_t upperLimit) override;
235 void SetMeasurementLowerLimit(wpi::units::meter_t lowerLimit) override;
237 void SetMotionProfileMaxVelocity(wpi::units::turns_per_second_t maxVelocity) override;
239 void SetMotionProfileMaxVelocity(wpi::units::meters_per_second_t maxVelocity) override;
243 void SetMotionProfileMaxAcceleration(wpi::units::turns_per_second_squared_t maxAcc) override;
247 void SetMotionProfileMaxAcceleration(wpi::units::meters_per_second_squared_t maxAcc) override;
254 void SetMotionProfileMaxJerk(wpi::units::angular_jerk::turns_per_second_cubed_t maxJerk) override;
256 void SetExponentialProfile(std::optional<double> kV, std::optional<double> kA,
257 std::optional<wpi::units::volt_t> maxInput) override;
267 void SetMechanismCircumference(wpi::units::meter_t circumference) override;
268
276 void* GetMotorController() override;
282 void* GetMotorControllerConfig() override;
285
286 private:
287 first::a301::A301* m_a301{nullptr};
289 wpi::math::DCMotor m_motor{YMotors::A301()};
291 int m_motorCount{1};
293 std::vector<std::pair<A301Wrapper*, bool>> m_a301Followers;
295 A301Wrapper* m_leader{nullptr};
296 std::optional<wpi::sim::DCMotorSim> m_motorSim;
298 bool m_useAbsoluteEncoder{false};
304 double m_simDutyCycle{0.0};
305 math::DerivativeTimeFilter m_accelFilter{20_ms};
306
307 std::optional<wpi::util::Alert> m_systemCoreClosedLoopAlert;
308
310 std::string AlertId(const std::string& alertType) const;
312 double MechanismToRotorRatio() const;
314 double MechanismToExternalEncoderRatio() const;
316 double ZeroOffsetRotations() const;
318 void LoadClosedLoopController(const SmartMotorControllerConfig& config);
320 void ApplyFeedback(double kP, double kI, double kD);
322 void CreateMotorSim();
324 void StopFollowing();
326 std::optional<wpi::units::turn_t> GetExternalEncoderSensorPosition();
327};
328
329} // namespace yams::motorcontrollers::local
Definition MechanismGearing.hpp:19
Definition SmartMotorControllerConfig.hpp:66
SmartMotorControllerConfig::MotorMode MotorMode
Definition SmartMotorController.hpp:52
SmartMotorControllerConfig::ClosedLoopControllerSlot ClosedLoopControllerSlot
Definition SmartMotorController.hpp:51
virtual void SetVelocity(wpi::units::turns_per_second_t velocity)=0
void SetMechanismLimitsEnabled(bool enabled) override
void SetExponentialProfile(std::optional< double > kV, std::optional< double > kA, std::optional< wpi::units::volt_t > maxInput) override
void SetEncoderVelocity(wpi::units::meters_per_second_t velocity) override
wpi::units::ampere_t GetStatorCurrent() override
void SetMechanismCircumference(wpi::units::meter_t circumference) override
void SetFeedback(double kP, double kI, double kD) override
void SetSupplyCurrentLimit(wpi::units::ampere_t currentLimit) override
void SetVelocity(wpi::units::meters_per_second_t velocity) override
void SetMotionProfileMaxAcceleration(wpi::units::turns_per_second_squared_t maxAcc) override
std::optional< wpi::units::ampere_t > GetSupplyCurrent() override
wpi::units::turns_per_second_t GetMechanismVelocity() override
void SetEncoderPosition(wpi::units::turn_t angle) override
void SetMotionProfileMaxVelocity(wpi::units::meters_per_second_t maxVelocity) override
wpi::units::celsius_t GetTemperature() override
wpi::units::meters_per_second_squared_t GetMeasurementAcceleration() override
void SetPosition(wpi::units::turn_t angle) override
SmartMotorControllerConfig & GetConfig() override
void SetClosedLoopSlot(ClosedLoopControllerSlot slot) override
void SetMotionProfileMaxAcceleration(wpi::units::meters_per_second_squared_t maxAcc) override
wpi::math::DCMotor GetDCMotor() override
wpi::units::turns_per_second_t GetRotorVelocity() override
void SetMechanismLimits(wpi::units::turn_t lower, wpi::units::turn_t upper) override
void SetZeroPower(MotorMode mode) override
void SetMeasurementLowerLimit(wpi::units::meter_t lowerLimit) override
void SetEncoderInverted(bool inverted) override
wpi::units::turn_t GetRelativeMechanismPosition() override
A301Wrapper(first::a301::A301 *a301, SmartMotorControllerConfig *config)
void SetOpenLoopRampRate(wpi::units::second_t rampRate) override
void SetDutyCycle(double dutyCycle) override
void SetFeedforward(double kS, double kV, double kA, double kG) override
void SetVelocity(wpi::units::turns_per_second_t velocity) override
void SetMechanismLowerLimit(wpi::units::turn_t lowerLimit) override
void SetEncoderPosition(wpi::units::meter_t distance) override
void SetStatorCurrentLimit(wpi::units::ampere_t currentLimit) override
wpi::units::turn_t GetMechanismPosition() override
void SetMotorInverted(bool inverted) override
void SetVoltage(wpi::units::volt_t voltage) override
void SetMotionProfileMaxVelocity(wpi::units::turns_per_second_t maxVelocity) override
telemetry::UnsupportedTelemetryFields GetUnsupportedTelemetryFields() override
wpi::units::meters_per_second_t GetMeasurementVelocity() override
wpi::units::turn_t GetRotorPosition() override
std::optional< wpi::units::turns_per_second_t > GetExternalEncoderMechanismVelocity() override
wpi::units::volt_t GetVoltage() override
wpi::units::turns_per_second_squared_t GetMechanismAcceleration() override
void SetMeasurementUpperLimit(wpi::units::meter_t upperLimit) override
void SetMechanismGearing(const gearing::MechanismGearing &gearing) override
void SetVelocity(wpi::units::turns_per_second_t velocity, wpi::units::newton_t feedforwardForce) override
wpi::units::meter_t GetMeasurementPosition() override
wpi::units::turns_per_second_t GetRelativeMechanismVelocity() override
void SetEncoderVelocity(wpi::units::turns_per_second_t velocity) override
void SetMotionProfileMaxJerk(wpi::units::angular_jerk::turns_per_second_cubed_t maxJerk) override
std::optional< wpi::units::turn_t > GetExternalEncoderMechanismPosition() override
void SetMechanismUpperLimit(wpi::units::turn_t upperLimit) override
void SetClosedLoopRampRate(wpi::units::second_t rampRate) override
void SetPosition(wpi::units::meter_t distance) override
bool ApplyConfig(const SmartMotorControllerConfig &config) override
Definition GearBox.hpp:11
Definition A301Wrapper.hpp:17
static constexpr wpi::math::DCMotor A301(int numMotors=1)
Definition YMotors.hpp:33
Definition SmartMotorControllerTelemetry.hpp:124