frc.robot.subsystems.Arm.ArmDefinition Class Reference

This class is where all the devices and defined and configured and all the necessary functions needed to maintain/run the Arm Subsystem Class. More...

Inheritance diagram for frc.robot.subsystems.Arm.ArmDefinition:

Public Member Functions
	ArmDefinition ()
	Constructor for Defining and Initializing Motors and other items responsible for the Arm.
void	updateInputs (ArmIOInputs inputs)
	Updates all the listed variables stored.
void	stop ()
	Sets the following Motors to a Netural Mode, which stops all the motors from running.
void	setPositionControl (double positionRotations)
	This method uses a simple position control to move the arm to a specific position (in rotations).
void	setMotionControl (double positionRotations)
	This method uses Motion Magic to move the arm smoothly to a specific position, considering the velocity and acceleration limits defined in the configuration.
Public Member Functions inherited from frc.robot.subsystems.Arm.ArmIO

Detailed Description

This class is where all the devices and defined and configured and all the necessary functions needed to maintain/run the Arm Subsystem Class.

In essense, it contains all the functions/methods for the Arm Subsystem class.

Constructor & Destructor Documentation

ArmDefinition()

frc.robot.subsystems.Arm.ArmDefinition.ArmDefinition

(

)

Constructor for Defining and Initializing Motors and other items responsible for the Arm.

Member Function Documentation

setMotionControl()

void frc.robot.subsystems.Arm.ArmDefinition.setMotionControl

(

double

positionRotations

)

This method uses Motion Magic to move the arm smoothly to a specific position, considering the velocity and acceleration limits defined in the configuration.

Parameters

positionRotations

The specific position that the arm would like to move to

Returns

Implements frc.robot.subsystems.Arm.ArmIO.

setPositionControl()

void frc.robot.subsystems.Arm.ArmDefinition.setPositionControl

(

double

positionRotations

)

This method uses a simple position control to move the arm to a specific position (in rotations).

It sets the desired position for both the leader and follower motors using the PositionVoltage control mode.

Parameters

positionRotations

The desired position that the arm would like to go to

Returns

Implements frc.robot.subsystems.Arm.ArmIO.

stop()

void frc.robot.subsystems.Arm.ArmDefinition.stop

(

)

Sets the following Motors to a Netural Mode, which stops all the motors from running.

Returns

Implements frc.robot.subsystems.Arm.ArmIO.

updateInputs()

void frc.robot.subsystems.Arm.ArmDefinition.updateInputs

(

ArmIOInputs

inputs

)

Updates all the listed variables stored.

Implements frc.robot.subsystems.Arm.ArmIO.

---

The documentation for this class was generated from the following file:

• 2024-CommandRobot/src/main/java/frc/robot/subsystems/Arm/ArmDefinition.java