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

Update documentation for v2.7.0

This commit is contained in:
Will Hedgecock 2021-04-14 13:33:00 -05:00
parent 34a104ebcc
commit c6b7aad682
31 changed files with 120 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
binaries/jSerialComm-2.6.2-javadoc.jar → binaries/jSerialComm-2.7.0-javadoc.jar
View File

Binary file not shown.

BIN
binaries/jSerialComm-2.6.2-sources.jar → binaries/jSerialComm-2.7.0-sources.jar
View File

Binary file not shown.

BIN
binaries/jSerialComm-2.6.2-test.jar → binaries/jSerialComm-2.7.0-test.jar
View File

Binary file not shown.

BIN
binaries/jSerialComm-2.6.2.jar → binaries/jSerialComm-2.7.0.jar
View File

Binary file not shown.

4
index.html
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.6.2.jar">Download this library as a .jar file</a>
<a class="jar_download_link" href="binaries/jSerialComm-2.7.0.jar">Download this library as a .jar file</a>
</section>
</header>
</div>
@ -75,7 +75,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.6.2.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.7.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>

2
javadoc/allclasses-frame.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (jSerialComm 2.6.2 API)</title>
<title>All Classes (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">

2
javadoc/allclasses-noframe.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (jSerialComm 2.6.2 API)</title>
<title>All Classes (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPort (jSerialComm 2.6.2 API)</title>
<title>SerialPort (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,13 +20,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPort (jSerialComm 2.6.2 API)";
parent.document.title="SerialPort (jSerialComm 2.7.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":9,"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":9,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":9,"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":9,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":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";
@ -431,104 +431,112 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getInputStreamWithSuppressedTimeoutExceptions--">getInputStreamWithSuppressedTimeoutExceptions</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns an <a href="https://docs.oracle.com/javase/9/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, with read timeout exceptions
completely suppressed.</div>
</td>
</tr>
<tr id="i21" 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>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current number of data bits per word.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<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#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="i22" class="altColor">
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td>
<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 <a href="https://docs.oracle.com/javase/9/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>
</td>
</tr>
<tr id="i23" class="rowColor">
<tr id="i24" 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>&#8203;()</code></th>
<td class="colLast">
<div class="block">Gets the current parity error-checking scheme.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<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="i25" class="rowColor">
<tr id="i26" 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>&#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="i26" class="altColor">
<tr id="i27" 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#getRI--">getRI</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns whether the RI line is currently asserted.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<tr id="i28" 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#getRTS--">getRTS</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns whether the RTS line is currently asserted.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<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="i29" class="rowColor">
<tr id="i30" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#getVersion--">getVersion</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Returns the current version of the jSerialComm library.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<tr id="i31" 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#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="i31" class="rowColor">
<tr id="i32" 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#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="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#openPort--">openPort</a></span>&#8203;()</code></th>
<td class="colLast">
<div class="block">Opens this serial port for reading and writing.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<tr id="i34" 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-int-">openPort</a></span>&#8203;(int&nbsp;safetySleepTime)</code></th>
<td class="colLast">
<div class="block">Opens this serial port for reading and writing with an optional delay time.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<tr id="i35" 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#openPort-int-int-int-">openPort</a></span>&#8203;(int&nbsp;safetySleepTime,
int&nbsp;deviceSendQueueSize,
@ -537,7 +545,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Opens this serial port for reading and writing with an optional delay time and user-specified device buffer size.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<tr id="i36" 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#readBytes-byte:A-long-">readBytes</a></span>&#8203;(byte[]&nbsp;buffer,
long&nbsp;bytesToRead)</code></th>
@ -545,7 +553,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Reads up to <i>bytesToRead</i> raw data bytes from the serial port and stores them in the buffer.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<tr id="i37" 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,
@ -554,28 +562,28 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<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="i37" class="rowColor">
<tr id="i38" 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>&#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="i38" class="altColor">
<tr id="i39" 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#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="i39" class="rowColor">
<tr id="i40" 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>&#8203;()</code></th>
<td class="colLast">
<div class="block">Sets the BREAK signal on the serial control line.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<tr id="i41" 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#setComPortParameters-int-int-int-int-">setComPortParameters</a></span>&#8203;(int&nbsp;newBaudRate,
int&nbsp;newDataBits,
@ -585,7 +593,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Sets all serial port parameters at one time.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<tr id="i42" 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#setComPortParameters-int-int-int-int-boolean-">setComPortParameters</a></span>&#8203;(int&nbsp;newBaudRate,
int&nbsp;newDataBits,
@ -596,7 +604,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Sets all serial port parameters at one time.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<tr id="i43" 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#setComPortTimeouts-int-int-int-">setComPortTimeouts</a></span>&#8203;(int&nbsp;newTimeoutMode,
int&nbsp;newReadTimeout,
@ -605,42 +613,42 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Sets the serial port read and write timeout parameters.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<tr id="i44" 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#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="i44" class="altColor">
<tr id="i45" 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#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="i45" class="rowColor">
<tr id="i46" 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#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="i46" class="altColor">
<tr id="i47" 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#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="i47" class="rowColor">
<tr id="i48" 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#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="i48" class="altColor">
<tr id="i49" 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#setRs485ModeParameters-boolean-boolean-int-int-">setRs485ModeParameters</a></span>&#8203;(boolean&nbsp;useRS485Mode,
boolean&nbsp;rs485RtsActiveHigh,
@ -650,21 +658,21 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<div class="block">Sets whether to enable RS-485 mode for this device.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<tr id="i50" 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>&#8203;()</code></th>
<td class="colLast">
<div class="block">Sets the state of the RTS line to 1.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<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="i51" class="rowColor">
<tr id="i52" 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>
@ -672,7 +680,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<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="i52" class="altColor">
<tr id="i53" 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,
@ -1597,6 +1605,36 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
</dl>
</li>
</ul>
<a name="getInputStreamWithSuppressedTimeoutExceptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputStreamWithSuppressedTimeoutExceptions</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;getInputStreamWithSuppressedTimeoutExceptions&#8203;()</pre>
<div class="block">Returns an <a href="https://docs.oracle.com/javase/9/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, with read timeout exceptions
completely suppressed.
<p>
Allows for easier read access of the underlying data stream and abstracts away many low-level read details.
<p>
Note that any time a method is marked as throwable for an <a href="https://docs.oracle.com/javase/9/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> in the official Java
<a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> documentation, you can catch this exception directly, or you can choose to catch
either a <a href="../../../com/fazecast/jSerialComm/SerialPortIOException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortIOException</code></a> or a <a href="../../../com/fazecast/jSerialComm/SerialPortTimeoutException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortTimeoutException</code></a> (or both) which may make it
easier for your code to determine why the exception was thrown. In general, a <a href="../../../com/fazecast/jSerialComm/SerialPortIOException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortIOException</code></a>
means that the port is having connectivity issues, while a <a href="../../../com/fazecast/jSerialComm/SerialPortTimeoutException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortTimeoutException</code></a> indicates that
a user timeout has been reached before valid data was able to be returned (as specified in the
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#setComPortTimeouts-int-int-int-"><code>setComPortTimeouts(int, int, int)</code></a> method). When an <a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> is returned using
this method, a <a href="../../../com/fazecast/jSerialComm/SerialPortTimeoutException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortTimeoutException</code></a> will never be thrown.
<p>
Make sure to call the <a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true#close--" title="class or interface in java.io"><code>InputStream.close()</code></a> method when you are done using this stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="https://docs.oracle.com/javase/9/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.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a></dd>
</dl>
</li>
</ul>
<a name="getOutputStream--">
<!-- -->
</a>
@ -1608,7 +1646,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
<p>
Allows for easier write access to the underlying data stream and abstracts away many low-level writing details.
<p>
Note that any time a method is marked as throwable for an <a href="https://docs.oracle.com/javase/9/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> in the official Java
Note that any time a method is marked as throwable for an <a href="https://docs.oracle.com/javase/9/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> in the official Java
<a href="https://docs.oracle.com/javase/9/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> documentation, you can catch this exception directly, or you can choose to catch
either a <a href="../../../com/fazecast/jSerialComm/SerialPortIOException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortIOException</code></a> or a <a href="../../../com/fazecast/jSerialComm/SerialPortTimeoutException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortTimeoutException</code></a> (or both) which may make it
easier for your code to determine why the exception was thrown. In general, a <a href="../../../com/fazecast/jSerialComm/SerialPortIOException.html" title="class in com.fazecast.jSerialComm"><code>SerialPortIOException</code></a>

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortDataListener (jSerialComm 2.6.2 API)</title>
<title>SerialPortDataListener (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortDataListener (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortDataListener (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortDataListenerWithExceptions (jSerialComm 2.6.2 API)</title>
<title>SerialPortDataListenerWithExceptions (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortDataListenerWithExceptions (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortDataListenerWithExceptions (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortEvent (jSerialComm 2.6.2 API)</title>
<title>SerialPortEvent (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortEvent (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortEvent (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortIOException (jSerialComm 2.6.2 API)</title>
<title>SerialPortIOException (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortIOException (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortIOException (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortInvalidPortException (jSerialComm 2.6.2 API)</title>
<title>SerialPortInvalidPortException (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortInvalidPortException (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortInvalidPortException (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortMessageListener (jSerialComm 2.6.2 API)</title>
<title>SerialPortMessageListener (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortMessageListener (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortMessageListener (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortMessageListenerWithExceptions (jSerialComm 2.6.2 API)</title>
<title>SerialPortMessageListenerWithExceptions (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortMessageListenerWithExceptions (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortMessageListenerWithExceptions (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortPacketListener (jSerialComm 2.6.2 API)</title>
<title>SerialPortPacketListener (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortPacketListener (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortPacketListener (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SerialPortTimeoutException (jSerialComm 2.6.2 API)</title>
<title>SerialPortTimeoutException (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerialPortTimeoutException (jSerialComm 2.6.2 API)";
parent.document.title="SerialPortTimeoutException (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>com.fazecast.jSerialComm (jSerialComm 2.6.2 API)</title>
<title>com.fazecast.jSerialComm (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>com.fazecast.jSerialComm (jSerialComm 2.6.2 API)</title>
<title>com.fazecast.jSerialComm (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.fazecast.jSerialComm (jSerialComm 2.6.2 API)";
parent.document.title="com.fazecast.jSerialComm (jSerialComm 2.7.0 API)";
}
}
catch(err) {

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

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.6.2 API)</title>
<title>com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.6.2 API)";
parent.document.title="com.fazecast.jSerialComm Class Hierarchy (jSerialComm 2.7.0 API)";
}
}
catch(err) {

4
javadoc/constant-values.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Constant Field Values (jSerialComm 2.6.2 API)</title>
<title>Constant Field Values (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (jSerialComm 2.6.2 API)";
parent.document.title="Constant Field Values (jSerialComm 2.7.0 API)";
}
}
catch(err) {

4
javadoc/deprecated-list.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Deprecated List (jSerialComm 2.6.2 API)</title>
<title>Deprecated List (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (jSerialComm 2.6.2 API)";
parent.document.title="Deprecated List (jSerialComm 2.7.0 API)";
}
}
catch(err) {

4
javadoc/help-doc.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>API Help (jSerialComm 2.6.2 API)</title>
<title>API Help (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (jSerialComm 2.6.2 API)";
parent.document.title="API Help (jSerialComm 2.7.0 API)";
}
}
catch(err) {

9
javadoc/index-all.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Index (jSerialComm 2.6.2 API)</title>
<title>Index (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (jSerialComm 2.6.2 API)";
parent.document.title="Index (jSerialComm 2.7.0 API)";
}
}
catch(err) {
@ -247,6 +247,11 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd>
<div class="block">Returns an <a href="https://docs.oracle.com/javase/9/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/SerialPort.html#getInputStreamWithSuppressedTimeoutExceptions--">getInputStreamWithSuppressedTimeoutExceptions()</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 an <a href="https://docs.oracle.com/javase/9/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, with read timeout exceptions
completely suppressed.</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>
<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>

2
javadoc/index.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>jSerialComm 2.6.2 API</title>
<title>jSerialComm 2.7.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">

2
javadoc/member-search-index.js
View File

File diff suppressed because one or more lines are too long

BIN
javadoc/member-search-index.zip
View File

Binary file not shown.

4
javadoc/overview-tree.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Class Hierarchy (jSerialComm 2.6.2 API)</title>
<title>Class Hierarchy (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Class Hierarchy (jSerialComm 2.6.2 API)";
parent.document.title="Class Hierarchy (jSerialComm 2.7.0 API)";
}
}
catch(err) {

BIN
javadoc/package-search-index.zip
View File

Binary file not shown.

4
javadoc/serialized-form.html
View File

@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Serialized Form (jSerialComm 2.6.2 API)</title>
<title>Serialized Form (jSerialComm 2.7.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">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
@ -20,7 +20,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Serialized Form (jSerialComm 2.6.2 API)";
parent.document.title="Serialized Form (jSerialComm 2.7.0 API)";
}
}
catch(err) {

BIN
javadoc/type-search-index.zip
View File

Binary file not shown.