rusefi
/
jSerialComm
mirror of https://github.com/rusefi/jSerialComm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated all documentation and initial version of the web site.

This commit is contained in:
Will Hedgecock 2015-03-12 18:11:20 -05:00
parent 4b4383ef9b
commit 60df0fa618
23 changed files with 399 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
images/sprite_download.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 20 KiB

164
index.html
View File

@ -5,7 +5,12 @@
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="jSerialComm : Platform-independent serial port access for Java">
<link rel="stylesheet" href="http://code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css">
<script src="http://code.jquery.com/jquery-1.10.2.js"></script>
<script src="http://code.jquery.com/ui/1.11.4/jquery-ui.js"></script>
<script>$(function() { $( ".tabs" ).tabs(); });</script>
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>jSerialComm</title>
@ -18,12 +23,13 @@
<header class="inner">
<a id="forkme_banner" href="https://github.com/Fazecast/jSerialComm">View on GitHub</a>
<h1 id="project_title">jSerialComm</h1>
<h2 id="project_tagline">Platform-independent serial port access for Java</h2>
<img src="images/logo-with-title-white.png" width=319 height=55 style="border-style:none;box-shadow:none;margin:0;padding:0;" alt="jSerialComm"/>
<h2 id="project_tagline" style="margin-top:0;padding-top:0;">Platform-independent serial port access for Java</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/Fazecast/jSerialComm/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/Fazecast/jSerialComm/tarball/master">Download this project as a tar.gz file</a>
<a class="jar_download_link" href="binaries/jSerialComm-1.0.0.jar">Download this library as a .jar file</a>
</section>
</header>
</div>
@ -31,59 +37,125 @@
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h3>
<a id="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages" aria-hidden="true"><span class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3>
<h3><a class="anchor" aria-hidden="true"><span class="octicon octicon-link"></span></a>What is jSerialComm?</h3>
<p>jSerialComm is a Java library designed to provide a platform-independent way to access standard serial ports without requiring external libraries, native code, or any other tools. It is meant as an alternative to RxTx and the (deprecated) Java Communications API, with increased ease-of-use and an enhanced support for timeouts.</p>
<p>Some of the features of this library include:</p>
<ul>
<li>Platform-independent library deployment (automatically uses correct native library based on current architecture)</li>
<li>Very lightweight and efficient implementation</li>
<li>Enumerates all available serial ports on a machine</li>
<li>Returns both a system port description and a friendly device description</li>
<li>Configurable ports according to baud rate, data bits, stop bits, and parity</li>
<li>Configurable port timeouts (blocking and non-blocking) for both reading and writing</li>
<li>Configurable flow control parameters for the serial port (CTS, RTS/CTS, DSR, DTR/DSR, XOn/XOff)</li>
<li>Ability to read and write raw data bytes directly to the serial port</li>
<li>Ability to read and write byte streams via Java's <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html" target="_blank">InputStream</a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html" target="_blank">OutputStream</a> interfaces</li>
<li>Event-based reading and writing via callbacks</li>
<li>Callback notification when:</li>
<ul>
<li>New data is available for reading</li>
<li>All data has been successfully written</li>
<li>A complete fixed-length data packet has arrived</li>
</ul>
</ul>
<p>Additionally, this library can be used in any Java project intended for use on the following platforms:</p>
<ul>
<li>32/64-bit Windows XP or later</li>
<li>32/64-bit Mac OS X Tiger (10.4) or later</li>
<li>32/64-bit Linux distributions</li>
<li>32/64-bit Mobile Linux derivatives (e.g. Android)</li>
</ul>
<h3><a class="anchor" aria-hidden="true"><span class="octicon octicon-link"></span></a>How can use this library in my own project?</h3>
<p>One of the most convenient features of this library is that it allows you to simply include the JAR file in your custom project, and it will automatically select and load the correct native library for your platform and architecture. As such, you can make use of this library by simply copying the jSerialComm.jar file into your project directory and linking to it as you would any other JAR file.</p>
<p>To access the contents of the library in your project, make sure to <code>import com.fazecast.jSerialComm.*</code> into your java files. You can then generate a list of all available serial ports on your system (real or virtual), by calling the following static method:</p>
<pre><code>SerialPort.getCommPorts()</code></pre>
<p>This will return an array of SerialPort objects through which you can iterate. See the <a href="javadoc/index.html" target="_blank">Javadoc Library Reference</a> for a complete overview of this library and its methods.</p>
<p><i>Note for Linux users</i>: Serial port access is limited to certain users and groups in Linux. To enable user access, you must open a terminal and enter the following commands before jSerialComm will be able to access the ports on your system. (Note, this must only be done once for each user):</p>
<pre><code>sudo usermod -a -G uucp username<br />sudo usermod -a -G dialout username</code></pre>
<p>Replace the username parameter with your current username. (If you are not sure what your username is, type <code>whoami</code> and it will tell you.) If you are using SUSE 11.3 or higher, replace the '-a -G' flags with a single '-A' flag. Log out and you should have access to the serial port after logging back in.</p>
<p>Additionally, if you are using an automated build system (such as Maven), you can import this library directly into your project as a dependency from the Maven Central Repository instead of copying the .jar file manually. Use one of the following dependency declarations depending on the build system you are using:</p>
<div id="tabs-nohdr" class="tabs">
<ul>
<li><a href="#tabs-1">Maven</a></li>
<li><a href="#tabs-2">Ivy</a></li>
<li><a href="#tabs-3">Grape</a></li>
<li><a href="#tabs-4">Gradle</a></li>
<li><a href="#tabs-5">Buildr</a></li>
<li><a href="#tabs-6">SBT</a></li>
<li><a href="#tabs-7">Leiningen</a></li>
</ul>
<div id="tabs-1">
<pre><code>&lt;dependency&gt;<br />&nbsp;&nbsp;&nbsp;&lt;groupId&gt;com.fazecast.jSerialComm&lt;/groupId&gt;<br />&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;jSerialComm&lt;/artifactId&gt;<br />&nbsp;&nbsp;&nbsp;&lt;version&gt;1.0.0&lt;/version&gt;<br />&lt;/dependency&gt;</code></pre>
</div>
<div id="tabs-2">
<pre><code>&lt;dependency org="com.fazecast.jSerialComm" name="jSerialComm" rev="1.0.0"/&gt;</code></pre>
</div>
<div id="tabs-3">
<pre><code>@Grapes(<br />&nbsp;&nbsp;&nbsp;@Grab(group='com.fazecast.jSerialComm', module='jSerialComm', version='1.0.0')<br />)</code></pre>
</div>
<div id="tabs-4">
<pre><code>'com.fazecast.jSerialComm:jSerialComm:1.0.0'</code></pre>
</div>
<div id="tabs-5">
<pre><code>'com.fazecast.jSerialComm:jSerialComm:jar:1.0.0'</code></pre>
</div>
<div id="tabs-6">
<pre><code>libraryDependencies += "com.fazecast.jSerialComm" % "jSerialComm" % "1.0.0"</code></pre>
</div>
<div id="tabs-7">
<pre><code>[com.fazecast.jSerialComm/jSerialComm "1.0.0"]</code></pre>
</div>
</div>
<h3><a class="anchor" aria-hidden="true"><span class="octicon octicon-link"></span></a>Are there any usage examples?</h3>
<p>Although this library was designed to be as simple and flexible as possible, you can enable a number of different modes of operation via manipulation of the serial port timeout values and the interface through which you choose to access the serial port.</p>
<p>For a description of the various modes of operation available in this library, please refer to the <a href="https://github.com/Fazecast/jSerialComm/wiki/Modes-of-Operation" target="_blank">Modes of Operation</a> wiki article. For code-based examples of how to use this library in your own project, we provide a <a href="https://github.com/Fazecast/jSerialComm/wiki/Usage-Examples" target="_blank">Usage Examples</a> wiki.</p>
<p>Finally, you can view the <a href="javadoc/index.html" target="_blank">API Documentation</a> for further information on how to use this library.</p>
<h3><a class="anchor" aria-hidden="true"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>This library was created and developed by Will Hedgecock (<a href="https://github.com/hedgecrw" class="user-mention">@willhedgecock</a>) of Fazecast, Inc. (<a href="https://github.com/fazecast" class="user-mention">@fazecast</a>)</p>
<h3><a class="anchor" ria-hidden="true"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with this library? Check out the <a href="javadoc/index.html" target="_blank">documentation</a> or open an <a href="https://github.com/Fazecast/jSerialComm/issues" target="_blank">issue report</a> and we’ll help you sort it out.</p>
<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:</p>
<pre><code>$ cd your_repo_root/repo_name
$ git fetch origin
$ git checkout gh-pages
</code></pre>
<p>If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.</p>
<h3>
<a id="designer-templates" class="anchor" href="#designer-templates" aria-hidden="true"><span class="octicon octicon-link"></span></a>Designer Templates</h3>
<p>We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.</p>
<h3>
<a id="rather-drive-stick" class="anchor" href="#rather-drive-stick" aria-hidden="true"><span class="octicon octicon-link"></span></a>Rather Drive Stick?</h3>
<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p>
<h3>
<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>You can <a href="https://github.com/blog/821" class="user-mention">@mention</a> a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p>
<h3>
<a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with Pages? Check out the documentation at <a href="https://help.github.com/pages">https://help.github.com/pages</a> or contact <a href="mailto:support@github.com">support@github.com</a> and we’ll help you sort it out.</p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">jSerialComm maintained by <a href="https://github.com/Fazecast">Fazecast</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
<p class="copyright">The jSerialComm project is maintained by <a href="https://github.com/Fazecast">Fazecast, Inc.</a></p>
<p>Copyright &#169; <script>document.write(new Date().getFullYear());</script> Fazecast, Inc. All rights reserved.</p>
</footer>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-60159197-1");
pageTracker._trackPageview();
} catch(err) {}
</script>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try { var pageTracker = _gat._getTracker("UA-60159197-1"); pageTracker._trackPageview(); } catch(err) {}
</script>
</body>
</html>

4
javadoc/allclasses-frame.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>All Classes (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

4
javadoc/allclasses-noframe.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>All Classes (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

4
javadoc/com/fazecast/jSerialComm/SerialPort.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>SerialPort (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>

44
javadoc/com/fazecast/jSerialComm/SerialPortDataListener.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>SerialPortDataListener (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@ -109,6 +109,11 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public interface <span class="typeNameLabel">SerialPortDataListener</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a></pre>
<div class="block">This interface must be implemented to enable simple event-based serial port I/O.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util"><code>EventListener</code></a></dd>
</dl>
</li>
</ul>
</div>
@ -129,11 +134,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListene
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--">getListeningEvents</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--">getListeningEvents</a></span>()</code>
<div class="block">Must be overridden to return one or more desired event constants for which the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>serialEvent(SerialPortEvent)</code></a> callback should be triggered.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-">serialEvent</a></span>(<a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a>&nbsp;event)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-">serialEvent</a></span>(<a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a>&nbsp;event)</code>
<div class="block">Called whenever one of the serial port events specified by the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--"><code>getListeningEvents()</code></a> method occurs.</div>
</td>
</tr>
</table>
</li>
@ -157,6 +166,26 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListene
<li class="blockList">
<h4>getListeningEvents</h4>
<pre>int&nbsp;getListeningEvents()</pre>
<div class="block">Must be overridden to return one or more desired event constants for which the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>serialEvent(SerialPortEvent)</code></a> callback should be triggered.
<p>
Valid event constants are:
<p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a><br>
<p>
If you choose to listen for the <a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a> event, you should implement the sub-interface <a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html" title="interface in com.fazecast.jSerialComm"><code>SerialPortPacketListener</code></a> instead of this one.
<p>
Two or more events may be OR'd together to listen for multiple events; however, if <a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a> is OR'd with <a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a>, the <a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a> flag will take precedence.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The event constants that should trigger the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>serialEvent(SerialPortEvent)</code></a> callback.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a></dd>
</dl>
</li>
</ul>
<a name="serialEvent-com.fazecast.jSerialComm.SerialPortEvent-">
@ -166,6 +195,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListene
<li class="blockList">
<h4>serialEvent</h4>
<pre>void&nbsp;serialEvent(<a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a>&nbsp;event)</pre>
<div class="block">Called whenever one of the serial port events specified by the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--"><code>getListeningEvents()</code></a> method occurs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - A <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object containing information and/or data about the serial event that occurred.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a></dd>
</dl>
</li>
</ul>
</li>

116
javadoc/com/fazecast/jSerialComm/SerialPortEvent.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>SerialPortEvent (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@ -118,9 +118,11 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public final class <span class="typeNameLabel">SerialPortEvent</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">EventObject</a></pre>
<div class="block">This class describes an asynchronous serial port event.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#com.fazecast.jSerialComm.SerialPortEvent">Serialized Form</a></dd>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util"><code>EventObject</code></a>,
<a href="../../../serialized-form.html#com.fazecast.jSerialComm.SerialPortEvent">Serialized Form</a></dd>
</dl>
</li>
</ul>
@ -155,13 +157,17 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-java.lang.Object-int-">SerialPortEvent</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source,
int&nbsp;serialEventType)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-">SerialPortEvent</a></span>(<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;comPort,
int&nbsp;serialEventType)</code>
<div class="block">Constructs a <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-java.lang.Object-int-byte:A-">SerialPortEvent</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source,
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-byte:A-">SerialPortEvent</a></span>(<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;comPort,
int&nbsp;serialEventType,
byte[]&nbsp;data)</code>&nbsp;</td>
byte[]&nbsp;data)</code>
<div class="block">Constructs a <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type and containing the passed-in data bytes.</div>
</td>
</tr>
</table>
</li>
@ -180,11 +186,21 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getEventType--">getEventType</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getEventType--">getEventType</a></span>()</code>
<div class="block">Returns the type of serial port event that caused this object to be created.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getReceivedData--">getReceivedData</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getReceivedData--">getReceivedData</a></span>()</code>
<div class="block">Returns any raw data bytes associated with this serial port event.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getSerialPort--">getSerialPort</a></span>()</code>
<div class="block">Returns the <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> that triggered this event.</div>
</td>
</tr>
</table>
<ul class="blockList">
@ -215,25 +231,62 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SerialPortEvent-java.lang.Object-int-">
<a name="SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SerialPortEvent</h4>
<pre>public&nbsp;SerialPortEvent(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source,
<pre>public&nbsp;SerialPortEvent(<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;comPort,
int&nbsp;serialEventType)</pre>
<div class="block">Constructs a <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type.
<p>
This constructor should only be used when the <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> does not contain any data bytes.
<p>
Valid serial event types are:
<p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a><br>
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>comPort</code> - The <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> about which this object is being created.</dd>
<dd><code>serialEventType</code> - The type of serial port event that this object describes.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a></dd>
</dl>
</li>
</ul>
<a name="SerialPortEvent-java.lang.Object-int-byte:A-">
<a name="SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SerialPortEvent</h4>
<pre>public&nbsp;SerialPortEvent(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;source,
<pre>public&nbsp;SerialPortEvent(<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;comPort,
int&nbsp;serialEventType,
byte[]&nbsp;data)</pre>
<div class="block">Constructs a <a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type and containing the passed-in data bytes.
<p>
Valid serial event types are:
<p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a><br>
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>comPort</code> - The <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> about which this object is being created.</dd>
<dd><code>serialEventType</code> - The type of serial port event that this object describes.</dd>
<dd><code>data</code> - The raw data bytes corresponding to this serial port event.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a></dd>
</dl>
</li>
</ul>
</li>
@ -244,6 +297,20 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSerialPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSerialPort</h4>
<pre>public final&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;getSerialPort()</pre>
<div class="block">Returns the <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> that triggered this event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> that triggered this event.</dd>
</dl>
</li>
</ul>
<a name="getEventType--">
<!-- -->
</a>
@ -251,6 +318,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
<li class="blockList">
<h4>getEventType</h4>
<pre>public final&nbsp;int&nbsp;getEventType()</pre>
<div class="block">Returns the type of serial port event that caused this object to be created.
<p>
Return values will be one and only one of the following:
<p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a><br>
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The serial port event that this object describes.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_AVAILABLE"><code>SerialPort.LISTENING_EVENT_DATA_AVAILABLE</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_RECEIVED"><code>SerialPort.LISTENING_EVENT_DATA_RECEIVED</code></a>,
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#LISTENING_EVENT_DATA_WRITTEN"><code>SerialPort.LISTENING_EVENT_DATA_WRITTEN</code></a></dd>
</dl>
</li>
</ul>
<a name="getReceivedData--">
@ -260,6 +343,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventObject.
<li class="blockList">
<h4>getReceivedData</h4>
<pre>public final&nbsp;byte[]&nbsp;getReceivedData()</pre>
<div class="block">Returns any raw data bytes associated with this serial port event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Any data bytes associated with this serial port event or null if none exist.</dd>
</dl>
</li>
</ul>
</li>

21
javadoc/com/fazecast/jSerialComm/SerialPortPacketListener.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>SerialPortPacketListener (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@ -105,6 +105,14 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public interface <span class="typeNameLabel">SerialPortPacketListener</span>
extends <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm">SerialPortDataListener</a></pre>
<div class="block">This interface must be implemented to enable full packet reads using event-based serial port I/O.
<p>
<i>Note</i>: Using this interface will negate any serial port read timeout settings since they make no sense in an asynchronous context.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm"><code>SerialPortDataListener</code></a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util"><code>EventListener</code></a></dd>
</dl>
</li>
</ul>
</div>
@ -125,7 +133,9 @@ extends <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html"
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html#getPacketSize--">getPacketSize</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html#getPacketSize--">getPacketSize</a></span>()</code>
<div class="block">Must be overridden to return the desired number of bytes that <b>must</b> be read before the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>SerialPortDataListener.serialEvent(SerialPortEvent)</code></a> callback is triggered.</div>
</td>
</tr>
</table>
<ul class="blockList">
@ -156,6 +166,11 @@ extends <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html"
<li class="blockList">
<h4>getPacketSize</h4>
<pre>int&nbsp;getPacketSize()</pre>
<div class="block">Must be overridden to return the desired number of bytes that <b>must</b> be read before the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>SerialPortDataListener.serialEvent(SerialPortEvent)</code></a> callback is triggered.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes that must be read before the <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>SerialPortDataListener.serialEvent(SerialPortEvent)</code></a> callback is triggered.</dd>
</dl>
</li>
</ul>
</li>

4
javadoc/com/fazecast/jSerialComm/package-frame.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>com.fazecast.jSerialComm (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>

16
javadoc/com/fazecast/jSerialComm/package-summary.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:05 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:44 CDT 2015 -->
<title>com.fazecast.jSerialComm (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
@ -82,11 +82,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm">SerialPortDataListener</a></td>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">This interface must be implemented to enable simple event-based serial port I/O.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html" title="interface in com.fazecast.jSerialComm">SerialPortPacketListener</a></td>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">This interface must be implemented to enable full packet reads using event-based serial port I/O.</div>
</td>
</tr>
</tbody>
</table>
@ -107,7 +111,9 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></td>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">This class describes an asynchronous serial port event.</div>
</td>
</tr>
</tbody>
</table>

4
javadoc/com/fazecast/jSerialComm/package-tree.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>com.fazecast.jSerialComm Class Hierarchy (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>

4
javadoc/constant-values.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>Constant Field Values (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

4
javadoc/deprecated-list.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>Deprecated List (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

4
javadoc/help-doc.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>API Help (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

52
javadoc/index-all.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>Index (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@ -146,7 +146,9 @@
<div class="block">Gets a descriptive string representing this serial port or the device connected to it.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#getEventType--">getEventType()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Returns the type of serial port event that caused this object to be created.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#getFlowControlSettings--">getFlowControlSettings()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>
<div class="block">Returns the flow control settings enabled on this serial port.</div>
@ -156,7 +158,9 @@
<div class="block">Returns an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> object associated with this serial port.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--">getListeningEvents()</a></span> - Method in interface com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm">SerialPortDataListener</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Must be overridden to return one or more desired event constants for which the <a href="com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>SerialPortDataListener.serialEvent(SerialPortEvent)</code></a> callback should be triggered.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#getNumDataBits--">getNumDataBits()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>
<div class="block">Gets the current number of data bits per word.</div>
@ -170,7 +174,9 @@
<div class="block">Returns an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> object associated with this serial port.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortPacketListener.html#getPacketSize--">getPacketSize()</a></span> - Method in interface com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortPacketListener.html" title="interface in com.fazecast.jSerialComm">SerialPortPacketListener</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Must be overridden to return the desired number of bytes that <b>must</b> be read before the <a href="com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-"><code>SerialPortDataListener.serialEvent(SerialPortEvent)</code></a> callback is triggered.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#getParity--">getParity()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>
<div class="block">Gets the current parity error-checking scheme.</div>
@ -180,7 +186,13 @@
<div class="block">Gets the number of milliseconds of inactivity to tolerate before returning from a <a href="com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>SerialPort.readBytes(byte[],long)</code></a> call.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#getReceivedData--">getReceivedData()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Returns any raw data bytes associated with this serial port event.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#getSerialPort--">getSerialPort()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>
<div class="block">Returns the <a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> that triggered this event.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#getSystemPortName--">getSystemPortName()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>
<div class="block">Gets the operating system-defined device name corresponding to this serial port.</div>
@ -254,7 +266,9 @@
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortDataListener.html#serialEvent-com.fazecast.jSerialComm.SerialPortEvent-">serialEvent(SerialPortEvent)</a></span> - Method in interface com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm">SerialPortDataListener</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Called whenever one of the serial port events specified by the <a href="com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--"><code>SerialPortDataListener.getListeningEvents()</code></a> method occurs.</div>
</dd>
<dt><a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><span class="typeNameLink">SerialPort</span></a> - Class in <a href="com/fazecast/jSerialComm/package-summary.html">com.fazecast.jSerialComm</a></dt>
<dd>
<div class="block">This class provides native access to serial ports and devices without requiring external libraries or tools.</div>
@ -262,15 +276,25 @@
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#SerialPort--">SerialPort()</a></span> - Constructor for class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>&nbsp;</dd>
<dt><a href="com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm"><span class="typeNameLink">SerialPortDataListener</span></a> - Interface in <a href="com/fazecast/jSerialComm/package-summary.html">com.fazecast.jSerialComm</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This interface must be implemented to enable simple event-based serial port I/O.</div>
</dd>
<dt><a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><span class="typeNameLink">SerialPortEvent</span></a> - Class in <a href="com/fazecast/jSerialComm/package-summary.html">com.fazecast.jSerialComm</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-java.lang.Object-int-">SerialPortEvent(Object, int)</a></span> - Constructor for class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-java.lang.Object-int-byte:A-">SerialPortEvent(Object, int, byte[])</a></span> - Constructor for class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This class describes an asynchronous serial port event.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-">SerialPortEvent(SerialPort, int)</a></span> - Constructor for class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>
<div class="block">Constructs a <a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPortEvent.html#SerialPortEvent-com.fazecast.jSerialComm.SerialPort-int-byte:A-">SerialPortEvent(SerialPort, int, byte[])</a></span> - Constructor for class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm">SerialPortEvent</a></dt>
<dd>
<div class="block">Constructs a <a href="com/fazecast/jSerialComm/SerialPortEvent.html" title="class in com.fazecast.jSerialComm"><code>SerialPortEvent</code></a> object corresponding to the specified serial event type and containing the passed-in data bytes.</div>
</dd>
<dt><a href="com/fazecast/jSerialComm/SerialPortPacketListener.html" title="interface in com.fazecast.jSerialComm"><span class="typeNameLink">SerialPortPacketListener</span></a> - Interface in <a href="com/fazecast/jSerialComm/package-summary.html">com.fazecast.jSerialComm</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This interface must be implemented to enable full packet reads using event-based serial port I/O.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#setBaudRate-int-">setBaudRate(int)</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
<dd>
<div class="block">Sets the desired baud rate for this serial port.</div>

2
javadoc/index.html
View File

@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>jSerialComm 1.0.0 API</title>
<script type="text/javascript">
targetPage = "" + window.location.search;

4
javadoc/overview-tree.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>Class Hierarchy (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

4
javadoc/serialized-form.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_20) on Wed Mar 11 17:45:06 CDT 2015 -->
<!-- Generated by javadoc (1.8.0_20) on Thu Mar 12 16:15:45 CDT 2015 -->
<title>Serialized Form (jSerialComm 1.0.0 API)</title>
<meta name="date" content="2015-03-11">
<meta name="date" content="2015-03-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

1
javascripts/main.js
View File

@ -1 +0,0 @@
console.log('This would be the main JS file.');

1
params.json
View File

@ -1 +0,0 @@
{"name":"jSerialComm","tagline":"Platform-independent serial port access for Java","body":"### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:\r\n\r\n```\r\n$ cd your_repo_root/repo_name\r\n$ git fetch origin\r\n$ git checkout gh-pages\r\n```\r\n\r\nIf you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.\r\n\r\n### Designer Templates\r\nWe've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.\r\n\r\n### Rather Drive Stick?\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out the documentation at https://help.github.com/pages or contact support@github.com and we’ll help you sort it out.\r\n","google":"UA-60159197-1","note":"Don't delete this file! It's used internally to help with page regeneration."}

70
stylesheets/pygment_trac.css
View File

@ -1,70 +0,0 @@
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f0f3f3; }
.highlight .c { color: #0099FF; font-style: italic } /* Comment */
.highlight .err { color: #AA0000; background-color: #FFAAAA } /* Error */
.highlight .k { color: #006699; font-weight: bold } /* Keyword */
.highlight .o { color: #555555 } /* Operator */
.highlight .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #009999 } /* Comment.Preproc */
.highlight .c1 { color: #0099FF; font-style: italic } /* Comment.Single */
.highlight .cs { color: #0099FF; font-weight: bold; font-style: italic } /* Comment.Special */
.highlight .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #003300; font-weight: bold } /* Generic.Heading */
.highlight .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */
.highlight .go { color: #AAAAAA } /* Generic.Output */
.highlight .gp { color: #000099; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #003300; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #99CC66 } /* Generic.Traceback */
.highlight .kc { color: #006699; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #006699; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #006699; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #006699 } /* Keyword.Pseudo */
.highlight .kr { color: #006699; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #007788; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #FF6600 } /* Literal.Number */
.highlight .s { color: #CC3300 } /* Literal.String */
.highlight .na { color: #330099 } /* Name.Attribute */
.highlight .nb { color: #336666 } /* Name.Builtin */
.highlight .nc { color: #00AA88; font-weight: bold } /* Name.Class */
.highlight .no { color: #336600 } /* Name.Constant */
.highlight .nd { color: #9999FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CC0000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #CC00FF } /* Name.Function */
.highlight .nl { color: #9999FF } /* Name.Label */
.highlight .nn { color: #00CCFF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #330099; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #003333 } /* Name.Variable */
.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #FF6600 } /* Literal.Number.Float */
.highlight .mh { color: #FF6600 } /* Literal.Number.Hex */
.highlight .mi { color: #FF6600 } /* Literal.Number.Integer */
.highlight .mo { color: #FF6600 } /* Literal.Number.Oct */
.highlight .sb { color: #CC3300 } /* Literal.String.Backtick */
.highlight .sc { color: #CC3300 } /* Literal.String.Char */
.highlight .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #CC3300 } /* Literal.String.Double */
.highlight .se { color: #CC3300; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #CC3300 } /* Literal.String.Heredoc */
.highlight .si { color: #AA0000 } /* Literal.String.Interpol */
.highlight .sx { color: #CC3300 } /* Literal.String.Other */
.highlight .sr { color: #33AAAA } /* Literal.String.Regex */
.highlight .s1 { color: #CC3300 } /* Literal.String.Single */
.highlight .ss { color: #FFCC33 } /* Literal.String.Symbol */
.highlight .bp { color: #336666 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #003333 } /* Name.Variable.Class */
.highlight .vg { color: #003333 } /* Name.Variable.Global */
.highlight .vi { color: #003333 } /* Name.Variable.Instance */
.highlight .il { color: #FF6600 } /* Literal.Number.Integer.Long */
.type-csharp .highlight .k { color: #0000FF }
.type-csharp .highlight .kt { color: #0000FF }
.type-csharp .highlight .nf { color: #000000; font-weight: normal }
.type-csharp .highlight .nc { color: #2B91AF }
.type-csharp .highlight .nn { color: #000000 }
.type-csharp .highlight .s { color: #A31515 }
.type-csharp .highlight .sc { color: #A31515 }

60
stylesheets/stylesheet.css
View File

@ -1,10 +1,3 @@
/*******************************************************************************
Slate Theme for GitHub Pages
by Jason Costello, @jsncostello
*******************************************************************************/
@import url(pygment_trac.css);
/*******************************************************************************
MeyerWeb Reset
*******************************************************************************/
@ -266,7 +259,7 @@ Full-Width Styles
.inner {
position: relative;
max-width: 640px;
max-width: 780px;
padding: 20px 10px;
margin: 0 auto;
}
@ -317,7 +310,7 @@ Full-Width Styles
#downloads {
position: absolute;
width: 210px;
width: 303px;
z-index: 10;
bottom: -40px;
right: 0;
@ -336,6 +329,17 @@ Full-Width Styles
}
.tar_download_link {
display: block;
float: right;
width: 90px;
height:70px;
text-indent: -5000px;
overflow: hidden;
background: url(../images/sprite_download.png) no-repeat bottom center;
margin-left: 10px;
}
.jar_download_link {
display: block;
float: right;
width: 90px;
@ -351,6 +355,10 @@ Full-Width Styles
}
.tar_download_link:hover {
background: url(../images/sprite_download.png) no-repeat top center;
}
.jar_download_link:hover {
background: url(../images/sprite_download.png) no-repeat top right;
}
@ -423,3 +431,37 @@ Small Device Styles
}
}
#tabs-nohdr {
padding: 0px;
background: none;
border-width: 0px;
}
#tabs-nohdr .ui-tabs-nav {
padding-left: 0px;
font-size: small;
background: transparent;
border-width: 0px 0px 1px 0px;
-moz-border-radius: 0px;
-webkit-border-radius: 0px;
border-radius: 0px;
}
#tabs-nohdr .ui-tabs-panel {
background: #f5f3e5;
border-width: 0px 1px 1px 1px;
}
#tabs-nohdr pre {
background: transparent;
padding: 0;
overflow: hidden;
box-shadow: none;
-webkit-box-shadow: none;
-moz-box-shadow: none;
-o-box-shadow: none;
-ms-box-shadow: none;
}
#tabs-nohdr code {
background: transparent;
padding: 0;
overflow: hidden;
}