YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
NovaWrapper.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 <thrifty/canEncoder/CanEncoder.h>
7#include <thrifty/core/Motor.h>
8#include <thrifty/core/MotorControl.h>
9#include <thrifty/nova/Nova.h>
10#include <thrifty/sim/MotorSim.h>
11
12#include <memory>
13#include <optional>
14#include <string>
15#include <wpi/simulation/DCMotorSim.hpp>
16#include <wpi/util/Alert.hpp>
17
21
23
72 public:
73 // Expose SetVelocity(velocity, feedforwardForce) from the base class alongside the overrides.
75
83 NovaWrapper(thrifty::Nova* nova, wpi::math::DCMotor motor, SmartMotorControllerConfig* config);
85
86 // ---- Configuration ------------------------------------------------------
88 bool ApplyConfig(const SmartMotorControllerConfig& config) override;
89
90 // ---- Simulation ---------------------------------------------------------
92 void SetupSimulation() override;
94 void SimIterate() override;
95
96 // ---- Encoder sync -------------------------------------------------------
98 void SeedRelativeEncoder() override;
101
102 // ---- Open-loop outputs --------------------------------------------------
104 void SetDutyCycle(double dutyCycle) override;
106 double GetDutyCycle() override;
108 void SetVoltage(wpi::units::volt_t voltage) override;
110 wpi::units::volt_t GetVoltage() override;
111
112 // ---- Closed-loop setpoints ----------------------------------------------
114 void SetPosition(wpi::units::turn_t angle) override;
116 void SetPosition(wpi::units::meter_t distance) override;
118 void SetVelocity(wpi::units::turns_per_second_t velocity) override;
126 void SetVelocity(wpi::units::turns_per_second_t velocity,
127 wpi::units::newton_t feedforwardForce) override;
129 void SetVelocity(wpi::units::meters_per_second_t velocity) override;
130
131 // ---- Encoder writes -----------------------------------------------------
133 void SetEncoderPosition(wpi::units::turn_t angle) override;
135 void SetEncoderPosition(wpi::units::meter_t distance) override;
142 void SetEncoderVelocity(wpi::units::turns_per_second_t velocity) override;
149 void SetEncoderVelocity(wpi::units::meters_per_second_t velocity) override;
150
151 // ---- Encoder reads ------------------------------------------------------
153 wpi::units::turn_t GetMechanismPosition() override;
155 wpi::units::turns_per_second_t GetMechanismVelocity() override;
157 wpi::units::turn_t GetRelativeMechanismPosition() override;
159 wpi::units::turns_per_second_t GetRelativeMechanismVelocity() override;
161 wpi::units::turns_per_second_squared_t GetMechanismAcceleration() override;
163 wpi::units::turn_t GetRotorPosition() override;
165 wpi::units::turns_per_second_t GetRotorVelocity() override;
167 wpi::units::meter_t GetMeasurementPosition() override;
169 wpi::units::meters_per_second_t GetMeasurementVelocity() override;
171 wpi::units::meters_per_second_squared_t GetMeasurementAcceleration() override;
173 std::optional<wpi::units::turn_t> GetExternalEncoderMechanismPosition() override;
175 std::optional<wpi::units::turns_per_second_t> GetExternalEncoderMechanismVelocity() override;
176
177 // ---- Motor status -------------------------------------------------------
179 std::optional<wpi::units::ampere_t> GetSupplyCurrent() override;
181 wpi::units::ampere_t GetStatorCurrent() override;
183 wpi::units::celsius_t GetTemperature() override;
185 wpi::math::DCMotor GetDCMotor() override;
186
187 // ---- Configuration setters (live tuning) --------------------------------
189 void SetZeroPower(MotorMode mode) override;
191 void SetMotorInverted(bool inverted) override;
193 void SetEncoderInverted(bool inverted) override;
195 void SetKp(double kP) override;
197 void SetKi(double kI) override;
199 void SetKd(double kD) override;
201 void SetFeedback(double kP, double kI, double kD) override;
203 void SetKs(double kS) override;
205 void SetKv(double kV) override;
207 void SetKa(double kA) override;
209 void SetKg(double kG) override;
211 void SetFeedforward(double kS, double kV, double kA, double kG) override;
213 void SetStatorCurrentLimit(wpi::units::ampere_t currentLimit) override;
215 void SetSupplyCurrentLimit(wpi::units::ampere_t currentLimit) override;
217 void SetClosedLoopRampRate(wpi::units::second_t rampRate) override;
219 void SetOpenLoopRampRate(wpi::units::second_t rampRate) override;
221 void SetMechanismUpperLimit(wpi::units::turn_t upperLimit) override;
223 void SetMechanismLowerLimit(wpi::units::turn_t lowerLimit) override;
225 void SetMechanismLimits(wpi::units::turn_t lower, wpi::units::turn_t upper) override;
227 void SetMechanismLimitsEnabled(bool enabled) override;
229 void SetMeasurementUpperLimit(wpi::units::meter_t upperLimit) override;
231 void SetMeasurementLowerLimit(wpi::units::meter_t lowerLimit) override;
233 void SetMotionProfileMaxVelocity(wpi::units::turns_per_second_t maxVelocity) override;
235 void SetMotionProfileMaxVelocity(wpi::units::meters_per_second_t maxVelocity) override;
237 void SetMotionProfileMaxAcceleration(wpi::units::turns_per_second_squared_t maxAcc) override;
239 void SetMotionProfileMaxAcceleration(wpi::units::meters_per_second_squared_t maxAcc) override;
246 void SetMotionProfileMaxJerk(wpi::units::angular_jerk::turns_per_second_cubed_t maxJerk) override;
248 void SetExponentialProfile(std::optional<double> kV, std::optional<double> kA,
249 std::optional<wpi::units::volt_t> maxInput) override;
259 void SetMechanismCircumference(wpi::units::meter_t circumference) override;
260
268 void* GetMotorController() override;
277 void* GetMotorControllerConfig() override;
278
285 void SetSimSupplier(std::shared_ptr<SimSupplier> supplier) override;
286
287 private:
289 thrifty::Nova* m_nova{nullptr};
291 std::optional<thrifty::NovaConfigBatch> m_vendorConfig;
292 wpi::math::DCMotor m_motor;
293 std::optional<wpi::sim::DCMotorSim> m_motorSim;
295 std::optional<thrifty::Motor::FeedbackSensorType> m_dataPortEncoder;
297 thrifty::CanEncoder* m_canEncoder{nullptr};
302 bool m_closedLoopOnNova{false};
304 thrifty::MotorControl::Slot m_novaSlot{thrifty::MotorControl::Slot::SLOT0};
309 double m_rotationsPerGainUnit{1.0};
311 double m_mechanismToFeedbackSensorRatio{1.0};
313 thrifty::Motor::FeedbackSensorType m_feedbackSensor{thrifty::Motor::FeedbackSensorType::INTERNAL};
315 std::shared_ptr<simulation::NovaSimSupplier> m_novaSim;
320 std::optional<thrifty::MotorSim> m_externalEncoderSim;
321 math::DerivativeTimeFilter m_accelFilter{20_ms};
322
323 std::optional<wpi::util::Alert> m_systemCoreClosedLoopAlert;
324
326 std::string AlertId(const std::string& alertType) const;
328 double MechanismToRotorRatio() const;
330 double MechanismToExternalEncoderRatio() const;
332 void LoadClosedLoopController(const SmartMotorControllerConfig& config);
334 void ApplyFeedback(double kP, double kI, double kD);
336 void CreateMotorSim();
341 void ApplyExternalEncoder(const SmartMotorControllerConfig& config,
342 thrifty::NovaConfigBatch& novaConfig);
350 bool NovaCanRunClosedLoop(const SmartMotorControllerConfig& config) const;
358 double NovaPositionTarget(wpi::units::turn_t angle);
360 std::optional<wpi::units::turn_t> GetExternalEncoderSensorPosition();
362 std::optional<wpi::units::turns_per_second_t> GetExternalEncoderSensorVelocity();
363};
364
365} // namespace yams::motorcontrollers::local
Definition MechanismGearing.hpp:19
Definition SmartMotorControllerConfig.hpp:66
ClosedLoopControllerSlot
Definition SmartMotorControllerConfig.hpp:75
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 SetExponentialProfile(std::optional< double > kV, std::optional< double > kA, std::optional< wpi::units::volt_t > maxInput) override
void SetMechanismCircumference(wpi::units::meter_t circumference) override
void SetFeedforward(double kS, double kV, double kA, double kG) override
void SetEncoderInverted(bool inverted) override
wpi::units::meters_per_second_squared_t GetMeasurementAcceleration() override
wpi::math::DCMotor GetDCMotor() override
wpi::units::turn_t GetRotorPosition() override
void SetMeasurementUpperLimit(wpi::units::meter_t upperLimit) override
void SetMeasurementLowerLimit(wpi::units::meter_t lowerLimit) override
wpi::units::meters_per_second_t GetMeasurementVelocity() override
wpi::units::volt_t GetVoltage() override
wpi::units::turns_per_second_t GetRotorVelocity() override
void SetMotorInverted(bool inverted) override
void SetSupplyCurrentLimit(wpi::units::ampere_t currentLimit) override
void SetFeedback(double kP, double kI, double kD) override
void SetOpenLoopRampRate(wpi::units::second_t rampRate) override
bool ApplyConfig(const SmartMotorControllerConfig &config) override
wpi::units::turn_t GetRelativeMechanismPosition() override
void SetEncoderPosition(wpi::units::turn_t angle) override
void SetZeroPower(MotorMode mode) override
void SetVelocity(wpi::units::meters_per_second_t velocity) override
wpi::units::turn_t GetMechanismPosition() override
wpi::units::turns_per_second_t GetMechanismVelocity() override
void SetEncoderVelocity(wpi::units::meters_per_second_t velocity) override
void SetVelocity(wpi::units::turns_per_second_t velocity, wpi::units::newton_t feedforwardForce) override
void SetMechanismLimits(wpi::units::turn_t lower, wpi::units::turn_t upper) override
void SetMechanismUpperLimit(wpi::units::turn_t upperLimit) override
wpi::units::celsius_t GetTemperature() override
void SetMotionProfileMaxJerk(wpi::units::angular_jerk::turns_per_second_cubed_t maxJerk) override
wpi::units::meter_t GetMeasurementPosition() override
NovaWrapper(thrifty::Nova *nova, wpi::math::DCMotor motor, SmartMotorControllerConfig *config)
std::optional< wpi::units::ampere_t > GetSupplyCurrent() override
void SetMechanismLimitsEnabled(bool enabled) override
void SetEncoderPosition(wpi::units::meter_t distance) override
wpi::units::turns_per_second_t GetRelativeMechanismVelocity() override
wpi::units::turns_per_second_squared_t GetMechanismAcceleration() override
void SetEncoderVelocity(wpi::units::turns_per_second_t velocity) override
void SetStatorCurrentLimit(wpi::units::ampere_t currentLimit) override
void SetVelocity(wpi::units::turns_per_second_t velocity) override
wpi::units::ampere_t GetStatorCurrent() override
std::optional< wpi::units::turns_per_second_t > GetExternalEncoderMechanismVelocity() override
void SetMotionProfileMaxVelocity(wpi::units::meters_per_second_t maxVelocity) override
void SetClosedLoopSlot(ClosedLoopControllerSlot slot) override
void SetSimSupplier(std::shared_ptr< SimSupplier > supplier) override
void SetVoltage(wpi::units::volt_t voltage) override
void SetDutyCycle(double dutyCycle) override
void SetMotionProfileMaxAcceleration(wpi::units::meters_per_second_squared_t maxAcc) override
void SetMechanismGearing(const gearing::MechanismGearing &gearing) override
void SetMotionProfileMaxVelocity(wpi::units::turns_per_second_t maxVelocity) override
void SetPosition(wpi::units::meter_t distance) override
std::optional< wpi::units::turn_t > GetExternalEncoderMechanismPosition() override
SmartMotorControllerConfig & GetConfig() override
void SetMechanismLowerLimit(wpi::units::turn_t lowerLimit) override
void SetPosition(wpi::units::turn_t angle) override
void SetClosedLoopRampRate(wpi::units::second_t rampRate) override
void SetMotionProfileMaxAcceleration(wpi::units::turns_per_second_squared_t maxAcc) override
Definition GearBox.hpp:11
Definition A301Wrapper.hpp:17