mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
418 lines
28 KiB
HTML
418 lines
28 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
|
<title>SwerveModuleConfiguration</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2024-01-26">
|
|
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../script.js"></script>
|
|
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var pathtoroot = "../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field-summary">Field</a> | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field-detail">Field</a> | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li>Method</li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.parser</a></div>
|
|
<h1 title="Class SwerveModuleConfiguration" class="title">Class SwerveModuleConfiguration</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">swervelib.parser.SwerveModuleConfiguration</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveModuleConfiguration</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Swerve Module configuration class which is used to configure <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code><a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The Absolute Encoder for the swerve module.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>final boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Whether the absolute encoder is inverted.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>final boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#angleMotorInverted" class="member-name-link">angleMotorInverted</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">State of inversion of the angle motor.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final double</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Angle offset in degrees for the Swerve Module.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#anglePIDF" class="member-name-link">anglePIDF</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final <a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#conversionFactors" class="member-name-link">conversionFactors</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Conversion factor for drive motor onboard PID's and angle PID's.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#driveMotorInverted" class="member-name-link">driveMotorInverted</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">State of inversion of the drive motor.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>edu.wpi.first.math.geometry.Translation2d</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#moduleLocation" class="member-name-link">moduleLocation</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Swerve module location relative to the robot.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><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"><code><a href="#name" class="member-name-link">name</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Name for the swerve module for telemetry.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Physical characteristics of the swerve module.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#useCosineCompensator" class="member-name-link">useCosineCompensator</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Should do cosine compensation when not pointing correct direction;.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#velocityPIDF" class="member-name-link">velocityPIDF</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String,boolean)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> driveMotor,
|
|
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> angleMotor,
|
|
<a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a> conversionFactors,
|
|
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> absoluteEncoder,
|
|
double angleOffset,
|
|
double xMeters,
|
|
double yMeters,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
|
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics,
|
|
boolean absoluteEncoderInverted,
|
|
boolean driveMotorInverted,
|
|
boolean angleMotorInverted,
|
|
<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> name,
|
|
boolean useCosineCompensator)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Construct a configuration object for swerve modules.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String,boolean)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> driveMotor,
|
|
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> angleMotor,
|
|
<a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a> conversionFactors,
|
|
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> absoluteEncoder,
|
|
double angleOffset,
|
|
double xMeters,
|
|
double yMeters,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
|
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics,
|
|
<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> name,
|
|
boolean useCosineCompensator)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Construct a configuration object for swerve modules.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="conversionFactors">
|
|
<h3>conversionFactors</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></span> <span class="element-name">conversionFactors</span></div>
|
|
<div class="block">Conversion factor for drive motor onboard PID's and angle PID's. Use
|
|
<a href="../math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a> and
|
|
<a href="../math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a> respectively to calculate the
|
|
conversion factors.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="angleOffset">
|
|
<h3>angleOffset</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">angleOffset</span></div>
|
|
<div class="block">Angle offset in degrees for the Swerve Module.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="absoluteEncoderInverted">
|
|
<h3>absoluteEncoderInverted</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">absoluteEncoderInverted</span></div>
|
|
<div class="block">Whether the absolute encoder is inverted.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="driveMotorInverted">
|
|
<h3>driveMotorInverted</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">driveMotorInverted</span></div>
|
|
<div class="block">State of inversion of the drive motor.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="angleMotorInverted">
|
|
<h3>angleMotorInverted</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">angleMotorInverted</span></div>
|
|
<div class="block">State of inversion of the angle motor.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="anglePIDF">
|
|
<h3>anglePIDF</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">anglePIDF</span></div>
|
|
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="velocityPIDF">
|
|
<h3>velocityPIDF</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">velocityPIDF</span></div>
|
|
<div class="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="moduleLocation">
|
|
<h3>moduleLocation</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.geometry.Translation2d</span> <span class="element-name">moduleLocation</span></div>
|
|
<div class="block">Swerve module location relative to the robot.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="physicalCharacteristics">
|
|
<h3>physicalCharacteristics</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></span> <span class="element-name">physicalCharacteristics</span></div>
|
|
<div class="block">Physical characteristics of the swerve module.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="driveMotor">
|
|
<h3>driveMotor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">driveMotor</span></div>
|
|
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="angleMotor">
|
|
<h3>angleMotor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">angleMotor</span></div>
|
|
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="absoluteEncoder">
|
|
<h3>absoluteEncoder</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span> <span class="element-name">absoluteEncoder</span></div>
|
|
<div class="block">The Absolute Encoder for the swerve module.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="name">
|
|
<h3>name</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">name</span></div>
|
|
<div class="block">Name for the swerve module for telemetry.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="useCosineCompensator">
|
|
<h3>useCosineCompensator</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">useCosineCompensator</span></div>
|
|
<div class="block">Should do cosine compensation when not pointing correct direction;.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String,boolean)">
|
|
<h3>SwerveModuleConfiguration</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveModuleConfiguration</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> driveMotor,
|
|
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> angleMotor,
|
|
<a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a> conversionFactors,
|
|
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> absoluteEncoder,
|
|
double angleOffset,
|
|
double xMeters,
|
|
double yMeters,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
|
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics,
|
|
boolean absoluteEncoderInverted,
|
|
boolean driveMotorInverted,
|
|
boolean angleMotorInverted,
|
|
<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> name,
|
|
boolean useCosineCompensator)</span></div>
|
|
<div class="block">Construct a configuration object for swerve modules.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>driveMotor</code> - Drive <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</dd>
|
|
<dd><code>angleMotor</code> - Angle <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a></dd>
|
|
<dd><code>absoluteEncoder</code> - Absolute encoder <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</dd>
|
|
<dd><code>angleOffset</code> - Absolute angle offset to 0.</dd>
|
|
<dd><code>absoluteEncoderInverted</code> - Absolute encoder inverted.</dd>
|
|
<dd><code>angleMotorInverted</code> - State of inversion of the angle motor.</dd>
|
|
<dd><code>driveMotorInverted</code> - Drive motor inverted.</dd>
|
|
<dd><code>xMeters</code> - Module location in meters from the center horizontally.</dd>
|
|
<dd><code>yMeters</code> - Module location in meters from center vertically.</dd>
|
|
<dd><code>anglePIDF</code> - Angle PIDF configuration.</dd>
|
|
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
|
|
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
|
|
<dd><code>name</code> - The name for the swerve module.</dd>
|
|
<dd><code>conversionFactors</code> - Conversion factors to be applied to the drive and angle motors.</dd>
|
|
<dd><code>useCosineCompensator</code> - Should use cosineCompensation.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String,boolean)">
|
|
<h3>SwerveModuleConfiguration</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveModuleConfiguration</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> driveMotor,
|
|
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> angleMotor,
|
|
<a href="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a> conversionFactors,
|
|
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> absoluteEncoder,
|
|
double angleOffset,
|
|
double xMeters,
|
|
double yMeters,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
|
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
|
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics,
|
|
<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> name,
|
|
boolean useCosineCompensator)</span></div>
|
|
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive motor are not
|
|
inverted.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>driveMotor</code> - Drive <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</dd>
|
|
<dd><code>angleMotor</code> - Angle <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a></dd>
|
|
<dd><code>conversionFactors</code> - Conversion factors for angle/azimuth motors drive factors.</dd>
|
|
<dd><code>absoluteEncoder</code> - Absolute encoder <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</dd>
|
|
<dd><code>angleOffset</code> - Absolute angle offset to 0.</dd>
|
|
<dd><code>xMeters</code> - Module location in meters from the center horizontally.</dd>
|
|
<dd><code>yMeters</code> - Module location in meters from center vertically.</dd>
|
|
<dd><code>anglePIDF</code> - Angle PIDF configuration.</dd>
|
|
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
|
|
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
|
|
<dd><code>name</code> - Name for the module.</dd>
|
|
<dd><code>useCosineCompensator</code> - Should use cosineCompensation.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|