wpilib18/java/current/javadoc/edu/wpi/first/wpilibj/livewindow/LiveWindow.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 05:22:53 EDT 2017 -->
<title>LiveWindow (Documentation - Release API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LiveWindow (Documentation - Release API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/wpi/first/wpilibj/livewindow/LiveWindow.html" target="_top">Frames</a></li>
<li><a href="LiveWindow.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.wpi.first.wpilibj.livewindow</div>
<h2 title="Class LiveWindow" class="title">Class LiveWindow</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.wpi.first.wpilibj.livewindow.LiveWindow</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">LiveWindow</span>
extends java.lang.Object</pre>
<div class="block">The LiveWindow class is the public interface for putting sensors and actuators on the
LiveWindow.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#LiveWindow--">LiveWindow</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#addActuator-java.lang.String-int-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">addActuator</a></span>(java.lang.String moduleType,
int moduleNumber,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</code>
<div class="block">Add Actuator to LiveWindow.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#addActuator-java.lang.String-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">addActuator</a></span>(java.lang.String moduleType,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</code>
<div class="block">Add Actuator to LiveWindow.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#addActuator-java.lang.String-java.lang.String-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">addActuator</a></span>(java.lang.String subsystem,
java.lang.String name,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</code>
<div class="block">Add an Actuator associated with the subsystem and with call it by the given name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#addSensor-java.lang.String-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">addSensor</a></span>(java.lang.String moduleType,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</code>
<div class="block">Add Sensor to LiveWindow.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#addSensor-java.lang.String-java.lang.String-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">addSensor</a></span>(java.lang.String subsystem,
java.lang.String name,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</code>
<div class="block">Add a Sensor associated with the subsystem and with call it by the given name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#run--">run</a></span>()</code>
<div class="block">The run method is called repeatedly to keep the values refreshed on the screen in test mode.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindow.html#setEnabled-boolean-">setEnabled</a></span>(boolean enabled)</code>
<div class="block">Set the enabled state of LiveWindow.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LiveWindow--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LiveWindow</h4>
<pre>public LiveWindow()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnabled</h4>
<pre>public static void setEnabled(boolean enabled)</pre>
<div class="block">Set the enabled state of LiveWindow. If it's being enabled, turn off the scheduler and remove
all the commands from the queue and enable all the components registered for LiveWindow. If
it's being disabled, stop all the registered components and reenable the scheduler. TODO: add
code to disable PID loops when enabling LiveWindow. The commands should reenable the PID loops
themselves when they get rescheduled. This prevents arms from starting to move around, etc.
after a period of adjusting them in LiveWindow mode.</div>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public static void run()</pre>
<div class="block">The run method is called repeatedly to keep the values refreshed on the screen in test mode.</div>
</li>
</ul>
<a name="addSensor-java.lang.String-java.lang.String-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSensor</h4>
<pre>public static void addSensor(java.lang.String subsystem,
java.lang.String name,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</pre>
<div class="block">Add a Sensor associated with the subsystem and with call it by the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subsystem</code> - The subsystem this component is part of.</dd>
<dd><code>name</code> - The name of this component.</dd>
<dd><code>component</code> - A LiveWindowSendable component that represents a sensor.</dd>
</dl>
</li>
</ul>
<a name="addSensor-java.lang.String-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSensor</h4>
<pre>public static void addSensor(java.lang.String moduleType,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</pre>
<div class="block">Add Sensor to LiveWindow. The components are shown with the type and channel like this: Gyro[1]
for a gyro object connected to the first analog channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>moduleType</code> - A string indicating the type of the module used in the naming (above)</dd>
<dd><code>channel</code> - The channel number the device is connected to</dd>
<dd><code>component</code> - A reference to the object being added</dd>
</dl>
</li>
</ul>
<a name="addActuator-java.lang.String-java.lang.String-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addActuator</h4>
<pre>public static void addActuator(java.lang.String subsystem,
java.lang.String name,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</pre>
<div class="block">Add an Actuator associated with the subsystem and with call it by the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subsystem</code> - The subsystem this component is part of.</dd>
<dd><code>name</code> - The name of this component.</dd>
<dd><code>component</code> - A LiveWindowSendable component that represents a actuator.</dd>
</dl>
</li>
</ul>
<a name="addActuator-java.lang.String-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addActuator</h4>
<pre>public static void addActuator(java.lang.String moduleType,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</pre>
<div class="block">Add Actuator to LiveWindow. The components are shown with the module type, slot and channel
like this: Servo[1,2] for a servo object connected to the first digital module and PWM port 2.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>moduleType</code> - A string that defines the module name in the label for the value</dd>
<dd><code>channel</code> - The channel number the device is plugged into (usually PWM)</dd>
<dd><code>component</code> - The reference to the object being added</dd>
</dl>
</li>
</ul>
<a name="addActuator-java.lang.String-int-int-edu.wpi.first.wpilibj.livewindow.LiveWindowSendable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addActuator</h4>
<pre>public static void addActuator(java.lang.String moduleType,
int moduleNumber,
int channel,
<a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow">LiveWindowSendable</a> component)</pre>
<div class="block">Add Actuator to LiveWindow. The components are shown with the module type, slot and channel
like this: Servo[1,2] for a servo object connected to the first digital module and PWM port 2.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>moduleType</code> - A string that defines the module name in the label for the value</dd>
<dd><code>moduleNumber</code> - The number of the particular module type</dd>
<dd><code>channel</code> - The channel number the device is plugged into (usually PWM)</dd>
<dd><code>component</code> - The reference to the object being added</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../edu/wpi/first/wpilibj/livewindow/LiveWindowSendable.html" title="interface in edu.wpi.first.wpilibj.livewindow"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/wpi/first/wpilibj/livewindow/LiveWindow.html" target="_top">Frames</a></li>
<li><a href="LiveWindow.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>