195 lines
16 KiB
HTML
195 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) -->
|
|
<title>Index (FtcRobotController API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="index">
|
|
<meta name="generator" content="javadoc/IndexWriter">
|
|
<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">
|
|
<script type="text/javascript" src="script.js"></script>
|
|
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
|
|
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="index-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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
|
<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="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">Package</a></li>
|
|
<li>Class</li>
|
|
<li><a href="overview-tree.html">Tree</a></li>
|
|
<li class="nav-bar-cell1-rev">Index</li>
|
|
<li><a href="help-doc.html#index">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list"></div>
|
|
<div class="nav-list-search"><a href="search.html">SEARCH</a>
|
|
<input type="text" id="search-input" disabled placeholder="Search">
|
|
<input type="reset" id="reset-button" disabled value="reset">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<div class="header">
|
|
<h1>Index</h1>
|
|
</div>
|
|
<a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:S">S</a> <a href="#I:U">U</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a>
|
|
<h2 class="title" id="I:B">B</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#basic-usage-testing--heading" class="search-tag-link">Basic Usage (Testing)</a> - Search tag in class org.firstinspires.ftc.teamcode.subsystems.chute.Chute</dt>
|
|
<dd>Section</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:C">C</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" class="type-name-link" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a> - Class in <a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a></dt>
|
|
<dd>
|
|
<div class="block">Main entry point for chute control system.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#%3Cinit%3E(double)" class="member-name-link">Chute(double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Creates chute with mock hardware for testing.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#%3Cinit%3E(double,double)" class="member-name-link">Chute(double, double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Creates chute with mock hardware and custom pot wraparound.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.subsystems.chute.ChuteController,org.firstinspires.ftc.teamcode.mock.MockMotor,org.firstinspires.ftc.teamcode.mock.MockPotentiometer)" class="member-name-link">Chute(ChuteController, MockMotor, MockPotentiometer)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Creates chute with real FTC hardware adapters.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" class="type-name-link" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a> - Class in <a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a></dt>
|
|
<dd>
|
|
<div class="block">Simple chute controller with homing and position control.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.mock.MockMotor,org.firstinspires.ftc.teamcode.mock.MockPotentiometer,double)" class="member-name-link">ChuteController(MockMotor, MockPotentiometer, double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Create a new chute controller.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:F">F</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#features-heading" class="search-tag-link">Features</a> - Search tag in class org.firstinspires.ftc.teamcode.subsystems.chute.Chute</dt>
|
|
<dd>Section</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:G">G</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#getHomeVoltage()" class="member-name-link">getHomeVoltage()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Get the home voltage reference captured during homing.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Gets motor instance for testing.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Gets current position of chute.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Get current position of chute.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#getPot()" class="member-name-link">getPot()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Gets potentiometer instance for testing.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#getWrapAmount()" class="member-name-link">getWrapAmount()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Get the pot wraparound amount.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:H">H</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#home()" class="member-name-link">home()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Starts homing sequence.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#home()" class="member-name-link">home()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Start homing sequence - drives down until pot stops changing, then captures reference voltage.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:I">I</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#isAtTarget()" class="member-name-link">isAtTarget()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Checks if chute is homed and stationary at target position.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#isHomed()" class="member-name-link">isHomed()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Checks if chute has completed homing sequence.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#isHomed()" class="member-name-link">isHomed()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Check if chute has been homed.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#isMoving()" class="member-name-link">isMoving()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Checks if chute is currently moving to target.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#isMoving()" class="member-name-link">isMoving()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Check if chute is currently moving to target.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:M">M</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#moveToPosition(double)" class="member-name-link">moveToPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Move to target position.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:O">O</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a> - package org.firstinspires.ftc.teamcode.subsystems.chute</dt>
|
|
<dd> </dd>
|
|
</dl>
|
|
<h2 class="title" id="I:S">S</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#setTargetPosition(double)" class="member-name-link">setTargetPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Commands chute to move to target position.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#stop()" class="member-name-link">stop()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Emergency stop - immediately halts motor and cancels any movement.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#stop()" class="member-name-link">stop()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Emergency stop - immediately stops motor and cancels movement.</div>
|
|
</dd>
|
|
</dl>
|
|
<h2 class="title" id="I:U">U</h2>
|
|
<dl class="index">
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
|
<dd>
|
|
<div class="block">Updates chute state - must be called every loop iteration.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
|
<dd>
|
|
<div class="block">Update controller state - call this every loop iteration.</div>
|
|
</dd>
|
|
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#usage-with-real-hardware-heading" class="search-tag-link">Usage with Real Hardware</a> - Search tag in class org.firstinspires.ftc.teamcode.subsystems.chute.Chute</dt>
|
|
<dd>Section</dd>
|
|
</dl>
|
|
<a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:S">S</a> <a href="#I:U">U</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a></main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|