diff --git a/binaries/jSerialComm-1.3.3-test.jar b/binaries/jSerialComm-1.3.3-test.jar deleted file mode 100644 index dbbb0c8..0000000 Binary files a/binaries/jSerialComm-1.3.3-test.jar and /dev/null differ diff --git a/binaries/jSerialComm-1.3.3.jar b/binaries/jSerialComm-1.3.3.jar deleted file mode 100644 index 62cf2e7..0000000 Binary files a/binaries/jSerialComm-1.3.3.jar and /dev/null differ diff --git a/binaries/jSerialComm-1.3.4-test.jar b/binaries/jSerialComm-1.3.4-test.jar new file mode 100644 index 0000000..d93b668 Binary files /dev/null and b/binaries/jSerialComm-1.3.4-test.jar differ diff --git a/binaries/jSerialComm-1.3.4.jar b/binaries/jSerialComm-1.3.4.jar new file mode 100644 index 0000000..159fbaa Binary files /dev/null and b/binaries/jSerialComm-1.3.4.jar differ diff --git a/images/Thumbs.db b/images/Thumbs.db deleted file mode 100644 index e7204b1..0000000 Binary files a/images/Thumbs.db and /dev/null differ diff --git a/index.html b/index.html index e697d85..f4dff88 100644 --- a/index.html +++ b/index.html @@ -29,7 +29,7 @@
Download this project as a .zip file Download this project as a tar.gz file - Download this library as a .jar file + Download this library as a .jar file
@@ -39,7 +39,7 @@

What is jSerialComm?

-

jSerialComm is a Java library designed to provide a platform-independent way to access standard serial ports without requiring external libraries, native code, or any other tools. It is meant as an alternative to RxTx and the (deprecated) Java Communications API, with increased ease-of-use and an enhanced support for timeouts.

+

jSerialComm is a Java library designed to provide a platform-independent way to access standard serial ports without requiring external libraries, native code, or any other tools. It is meant as an alternative to RxTx and the (deprecated) Java Communications API, with increased ease-of-use, an enhanced support for timeouts, and the ability to open multiple ports simultaneously.

Some of the features of this library include:

@@ -73,13 +73,13 @@

How can use this library in my own project?

-

One of the most convenient features of this library is that it allows you to simply include the JAR file in your custom project, and it will automatically select and load the correct native library for your platform and architecture. As such, you can make use of this library by simply copying the jSerialComm.jar file into your project directory and linking to it as you would any other JAR file.

+

One of the most convenient features of this library is that it allows you to simply include the JAR file in your custom project, and it will automatically select and load the correct native library for your platform and architecture. As such, you can make use of this library by simply copying the jSerialComm.jar file into your project directory and linking to it as you would any other JAR file.

To access the contents of the library in your project, make sure to import com.fazecast.jSerialComm.* 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:

SerialPort.getCommPorts()
-

This will return an array of SerialPort objects through which you can iterate. See the Javadoc Library Reference for a complete overview of this library and its methods. Alternately, if you already know the port descriptor of the port you wish to use (e.g., "/dev/ttyS0" or "COM3"), you can create a SerialPort object using the following static method:

+

This will return an array of SerialPort objects through which you can iterate. See the Javadoc Library Reference for a complete overview of this library and its methods. Alternately, if you already know the port descriptor of the port you wish to use (e.g., "/dev/ttyS0" or "COM3"), or if you are using this library with pseudo-terminals (e.g., "/dev/pts/14"), you can create a SerialPort object using the following static method:

SerialPort.getCommPort(String portDescriptor)
@@ -102,25 +102,25 @@
  • Leiningen
  • -
    <dependency>
       <groupId>com.fazecast</groupId>
       <artifactId>jSerialComm</artifactId>
       <version>1.3.3</version>
    </dependency>
    +
    <dependency>
       <groupId>com.fazecast</groupId>
       <artifactId>jSerialComm</artifactId>
       <version>1.3.4</version>
    </dependency>
    -
    <dependency org="com.fazecast" name="jSerialComm" rev="1.3.3"/>
    +
    <dependency org="com.fazecast" name="jSerialComm" rev="1.3.4"/>
    -
    @Grapes(
       @Grab(group='com.fazecast', module='jSerialComm', version='1.3.3')
    )
    +
    @Grapes(
       @Grab(group='com.fazecast', module='jSerialComm', version='1.3.4')
    )
    -
    'com.fazecast:jSerialComm:1.3.3'
    +
    'com.fazecast:jSerialComm:1.3.4'
    -
    'com.fazecast:jSerialComm:jar:1.3.3'
    +
    'com.fazecast:jSerialComm:jar:1.3.4'
    -
    libraryDependencies += "com.fazecast" % "jSerialComm" % "1.3.3"
    +
    libraryDependencies += "com.fazecast" % "jSerialComm" % "1.3.4"
    -
    [com.fazecast/jSerialComm "1.3.3"]
    +
    [com.fazecast/jSerialComm "1.3.4"]
    diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html index 3b3564e..49c903c 100644 --- a/javadoc/allclasses-frame.html +++ b/javadoc/allclasses-frame.html @@ -1,37 +1,22 @@ - - - - - -All Classes (jSerialComm 1.3.3 API) - - - - - - - - - - - -All Classes -
    - - - - - -
    SerialPort -
    -SerialPortDataListener -
    -SerialPortEvent -
    -SerialPortPacketListener -
    -
    - - - + + + + +All Classes (jSerialComm 1.3.4 API) + + + + + +

    All Classes

    +
    + +
    + + diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html index 067f8ee..f2ee4a9 100644 --- a/javadoc/allclasses-noframe.html +++ b/javadoc/allclasses-noframe.html @@ -1,37 +1,22 @@ - - - - - -All Classes (jSerialComm 1.3.3 API) - - - - - - - - - - - -All Classes -
    - - - - - -
    SerialPort -
    -SerialPortDataListener -
    -SerialPortEvent -
    -SerialPortPacketListener -
    -
    - - - + + + + +All Classes (jSerialComm 1.3.4 API) + + + + + +

    All Classes

    +
    + +
    + + diff --git a/javadoc/com/fazecast/jSerialComm/SerialPort.html b/javadoc/com/fazecast/jSerialComm/SerialPort.html index 6b93558..24a2e39 100644 --- a/javadoc/com/fazecast/jSerialComm/SerialPort.html +++ b/javadoc/com/fazecast/jSerialComm/SerialPort.html @@ -1,1026 +1,982 @@ - - - - - -SerialPort (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"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}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; + + - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    -

    - -com.fazecast.jSerialComm -
    -Class SerialPort

    -
    -java.lang.Object
    -  extended by com.fazecast.jSerialComm.SerialPort
    -
    -
    -
    -
    public final class SerialPort
    extends Object
    - - -

    -This class provides native access to serial ports and devices without requiring external libraries or tools. -

    - -

    -

    -
    See Also:
    InputStream, -OutputStream
    -
    - -

    +

    +
    com.fazecast.jSerialComm
    +

    Class SerialPort

    +
    +
    + +
    +
      +
    • +
      +
      +
      public final class SerialPort
      +extends Object
      +
      This class provides native access to serial ports and devices without requiring external libraries or tools.
      +
      +
      See Also:
      +
      InputStream, +OutputStream
      +
      +
    • +
    +
    +
    + +
    +
    +
      +
    • - - - - - - -
      -Field Detail
      - -

      -NO_PARITY

      -
      -public static final int NO_PARITY
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -ODD_PARITY

      -
      -public static final int ODD_PARITY
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -EVEN_PARITY

      -
      -public static final int EVEN_PARITY
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -MARK_PARITY

      -
      -public static final int MARK_PARITY
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -SPACE_PARITY

      -
      -public static final int SPACE_PARITY
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -ONE_STOP_BIT

      -
      -public static final int ONE_STOP_BIT
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -ONE_POINT_FIVE_STOP_BITS

      -
      -public static final int ONE_POINT_FIVE_STOP_BITS
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TWO_STOP_BITS

      -
      -public static final int TWO_STOP_BITS
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_DISABLED

      -
      -public static final int FLOW_CONTROL_DISABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_RTS_ENABLED

      -
      -public static final int FLOW_CONTROL_RTS_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_CTS_ENABLED

      -
      -public static final int FLOW_CONTROL_CTS_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_DSR_ENABLED

      -
      -public static final int FLOW_CONTROL_DSR_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_DTR_ENABLED

      -
      -public static final int FLOW_CONTROL_DTR_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_XONXOFF_IN_ENABLED

      -
      -public static final int FLOW_CONTROL_XONXOFF_IN_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -FLOW_CONTROL_XONXOFF_OUT_ENABLED

      -
      -public static final int FLOW_CONTROL_XONXOFF_OUT_ENABLED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_NONBLOCKING

      -
      -public static final int TIMEOUT_NONBLOCKING
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_READ_SEMI_BLOCKING

      -
      -public static final int TIMEOUT_READ_SEMI_BLOCKING
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_WRITE_SEMI_BLOCKING

      -
      -public static final int TIMEOUT_WRITE_SEMI_BLOCKING
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_READ_BLOCKING

      -
      -public static final int TIMEOUT_READ_BLOCKING
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_WRITE_BLOCKING

      -
      -public static final int TIMEOUT_WRITE_BLOCKING
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -TIMEOUT_SCANNER

      -
      -public static final int TIMEOUT_SCANNER
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -LISTENING_EVENT_DATA_AVAILABLE

      -
      -public static final int LISTENING_EVENT_DATA_AVAILABLE
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -LISTENING_EVENT_DATA_RECEIVED

      -
      -public static final int LISTENING_EVENT_DATA_RECEIVED
      -
      -
      -
      See Also:
      Constant Field Values
      -
      -
      - -

      -LISTENING_EVENT_DATA_WRITTEN

      -
      -public static final int LISTENING_EVENT_DATA_WRITTEN
      -
      -
      -
      See Also:
      Constant Field Values
      -
      - + - - - - - - -
      -Method Detail
      - -

      -getCommPorts

      -
      -public static SerialPort[] getCommPorts()
      -
      -
      Returns a list of all available serial ports on this machine. +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCommPorts

          +
          public static SerialPort[] getCommPorts()
          +
          Returns a list of all available serial ports on this machine.

          The serial ports can be accessed by iterating through each of the SerialPort objects in this array.

          - Note that the openPort() method must be called before any attempts to read from or write to the port. Likewise, closePort() should be called when you are finished accessing the port. + Note that the openPort() method must be called before any attempts to read from or write to the port. Likewise, closePort() should be called when you are finished accessing the port.

          - All serial port parameters or timeouts can be changed at any time after the port has been opened. -

          -

          - -
          Returns:
          An array of SerialPort objects.
          -
          -
      -
      - -

      -getCommPort

      -
      -public static SerialPort getCommPort(String portDescriptor)
      -
      -
      Allocates a SerialPort object corresponding to the user-specified port descriptor. + All serial port parameters or timeouts can be changed at any time after the port has been opened.
    +
    +
    Returns:
    +
    An array of SerialPort objects.
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    Parameters:
    +
    newBaudRate - The desired baud rate for this serial port.
    +
    newDataBits - The number of data bits to use per word.
    +
    newStopBits - The number of stop bits to use.
    +
    newParity - The type of parity error-checking desired.
    +
    See Also:
    +
    ONE_STOP_BIT, +ONE_POINT_FIVE_STOP_BITS, +TWO_STOP_BITS, +NO_PARITY, +EVEN_PARITY, +ODD_PARITY, +MARK_PARITY, +SPACE_PARITY
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    - - - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    - - - + + diff --git a/javadoc/com/fazecast/jSerialComm/SerialPortDataListener.html b/javadoc/com/fazecast/jSerialComm/SerialPortDataListener.html index b06e774..301b4b5 100644 --- a/javadoc/com/fazecast/jSerialComm/SerialPortDataListener.html +++ b/javadoc/com/fazecast/jSerialComm/SerialPortDataListener.html @@ -1,257 +1,275 @@ - - - - - -SerialPortDataListener (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; + + - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    -

    - -com.fazecast.jSerialComm -
    -Interface SerialPortDataListener

    -
    -
    All Superinterfaces:
    EventListener
    -
    -
    -
    All Known Subinterfaces:
    SerialPortPacketListener
    -
    -
    -
    -
    public interface SerialPortDataListener
    extends EventListener
    - - -

    -This interface must be implemented to enable simple event-based serial port I/O. -

    - -

    -

    -
    See Also:
    EventListener
    -
    - -

    - +

    +
    com.fazecast.jSerialComm
    +

    Interface SerialPortDataListener

    +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    Returns:
    +
    The event constants that should trigger the serialEvent(SerialPortEvent) callback.
    +
    See Also:
    +
    SerialPort.LISTENING_EVENT_DATA_AVAILABLE, +SerialPort.LISTENING_EVENT_DATA_RECEIVED, +SerialPort.LISTENING_EVENT_DATA_WRITTEN
    +
    + + + + + + + + + + +
    + -
    - - - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    - - - + + diff --git a/javadoc/com/fazecast/jSerialComm/SerialPortEvent.html b/javadoc/com/fazecast/jSerialComm/SerialPortEvent.html index 520607e..ea513c2 100644 --- a/javadoc/com/fazecast/jSerialComm/SerialPortEvent.html +++ b/javadoc/com/fazecast/jSerialComm/SerialPortEvent.html @@ -1,390 +1,421 @@ - - - - - -SerialPortEvent (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; + + - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    -

    - -com.fazecast.jSerialComm -
    -Class SerialPortEvent

    -
    -java.lang.Object
    -  extended by java.util.EventObject
    -      extended by com.fazecast.jSerialComm.SerialPortEvent
    -
    -
    -
    All Implemented Interfaces:
    Serializable
    -
    -
    -
    -
    public final class SerialPortEvent
    extends EventObject
    - - -

    -This class describes an asynchronous serial port event. -

    - -

    -

    -
    See Also:
    EventObject, -Serialized Form
    -
    - -

    +

    +
    com.fazecast.jSerialComm
    +

    Class SerialPortEvent

    +
    +
    + +
    + +
    +
    + +
    +
    +
    +
    +
    Parameters:
    +
    comPort - The SerialPort about which this object is being created.
    +
    serialEventType - The type of serial port event that this object describes.
    +
    See Also:
    +
    SerialPort.LISTENING_EVENT_DATA_AVAILABLE, +SerialPort.LISTENING_EVENT_DATA_RECEIVED, +SerialPort.LISTENING_EVENT_DATA_WRITTEN
    +
    + + + + + +
    +
    +
    Parameters:
    +
    comPort - The SerialPort about which this object is being created.
    +
    serialEventType - The type of serial port event that this object describes.
    +
    data - The raw data bytes corresponding to this serial port event.
    +
    See Also:
    +
    SerialPort.LISTENING_EVENT_DATA_AVAILABLE, +SerialPort.LISTENING_EVENT_DATA_RECEIVED, +SerialPort.LISTENING_EVENT_DATA_WRITTEN
    +
    + + + + - - - - - - -
    -Method Detail
    - -

    -getSerialPort

    -
    -public final SerialPort getSerialPort()
    -
    -
    Returns the SerialPort that triggered this event. -

    -

    - -
    Returns:
    The SerialPort that triggered this event.
    -
    -
    -
    - -

    -getEventType

    -
    -public final int getEventType()
    -
    -
    Returns the type of serial port event that caused this object to be created. +
    -
    - -

    -getReceivedData

    -
    -public final byte[] getReceivedData()
    -
    -
    Returns any raw data bytes associated with this serial port event. -

    -

    - -
    Returns:
    Any data bytes associated with this serial port event or null if none exist.
    -
    -
    +      SerialPort.LISTENING_EVENT_DATA_AVAILABLE
    +      SerialPort.LISTENING_EVENT_DATA_RECEIVED
    +      SerialPort.LISTENING_EVENT_DATA_WRITTEN
    +

    +

    +
    Returns:
    +
    The serial port event that this object describes.
    +
    See Also:
    +
    SerialPort.LISTENING_EVENT_DATA_AVAILABLE, +SerialPort.LISTENING_EVENT_DATA_RECEIVED, +SerialPort.LISTENING_EVENT_DATA_WRITTEN
    +
    + + + + + + + + + + + + -
    - - - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    - - - + + diff --git a/javadoc/com/fazecast/jSerialComm/SerialPortPacketListener.html b/javadoc/com/fazecast/jSerialComm/SerialPortPacketListener.html index fda143d..cac5479 100644 --- a/javadoc/com/fazecast/jSerialComm/SerialPortPacketListener.html +++ b/javadoc/com/fazecast/jSerialComm/SerialPortPacketListener.html @@ -1,229 +1,244 @@ - - - - - -SerialPortPacketListener (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; + + - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    -

    - -com.fazecast.jSerialComm -
    -Interface SerialPortPacketListener

    -
    -
    All Superinterfaces:
    EventListener, SerialPortDataListener
    -
    -
    -
    -
    public interface SerialPortPacketListener
    extends SerialPortDataListener
    - - -

    -This interface must be implemented to enable full packet reads using event-based serial port I/O. +

    +
    com.fazecast.jSerialComm
    +

    Interface SerialPortPacketListener

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    -
    - - - - - - - - - - - - - - - - - - -
    - -
    - + + +
    + + +
    + + + - -
    - - - + + diff --git a/javadoc/com/fazecast/jSerialComm/package-frame.html b/javadoc/com/fazecast/jSerialComm/package-frame.html index 1aa76e9..4381acf 100644 --- a/javadoc/com/fazecast/jSerialComm/package-frame.html +++ b/javadoc/com/fazecast/jSerialComm/package-frame.html @@ -1,47 +1,26 @@ - - - - - -com.fazecast.jSerialComm (jSerialComm 1.3.3 API) - - - - - - - - - - - -com.fazecast.jSerialComm - - - - -
    -Interfaces  - -
    -SerialPortDataListener -
    -SerialPortPacketListener
    - - - - - - -
    -Classes  - -
    -SerialPort -
    -SerialPortEvent
    - - - - + + + + +com.fazecast.jSerialComm (jSerialComm 1.3.4 API) + + + + + +

    com.fazecast.jSerialComm

    +
    +

    Interfaces

    + +

    Classes

    + +
    + + diff --git a/javadoc/com/fazecast/jSerialComm/package-summary.html b/javadoc/com/fazecast/jSerialComm/package-summary.html index 8d7e105..cf2e3ce 100644 --- a/javadoc/com/fazecast/jSerialComm/package-summary.html +++ b/javadoc/com/fazecast/jSerialComm/package-summary.html @@ -1,175 +1,169 @@ - - - - - -com.fazecast.jSerialComm (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -

    -Package com.fazecast.jSerialComm -

    - - - - - - - - - - - - - -
    -Interface Summary
    SerialPortDataListenerThis interface must be implemented to enable simple event-based serial port I/O.
    SerialPortPacketListenerThis interface must be implemented to enable full packet reads using event-based serial port I/O.
    -  - -

    - - - - - - - - - - - - - -
    -Class Summary
    SerialPortThis class provides native access to serial ports and devices without requiring external libraries or tools.
    SerialPortEventThis class describes an asynchronous serial port event.
    -  - -

    -

    -
    -
    - - +
    +

    Package com.fazecast.jSerialComm

    +
    +
    + +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/com/fazecast/jSerialComm/package-tree.html b/javadoc/com/fazecast/jSerialComm/package-tree.html index 2025d3b..2c3eb71 100644 --- a/javadoc/com/fazecast/jSerialComm/package-tree.html +++ b/javadoc/com/fazecast/jSerialComm/package-tree.html @@ -1,158 +1,146 @@ - - - - - -com.fazecast.jSerialComm Class Hierarchy (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -Hierarchy For Package com.fazecast.jSerialComm -

    -
    -

    -Class Hierarchy -

    - -

    -Interface Hierarchy -

    - -
    - - +
    +

    Hierarchy For Package com.fazecast.jSerialComm

    +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html index 05169f7..78ae289 100644 --- a/javadoc/constant-values.html +++ b/javadoc/constant-values.html @@ -1,308 +1,310 @@ - - - - - -Constant Field Values (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -Constant Field Values

    -
    -
    -Contents - - - - - - -
    -com.fazecast.*
    - -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    com.fazecast.jSerialComm.SerialPort
    -public static final intEVEN_PARITY2
    -public static final intFLOW_CONTROL_CTS_ENABLED16
    -public static final intFLOW_CONTROL_DISABLED0
    -public static final intFLOW_CONTROL_DSR_ENABLED256
    -public static final intFLOW_CONTROL_DTR_ENABLED4096
    -public static final intFLOW_CONTROL_RTS_ENABLED1
    -public static final intFLOW_CONTROL_XONXOFF_IN_ENABLED65536
    -public static final intFLOW_CONTROL_XONXOFF_OUT_ENABLED1048576
    -public static final intLISTENING_EVENT_DATA_AVAILABLE1
    -public static final intLISTENING_EVENT_DATA_RECEIVED16
    -public static final intLISTENING_EVENT_DATA_WRITTEN256
    -public static final intMARK_PARITY3
    -public static final intNO_PARITY0
    -public static final intODD_PARITY1
    -public static final intONE_POINT_FIVE_STOP_BITS2
    -public static final intONE_STOP_BIT1
    -public static final intSPACE_PARITY4
    -public static final intTIMEOUT_NONBLOCKING0
    -public static final intTIMEOUT_READ_BLOCKING256
    -public static final intTIMEOUT_READ_SEMI_BLOCKING1
    -public static final intTIMEOUT_SCANNER65536
    -public static final intTIMEOUT_WRITE_BLOCKING4096
    -public static final intTIMEOUT_WRITE_SEMI_BLOCKING16
    -public static final intTWO_STOP_BITS3
    - -

    - -

    -


    - - +
    +

    Constant Field Values

    +

    Contents

    + +
    +
    + + +

    com.fazecast.*

    + +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html index df5d863..76f42de 100644 --- a/javadoc/deprecated-list.html +++ b/javadoc/deprecated-list.html @@ -1,142 +1,120 @@ - - - - - -Deprecated List (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -Deprecated API

    -
    -
    -Contents - -
    - - +
    +

    Deprecated API

    +

    Contents

    +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html index 3a935d4..c69ff47 100644 --- a/javadoc/help-doc.html +++ b/javadoc/help-doc.html @@ -1,209 +1,217 @@ - - - - - -API Help (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -How This API Document Is Organized

    -
    -This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    -Package

    -
    - -

    -Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    -
    -

    -Class/Interface

    -
    - -

    -Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    -Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    - -

    -Annotation Type

    -
    - -

    -Each annotation type has its own separate page with the following sections:

    -
    - -

    -Enum

    -
    - -

    -Each enum has its own separate page with the following sections:

    -
    -

    -Tree (Class Hierarchy)

    -
    -There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. -
    -

    -Deprecated API

    -
    -The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    -

    -Index

    -
    -The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    -

    -Prev/Next

    -These links take you to the next or previous class, interface, package, or related page.

    -Frames/No Frames

    -These links show and hide the HTML frames. All pages are available with or without frames. -

    -

    -Serialized Form

    -Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. -

    -

    -Constant Field Values

    -The Constant Field Values page lists the static final fields and their values. -

    - - -This help file applies to API documentation generated using the standard doclet. - -
    -


    - - +
    +

    How This API Document Is Organized

    +
    This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
    +
    +
    + +This help file applies to API documentation generated using the standard doclet.
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/index-all.html b/javadoc/index-all.html index 2e79686..8503e2e 100644 --- a/javadoc/index-all.html +++ b/javadoc/index-all.html @@ -1,381 +1,408 @@ - - - - - -Index (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -A B C E F G L M N O R S T W
    -

    -A

    -
    -
    addDataListener(SerialPortDataListener) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Adds a SerialPortDataListener to the serial port interface. -
    -
    -

    -B

    -
    -
    bytesAvailable() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Returns the number of bytes available without blocking if SerialPort.readBytes(byte[], long) were to be called immediately - after this method returns. -
    -
    -

    -C

    -
    -
    closePort() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Closes this serial port. -
    com.fazecast.jSerialComm - package com.fazecast.jSerialComm
     
    -
    -

    -E

    -
    -
    EVEN_PARITY - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -F

    -
    -
    FLOW_CONTROL_CTS_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_DISABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_DSR_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_DTR_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_RTS_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_XONXOFF_IN_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    FLOW_CONTROL_XONXOFF_OUT_ENABLED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -G

    -
    -
    getBaudRate() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the current baud rate of the serial port. -
    getCommPort(String) - -Static method in class com.fazecast.jSerialComm.SerialPort -
    Allocates a SerialPort object corresponding to the user-specified port descriptor. -
    getCommPorts() - -Static method in class com.fazecast.jSerialComm.SerialPort -
    Returns a list of all available serial ports on this machine. -
    getDescriptivePortName() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets a descriptive string representing this serial port or the device connected to it. -
    getEventType() - -Method in class com.fazecast.jSerialComm.SerialPortEvent -
    Returns the type of serial port event that caused this object to be created. -
    getFlowControlSettings() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Returns the flow control settings enabled on this serial port. -
    getInputStream() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Returns an InputStream object associated with this serial port. -
    getListeningEvents() - -Method in interface com.fazecast.jSerialComm.SerialPortDataListener -
    Must be overridden to return one or more desired event constants for which the SerialPortDataListener.serialEvent(SerialPortEvent) callback should be triggered. -
    getNumDataBits() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the current number of data bits per word. -
    getNumStopBits() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the current number of stop bits per word. -
    getOutputStream() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Returns an OutputStream object associated with this serial port. -
    getPacketSize() - -Method in interface com.fazecast.jSerialComm.SerialPortPacketListener -
    Must be overridden to return the desired number of bytes that must be read before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered. -
    getParity() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the current parity error-checking scheme. -
    getReadTimeout() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.readBytes(byte[],long) call. -
    getReceivedData() - -Method in class com.fazecast.jSerialComm.SerialPortEvent -
    Returns any raw data bytes associated with this serial port event. -
    getSerialPort() - -Method in class com.fazecast.jSerialComm.SerialPortEvent -
    Returns the SerialPort that triggered this event. -
    getSystemPortName() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the operating system-defined device name corresponding to this serial port. -
    getWriteTimeout() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.writeBytes(byte[],long) call. -
    -
    -

    -L

    -
    -
    LISTENING_EVENT_DATA_AVAILABLE - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    LISTENING_EVENT_DATA_RECEIVED - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    LISTENING_EVENT_DATA_WRITTEN - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -M

    -
    -
    MARK_PARITY - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -N

    -
    -
    NO_PARITY - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -O

    -
    -
    ODD_PARITY - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    ONE_POINT_FIVE_STOP_BITS - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    ONE_STOP_BIT - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    openPort() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Opens this serial port for reading and writing. -
    -
    -

    -R

    -
    -
    readBytes(byte[], long) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer. -
    removeDataListener() - -Method in class com.fazecast.jSerialComm.SerialPort -
    Removes the associated SerialPortDataListener from the serial port interface. -
    -
    -

    -S

    -
    -
    serialEvent(SerialPortEvent) - -Method in interface com.fazecast.jSerialComm.SerialPortDataListener -
    Called whenever one of the serial port events specified by the SerialPortDataListener.getListeningEvents() method occurs. -
    SerialPort - Class in com.fazecast.jSerialComm
    This class provides native access to serial ports and devices without requiring external libraries or tools.
    SerialPortDataListener - Interface in com.fazecast.jSerialComm
    This interface must be implemented to enable simple event-based serial port I/O.
    SerialPortEvent - Class in com.fazecast.jSerialComm
    This class describes an asynchronous serial port event.
    SerialPortEvent(SerialPort, int) - -Constructor for class com.fazecast.jSerialComm.SerialPortEvent -
    Constructs a SerialPortEvent object corresponding to the specified serial event type. -
    SerialPortEvent(SerialPort, int, byte[]) - -Constructor for class com.fazecast.jSerialComm.SerialPortEvent -
    Constructs a SerialPortEvent object corresponding to the specified serial event type and containing the passed-in data bytes. -
    SerialPortPacketListener - Interface in com.fazecast.jSerialComm
    This interface must be implemented to enable full packet reads using event-based serial port I/O.
    setBaudRate(int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets the desired baud rate for this serial port. -
    setComPortParameters(int, int, int, int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets all serial port parameters at one time. -
    setComPortTimeouts(int, int, int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets the serial port read and write timeout parameters. -
    setFlowControl(int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Specifies what kind of flow control to enable for this serial port. -
    setNumDataBits(int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets the desired number of data bits per word. -
    setNumStopBits(int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets the desired number of stop bits per word. -
    setParity(int) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Sets the desired parity error-detection scheme to be used. -
    SPACE_PARITY - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -T

    -
    -
    TIMEOUT_NONBLOCKING - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TIMEOUT_READ_BLOCKING - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TIMEOUT_READ_SEMI_BLOCKING - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TIMEOUT_SCANNER - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TIMEOUT_WRITE_BLOCKING - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TIMEOUT_WRITE_SEMI_BLOCKING - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    TWO_STOP_BITS - -Static variable in class com.fazecast.jSerialComm.SerialPort -
      -
    -
    -

    -W

    -
    -
    writeBytes(byte[], long) - -Method in class com.fazecast.jSerialComm.SerialPort -
    Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port. -
    -
    -A B C E F G L M N O R S T W - +
    A B C E F G L M N O R S T W  + + +

    A

    +
    +
    addDataListener(SerialPortDataListener) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Adds a SerialPortDataListener to the serial port interface.
    +
    +
    + + + +

    B

    +
    +
    bytesAvailable() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Returns the number of bytes available without blocking if SerialPort.readBytes(long, byte[], long) were to be called immediately + after this method returns.
    +
    +
    + + + +

    C

    +
    +
    closePort() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Closes this serial port.
    +
    +
    com.fazecast.jSerialComm - package com.fazecast.jSerialComm
    +
     
    +
    + + + +

    E

    +
    +
    EVEN_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    F

    +
    +
    FLOW_CONTROL_CTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_DISABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_DSR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_DTR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_RTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_XONXOFF_IN_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    FLOW_CONTROL_XONXOFF_OUT_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    G

    +
    +
    getBaudRate() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the current baud rate of the serial port.
    +
    +
    getCommPort(String) - Static method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Allocates a SerialPort object corresponding to the user-specified port descriptor.
    +
    +
    getCommPorts() - Static method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Returns a list of all available serial ports on this machine.
    +
    +
    getDescriptivePortName() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets a descriptive string representing this serial port or the device connected to it.
    +
    +
    getEventType() - Method in class com.fazecast.jSerialComm.SerialPortEvent
    +
    +
    Returns the type of serial port event that caused this object to be created.
    +
    +
    getFlowControlSettings() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Returns the flow control settings enabled on this serial port.
    +
    +
    getInputStream() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Returns an InputStream object associated with this serial port.
    +
    +
    getListeningEvents() - Method in interface com.fazecast.jSerialComm.SerialPortDataListener
    +
    +
    Must be overridden to return one or more desired event constants for which the SerialPortDataListener.serialEvent(SerialPortEvent) callback should be triggered.
    +
    +
    getNumDataBits() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the current number of data bits per word.
    +
    +
    getNumStopBits() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the current number of stop bits per word.
    +
    +
    getOutputStream() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Returns an OutputStream object associated with this serial port.
    +
    +
    getPacketSize() - Method in interface com.fazecast.jSerialComm.SerialPortPacketListener
    +
    +
    Must be overridden to return the desired number of bytes that must be read before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.
    +
    +
    getParity() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the current parity error-checking scheme.
    +
    +
    getReadTimeout() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.readBytes(byte[],long) call.
    +
    +
    getReceivedData() - Method in class com.fazecast.jSerialComm.SerialPortEvent
    +
    +
    Returns any raw data bytes associated with this serial port event.
    +
    +
    getSerialPort() - Method in class com.fazecast.jSerialComm.SerialPortEvent
    +
    +
    Returns the SerialPort that triggered this event.
    +
    +
    getSystemPortName() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the operating system-defined device name corresponding to this serial port.
    +
    +
    getWriteTimeout() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.writeBytes(byte[],long) call.
    +
    +
    + + + +

    L

    +
    +
    LISTENING_EVENT_DATA_AVAILABLE - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    LISTENING_EVENT_DATA_RECEIVED - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    LISTENING_EVENT_DATA_WRITTEN - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    M

    +
    +
    MARK_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    N

    +
    +
    NO_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    O

    +
    +
    ODD_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    ONE_POINT_FIVE_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    ONE_STOP_BIT - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    openPort() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Opens this serial port for reading and writing.
    +
    +
    + + + +

    R

    +
    +
    readBytes(byte[], long) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer.
    +
    +
    removeDataListener() - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Removes the associated SerialPortDataListener from the serial port interface.
    +
    +
    + + + +

    S

    +
    +
    serialEvent(SerialPortEvent) - Method in interface com.fazecast.jSerialComm.SerialPortDataListener
    +
    +
    Called whenever one of the serial port events specified by the SerialPortDataListener.getListeningEvents() method occurs.
    +
    +
    SerialPort - Class in com.fazecast.jSerialComm
    +
    +
    This class provides native access to serial ports and devices without requiring external libraries or tools.
    +
    +
    SerialPortDataListener - Interface in com.fazecast.jSerialComm
    +
    +
    This interface must be implemented to enable simple event-based serial port I/O.
    +
    +
    SerialPortEvent - Class in com.fazecast.jSerialComm
    +
    +
    This class describes an asynchronous serial port event.
    +
    +
    SerialPortEvent(SerialPort, int) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent
    +
    +
    Constructs a SerialPortEvent object corresponding to the specified serial event type.
    +
    +
    SerialPortEvent(SerialPort, int, byte[]) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent
    +
    +
    Constructs a SerialPortEvent object corresponding to the specified serial event type and containing the passed-in data bytes.
    +
    +
    SerialPortPacketListener - Interface in com.fazecast.jSerialComm
    +
    +
    This interface must be implemented to enable full packet reads using event-based serial port I/O.
    +
    +
    setBaudRate(int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets the desired baud rate for this serial port.
    +
    +
    setComPortParameters(int, int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets all serial port parameters at one time.
    +
    +
    setComPortTimeouts(int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets the serial port read and write timeout parameters.
    +
    +
    setFlowControl(int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Specifies what kind of flow control to enable for this serial port.
    +
    +
    setNumDataBits(int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets the desired number of data bits per word.
    +
    +
    setNumStopBits(int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets the desired number of stop bits per word.
    +
    +
    setParity(int) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Sets the desired parity error-detection scheme to be used.
    +
    +
    SPACE_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    T

    +
    +
    TIMEOUT_NONBLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TIMEOUT_READ_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TIMEOUT_READ_SEMI_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TIMEOUT_SCANNER - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TIMEOUT_WRITE_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TIMEOUT_WRITE_SEMI_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    TWO_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort
    +
     
    +
    + + + +

    W

    +
    +
    writeBytes(byte[], long) - Method in class com.fazecast.jSerialComm.SerialPort
    +
    +
    Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port.
    +
    +
    +A B C E F G L M N O R S T W 
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/index.html b/javadoc/index.html index 86856c1..1e05742 100644 --- a/javadoc/index.html +++ b/javadoc/index.html @@ -1,36 +1,71 @@ - - - - - -jSerialComm 1.3.3 API - - - - - - - - -<H2> -Frame Alert</H2> - -<P> -This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. -<BR> -Link to<A HREF="com/fazecast/jSerialComm/package-summary.html">Non-frame version.</A> - - - + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="com/fazecast/jSerialComm/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html index 5ede97d..638a29d 100644 --- a/javadoc/overview-tree.html +++ b/javadoc/overview-tree.html @@ -1,160 +1,150 @@ - - - - - -Class Hierarchy (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -Hierarchy For All Packages

    -
    -
    -
    Package Hierarchies:
    com.fazecast.jSerialComm
    -
    -

    -Class Hierarchy -

    - -

    -Interface Hierarchy -

    - -
    - - +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/resources/Thumbs.db b/javadoc/resources/Thumbs.db deleted file mode 100644 index bd8ac39..0000000 Binary files a/javadoc/resources/Thumbs.db and /dev/null differ diff --git a/javadoc/resources/inherit.gif b/javadoc/resources/inherit.gif deleted file mode 100644 index c814867..0000000 Binary files a/javadoc/resources/inherit.gif and /dev/null differ diff --git a/javadoc/script.js b/javadoc/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(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 = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html index 207ae1a..ed06d2c 100644 --- a/javadoc/serialized-form.html +++ b/javadoc/serialized-form.html @@ -1,187 +1,152 @@ - - - - - -Serialized Form (jSerialComm 1.3.3 API) - - - - - - - + + + - - - - - -
    - - + catch(err) { + } +//--> + + - - - - - - - - - - - - -
    - -
    - + + + + + - -
    -
    -

    -Serialized Form

    -
    -
    - - - - - -
    -Package com.fazecast.jSerialComm
    - -

    - - - - - -
    -Class com.fazecast.jSerialComm.SerialPortEvent extends EventObject implements Serializable
    - -

    -serialVersionUID: 3060830619653354150L - -

    - - - - - -
    -Serialized Fields
    - -

    -eventType

    -
    -int eventType
    -
    -
    -
    -
    -
    -

    -serialData

    -
    -byte[] serialData
    -
    -
    -
    -
    - -

    -


    - - +
    +

    Serialized Form

    +
    +
    + +
    - - - - - - - - - - - - -
    - -
    - + + + + + - -
    - - - + + diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css index 6ea9e51..cebb4fd 100644 --- a/javadoc/stylesheet.css +++ b/javadoc/stylesheet.css @@ -1,29 +1,574 @@ /* Javadoc style sheet */ +/* +Overall document style +*/ -/* Define colors, fonts and other style attributes here to override the defaults */ +@import url('resources/fonts/dejavu.css'); -/* Page background color */ -body { background-color: #FFFFFF; color:#000000 } +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +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; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; -/* Headings */ -h1 { font-size: 145% } +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} -/* Table colors */ -.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ -.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ -.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} -/* Font used in left-hand frame lists */ -.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } -.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } -.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} -/* Navigation bar fonts and colors */ -.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ -.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ -.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} -.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} +td.colLast div { + padding-top:0px; +} -.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} -.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +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; +}