keyboardteleop docs

RobotWebTools · Mar 10, 2015 · 2d98ac1 · 2d98ac1
1 parent 6ef5aa8
commit 2d98ac1
Show file tree

Hide file tree

Showing 16 changed files with 1,437 additions and 23 deletions.
diff --git a/jsdoc/keyboardteleopjs/0.3.0/KEYBOARDTELEOP.Teleop.html b/jsdoc/keyboardteleopjs/0.3.0/KEYBOARDTELEOP.Teleop.html
@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Teleop</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Teleop</h1>
+
+
+
+
+
+<section>
+
+<header>
+    <h2>
+        <span class="ancestors"><a href="global.html#KEYBOARDTELEOP">KEYBOARDTELEOP</a>.</span>
+
+    Teleop
+    </h2>
+
+</header>  
+
+<article>
+    <div class="container-overview">
+
+
+
+
+<dt>
+    <h4 class="name" id="Teleop"><span class="type-signature"></span>new Teleop<span class="signature">(options)</span><span class="type-signature"></span></h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        Manages connection to the server and all interactions with ROS.
+
+Emits the following events:
+  * 'change' - emitted with a change in speed occurs
+    </div>
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params">
+    <thead>
+	<tr>
+
+		<th>Name</th>
+
+
+		<th>Type</th>
+
+
+
+
+
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+
+	<tbody>
+
+
+        <tr>
+
+                <td class="name"><code>options</code></td>
+
+
+            <td class="type">
+
+            </td>
+
+
+
+
+
+            <td class="description last">possible keys include:
+  * ros - the ROSLIB.Ros connection handle
+  * topic (optional) - the Twist topic to publish to, like '/cmd_vel'
+  * throttle (optional) - a constant throttle for the speed</td>
+        </tr>
+
+
+	</tbody>
+</table>
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Teleop.js.html">teleop/Teleop.js</a>, line 17
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+</dd>
+
+
+    </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>  
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="KEYBOARDTELEOP.Teleop.html">Teleop</a></li></ul><h3>Global</h3><ul><li><a href="global.html#KEYBOARDTELEOP">KEYBOARDTELEOP</a></li></ul>
+</nav>
+
+<br clear="both">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Wed Feb 04 2015 08:47:10 GMT-0500 (EST)
+</footer>
+
+<script> prettyPrint(); </script>
+</body>
+</html>
diff --git a/jsdoc/keyboardteleopjs/0.3.0/KeyboardTeleop.js.html b/jsdoc/keyboardteleopjs/0.3.0/KeyboardTeleop.js.html
@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: KeyboardTeleop.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: KeyboardTeleop.js</h1>
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="prettyprint source"><code>/**
+ * @author Russell Toris - rctoris@wpi.edu
+ */
+
+var KEYBOARDTELEOP = KEYBOARDTELEOP || {
+  REVISION : '0.3.0'
+};
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="KEYBOARDTELEOP.Teleop.html">Teleop</a></li></ul><h3>Global</h3><ul><li><a href="global.html#KEYBOARDTELEOP">KEYBOARDTELEOP</a></li></ul>
+</nav>
+
+<br clear="both">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Wed Feb 04 2015 08:47:10 GMT-0500 (EST)
+</footer>
+
+<script> prettyPrint(); </script>
+</body>
+</html>