mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
Update YAGSL to handle controls better
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Wed Apr 05 08:59:10 CDT 2023 -->
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 12:30:47 CDT 2023 -->
|
||||
<title>ModuleJson</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="2023-04-05">
|
||||
<meta name="dc.created" content="2023-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.parser.json, class: ModuleJson">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||||
@@ -111,29 +111,24 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The angle encoder pulse per revolution override.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a></code></div>
|
||||
<div class="col-first even-row-color"><code><a href="DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#drive" class="member-name-link">drive</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Angle motor free speed RPM.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#drive" class="member-name-link">drive</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Drive motor device configuration.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code><a href="DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Absolute encoder device configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code><a href="modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Defines which motors are inverted.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#location" class="member-name-link">location</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code><a href="modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#location" class="member-name-link">location</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The location of the swerve module from the center of the robot in inches.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -164,10 +159,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">createModuleConfiguration</a><wbr>(<a href="../PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration</a><wbr>(<a href="../PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
||||
<a href="../PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
||||
double maxSpeed,
|
||||
<a href="../SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics)</code></div>
|
||||
<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)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Create the swerve module configuration based off of parsed data.</div>
|
||||
</div>
|
||||
@@ -238,13 +234,6 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="angleMotorFreeSpeedRPM">
|
||||
<h3>angleMotorFreeSpeedRPM</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">angleMotorFreeSpeedRPM</span></div>
|
||||
<div class="block">Angle motor free speed RPM.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="location">
|
||||
<h3>location</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></span> <span class="element-name">location</span></div>
|
||||
@@ -274,12 +263,13 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics)">
|
||||
<section class="detail" id="createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)">
|
||||
<h3>createModuleConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></span> <span class="element-name">createModuleConfiguration</span><wbr><span class="parameters">(<a href="../PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> anglePIDF,
|
||||
<a href="../PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> velocityPIDF,
|
||||
double maxSpeed,
|
||||
<a href="../SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics)</span></div>
|
||||
<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)</span></div>
|
||||
<div class="block">Create the swerve module configuration based off of parsed data.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
@@ -287,6 +277,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>velocityPIDF</code> - The velocity PIDF values for the drive motor.</dd>
|
||||
<dd><code>maxSpeed</code> - The maximum speed of the robot in meters per second.</dd>
|
||||
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
|
||||
<dd><code>name</code> - Module json filename.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="../SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> based on the provided data and parsed data.</dd>
|
||||
</dl>
|
||||
|
||||
Reference in New Issue
Block a user