Skip to content

Commit

Permalink
Automated Release 45 **NO_CI**
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenjust committed Jan 30, 2024
1 parent 32c86c9 commit 73917ae
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 59 deletions.
8 changes: 5 additions & 3 deletions index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -2962,6 +2962,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>
<div class="block">Returns the <a href="xbot/common/injection/electrical_contract/DeviceInfo.html" title="class in xbot.common.injection.electrical_contract"><code>DeviceInfo</code></a> for the drive motor for the given <a href="xbot/common/injection/swerve/SwerveInstance.html" title="class in xbot.common.injection.swerve"><code>SwerveInstance</code></a>.</div>
</dd>
<dt><a href="xbot/common/subsystems/drive/swerve/SwerveDriveSubsystem.html#getDrivePidEnabled()" class="member-name-link">getDrivePidEnabled()</a> - Method in class xbot.common.subsystems.drive.swerve.<a href="xbot/common/subsystems/drive/swerve/SwerveDriveSubsystem.html" title="class in xbot.common.subsystems.drive.swerve">SwerveDriveSubsystem</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/subsystems/drive/swerve/SwerveModuleSubsystem.html#getDriveSubsystem()" class="member-name-link">getDriveSubsystem()</a> - Method in class xbot.common.subsystems.drive.swerve.<a href="xbot/common/subsystems/drive/swerve/SwerveModuleSubsystem.html" title="class in xbot.common.subsystems.drive.swerve">SwerveModuleSubsystem</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/injection/modules/MockDevicesModule.html#getDutyCycleEncoderFactory(xbot.common.controls.sensors.mock_adapters.MockDutyCycleEncoder.MockDutyCycleEncoderFactory)" class="member-name-link">getDutyCycleEncoderFactory(MockDutyCycleEncoder.MockDutyCycleEncoderFactory)</a> - Method in class xbot.common.injection.modules.<a href="xbot/common/injection/modules/MockDevicesModule.html" title="class in xbot.common.injection.modules">MockDevicesModule</a></dt>
Expand Down Expand Up @@ -3443,7 +3445,7 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/controls/actuators/XSolenoid.html#getMaxSupportedChannel()" class="member-name-link">getMaxSupportedChannel()</a> - Method in class xbot.common.controls.actuators.<a href="xbot/common/controls/actuators/XSolenoid.html" title="class in xbot.common.controls.actuators">XSolenoid</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/subsystems/drive/BaseSwerveDriveSubsystem.html#getMaxTargetSpeedInchesPerSecond()" class="member-name-link">getMaxTargetSpeedInchesPerSecond()</a> - Method in class xbot.common.subsystems.drive.<a href="xbot/common/subsystems/drive/BaseSwerveDriveSubsystem.html" title="class in xbot.common.subsystems.drive">BaseSwerveDriveSubsystem</a></dt>
<dt><a href="xbot/common/subsystems/drive/BaseSwerveDriveSubsystem.html#getMaxTargetSpeedMetersPerSecond()" class="member-name-link">getMaxTargetSpeedMetersPerSecond()</a> - Method in class xbot.common.subsystems.drive.<a href="xbot/common/subsystems/drive/BaseSwerveDriveSubsystem.html" title="class in xbot.common.subsystems.drive">BaseSwerveDriveSubsystem</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.html#getMeasurementPeriod()" class="member-name-link">getMeasurementPeriod()</a> - Method in class xbot.common.controls.actuators.mock_adapters.<a href="xbot/common/controls/actuators/mock_adapters/MockCANSparkMax.html" title="class in xbot.common.controls.actuators.mock_adapters">MockCANSparkMax</a></dt>
<dd>&nbsp;</dd>
Expand Down Expand Up @@ -3711,8 +3713,6 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/command/BaseCommand.html#getPrefix()" class="member-name-link">getPrefix()</a> - Method in class xbot.common.command.<a href="xbot/common/command/BaseCommand.html" title="class in xbot.common.command">BaseCommand</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/command/BaseMaintainerCommand.html#getPrefix()" class="member-name-link">getPrefix()</a> - Method in class xbot.common.command.<a href="xbot/common/command/BaseMaintainerCommand.html" title="class in xbot.common.command">BaseMaintainerCommand</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/command/BaseSubsystem.html#getPrefix()" class="member-name-link">getPrefix()</a> - Method in class xbot.common.command.<a href="xbot/common/command/BaseSubsystem.html" title="class in xbot.common.command">BaseSubsystem</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/controls/actuators/XCANSparkMax.html#getPrefix()" class="member-name-link">getPrefix()</a> - Method in class xbot.common.controls.actuators.<a href="xbot/common/controls/actuators/XCANSparkMax.html" title="class in xbot.common.controls.actuators">XCANSparkMax</a></dt>
Expand Down Expand Up @@ -6594,6 +6594,8 @@ <h2 class="title" id="I:S">S</h2>
<dd>
<div class="block">Calculates the nearest position on the motor encoder to targetDegrees and sets the controller's PID target.</div>
</dd>
<dt><a href="xbot/common/subsystems/drive/swerve/SwerveDriveSubsystem.html#setMotorControllerVelocityPidFromSubsystemTarget()" class="member-name-link">setMotorControllerVelocityPidFromSubsystemTarget()</a> - Method in class xbot.common.subsystems.drive.swerve.<a href="xbot/common/subsystems/drive/swerve/SwerveDriveSubsystem.html" title="class in xbot.common.subsystems.drive.swerve">SwerveDriveSubsystem</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/controls/actuators/mock_adapters/MockCANTalon.html#setNeutralMode(com.ctre.phoenix.motorcontrol.NeutralMode)" class="member-name-link">setNeutralMode(NeutralMode)</a> - Method in class xbot.common.controls.actuators.mock_adapters.<a href="xbot/common/controls/actuators/mock_adapters/MockCANTalon.html" title="class in xbot.common.controls.actuators.mock_adapters">MockCANTalon</a></dt>
<dd>&nbsp;</dd>
<dt><a href="xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.html#setNeutralMode(com.ctre.phoenix.motorcontrol.NeutralMode)" class="member-name-link">setNeutralMode(NeutralMode)</a> - Method in class xbot.common.controls.actuators.mock_adapters.<a href="xbot/common/controls/actuators/mock_adapters/MockCANVictorSPX.html" title="class in xbot.common.controls.actuators.mock_adapters">MockCANVictorSPX</a></dt>
Expand Down
2 changes: 1 addition & 1 deletion member-search-index.js

Large diffs are not rendered by default.

55 changes: 20 additions & 35 deletions xbot/common/command/BaseMaintainerCommand.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,51 +206,48 @@ <h2>Method Summary</h2>
<div class="block">Gets the magnitude of the human input to use for the maintain command,
since the generic type T may not be a number.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrefix()" class="member-name-link">getPrefix</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#humanControlAction()" class="member-name-link">humanControlAction</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The human control action.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initializeMachineControlAction()" class="member-name-link">initializeMachineControlAction</a>()</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#humanControlAction()" class="member-name-link">humanControlAction</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The initialize machine control action.</div>
<div class="block">The human control action.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMaintainerAtGoal()" class="member-name-link">isMaintainerAtGoal</a>()</code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initializeMachineControlAction()" class="member-name-link">initializeMachineControlAction</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if the subsystem is at its goal.</div>
<div class="block">The initialize machine control action.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maintain()" class="member-name-link">maintain</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMaintainerAtGoal()" class="member-name-link">isMaintainerAtGoal</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Contains all the logic associated with keeping the subsystem
at its goal.</div>
<div class="block">Checks if the subsystem is at its goal.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetDecider(boolean)" class="member-name-link">resetDecider</a><wbr>(boolean&nbsp;startInAutomaticMode)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maintain()" class="member-name-link">maintain</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Resets the decider to the given mode.</div>
<div class="block">Contains all the logic associated with keeping the subsystem
at its goal.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setErrorTolerance(double)" class="member-name-link">setErrorTolerance</a><wbr>(double&nbsp;tolerance)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetDecider(boolean)" class="member-name-link">resetDecider</a><wbr>(boolean&nbsp;startInAutomaticMode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the error tolerance for the maintain command.</div>
<div class="block">Resets the decider to the given mode.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#uncalibratedMachineControlAction()" class="member-name-link">uncalibratedMachineControlAction</a>()</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setErrorTolerance(double)" class="member-name-link">setErrorTolerance</a><wbr>(double&nbsp;tolerance)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the error tolerance for the maintain command.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#uncalibratedMachineControlAction()" class="member-name-link">uncalibratedMachineControlAction</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The uncalibrated machine control action.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-xbot.common.command.BaseCommand">Methods inherited from class&nbsp;xbot.common.command.<a href="BaseCommand.html" title="class in xbot.common.command">BaseCommand</a></h3>
<code><a href="BaseCommand.html#includeOnSmartDashboard()">includeOnSmartDashboard</a>, <a href="BaseCommand.html#includeOnSmartDashboard(java.lang.String)">includeOnSmartDashboard</a>, <a href="BaseCommand.html#initialize()">initialize</a>, <a href="BaseCommand.html#requires(xbot.common.command.BaseSubsystem)">requires</a>, <a href="BaseCommand.html#runsWhenDisabled()">runsWhenDisabled</a>, <a href="BaseCommand.html#setRunsWhenDisabled(boolean)">setRunsWhenDisabled</a></code></div>
<code><a href="BaseCommand.html#getPrefix()">getPrefix</a>, <a href="BaseCommand.html#includeOnSmartDashboard()">includeOnSmartDashboard</a>, <a href="BaseCommand.html#includeOnSmartDashboard(java.lang.String)">includeOnSmartDashboard</a>, <a href="BaseCommand.html#initialize()">initialize</a>, <a href="BaseCommand.html#requires(xbot.common.command.BaseSubsystem)">requires</a>, <a href="BaseCommand.html#runsWhenDisabled()">runsWhenDisabled</a>, <a href="BaseCommand.html#setRunsWhenDisabled(boolean)">setRunsWhenDisabled</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h3>
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isFinished, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
Expand Down Expand Up @@ -462,18 +459,6 @@ <h3>getHumanInputMagnitude</h3>
</section>
</li>
<li>
<section class="detail" id="getPrefix()">
<h3>getPrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getPrefix</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../properties/IPropertySupport.html#getPrefix()">getPrefix</a></code>&nbsp;in interface&nbsp;<code><a href="../properties/IPropertySupport.html" title="interface in xbot.common.properties">IPropertySupport</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="BaseCommand.html#getPrefix()">getPrefix</a></code>&nbsp;in class&nbsp;<code><a href="BaseCommand.html" title="class in xbot.common.command">BaseCommand</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setErrorTolerance(double)">
<h3>setErrorTolerance</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setErrorTolerance</span><wbr><span class="parameters">(double&nbsp;tolerance)</span></div>
Expand Down
8 changes: 4 additions & 4 deletions xbot/common/subsystems/drive/BaseSwerveDriveSubsystem.html
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ <h2>Method Summary</h2>
- Pointing in the direction of +Y travel</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxTargetSpeedInchesPerSecond()" class="member-name-link">getMaxTargetSpeedInchesPerSecond</a>()</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxTargetSpeedMetersPerSecond()" class="member-name-link">getMaxTargetSpeedMetersPerSecond</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../math/PIDManager.html" title="class in xbot.common.math">PIDManager</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPositionalPid()" class="member-name-link">getPositionalPid</a>()</code></div>
Expand Down Expand Up @@ -423,9 +423,9 @@ <h3>getSwerveDriveKinematics</h3>
</section>
</li>
<li>
<section class="detail" id="getMaxTargetSpeedInchesPerSecond()">
<h3>getMaxTargetSpeedInchesPerSecond</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getMaxTargetSpeedInchesPerSecond</span>()</div>
<section class="detail" id="getMaxTargetSpeedMetersPerSecond()">
<h3>getMaxTargetSpeedMetersPerSecond</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getMaxTargetSpeedMetersPerSecond</span>()</div>
</section>
</li>
<li>
Expand Down
Loading

0 comments on commit 73917ae

Please sign in to comment.