YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
yams::motorcontrollers::simulation::NovaSimSupplier Class Reference

#include <NovaSimSupplier.hpp>

Inheritance diagram for yams::motorcontrollers::simulation::NovaSimSupplier:
Collaboration diagram for yams::motorcontrollers::simulation::NovaSimSupplier:

Public Member Functions

 NovaSimSupplier (std::shared_ptr< SimSupplier > mechanism, thrifty::Nova &nova, wpi::units::second_t period)
void SetControlRequest (const thrifty::MotorControlRequest &request)
const std::optional< thrifty::MotorControlRequest > & GetControlRequest () const
double GetDutyCycle () const
void UpdateSim () override
bool GetUpdatedSim () override
void FeedUpdateSim () override
void StarveUpdateSim () override
bool IsInputFed () override
void FeedInput () override
void StarveInput () override
void SetMechanismStatorDutyCycle (double dutyCycle) override
wpi::units::volt_t GetMechanismSupplyVoltage () override
wpi::units::volt_t GetMechanismStatorVoltage () override
void SetMechanismStatorVoltage (wpi::units::volt_t volts) override
wpi::units::turn_t GetMechanismPosition () override
void SetMechanismPosition (wpi::units::turn_t angle) override
wpi::units::turn_t GetRotorPosition () override
wpi::units::turns_per_second_t GetMechanismVelocity () override
void SetMechanismVelocity (wpi::units::turns_per_second_t velocity) override
wpi::units::turns_per_second_t GetRotorVelocity () override
wpi::units::turns_per_second_squared_t GetMechanismAcceleration () override
wpi::units::turns_per_second_squared_t GetRotorAcceleration () override
void SetRotorPosition (wpi::units::turn_t angle) override
void SetRotorVelocity (wpi::units::turns_per_second_t velocity) override
wpi::units::ampere_t GetStatorCurrent () override
wpi::units::ampere_t GetSupplyCurrent () override
Public Member Functions inherited from yams::motorcontrollers::SimSupplier
virtual ~SimSupplier ()=default

Detailed Description

A simulated Thrifty Nova driving a mechanism's SimSupplier. ThriftyLib's simulation ignores the Nova's closed loop, so this runs it as the Nova would, with the gains read back from the Nova: the voltage position and velocity loops with the PID slot's gains and its F times the target, and the motion profile with its slot's kS, kV, kA and kG. It keeps within the Nova's soft limits, and, with its absolute wrapping on, takes a position the short way, one mechanism rotation apart. Targets and gains are in mechanism rotations, as on a Nova with its sensor-to-mechanism ratio set, and the integral and derivative gains are per second, as the Nova's are. Open loop output, a duty cycle or a voltage, is passed on to the mechanism.

Constructor & Destructor Documentation

◆ NovaSimSupplier()

yams::motorcontrollers::simulation::NovaSimSupplier::NovaSimSupplier ( std::shared_ptr< SimSupplier > mechanism,
thrifty::Nova & nova,
wpi::units::second_t period )

Create a simulated Nova.

Parameters
mechanismMechanism the Nova drives.
novaNova whose gains are simulated.
periodSimulation period.

Member Function Documentation

◆ FeedInput()

void yams::motorcontrollers::simulation::NovaSimSupplier::FeedInput ( )
overridevirtual

Mark the input as supplied directly for this loop.

Implements yams::motorcontrollers::SimSupplier.

◆ FeedUpdateSim()

void yams::motorcontrollers::simulation::NovaSimSupplier::FeedUpdateSim ( )
overridevirtual

Mark the simulation as stepped for this loop.

Implements yams::motorcontrollers::SimSupplier.

◆ GetControlRequest()

const std::optional< thrifty::MotorControlRequest > & yams::motorcontrollers::simulation::NovaSimSupplier::GetControlRequest ( ) const
Returns
The closed loop request being run, or empty in open loop.

◆ GetDutyCycle()

double yams::motorcontrollers::simulation::NovaSimSupplier::GetDutyCycle ( ) const
Returns
Duty cycle applied to the motor, from -1 to 1.

◆ GetMechanismAcceleration()

wpi::units::turns_per_second_squared_t yams::motorcontrollers::simulation::NovaSimSupplier::GetMechanismAcceleration ( )
overridevirtual

Get the simulated mechanism angular acceleration.

Returns
Mechanism acceleration in turns per second squared.

Implements yams::motorcontrollers::SimSupplier.

◆ GetMechanismPosition()

wpi::units::turn_t yams::motorcontrollers::simulation::NovaSimSupplier::GetMechanismPosition ( )
overridevirtual

Get the simulated mechanism position.

Returns
Mechanism position in turns.

Implements yams::motorcontrollers::SimSupplier.

◆ GetMechanismStatorVoltage()

wpi::units::volt_t yams::motorcontrollers::simulation::NovaSimSupplier::GetMechanismStatorVoltage ( )
overridevirtual

Get the voltage applied to the simulated motor.

Returns
Stator voltage in volts.

Implements yams::motorcontrollers::SimSupplier.

◆ GetMechanismSupplyVoltage()

wpi::units::volt_t yams::motorcontrollers::simulation::NovaSimSupplier::GetMechanismSupplyVoltage ( )
overridevirtual

Get the supply voltage available to the simulated motor controller (bus voltage).

Returns
Supply voltage in volts.

Implements yams::motorcontrollers::SimSupplier.

◆ GetMechanismVelocity()

wpi::units::turns_per_second_t yams::motorcontrollers::simulation::NovaSimSupplier::GetMechanismVelocity ( )
overridevirtual

Get the simulated mechanism velocity.

Returns
Mechanism velocity in turns per second.

Implements yams::motorcontrollers::SimSupplier.

◆ GetRotorAcceleration()

wpi::units::turns_per_second_squared_t yams::motorcontrollers::simulation::NovaSimSupplier::GetRotorAcceleration ( )
overridevirtual

Get the simulated rotor angular acceleration.

Returns
Rotor acceleration in turns per second squared.

Implements yams::motorcontrollers::SimSupplier.

◆ GetRotorPosition()

wpi::units::turn_t yams::motorcontrollers::simulation::NovaSimSupplier::GetRotorPosition ( )
overridevirtual

Get the simulated rotor position.

Returns
Rotor position in turns.

Implements yams::motorcontrollers::SimSupplier.

◆ GetRotorVelocity()

wpi::units::turns_per_second_t yams::motorcontrollers::simulation::NovaSimSupplier::GetRotorVelocity ( )
overridevirtual

Get the simulated rotor velocity.

Returns
Rotor velocity in turns per second.

Implements yams::motorcontrollers::SimSupplier.

◆ GetStatorCurrent()

wpi::units::ampere_t yams::motorcontrollers::simulation::NovaSimSupplier::GetStatorCurrent ( )
overridevirtual

Get the simulated stator (motor) current.

Returns
Stator current in amperes.

Implements yams::motorcontrollers::SimSupplier.

◆ GetSupplyCurrent()

wpi::units::ampere_t yams::motorcontrollers::simulation::NovaSimSupplier::GetSupplyCurrent ( )
overridevirtual

Get the simulated supply (battery) current: duty cycle times stator current, filtered by a 0.1 s single-pole IIR filter.

Returns
Supply current in amperes.

Implements yams::motorcontrollers::SimSupplier.

◆ GetUpdatedSim()

bool yams::motorcontrollers::simulation::NovaSimSupplier::GetUpdatedSim ( )
overridevirtual

Whether the simulation has already been stepped this loop.

Returns
true if UpdateSim() stepped the physics since the last StarveUpdateSim().

Implements yams::motorcontrollers::SimSupplier.

◆ IsInputFed()

bool yams::motorcontrollers::simulation::NovaSimSupplier::IsInputFed ( )
overridevirtual

Whether an input voltage was supplied directly this loop (e.g. from a hardware sim state).

Returns
true if the input was fed since the simulation last stepped.

Implements yams::motorcontrollers::SimSupplier.

◆ SetControlRequest()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetControlRequest ( const thrifty::MotorControlRequest & request)

Run a closed loop control request, as the Nova does when it is sent one. The integral, and the motion profile, carry on while requests of the same type are sent.

Parameters
requestVoltage position, voltage velocity or motion profile request.

◆ SetMechanismPosition()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetMechanismPosition ( wpi::units::turn_t angle)
overridevirtual

Set the simulated mechanism position.

Parameters
angleMechanism position to inject.

Implements yams::motorcontrollers::SimSupplier.

◆ SetMechanismStatorDutyCycle()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetMechanismStatorDutyCycle ( double dutyCycle)
overridevirtual

Open loop: the Nova stops its closed loop.

Implements yams::motorcontrollers::SimSupplier.

◆ SetMechanismStatorVoltage()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetMechanismStatorVoltage ( wpi::units::volt_t volts)
overridevirtual

Open loop: the Nova stops its closed loop.

Implements yams::motorcontrollers::SimSupplier.

◆ SetMechanismVelocity()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetMechanismVelocity ( wpi::units::turns_per_second_t velocity)
overridevirtual

Set the simulated mechanism velocity.

Parameters
velocityMechanism velocity to inject.

Implements yams::motorcontrollers::SimSupplier.

◆ SetRotorPosition()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetRotorPosition ( wpi::units::turn_t angle)
overridevirtual

Set the simulated rotor position.

Parameters
angleRotor position to inject.

Implements yams::motorcontrollers::SimSupplier.

◆ SetRotorVelocity()

void yams::motorcontrollers::simulation::NovaSimSupplier::SetRotorVelocity ( wpi::units::turns_per_second_t velocity)
overridevirtual

Set the simulated rotor velocity.

Parameters
velocityRotor velocity to inject.

Implements yams::motorcontrollers::SimSupplier.

◆ StarveInput()

void yams::motorcontrollers::simulation::NovaSimSupplier::StarveInput ( )
overridevirtual

Clear the input-fed flag so UpdateSim() falls back to the duty-cycle supplier.

Implements yams::motorcontrollers::SimSupplier.

◆ StarveUpdateSim()

void yams::motorcontrollers::simulation::NovaSimSupplier::StarveUpdateSim ( )
overridevirtual

Clear the stepped flag so the next UpdateSim() steps the physics again.

Implements yams::motorcontrollers::SimSupplier.

◆ UpdateSim()

void yams::motorcontrollers::simulation::NovaSimSupplier::UpdateSim ( )
overridevirtual

Advance the simulation by one loop iteration.

When the input has not been fed this loop (see FeedInput()), the motor duty cycle times the supply voltage is applied as the input and the battery voltage is updated. The physics are only stepped if the simulation has not already been updated this loop (see GetUpdatedSim()); stepping marks it updated, so a mechanism and its motor controller calling UpdateSim() in the same loop step the physics once.

Implements yams::motorcontrollers::SimSupplier.


The documentation for this class was generated from the following file:
  • /home/runner/work/YAMS/YAMS/yams/cpp/include/yams/motorcontrollers/simulation/NovaSimSupplier.hpp