Updated to version 2.1.0

This commit is contained in:
Will Hedgecock 2018-08-01 10:45:36 -05:00
parent cfa36a7772
commit c4f61b07bd
29 changed files with 334 additions and 318 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -29,7 +29,7 @@
<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-2.0.3.jar">Download this library as a .jar file</a>
<a class="jar_download_link" href="binaries/jSerialComm-2.1.0.jar">Download this library as a .jar file</a>
</section>
</header>
</div>
@ -74,7 +74,7 @@
<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 <a href="binaries/jSerialComm-2.0.3.jar">JAR file</a> 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>One of the most convenient features of this library is that it allows you to simply include the <a href="binaries/jSerialComm-2.1.0.jar">JAR file</a> 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>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>All Classes (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>All Classes (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>All Classes (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>All Classes (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>SerialPort (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>SerialPort (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,13 +21,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPort (jSerialComm 2.0.3 API)";
parent.document.title="SerialPort (jSerialComm 2.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@ -68,9 +68,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
@ -131,6 +131,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">SerialPort</span>
extends java.lang.Object</pre>
<div class="block">This class provides native access to serial ports and devices without requiring external libraries or tools.</div>
@ -303,50 +304,50 @@ extends java.lang.Object</pre>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#bytesAvailable--">bytesAvailable</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#bytesAvailable--">bytesAvailable</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns the number of bytes available without blocking if <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-"><code>readBytes(long, byte[], long)</code></a> were to be called immediately
<div class="block">Returns the number of bytes available without blocking if <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-long-"><code>readBytes(long, byte[], long, long)</code></a> were to be called immediately
after this method returns.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#bytesAwaitingWrite--">bytesAwaitingWrite</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#bytesAwaitingWrite--">bytesAwaitingWrite</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns the number of bytes still waiting to be written in the device's output queue.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearBreak--">clearBreak</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearBreak--">clearBreak</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Clears the BREAK signal from the serial control line.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearDTR--">clearDTR</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearDTR--">clearDTR</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Clears the state of the DTR line to 0.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearRTS--">clearRTS</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#clearRTS--">clearRTS</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Clears the state of the RTS line to 0.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#closePort--">closePort</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#closePort--">closePort</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Closes this serial port.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getBaudRate--">getBaudRate</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getBaudRate--">getBaudRate</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current baud rate of the serial port.</div>
</td>
@ -360,112 +361,112 @@ extends java.lang.Object</pre>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getCommPorts--">getCommPorts</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getCommPorts--">getCommPorts</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns a list of all available serial ports on this machine.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getCTS--">getCTS</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getCTS--">getCTS</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns whether the CTS line is currently asserted.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getDescriptivePortName--">getDescriptivePortName</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getDescriptivePortName--">getDescriptivePortName</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets a descriptive string representing this serial port or the device connected to it.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getDSR--">getDSR</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getDSR--">getDSR</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns whether the DSR line is currently asserted.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getFlowControlSettings--">getFlowControlSettings</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getFlowControlSettings--">getFlowControlSettings</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns the flow control settings enabled on this serial port.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getInputStream--">getInputStream</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getInputStream--">getInputStream</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns an <code>InputStream</code> object associated with this serial port.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getNumDataBits--">getNumDataBits</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getNumDataBits--">getNumDataBits</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current number of data bits per word.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getNumStopBits--">getNumStopBits</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getNumStopBits--">getNumStopBits</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current number of stop bits per word.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getOutputStream--">getOutputStream</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getOutputStream--">getOutputStream</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns an <code>OutputStream</code> object associated with this serial port.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getParity--">getParity</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getParity--">getParity</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current parity error-checking scheme.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getPortDescription--">getPortDescription</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getPortDescription--">getPortDescription</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets a description of the port as reported by the device itself.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getReadTimeout--">getReadTimeout</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getReadTimeout--">getReadTimeout</a></span>&#8203;()</code></th>
<td class="colLast">
<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>readBytes(byte[],long)</code></a> call.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getSystemPortName--">getSystemPortName</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getSystemPortName--">getSystemPortName</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the operating system-defined device name corresponding to this serial port.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getWriteTimeout--">getWriteTimeout</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getWriteTimeout--">getWriteTimeout</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the number of milliseconds of inactivity to tolerate before returning from a <a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a> call.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#isOpen--">isOpen</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#isOpen--">isOpen</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns whether the port is currently open and available for communication.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#openPort--">openPort</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#openPort--">openPort</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Opens this serial port for reading and writing.</div>
</td>
@ -486,27 +487,36 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-long-">readBytes</a></span>&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToRead,
long&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Reads up to <i>bytesToRead</i> raw data bytes from the serial port and stores them in the buffer starting at the indicated offset.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#removeDataListener--">removeDataListener</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#removeDataListener--">removeDataListener</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Removes the associated <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm"><code>SerialPortDataListener</code></a> from the serial port interface.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setBaudRate-int-">setBaudRate</a></span>&#8203;(int&nbsp;newBaudRate)</code></th>
<td class="colLast">
<div class="block">Sets the desired baud rate for this serial port.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setBreak--">setBreak</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setBreak--">setBreak</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Sets the BREAK signal on the serial control line.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setComPortParameters-int-int-int-int-">setComPortParameters</a></span>&#8203;(int&nbsp;newBaudRate,
int&nbsp;newDataBits,
@ -516,7 +526,7 @@ extends java.lang.Object</pre>
<div class="block">Sets all serial port parameters at one time.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setComPortTimeouts-int-int-int-">setComPortTimeouts</a></span>&#8203;(int&nbsp;newTimeoutMode,
int&nbsp;newReadTimeout,
@ -525,56 +535,56 @@ extends java.lang.Object</pre>
<div class="block">Sets the serial port read and write timeout parameters.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<tr id="i33" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setDTR--">setDTR</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setDTR--">setDTR</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Sets the state of the DTR line to 1.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setFlowControl-int-">setFlowControl</a></span>&#8203;(int&nbsp;newFlowControlSettings)</code></th>
<td class="colLast">
<div class="block">Specifies what kind of flow control to enable for this serial port.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setNumDataBits-int-">setNumDataBits</a></span>&#8203;(int&nbsp;newDataBits)</code></th>
<td class="colLast">
<div class="block">Sets the desired number of data bits per word.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setNumStopBits-int-">setNumStopBits</a></span>&#8203;(int&nbsp;newStopBits)</code></th>
<td class="colLast">
<div class="block">Sets the desired number of stop bits per word.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setParity-int-">setParity</a></span>&#8203;(int&nbsp;newParity)</code></th>
<td class="colLast">
<div class="block">Sets the desired parity error-detection scheme to be used.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<tr id="i38" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setRTS--">setRTS</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#setRTS--">setRTS</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Sets the state of the RTS line to 1.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<tr id="i39" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#toString--">toString</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#toString--">toString</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns the same output as calling <a href="../../../com/fazecast/jSerialComm/SerialPort.html#getPortDescription--"><code>getPortDescription()</code></a>.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i40" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-">writeBytes</a></span>&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToWrite)</code></th>
@ -582,6 +592,15 @@ extends java.lang.Object</pre>
<div class="block">Writes up to <i>bytesToWrite</i> raw data bytes from the buffer parameter to the serial port.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-long-">writeBytes</a></span>&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToWrite,
long&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Writes up to <i>bytesToWrite</i> raw data bytes from the buffer parameter to the serial port starting at the indicated offset.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@ -930,7 +949,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&nbsp;java.lang.String&nbsp;toString&#8203;()</pre>
<div class="block">Returns the same output as calling <a href="../../../com/fazecast/jSerialComm/SerialPort.html#getPortDescription--"><code>getPortDescription()</code></a>. This may be useful for display containers which call a Java Object's default toString() method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
@ -946,7 +965,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getCommPorts</h4>
<pre>public static&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>[]&nbsp;getCommPorts()</pre>
<pre>public static&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>[]&nbsp;getCommPorts&#8203;()</pre>
<div class="block">Returns a list of all available serial ports on this machine.
<p>
The serial ports can be accessed by iterating through each of the SerialPort objects in this array.
@ -1005,7 +1024,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>openPort</h4>
<pre>public final&nbsp;boolean&nbsp;openPort()</pre>
<pre>public final&nbsp;boolean&nbsp;openPort&#8203;()</pre>
<div class="block">Opens this serial port for reading and writing.
<p>
This method is equivalent to calling <a href="../../../com/fazecast/jSerialComm/SerialPort.html#openPort-int-"><code>openPort(int)</code></a> with a value of 1000.
@ -1025,7 +1044,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>closePort</h4>
<pre>public final&nbsp;boolean&nbsp;closePort()</pre>
<pre>public final&nbsp;boolean&nbsp;closePort&#8203;()</pre>
<div class="block">Closes this serial port.
<p>
Note that calling this method on an already closed port will simply return a value of true.</div>
@ -1041,7 +1060,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>public final&nbsp;boolean&nbsp;isOpen()</pre>
<pre>public final&nbsp;boolean&nbsp;isOpen&#8203;()</pre>
<div class="block">Returns whether the port is currently open and available for communication.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1055,8 +1074,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>bytesAvailable</h4>
<pre>public final&nbsp;int&nbsp;bytesAvailable()</pre>
<div class="block">Returns the number of bytes available without blocking if <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-"><code>readBytes(long, byte[], long)</code></a> were to be called immediately
<pre>public final&nbsp;int&nbsp;bytesAvailable&#8203;()</pre>
<div class="block">Returns the number of bytes available without blocking if <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-long-"><code>readBytes(long, byte[], long, long)</code></a> were to be called immediately
after this method returns.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1070,7 +1089,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>bytesAwaitingWrite</h4>
<pre>public final&nbsp;int&nbsp;bytesAwaitingWrite()</pre>
<pre>public final&nbsp;int&nbsp;bytesAwaitingWrite&#8203;()</pre>
<div class="block">Returns the number of bytes still waiting to be written in the device's output queue.
<p>
Note that this method is not required or guaranteed to be implemented by the underlying device driver. Use it carefully and test your application to ensure it is working as you expect.</div>
@ -1104,6 +1123,32 @@ extends java.lang.Object</pre>
</dl>
</li>
</ul>
<a name="readBytes-byte:A-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readBytes</h4>
<pre>public final&nbsp;int&nbsp;readBytes&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToRead,
long&nbsp;offset)</pre>
<div class="block">Reads up to <i>bytesToRead</i> raw data bytes from the serial port and stores them in the buffer starting at the indicated offset.
<p>
The length of the byte buffer minus the offset must be greater than or equal to the value passed in for <i>bytesToRead</i>
<p>
If no timeouts were specified or the read timeout was set to 0, this call will block until <i>bytesToRead</i> bytes of data have been successfully read from the serial port.
Otherwise, this method will return after <i>bytesToRead</i> bytes of data have been read or the number of milliseconds specified by the read timeout have elapsed,
whichever comes first, regardless of the availability of more data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer into which the raw data is read.</dd>
<dd><code>bytesToRead</code> - The number of bytes to read from the serial port.</dd>
<dd><code>offset</code> - The read buffer index into which to begin storing data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes successfully read, or -1 if there was an error reading from the port.</dd>
</dl>
</li>
</ul>
<a name="writeBytes-byte:A-long-">
<!-- -->
</a>
@ -1128,13 +1173,39 @@ extends java.lang.Object</pre>
</dl>
</li>
</ul>
<a name="writeBytes-byte:A-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeBytes</h4>
<pre>public final&nbsp;int&nbsp;writeBytes&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToWrite,
long&nbsp;offset)</pre>
<div class="block">Writes up to <i>bytesToWrite</i> raw data bytes from the buffer parameter to the serial port starting at the indicated offset.
<p>
The length of the byte buffer minus the offset must be greater than or equal to the value passed in for <i>bytesToWrite</i>
<p>
If no timeouts were specified or the write timeout was set to 0, this call will block until <i>bytesToWrite</i> bytes of data have been successfully written the serial port.
Otherwise, this method will return after <i>bytesToWrite</i> bytes of data have been written or the number of milliseconds specified by the write timeout have elapsed,
whichever comes first, regardless of the availability of more data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer containing the raw data to write to the serial port.</dd>
<dd><code>bytesToWrite</code> - The number of bytes to write to the serial port.</dd>
<dd><code>offset</code> - The buffer index from which to begin writing to the serial port.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes successfully written, or -1 if there was an error writing to the port.</dd>
</dl>
</li>
</ul>
<a name="setBreak--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBreak</h4>
<pre>public final&nbsp;boolean&nbsp;setBreak()</pre>
<pre>public final&nbsp;boolean&nbsp;setBreak&#8203;()</pre>
<div class="block">Sets the BREAK signal on the serial control line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1148,7 +1219,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>clearBreak</h4>
<pre>public final&nbsp;boolean&nbsp;clearBreak()</pre>
<pre>public final&nbsp;boolean&nbsp;clearBreak&#8203;()</pre>
<div class="block">Clears the BREAK signal from the serial control line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1162,7 +1233,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setRTS</h4>
<pre>public final&nbsp;boolean&nbsp;setRTS()</pre>
<pre>public final&nbsp;boolean&nbsp;setRTS&#8203;()</pre>
<div class="block">Sets the state of the RTS line to 1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1176,7 +1247,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>clearRTS</h4>
<pre>public final&nbsp;boolean&nbsp;clearRTS()</pre>
<pre>public final&nbsp;boolean&nbsp;clearRTS&#8203;()</pre>
<div class="block">Clears the state of the RTS line to 0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1190,7 +1261,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setDTR</h4>
<pre>public final&nbsp;boolean&nbsp;setDTR()</pre>
<pre>public final&nbsp;boolean&nbsp;setDTR&#8203;()</pre>
<div class="block">Sets the state of the DTR line to 1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1204,7 +1275,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>clearDTR</h4>
<pre>public final&nbsp;boolean&nbsp;clearDTR()</pre>
<pre>public final&nbsp;boolean&nbsp;clearDTR&#8203;()</pre>
<div class="block">Clears the state of the DTR line to 0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1218,7 +1289,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getCTS</h4>
<pre>public final&nbsp;boolean&nbsp;getCTS()</pre>
<pre>public final&nbsp;boolean&nbsp;getCTS&#8203;()</pre>
<div class="block">Returns whether the CTS line is currently asserted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1232,7 +1303,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getDSR</h4>
<pre>public final&nbsp;boolean&nbsp;getDSR()</pre>
<pre>public final&nbsp;boolean&nbsp;getDSR&#8203;()</pre>
<div class="block">Returns whether the DSR line is currently asserted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1274,7 +1345,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>removeDataListener</h4>
<pre>public final&nbsp;void&nbsp;removeDataListener()</pre>
<pre>public final&nbsp;void&nbsp;removeDataListener&#8203;()</pre>
<div class="block">Removes the associated <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm"><code>SerialPortDataListener</code></a> from the serial port interface.</div>
</li>
</ul>
@ -1284,7 +1355,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getInputStream</h4>
<pre>public final&nbsp;java.io.InputStream&nbsp;getInputStream()</pre>
<pre>public final&nbsp;java.io.InputStream&nbsp;getInputStream&#8203;()</pre>
<div class="block">Returns an <code>InputStream</code> object associated with this serial port.
<p>
Allows for easier read access of the underlying data stream and abstracts away many low-level read details.
@ -1304,7 +1375,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStream</h4>
<pre>public final&nbsp;java.io.OutputStream&nbsp;getOutputStream()</pre>
<pre>public final&nbsp;java.io.OutputStream&nbsp;getOutputStream&#8203;()</pre>
<div class="block">Returns an <code>OutputStream</code> object associated with this serial port.
<p>
Allows for easier write access to the underlying data stream and abstracts away many low-level writing details.
@ -1534,7 +1605,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptivePortName</h4>
<pre>public final&nbsp;java.lang.String&nbsp;getDescriptivePortName()</pre>
<pre>public final&nbsp;java.lang.String&nbsp;getDescriptivePortName&#8203;()</pre>
<div class="block">Gets a descriptive string representing this serial port or the device connected to it.
<p>
This description is generated by the operating system and may or may not be a good representation of the actual port or
@ -1551,7 +1622,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getSystemPortName</h4>
<pre>public final&nbsp;java.lang.String&nbsp;getSystemPortName()</pre>
<pre>public final&nbsp;java.lang.String&nbsp;getSystemPortName&#8203;()</pre>
<div class="block">Gets the operating system-defined device name corresponding to this serial port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1565,7 +1636,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getPortDescription</h4>
<pre>public final&nbsp;java.lang.String&nbsp;getPortDescription()</pre>
<pre>public final&nbsp;java.lang.String&nbsp;getPortDescription&#8203;()</pre>
<div class="block">Gets a description of the port as reported by the device itself.
<p>
This will only be available for USB-connected devices that report a product description.
@ -1582,7 +1653,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getBaudRate</h4>
<pre>public final&nbsp;int&nbsp;getBaudRate()</pre>
<pre>public final&nbsp;int&nbsp;getBaudRate&#8203;()</pre>
<div class="block">Gets the current baud rate of the serial port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1596,7 +1667,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getNumDataBits</h4>
<pre>public final&nbsp;int&nbsp;getNumDataBits()</pre>
<pre>public final&nbsp;int&nbsp;getNumDataBits&#8203;()</pre>
<div class="block">Gets the current number of data bits per word.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@ -1610,7 +1681,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getNumStopBits</h4>
<pre>public final&nbsp;int&nbsp;getNumStopBits()</pre>
<pre>public final&nbsp;int&nbsp;getNumStopBits&#8203;()</pre>
<div class="block">Gets the current number of stop bits per word.
<p>
The return value should not be interpreted as an integer, but rather compared with the built-in stop bit constants
@ -1631,7 +1702,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getParity</h4>
<pre>public final&nbsp;int&nbsp;getParity()</pre>
<pre>public final&nbsp;int&nbsp;getParity&#8203;()</pre>
<div class="block">Gets the current parity error-checking scheme.
<p>
The return value should not be interpreted as an integer, but rather compared with the built-in parity constants
@ -1654,7 +1725,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getReadTimeout</h4>
<pre>public final&nbsp;int&nbsp;getReadTimeout()</pre>
<pre>public final&nbsp;int&nbsp;getReadTimeout&#8203;()</pre>
<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>readBytes(byte[],long)</code></a> call.
<p>
A value of 0 indicates that a <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>readBytes(byte[],long)</code></a> call will block forever until it has successfully read
@ -1674,7 +1745,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getWriteTimeout</h4>
<pre>public final&nbsp;int&nbsp;getWriteTimeout()</pre>
<pre>public final&nbsp;int&nbsp;getWriteTimeout&#8203;()</pre>
<div class="block">Gets the number of milliseconds of inactivity to tolerate before returning from a <a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a> call.
<p>
A value of 0 indicates that a <a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a> call will block forever until it has successfully written
@ -1696,7 +1767,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>getFlowControlSettings</h4>
<pre>public final&nbsp;int&nbsp;getFlowControlSettings()</pre>
<pre>public final&nbsp;int&nbsp;getFlowControlSettings&#8203;()</pre>
<div class="block">Returns the flow control settings enabled on this serial port.
<p>
The integer result should be masked with the built-in flow control constants to test if the desired setting is enabled.

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>SerialPortDataListener (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>SerialPortDataListener (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortDataListener (jSerialComm 2.0.3 API)";
parent.document.title="SerialPortDataListener (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -68,9 +68,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
@ -131,6 +131,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd><code><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html" title="interface in com.fazecast.jSerialComm">SerialPortPacketListener</a></code></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SerialPortDataListener</span>
extends java.util.EventListener</pre>
<div class="block">This interface must be implemented to enable simple event-based serial port I/O.</div>
@ -159,7 +160,7 @@ extends java.util.EventListener</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--">getListeningEvents</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html#getListeningEvents--">getListeningEvents</a></span>&#8203;()</code></th>
<td class="colLast">
<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>
@ -192,7 +193,7 @@ extends java.util.EventListener</pre>
<ul class="blockList">
<li class="blockList">
<h4>getListeningEvents</h4>
<pre>int&nbsp;getListeningEvents()</pre>
<pre>int&nbsp;getListeningEvents&#8203;()</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:

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>SerialPortEvent (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>SerialPortEvent (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortEvent (jSerialComm 2.0.3 API)";
parent.document.title="SerialPortEvent (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -68,9 +68,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
@ -135,11 +135,8 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">SerialPortEvent</span>
extends java.util.EventObject</pre>
<div class="block">This class describes an asynchronous serial port event.</div>
@ -214,21 +211,21 @@ extends java.util.EventObject</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getEventType--">getEventType</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getEventType--">getEventType</a></span>&#8203;()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getReceivedData--">getReceivedData</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getReceivedData--">getReceivedData</a></span>&#8203;()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getSerialPort--">getSerialPort</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortEvent.html#getSerialPort--">getSerialPort</a></span>&#8203;()</code></th>
<td class="colLast">
<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>
@ -338,7 +335,7 @@ extends java.util.EventObject</pre>
<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>
<pre>public final&nbsp;<a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a>&nbsp;getSerialPort&#8203;()</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>
@ -352,7 +349,7 @@ extends java.util.EventObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getEventType</h4>
<pre>public final&nbsp;int&nbsp;getEventType()</pre>
<pre>public final&nbsp;int&nbsp;getEventType&#8203;()</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:
@ -379,7 +376,7 @@ extends java.util.EventObject</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>getReceivedData</h4>
<pre>public final&nbsp;byte[]&nbsp;getReceivedData()</pre>
<pre>public final&nbsp;byte[]&nbsp;getReceivedData&#8203;()</pre>
<div class="block">Returns any raw data bytes associated with this serial port event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>SerialPortPacketListener (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>SerialPortPacketListener (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortPacketListener (jSerialComm 2.0.3 API)";
parent.document.title="SerialPortPacketListener (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -68,9 +68,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
@ -127,6 +127,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd><code>java.util.EventListener</code>, <code><a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm">SerialPortDataListener</a></code></dd>
</dl>
<hr>
<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.
@ -158,7 +159,7 @@ extends <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html"
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html#getPacketSize--">getPacketSize</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPortPacketListener.html#getPacketSize--">getPacketSize</a></span>&#8203;()</code></th>
<td class="colLast">
<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>
@ -191,7 +192,7 @@ extends <a href="../../../com/fazecast/jSerialComm/SerialPortDataListener.html"
<ul class="blockListLast">
<li class="blockList">
<h4>getPacketSize</h4>
<pre>int&nbsp;getPacketSize()</pre>
<pre>int&nbsp;getPacketSize&#8203;()</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>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>com.fazecast.jSerialComm (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>com.fazecast.jSerialComm (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>com.fazecast.jSerialComm (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>com.fazecast.jSerialComm (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.fazecast.jSerialComm (jSerialComm 2.0.3 API)";
parent.document.title="com.fazecast.jSerialComm (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.0.3 API)";
parent.document.title="com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "../../../";loadScripts(document, 'script');</script>
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>Constant Field Values (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>Constant Field Values (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (jSerialComm 2.0.3 API)";
parent.document.title="Constant Field Values (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>Deprecated List (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>Deprecated List (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (jSerialComm 2.0.3 API)";
parent.document.title="Deprecated List (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>API Help (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>API Help (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (jSerialComm 2.0.3 API)";
parent.document.title="API Help (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>Index (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>Index (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (jSerialComm 2.0.3 API)";
parent.document.title="Index (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>
@ -109,7 +109,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dl>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#bytesAvailable--">bytesAvailable()</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 number of bytes available without blocking if <a href="com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-"><code>SerialPort.readBytes(long, byte[], long)</code></a> were to be called immediately
<div class="block">Returns the number of bytes available without blocking if <a href="com/fazecast/jSerialComm/SerialPort.html#readBytes-long-byte:A-long-long-"><code>SerialPort.readBytes(long, byte[], long, long)</code></a> were to be called immediately
after this method returns.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#bytesAwaitingWrite--">bytesAwaitingWrite()</a></span> - Method in class com.fazecast.jSerialComm.<a href="com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm">SerialPort</a></dt>
@ -326,6 +326,10 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd>
<div class="block">Reads up to <i>bytesToRead</i> raw data bytes from the serial port and stores them in the buffer.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-long-">readBytes(byte[], long, long)</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">Reads up to <i>bytesToRead</i> raw data bytes from the serial port and stores them in the buffer starting at the indicated offset.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#removeDataListener--">removeDataListener()</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">Removes the associated <a href="com/fazecast/jSerialComm/SerialPortDataListener.html" title="interface in com.fazecast.jSerialComm"><code>SerialPortDataListener</code></a> from the serial port interface.</div>
@ -440,6 +444,10 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd>
<div class="block">Writes up to <i>bytesToWrite</i> raw data bytes from the buffer parameter to the serial port.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-long-">writeBytes(byte[], long, long)</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">Writes up to <i>bytesToWrite</i> raw data bytes from the buffer parameter to the serial port starting at the indicated offset.</div>
</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:W">W</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->

View File

@ -2,8 +2,8 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>jSerialComm 2.0.3 API</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:48 CDT 2018 -->
<title>jSerialComm 2.1.0 API</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript">

File diff suppressed because one or more lines are too long

Binary file not shown.

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>Class Hierarchy (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>Class Hierarchy (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Class Hierarchy (jSerialComm 2.0.3 API)";
parent.document.title="Class Hierarchy (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

Binary file not shown.

View File

@ -134,21 +134,6 @@ function showPkgs(type)
updatePkgsTabs(type);
}
function showGroups(type)
{
count = 0;
for (var key in groups) {
var row = document.getElementById(key);
if ((groups[key] & type) !== 0) {
row.style.display = '';
row.className = (count++ % 2) ? rowColor : altColor;
}
else
row.style.display = 'none';
}
updateGroupsTabs(type);
}
function updateTabs(type)
{
for (var value in tabs) {
@ -186,19 +171,3 @@ function updatePkgsTabs(type)
}
}
}
function updateGroupsTabs(type)
{
for (var value in tabs) {
var sNode = document.getElementById(tabs[value][0]);
var spanNode = sNode.firstChild;
if (value == type) {
sNode.className = activeTableTab;
spanNode.innerHTML = tabs[value][1];
}
else {
sNode.className = tableTab;
spanNode.innerHTML = "<a href=\"javascript:showGroups(" + value + ");\">" + tabs[value][1] + "</a>";
}
}
}

View File

@ -78,7 +78,6 @@ function getHighlightedText(item) {
}
var watermark = 'Search';
$(function() {
$("#search").val('');
$("#search").prop("disabled", false);
$("#reset").prop("disabled", false);
$("#search").val(watermark).addClass('watermark');
@ -87,7 +86,7 @@ $(function() {
$(this).val(watermark).addClass('watermark');
}
});
$("#search").on('click keydown', function() {
$("#search").keydown(function() {
if ($(this).val() == watermark) {
$(this).val('').removeClass('watermark');
}

View File

@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (10.0.1) on Fri Jul 27 10:48:11 CDT 2018 -->
<title>Serialized Form (jSerialComm 2.0.3 API)</title>
<!-- Generated by javadoc (9.0.4) on Wed Aug 01 10:43:47 CDT 2018 -->
<title>Serialized Form (jSerialComm 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2018-07-27">
<meta name="date" content="2018-08-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Serialized Form (jSerialComm 2.0.3 API)";
parent.document.title="Serialized Form (jSerialComm 2.1.0 API)";
}
}
catch(err) {
@ -62,9 +62,9 @@ var pathtoroot = "./";loadScripts(document, 'script');</script>
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</li>
</ul>
<div>

View File

@ -1,16 +1,10 @@
/*
* Javadoc style sheet
*/
/* Javadoc style sheet */
/*
Overall document style
*/
@import url('resources/fonts/dejavu.css');
/*
* Styles for individual HTML elements.
*
* These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
* HTML element throughout the page.
*/
body {
background-color:#ffffff;
color:#353833;
@ -47,6 +41,9 @@ a[name]:before, a[name]:target, a[id]:before, a[id]:target {
padding-top:129px;
margin-top:-129px;
}
.searchTagResult:before, .searchTagResult:target {
color:red;
}
pre {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
@ -94,16 +91,9 @@ table tr td dt code {
sup {
font-size:8px;
}
/*
* Styles for HTML generated by javadoc.
*
* These are style classes that are used by the standard doclet to generate HTML documentation.
*/
/*
* Styles for document title and copyright.
*/
Document title and Copyright styles
*/
.clear {
clear:both;
height:0px;
@ -134,8 +124,8 @@ sup {
font-weight:bold;
}
/*
* Styles for navigation bar.
*/
Navigation bar styles
*/
.bar {
background-color:#4D7A97;
color:#FFFFFF;
@ -213,7 +203,7 @@ ul.navListSearch li {
padding: 5px 6px;
text-transform:uppercase;
}
ul.navListSearch li label {
ul.navListSearch li span {
position:relative;
right:-16px;
}
@ -243,8 +233,8 @@ ul.subNavList li {
overflow:hidden;
}
/*
* Styles for page header and footer.
*/
Page header and footer styles
*/
.header, .footer {
clear:both;
margin:0 20px;
@ -287,8 +277,8 @@ ul.subNavList li {
font-size:13px;
}
/*
* Styles for headings.
*/
Heading styles
*/
div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
@ -309,8 +299,8 @@ ul.blockList li.blockList h2 {
padding:0px 0 20px 0;
}
/*
* Styles for page layout containers.
*/
Page layout container styles
*/
.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
clear:both;
padding:10px 20px;
@ -356,8 +346,8 @@ ul.blockList li.blockList h2 {
display:inline;
}
/*
* Styles for lists.
*/
List styles
*/
li.circle {
list-style:circle;
}
@ -413,8 +403,8 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
margin-bottom:1px;
}
/*
* Styles for tables.
*/
Table styles
*/
.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary,
.requiresSummary, .packagesSummary, .providesSummary, .usesSummary {
width:100%;
@ -443,27 +433,23 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
white-space:pre;
}
.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
.constantsSummary caption a:link, .deprecatedSummary caption a:link,
.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link,
.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
.requiresSummary caption a:link, .packagesSummary caption a:link, providesSummary caption a:link,
.usesSummary caption a:link,
.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
.constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover,
.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
.requiresSummary caption a:hover, .packagesSummary caption a:hover, providesSummary caption a:hover,
.usesSummary caption a:hover,
.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
.constantsSummary caption a:active, .deprecatedSummary caption a:active,
.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active,
.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
.requiresSummary caption a:active, .packagesSummary caption a:active, providesSummary caption a:active,
.usesSummary caption a:active,
.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
.constantsSummary caption a:visited, .deprecatedSummary caption a:visited,
.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited,
.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited
.requiresSummary caption a:visited, .packagesSummary caption a:visited, providesSummary caption a:visited,
.usesSummary caption a:visited {
color:#FFFFFF;
}
.useSummary caption a:link, .useSummary caption a:hover, .useSummary caption a:active,
.useSummary caption a:visited {
color:#1f389c;
}
.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span,
.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span,
@ -479,8 +465,7 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
border: none;
height:16px;
}
.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span,
.overviewSummary caption span.activeTableTab span {
.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
@ -491,8 +476,7 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
background-color:#F8981D;
height:16px;
}
.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span,
.overviewSummary caption span.tableTab span {
.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
@ -504,8 +488,7 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
height:16px;
}
.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab,
.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab,
.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab {
.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab {
padding-top:0px;
padding-left:0px;
padding-right:0px;
@ -522,8 +505,7 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
float:left;
background-color:#F8981D;
}
.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd,
.overviewSummary .activeTableTab .tabEnd {
.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
@ -531,14 +513,14 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
float:left;
background-color:#F8981D;
}
.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd,
.overviewSummary .tableTab .tabEnd {
.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
background-color:#4D7A97;
float:left;
}
.rowColor th, .altColor th {
font-weight:normal;
@ -549,16 +531,14 @@ table tr td dl, table tr td dl dt, table tr td dl dd {
text-align:left;
padding:0px 0px 12px 10px;
}
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th,
.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td,
.constantsSummary td {
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, .useSummary th, .constantsSummary th, .packagesSummary th,
td.colFirst, td.colSecond, td.colLast, .useSummary td, .constantsSummary td {
vertical-align:top;
padding-right:0px;
padding-top:8px;
padding-bottom:3px;
}
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th,
.packagesSummary th {
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, .constantsSummary th, .packagesSummary th {
background:#dee3e9;
text-align:left;
padding:8px 3px 3px 7px;
@ -567,7 +547,7 @@ td.colFirst, th.colFirst {
white-space:nowrap;
font-size:13px;
}
td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast {
td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colLast {
font-size:13px;
}
.constantsSummary th, .packagesSummary th {
@ -596,7 +576,7 @@ td.colSecond a:link, td.colSecond a:visited,
th.colFirst a:link, th.colFirst a:visited,
th.colSecond a:link, th.colSecond a:visited,
th.colConstructorName a:link, th.colConstructorName a:visited,
th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
td.colLast a:link, td.colLast a:visited,
.constantValuesContainer td a:link, .constantValuesContainer td a:visited {
font-weight:bold;
}
@ -610,8 +590,8 @@ th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
background-color:#EEEEEF;
}
/*
* Styles for contents.
*/
Content styles
*/
.description pre {
margin-top:0;
}
@ -622,22 +602,27 @@ th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
.docSummary {
padding:0;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
font-style:normal;
}
div.block {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
}
td.colLast div {
padding-top:0px;
}
td.colLast a {
padding-bottom:3px;
}
/*
* Styles for formatting effect.
*/
Formatting effect styles
*/
.sourceLineNo {
color:green;
padding:0 30px 0 0;
@ -661,27 +646,18 @@ h1.hidden {
.deprecationComment, .emphasizedPhrase, .interfaceName {
font-style:italic;
}
.deprecationBlock {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
border-style:solid;
border-width:thin;
border-radius:10px;
padding:10px;
margin-bottom:10px;
margin-right:10px;
display:inline-block;
}
div.block div.deprecationComment, div.block div.block span.emphasizedPhrase,
div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
div.block div.block span.interfaceName {
font-style:normal;
}
div.contentContainer ul.blockList li.blockList h2 {
padding-bottom:0px;
}
/*
* Styles for IFRAME.
*/
IFRAME specific styles
*/
.mainContainer {
margin:0 auto;
padding:0;
@ -735,14 +711,11 @@ div.contentContainer ul.blockList li.blockList h2 {
margin-bottom:30px;
}
/*
* Styles specific to HTML5 elements.
*/
HTML5 specific styles
*/
main, nav, header, footer, section {
display:block;
}
/*
* Styles for javadoc search.
*/
.ui-autocomplete-category {
font-weight:bold;
font-size:15px;
@ -784,20 +757,18 @@ ul.ui-autocomplete li {
}
#reset {
background-color: rgb(255,255,255);
background-image:url('resources/x.png');
background-position:center;
background-repeat:no-repeat;
background-size:12px;
border:0 none;
width:16px;
height:17px;
position:relative;
left:-4px;
top:-4px;
font-size:0px;
left:-2px;
background-image:url('resources/x.png');
background-repeat:no-repeat;
background-size:12px;
background-position:center;
}
.watermark {
color:#545454;
color:#888;
}
.searchTagDescResult {
font-style:italic;
@ -807,9 +778,7 @@ ul.ui-autocomplete li {
font-style:italic;
font-size:12px;
}
.searchTagResult:before, .searchTagResult:target {
color:red;
}
.moduleGraph span {
display:none;
position:absolute;
@ -845,17 +814,20 @@ table.striped {
margin-top: 10px;
margin-bottom: 10px;
}
table.borderless > caption,
table.plain > caption,
table.striped > caption {
font-weight: bold;
font-size: smaller;
}
table.borderless th, table.borderless td,
table.plain th, table.plain td,
table.striped th, table.striped td {
padding: 2px 5px;
}
table.borderless,
table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
@ -864,6 +836,7 @@ table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.bo
table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
background-color: transparent;
}
table.plain {
border-collapse: collapse;
border: 1px solid black;
@ -875,14 +848,13 @@ table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr >
table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
border: 1px solid black;
}
table.striped {
border-collapse: collapse;
border: 1px solid black;
}
table.striped > thead {
background-color: #DDD;
}
table.striped > thead > tr > th, table.striped > thead > tr > td {
border: 1px solid black;
}
table.striped > tbody > tr:nth-child(even) {
@ -891,10 +863,8 @@ table.striped > tbody > tr:nth-child(even) {
table.striped > tbody > tr:nth-child(odd) {
background-color: #FFF
}
table.striped > tbody > tr > th, table.striped > tbody > tr > td {
table.striped > thead > tr > th, table.striped > tbody > tr > th,
table.striped > tbody > tr > td, table.striped > tbody > tr > td {
border-left: 1px solid black;
border-right: 1px solid black;
}
table.striped > tbody > tr > th {
font-weight: normal;
}

Binary file not shown.