|
|
|
@ -2,10 +2,10 @@
|
|
|
|
|
<!-- NewPage -->
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<!-- Generated by javadoc (9.0.4) on Tue Sep 25 11:10:47 CDT 2018 -->
|
|
|
|
|
<title>SerialPort (jSerialComm 2.2.2 API)</title>
|
|
|
|
|
<!-- Generated by javadoc (9.0.4) on Fri Oct 12 16:59:14 CDT 2018 -->
|
|
|
|
|
<title>SerialPort (jSerialComm 2.3.0 API)</title>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
|
|
<meta name="date" content="2018-09-25">
|
|
|
|
|
<meta name="date" content="2018-10-12">
|
|
|
|
|
<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.2.2 API)";
|
|
|
|
|
parent.document.title="SerialPort (jSerialComm 2.3.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,"i40":10,"i41":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":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};
|
|
|
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
|
|
|
var altColor = "altColor";
|
|
|
|
|
var rowColor = "rowColor";
|
|
|
|
@ -271,11 +271,6 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
</tr>
|
|
|
|
|
<tr class="altColor">
|
|
|
|
|
<td class="colFirst"><code>static int</code></td>
|
|
|
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_WRITE_SEMI_BLOCKING">TIMEOUT_WRITE_SEMI_BLOCKING</a></span></code></th>
|
|
|
|
|
<td class="colLast"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr class="rowColor">
|
|
|
|
|
<td class="colFirst"><code>static int</code></td>
|
|
|
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/fazecast/jSerialComm/SerialPort.html#TWO_STOP_BITS">TWO_STOP_BITS</a></span></code></th>
|
|
|
|
|
<td class="colLast"> </td>
|
|
|
|
|
</tr>
|
|
|
|
@ -346,139 +341,155 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i7" 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#disablePortConfiguration--">disablePortConfiguration</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Disables the library from calling any of the underlying device driver configuration methods.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i8" 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#getBaudRate--">getBaudRate</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Gets the current baud rate of the serial port.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i8" class="altColor">
|
|
|
|
|
<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#getCommPort-java.lang.String-">getCommPort</a></span>​(<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> portDescriptor)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Allocates a <a href="../../../com/fazecast/jSerialComm/SerialPort.html" title="class in com.fazecast.jSerialComm"><code>SerialPort</code></a> object corresponding to the user-specified port descriptor.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i9" class="rowColor">
|
|
|
|
|
<tr id="i10" class="altColor">
|
|
|
|
|
<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>
|
|
|
|
|
<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">
|
|
|
|
|
<tr id="i11" 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#getCTS--">getCTS</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Returns whether the CTS line is currently asserted.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i11" class="rowColor">
|
|
|
|
|
<tr id="i12" class="altColor">
|
|
|
|
|
<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#getDescriptivePortName--">getDescriptivePortName</a></span>​()</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">
|
|
|
|
|
<tr id="i13" 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#getDSR--">getDSR</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Returns whether the DSR line is currently asserted.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i13" class="rowColor">
|
|
|
|
|
<tr id="i14" 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#getFlowControlSettings--">getFlowControlSettings</a></span>​()</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">
|
|
|
|
|
<tr id="i15" class="rowColor">
|
|
|
|
|
<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#getInputStream--">getInputStream</a></span>​()</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.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i15" class="rowColor">
|
|
|
|
|
<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#getNumDataBits--">getNumDataBits</a></span>​()</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">
|
|
|
|
|
<tr id="i17" 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#getNumStopBits--">getNumStopBits</a></span>​()</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">
|
|
|
|
|
<tr id="i18" class="altColor">
|
|
|
|
|
<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>​()</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="i18" class="altColor">
|
|
|
|
|
<tr id="i19" 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#getParity--">getParity</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Gets the current parity error-checking scheme.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i19" class="rowColor">
|
|
|
|
|
<tr id="i20" class="altColor">
|
|
|
|
|
<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>​()</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">
|
|
|
|
|
<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#getReadTimeout--">getReadTimeout</a></span>​()</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">
|
|
|
|
|
<tr id="i22" class="altColor">
|
|
|
|
|
<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>​()</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">
|
|
|
|
|
<tr id="i23" 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>​()</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">
|
|
|
|
|
<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#isOpen--">isOpen</a></span>​()</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">
|
|
|
|
|
<tr id="i25" 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>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Opens this serial port for reading and writing.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i25" class="rowColor">
|
|
|
|
|
<tr id="i26" 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>​(int 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="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#openPort-int-int-int-">openPort</a></span>​(int safetySleepTime,
|
|
|
|
|
int deviceSendQueueSize,
|
|
|
|
|
int deviceReceiveQueueSize)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<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="i28" 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>​(byte[] buffer,
|
|
|
|
|
long bytesToRead)</code></th>
|
|
|
|
@ -486,7 +497,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="i27" class="rowColor">
|
|
|
|
|
<tr id="i29" 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>​(byte[] buffer,
|
|
|
|
|
long bytesToRead,
|
|
|
|
@ -495,28 +506,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="i28" class="altColor">
|
|
|
|
|
<tr id="i30" 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>
|
|
|
|
|
<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="i29" class="rowColor">
|
|
|
|
|
<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#setBaudRate-int-">setBaudRate</a></span>​(int newBaudRate)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the desired baud rate for this serial port.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i30" class="altColor">
|
|
|
|
|
<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#setBreak--">setBreak</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the BREAK signal on the serial control line.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i31" class="rowColor">
|
|
|
|
|
<tr id="i33" 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>​(int newBaudRate,
|
|
|
|
|
int newDataBits,
|
|
|
|
@ -526,7 +537,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="i32" class="altColor">
|
|
|
|
|
<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#setComPortTimeouts-int-int-int-">setComPortTimeouts</a></span>​(int newTimeoutMode,
|
|
|
|
|
int newReadTimeout,
|
|
|
|
@ -535,56 +546,56 @@ 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="i33" class="rowColor">
|
|
|
|
|
<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#setDTR--">setDTR</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the state of the DTR line to 1.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i34" class="altColor">
|
|
|
|
|
<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#setFlowControl-int-">setFlowControl</a></span>​(int 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="i35" class="rowColor">
|
|
|
|
|
<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#setNumDataBits-int-">setNumDataBits</a></span>​(int newDataBits)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the desired number of data bits per word.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i36" class="altColor">
|
|
|
|
|
<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#setNumStopBits-int-">setNumStopBits</a></span>​(int newStopBits)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the desired number of stop bits per word.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i37" class="rowColor">
|
|
|
|
|
<tr id="i39" 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>​(int newParity)</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the desired parity error-detection scheme to be used.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i38" class="altColor">
|
|
|
|
|
<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#setRTS--">setRTS</a></span>​()</code></th>
|
|
|
|
|
<td class="colLast">
|
|
|
|
|
<div class="block">Sets the state of the RTS line to 1.</div>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr id="i39" class="rowColor">
|
|
|
|
|
<tr id="i41" 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>​()</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="i40" class="altColor">
|
|
|
|
|
<tr id="i42" 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>​(byte[] buffer,
|
|
|
|
|
long bytesToWrite)</code></th>
|
|
|
|
@ -592,7 +603,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="i41" class="rowColor">
|
|
|
|
|
<tr id="i43" 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>​(byte[] buffer,
|
|
|
|
|
long bytesToWrite,
|
|
|
|
@ -844,19 +855,6 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="TIMEOUT_WRITE_SEMI_BLOCKING">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
|
<ul class="blockList">
|
|
|
|
|
<li class="blockList">
|
|
|
|
|
<h4>TIMEOUT_WRITE_SEMI_BLOCKING</h4>
|
|
|
|
|
<pre>public static final int TIMEOUT_WRITE_SEMI_BLOCKING</pre>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
|
|
<dd><a href="../../../constant-values.html#com.fazecast.jSerialComm.SerialPort.TIMEOUT_WRITE_SEMI_BLOCKING">Constant Field Values</a></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="TIMEOUT_READ_BLOCKING">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
@ -998,6 +996,30 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="openPort-int-int-int-">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
|
<ul class="blockList">
|
|
|
|
|
<li class="blockList">
|
|
|
|
|
<h4>openPort</h4>
|
|
|
|
|
<pre>public final boolean openPort​(int safetySleepTime,
|
|
|
|
|
int deviceSendQueueSize,
|
|
|
|
|
int deviceReceiveQueueSize)</pre>
|
|
|
|
|
<div class="block">Opens this serial port for reading and writing with an optional delay time and user-specified device buffer size.
|
|
|
|
|
<p>
|
|
|
|
|
All serial port parameters or timeouts can be changed at any time before or after the port has been opened.
|
|
|
|
|
<p>
|
|
|
|
|
Note that calling this method on an already opened port will simply reconfigure the port parameters.</div>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
|
|
<dd><code>safetySleepTime</code> - The number of milliseconds to sleep before opening the port in case of frequent closing/openings.</dd>
|
|
|
|
|
<dd><code>deviceSendQueueSize</code> - The requested size in bytes of the internal device driver's output queue (no effect on OSX)</dd>
|
|
|
|
|
<dd><code>deviceReceiveQueueSize</code> - The requested size in bytes of the internal device driver's input queue (no effect on Linux/OSX)</dd>
|
|
|
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
|
|
<dd>Whether the port was successfully opened.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="openPort-int-">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
@ -1009,7 +1031,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<p>
|
|
|
|
|
All serial port parameters or timeouts can be changed at any time before or after the port has been opened.
|
|
|
|
|
<p>
|
|
|
|
|
Note that calling this method on an already opened port will simply return a value of true.</div>
|
|
|
|
|
Note that calling this method on an already opened port will simply reconfigure the port parameters.</div>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
|
|
<dd><code>safetySleepTime</code> - The number of milliseconds to sleep before opening the port in case of frequent closing/openings.</dd>
|
|
|
|
@ -1027,11 +1049,11 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<pre>public final boolean openPort​()</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.
|
|
|
|
|
This method is equivalent to calling <a href="../../../com/fazecast/jSerialComm/SerialPort.html#openPort-int-int-int-"><code>openPort(int, int, int)</code></a> with a value of 1000.
|
|
|
|
|
<p>
|
|
|
|
|
All serial port parameters or timeouts can be changed at any time before or after the port has been opened.
|
|
|
|
|
<p>
|
|
|
|
|
Note that calling this method on an already opened port will simply return a value of true.</div>
|
|
|
|
|
Note that calling this method on an already opened port will simply reconfigure the port parameters.</div>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
|
|
<dd>Whether the port was successfully opened.</dd>
|
|
|
|
@ -1068,6 +1090,20 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="disablePortConfiguration--">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
|
<ul class="blockList">
|
|
|
|
|
<li class="blockList">
|
|
|
|
|
<h4>disablePortConfiguration</h4>
|
|
|
|
|
<pre>public final void disablePortConfiguration​()</pre>
|
|
|
|
|
<div class="block">Disables the library from calling any of the underlying device driver configuration methods.
|
|
|
|
|
<p>
|
|
|
|
|
This function should never be called except in very specific cases involving USB-to-Serial converters
|
|
|
|
|
with buggy device drivers. In that case, this function <b>must</b> be called before attempting to
|
|
|
|
|
open the port.</div>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a name="bytesAvailable--">
|
|
|
|
|
<!-- -->
|
|
|
|
|
</a>
|
|
|
|
@ -1111,9 +1147,9 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<p>
|
|
|
|
|
The length of the byte buffer 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>
|
|
|
|
|
In blocking-read mode, 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>
|
|
|
|
@ -1136,9 +1172,9 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<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>
|
|
|
|
|
In blocking-read mode, 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>
|
|
|
|
@ -1161,9 +1197,9 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<p>
|
|
|
|
|
The length of the byte buffer 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>
|
|
|
|
|
In blocking-write mode, this call will block until <i>bytesToWrite</i> bytes of data have been successfully written to the serial port. Otherwise, this method will return
|
|
|
|
|
after <i>bytesToWrite</i> bytes of data have been written to the device driver's internal data buffer, which, in most cases, should be almost instantaneous unless the data
|
|
|
|
|
buffer is full.</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>
|
|
|
|
@ -1186,9 +1222,9 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<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>
|
|
|
|
|
In blocking-write mode, this call will block until <i>bytesToWrite</i> bytes of data have been successfully written to the serial port. Otherwise, this method will return
|
|
|
|
|
after <i>bytesToWrite</i> bytes of data have been written to the device driver's internal data buffer, which, in most cases, should be almost instantaneous unless the data
|
|
|
|
|
buffer is full.</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>
|
|
|
|
@ -1456,24 +1492,29 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
int newWriteTimeout)</pre>
|
|
|
|
|
<div class="block">Sets the serial port read and write timeout parameters.
|
|
|
|
|
<p>
|
|
|
|
|
<i>Note that write timeouts are only available on Windows-based systems. There is no functionality to set a write timeout on other operating systems.</i>
|
|
|
|
|
<i>Note that time-based write timeouts are only available on Windows systems. There is no functionality to set a write timeout on other operating systems.</i>
|
|
|
|
|
<p>
|
|
|
|
|
The built-in timeout mode constants should be used (<a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_NONBLOCKING"><code>TIMEOUT_NONBLOCKING</code></a>, <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_SEMI_BLOCKING"><code>TIMEOUT_READ_SEMI_BLOCKING</code></a>, <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_BLOCKING"><code>TIMEOUT_READ_BLOCKING</code></a>,
|
|
|
|
|
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_SCANNER"><code>TIMEOUT_SCANNER</code></a>) to specify how timeouts are to be handled.
|
|
|
|
|
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_WRITE_BLOCKING"><code>TIMEOUT_WRITE_BLOCKING</code></a>, <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_SCANNER"><code>TIMEOUT_SCANNER</code></a>) to specify how timeouts are to be handled.
|
|
|
|
|
<p>
|
|
|
|
|
Valid modes are:
|
|
|
|
|
<p>
|
|
|
|
|
Read Non-blocking: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_NONBLOCKING"><code>TIMEOUT_NONBLOCKING</code></a><br>
|
|
|
|
|
Non-blocking: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_NONBLOCKING"><code>TIMEOUT_NONBLOCKING</code></a><br>
|
|
|
|
|
Write Blocking: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_WRITE_BLOCKING"><code>TIMEOUT_WRITE_BLOCKING</code></a><br>
|
|
|
|
|
Read Semi-blocking: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_SEMI_BLOCKING"><code>TIMEOUT_READ_SEMI_BLOCKING</code></a><br>
|
|
|
|
|
Read Full-blocking: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_BLOCKING"><code>TIMEOUT_READ_BLOCKING</code></a><br>
|
|
|
|
|
Scanner: <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_SCANNER"><code>TIMEOUT_SCANNER</code></a><br>
|
|
|
|
|
<p>
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_NONBLOCKING"><code>TIMEOUT_NONBLOCKING</code></a> mode specifies that the corresponding <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>readBytes(byte[],long)</code></a> call will return immediately with any available data.
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_NONBLOCKING"><code>TIMEOUT_NONBLOCKING</code></a> mode specifies that corresponding <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>readBytes(byte[],long)</code></a> and <a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a> calls will return
|
|
|
|
|
immediately with any available data.
|
|
|
|
|
<p>
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_SEMI_BLOCKING"><code>TIMEOUT_READ_SEMI_BLOCKING</code></a> mode specifies that the corresponding call will block until either <i>newReadTimeout</i> milliseconds of inactivity
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_WRITE_BLOCKING"><code>TIMEOUT_WRITE_BLOCKING</code></a> mode specifies that a corresponding write call will block until all data bytes have been successfully written to the
|
|
|
|
|
output serial device.
|
|
|
|
|
<p>
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_SEMI_BLOCKING"><code>TIMEOUT_READ_SEMI_BLOCKING</code></a> mode specifies that a corresponding read call will block until either <i>newReadTimeout</i> milliseconds of inactivity
|
|
|
|
|
have elapsed or at least 1 byte of data can be read.
|
|
|
|
|
<p>
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_BLOCKING"><code>TIMEOUT_READ_BLOCKING</code></a> mode specifies that the corresponding call will block until either <i>newReadTimeout</i> milliseconds have elapsed since
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_READ_BLOCKING"><code>TIMEOUT_READ_BLOCKING</code></a> mode specifies that a corresponding read call will block until either <i>newReadTimeout</i> milliseconds have elapsed since
|
|
|
|
|
the start of the call or the total number of requested bytes can be returned.
|
|
|
|
|
<p>
|
|
|
|
|
The <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_SCANNER"><code>TIMEOUT_SCANNER</code></a> mode is intended for use with the Java <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Scanner.html?is-external=true" title="class or interface in java.util"><code>Scanner</code></a> class for reading from the serial port. In this mode,
|
|
|
|
@ -1482,6 +1523,9 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
A value of 0 for either <i>newReadTimeout</i> or <i>newWriteTimeout</i> indicates that a <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>readBytes(byte[],long)</code></a> or
|
|
|
|
|
<a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a> call should block forever until it can return successfully (based upon the current timeout mode specified).
|
|
|
|
|
<p>
|
|
|
|
|
In order to specify that both a blocking read and write mode should be used, <a href="../../../com/fazecast/jSerialComm/SerialPort.html#TIMEOUT_WRITE_BLOCKING"><code>TIMEOUT_WRITE_BLOCKING</code></a> can be OR'd together with any of the read modes to pass
|
|
|
|
|
to the first parameter.
|
|
|
|
|
<p>
|
|
|
|
|
It is important to note that non-Windows operating systems only allow decisecond (1/10th of a second) granularity for serial port timeouts. As such, your
|
|
|
|
|
millisecond timeout value will be rounded to the nearest decisecond under Linux or Mac OS. To ensure consistent performance across multiple platforms, it is
|
|
|
|
|
advisable that you set your timeout values to be multiples of 100, although this is not strictly enforced.</div>
|
|
|
|
@ -1489,7 +1533,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
|
|
<dd><code>newTimeoutMode</code> - The new timeout mode as specified above.</dd>
|
|
|
|
|
<dd><code>newReadTimeout</code> - 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.</dd>
|
|
|
|
|
<dd><code>newWriteTimeout</code> - 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.</dd>
|
|
|
|
|
<dd><code>newWriteTimeout</code> - 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 (effective only on Windows).</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
@ -1744,7 +1788,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<pre>public final int getReadTimeout​()</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
|
|
|
|
|
A value of 0 in blocking-read mode 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
|
|
|
|
|
the indicated number of bytes from the serial port.
|
|
|
|
|
<p>
|
|
|
|
|
Any value other than 0 indicates the number of milliseconds of inactivity that will be tolerated before the <a href="../../../com/fazecast/jSerialComm/SerialPort.html#readBytes-byte:A-long-"><code>readBytes(byte[],long)</code></a>
|
|
|
|
@ -1764,7 +1808,7 @@ extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html
|
|
|
|
|
<pre>public final int getWriteTimeout​()</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
|
|
|
|
|
A value of 0 in blocking-write mode 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
|
|
|
|
|
the indicated number of bytes to the serial port.
|
|
|
|
|
<p>
|
|
|
|
|
Any value other than 0 indicates the number of milliseconds of inactivity that will be tolerated before the <a href="../../../com/fazecast/jSerialComm/SerialPort.html#writeBytes-byte:A-long-"><code>writeBytes(byte[],long)</code></a>
|
|
|
|
|