JTermios (Modbus Javacomm 1.6 API)

java.lang.Object
- com.sparetimelabs.serial.termios.JTermios

```
public class JTermios
extends Object
```
JTermios provides a limited cross platform unix termios type interface to serial ports.

Author:

nyholku

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JTermios.FDSet` The interface Fd set.
`static interface`	`JTermios.JTermiosInterface` The interface J termios interface.
`static class`	`JTermios.JTermiosLogging` The type J termios logging.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`B0` The constant B0.
`static int`	`B110` The constant B110.
`static int`	`B115200` The constant B115200.
`static int`	`B1200` The constant B1200.
`static int`	`B134` The constant B134.
`static int`	`B14400` The constant B14400.
`static int`	`B150` The constant B150.
`static int`	`B1800` The constant B1800.
`static int`	`B19200` The constant B19200.
`static int`	`B200` The constant B200.
`static int`	`B230400` The constant B230400.
`static int`	`B2400` The constant B2400.
`static int`	`B28800` The constant B28800.
`static int`	`B300` The constant B300.
`static int`	`B38400` The constant B38400.
`static int`	`B4800` The constant B4800.
`static int`	`B50` The constant B50.
`static int`	`B57600` The constant B57600.
`static int`	`B600` The constant B600.
`static int`	`B7200` The constant B7200.
`static int`	`B75` The constant B75.
`static int`	`B76800` The constant B76800.
`static int`	`B9600` The constant B9600.
`static int`	`BRKINT` The constant BRKINT.
`static int`	`CLOCAL` The constant CLOCAL.
`static int`	`CMSPAR` The constant CMSPAR.
`static int`	`CREAD` The constant CREAD.
`static int`	`CRTSCTS` The constant CRTSCTS.
`static int`	`CS5` The constant CS5.
`static int`	`CS6` The constant CS6.
`static int`	`CS7` The constant CS7.
`static int`	`CS8` The constant CS8.
`static int`	`CSIZE` The constant CSIZE.
`static int`	`CSTOPB` The constant CSTOPB.
`static int`	`DC1` The constant DC1.
`static int`	`DC3` The constant DC3.
`static int`	`EACCES` The constant EACCES.
`static int`	`EAGAIN` The constant EAGAIN.
`static int`	`EBADF` The constant EBADF.
`static int`	`EBUSY` The constant EBUSY.
`static int`	`ECHO` The constant ECHO.
`static int`	`ECHOE` The constant ECHOE.
`static int`	`ECHONL` The constant ECHONL.
`static int`	`EEXIST` The constant EEXIST.
`static int`	`EINTR` The constant EINTR.
`static int`	`EINVAL` The constant EINVAL.
`static int`	`EIO` The constant EIO.
`static int`	`EISDIR` The constant EISDIR.
`static int`	`ELOOP` The constant ELOOP.
`static int`	`EMFILE` The constant EMFILE.
`static int`	`ENAMETOOLONG` The constant ENAMETOOLONG.
`static int`	`ENFILE` The constant ENFILE.
`static int`	`ENOENT` The constant ENOENT.
`static int`	`ENOSPC` The constant ENOSPC.
`static int`	`ENOSR` The constant ENOSR.
`static int`	`ENOTDIR` The constant ENOTDIR.
`static int`	`ENOTSUP` The constant ENOTSUP.
`static int`	`ENOTTY` The constant ENOTTY.
`static int`	`ENXIO` The constant ENXIO.
`static int`	`EOVERFLOW` The constant EOVERFLOW.
`static int`	`EROFS` The constant EROFS.
`static int`	`F_GETFL` The constant F_GETFL.
`static int`	`F_SETFL` The constant F_SETFL.
`static int`	`FIONREAD` The constant FIONREAD.
`static int`	`ICANON` The constant ICANON.
`static int`	`ICRNL` The constant ICRNL.
`static int`	`IEXTEN` The constant IEXTEN.
`static int`	`IGNBRK` The constant IGNBRK.
`static int`	`IGNCR` The constant IGNCR.
`static int`	`IGNPAR` The constant IGNPAR.
`static int`	`INLCR` The constant INLCR.
`static int`	`INPCK` The constant INPCK.
`static int`	`ISIG` The constant ISIG.
`static int`	`ISTRIP` The constant ISTRIP.
`static int`	`IXANY` The constant IXANY.
`static int`	`IXOFF` The constant IXOFF.
`static int`	`IXON` The constant IXON.
`static int`	`O_CREAT` The constant O_CREAT.
`static int`	`O_NDELAY` The constant O_NDELAY.
`static int`	`O_NOCTTY` The constant O_NOCTTY.
`static int`	`O_NONBLOCK` The constant O_NONBLOCK.
`static int`	`O_RDWR` The constant O_RDWR.
`static int`	`OPOST` The constant OPOST.
`static int`	`PARENB` The constant PARENB.
`static int`	`PARMRK` The constant PARMRK.
`static int`	`PARODD` The constant PARODD.
`static short`	`POLLERR` The constant POLLERR.
`static short`	`POLLERR_OUT` The constant POLLERR_OUT.
`static short`	`POLLIN` The constant POLLIN.
`static short`	`POLLNVAL` The constant POLLNVAL.
`static int`	`POLLNVAL_OUT` The constant POLLNVAL_OUT.
`static short`	`POLLOUT` The constant POLLOUT.
`static short`	`POLLPRI` The constant POLLPRI.
`static int`	`TCIFLUSH` The constant TCIFLUSH.
`static int`	`TCIOFLUSH` The constant TCIOFLUSH.
`static int`	`TCOFLUSH` The constant TCOFLUSH.
`static int`	`TCSADRAIN` The constant TCSADRAIN.
`static int`	`TCSANOW` The constant TCSANOW.
`static int`	`TIOCM_CAR` The constant TIOCM_CAR.
`static int`	`TIOCM_CD` The constant TIOCM_CD.
`static int`	`TIOCM_CTS` The constant TIOCM_CTS.
`static int`	`TIOCM_DSR` The constant TIOCM_DSR.
`static int`	`TIOCM_DTR` The constant TIOCM_DTR.
`static int`	`TIOCM_RI` The constant TIOCM_RI.
`static int`	`TIOCM_RNG` The constant TIOCM_RNG.
`static int`	`TIOCM_RTS` The constant TIOCM_RTS.
`static int`	`TIOCMGET` The constant TIOCMGET.
`static int`	`TIOCMSET` The constant TIOCMSET.
`static int`	`VEOF` The constant VEOF.
`static int`	`VMIN` The constant VMIN.
`static int`	`VSTART` The constant VSTART.
`static int`	`VSTOP` The constant VSTOP.
`static int`	`VTIME` The constant VTIME.

Constructor Summary

Constructors
Constructor and Description

JTermios()

Constructors
Constructor and Description
`JTermios()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canPoll()` Can poll boolean.
`static int`	`cfgetispeed(Termios termios)` Cfgetispeed int.
`static int`	`cfgetospeed(Termios termios)` Cfgetospeed int.
`static void`	`cfmakeraw(int fd, Termios termios)` Cfmakeraw.
`static int`	`cfsetispeed(Termios termios, int speed)` Cfsetispeed int.
`static int`	`cfsetospeed(Termios termios, int speed)` Cfsetospeed int.
`static int`	`close(int fd)` Close int.
`static int`	`errno()` Errno int.
`static int`	`fcntl(int fd, int cmd, int arg)` Fcntl int.
`static void`	`FD_CLR(int fd, JTermios.FDSet set)` Fd clr.
`static boolean`	`FD_ISSET(int fd, JTermios.FDSet set)` Fd isset boolean.
`static void`	`FD_SET(int fd, JTermios.FDSet set)` Fd set.
`static void`	`FD_ZERO(JTermios.FDSet set)` Fd zero.
`static List<String>`	`getPortList()` Gets port list.
`static Pattern`	`getPortNamePattern(JTermios.JTermiosInterface jtermios)` Gets port name pattern.
`static int`	`ioctl(int fd, int cmd, int... data)` Ioctl int.
`static JTermios.FDSet`	`newFDSet()` New fd set fd set.
`static int`	`open(String s, int t)` Open int.
`static void`	`perror(String msg)` Perror.
`static int`	`pipe(int[] fds)` Pipe int.
`static int`	`poll(JTermios.JTermiosInterface.Pollfd[] fds, int nfds, int timeout)` Poll int.
`static int`	`read(int fd, byte[] buffer, int len)` Read int.
`static int`	`select(int n, JTermios.FDSet read, JTermios.FDSet write, JTermios.FDSet error, TimeVal timeout)` Unlike Linux select this does not modify 'timeout' so it can be re-used.
`static int`	`setspeed(int fd, Termios termios, int speed)` Sets .
`void`	`shutdown()` Shutdown.
`static int`	`tcdrain(int fd)` Tcdrain int.
`static int`	`tcflush(int a, int b)` Tcflush int.
`static int`	`tcgetattr(int fd, Termios termios)` Tcgetattr int.
`static int`	`tcsendbreak(int fd, int duration)` Tcsendbreak int.
`static int`	`tcsetattr(int fd, int cmd, Termios termios)` Tcsetattr int.
`static int`	`write(int fd, byte[] buffer, int len)` Write int.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- FIONREAD
```
public static int FIONREAD
```
  The constant FIONREAD.
- O_RDWR
```
public static int O_RDWR
```
  The constant O_RDWR.
- O_NONBLOCK
```
public static int O_NONBLOCK
```
  The constant O_NONBLOCK.
- O_NOCTTY
```
public static int O_NOCTTY
```
  The constant O_NOCTTY.
- O_NDELAY
```
public static int O_NDELAY
```
  The constant O_NDELAY.
- O_CREAT
```
public static int O_CREAT
```
  The constant O_CREAT.
- F_GETFL
```
public static int F_GETFL
```
  The constant F_GETFL.
- F_SETFL
```
public static int F_SETFL
```
  The constant F_SETFL.
- EAGAIN
```
public static int EAGAIN
```
  The constant EAGAIN.
- EBADF
```
public static int EBADF
```
  The constant EBADF.
- EACCES
```
public static int EACCES
```
  The constant EACCES.
- EEXIST
```
public static int EEXIST
```
  The constant EEXIST.
- EINTR
```
public static int EINTR
```
  The constant EINTR.
- EINVAL
```
public static int EINVAL
```
  The constant EINVAL.
- EIO
```
public static int EIO
```
  The constant EIO.
- EISDIR
```
public static int EISDIR
```
  The constant EISDIR.
- ELOOP
```
public static int ELOOP
```
  The constant ELOOP.
- EMFILE
```
public static int EMFILE
```
  The constant EMFILE.
- ENAMETOOLONG
```
public static int ENAMETOOLONG
```
  The constant ENAMETOOLONG.
- ENFILE
```
public static int ENFILE
```
  The constant ENFILE.
- ENOENT
```
public static int ENOENT
```
  The constant ENOENT.
- ENOSR
```
public static int ENOSR
```
  The constant ENOSR.
- ENOSPC
```
public static int ENOSPC
```
  The constant ENOSPC.
- ENOTDIR
```
public static int ENOTDIR
```
  The constant ENOTDIR.
- ENXIO
```
public static int ENXIO
```
  The constant ENXIO.
- EOVERFLOW
```
public static int EOVERFLOW
```
  The constant EOVERFLOW.
- EROFS
```
public static int EROFS
```
  The constant EROFS.
- ENOTSUP
```
public static int ENOTSUP
```
  The constant ENOTSUP.
- EBUSY
```
public static int EBUSY
```
  The constant EBUSY.
- ENOTTY
```
public static int ENOTTY
```
  The constant ENOTTY.
- TIOCM_RNG
```
public static int TIOCM_RNG
```
  The constant TIOCM_RNG.
- TIOCM_CAR
```
public static int TIOCM_CAR
```
  The constant TIOCM_CAR.
- IGNBRK
```
public static int IGNBRK
```
  The constant IGNBRK.
- BRKINT
```
public static int BRKINT
```
  The constant BRKINT.
- IGNPAR
```
public static int IGNPAR
```
  The constant IGNPAR.
- PARMRK
```
public static int PARMRK
```
  The constant PARMRK.
- INLCR
```
public static int INLCR
```
  The constant INLCR.
- IGNCR
```
public static int IGNCR
```
  The constant IGNCR.
- ICRNL
```
public static int ICRNL
```
  The constant ICRNL.
- ECHONL
```
public static int ECHONL
```
  The constant ECHONL.
- IEXTEN
```
public static int IEXTEN
```
  The constant IEXTEN.
- CLOCAL
```
public static int CLOCAL
```
  The constant CLOCAL.
- OPOST
```
public static int OPOST
```
  The constant OPOST.
- VSTART
```
public static int VSTART
```
  The constant VSTART.
- TCSANOW
```
public static int TCSANOW
```
  The constant TCSANOW.
- VSTOP
```
public static int VSTOP
```
  The constant VSTOP.
- VMIN
```
public static int VMIN
```
  The constant VMIN.
- VTIME
```
public static int VTIME
```
  The constant VTIME.
- VEOF
```
public static int VEOF
```
  The constant VEOF.
- TIOCMGET
```
public static int TIOCMGET
```
  The constant TIOCMGET.
- TIOCM_CTS
```
public static int TIOCM_CTS
```
  The constant TIOCM_CTS.
- TIOCM_DSR
```
public static int TIOCM_DSR
```
  The constant TIOCM_DSR.
- TIOCM_RI
```
public static int TIOCM_RI
```
  The constant TIOCM_RI.
- TIOCM_CD
```
public static int TIOCM_CD
```
  The constant TIOCM_CD.
- TIOCM_DTR
```
public static int TIOCM_DTR
```
  The constant TIOCM_DTR.
- TIOCM_RTS
```
public static int TIOCM_RTS
```
  The constant TIOCM_RTS.
- ICANON
```
public static int ICANON
```
  The constant ICANON.
- ECHO
```
public static int ECHO
```
  The constant ECHO.
- ECHOE
```
public static int ECHOE
```
  The constant ECHOE.
- ISIG
```
public static int ISIG
```
  The constant ISIG.
- TIOCMSET
```
public static int TIOCMSET
```
  The constant TIOCMSET.
- IXON
```
public static int IXON
```
  The constant IXON.
- IXOFF
```
public static int IXOFF
```
  The constant IXOFF.
- IXANY
```
public static int IXANY
```
  The constant IXANY.
- CRTSCTS
```
public static int CRTSCTS
```
  The constant CRTSCTS.
- TCSADRAIN
```
public static int TCSADRAIN
```
  The constant TCSADRAIN.
- INPCK
```
public static int INPCK
```
  The constant INPCK.
- ISTRIP
```
public static int ISTRIP
```
  The constant ISTRIP.
- CSIZE
```
public static int CSIZE
```
  The constant CSIZE.
- TCIFLUSH
```
public static int TCIFLUSH
```
  The constant TCIFLUSH.
- TCOFLUSH
```
public static int TCOFLUSH
```
  The constant TCOFLUSH.
- TCIOFLUSH
```
public static int TCIOFLUSH
```
  The constant TCIOFLUSH.
- CS5
```
public static int CS5
```
  The constant CS5.
- CS6
```
public static int CS6
```
  The constant CS6.
- CS7
```
public static int CS7
```
  The constant CS7.
- CS8
```
public static int CS8
```
  The constant CS8.
- CSTOPB
```
public static int CSTOPB
```
  The constant CSTOPB.
- CREAD
```
public static int CREAD
```
  The constant CREAD.
- PARENB
```
public static int PARENB
```
  The constant PARENB.
- PARODD
```
public static int PARODD
```
  The constant PARODD.
- CMSPAR
```
public static int CMSPAR
```
  The constant CMSPAR.
- B0
```
public static int B0
```
  The constant B0.
- B50
```
public static int B50
```
  The constant B50.
- B75
```
public static int B75
```
  The constant B75.
- B110
```
public static int B110
```
  The constant B110.
- B134
```
public static int B134
```
  The constant B134.
- B150
```
public static int B150
```
  The constant B150.
- B200
```
public static int B200
```
  The constant B200.
- B300
```
public static int B300
```
  The constant B300.
- B600
```
public static int B600
```
  The constant B600.
- B1200
```
public static int B1200
```
  The constant B1200.
- B1800
```
public static int B1800
```
  The constant B1800.
- B2400
```
public static int B2400
```
  The constant B2400.
- B4800
```
public static int B4800
```
  The constant B4800.
- B9600
```
public static int B9600
```
  The constant B9600.
- B19200
```
public static int B19200
```
  The constant B19200.
- B38400
```
public static int B38400
```
  The constant B38400.
- B7200
```
public static int B7200
```
  The constant B7200.
- B14400
```
public static int B14400
```
  The constant B14400.
- B28800
```
public static int B28800
```
  The constant B28800.
- B57600
```
public static int B57600
```
  The constant B57600.
- B76800
```
public static int B76800
```
  The constant B76800.
- B115200
```
public static int B115200
```
  The constant B115200.
- B230400
```
public static int B230400
```
  The constant B230400.
- POLLIN
```
public static short POLLIN
```
  The constant POLLIN.
- POLLPRI
```
public static short POLLPRI
```
  The constant POLLPRI.
- POLLOUT
```
public static short POLLOUT
```
  The constant POLLOUT.
- POLLERR
```
public static short POLLERR
```
  The constant POLLERR.
- POLLERR_OUT
```
public static short POLLERR_OUT
```
  The constant POLLERR_OUT.
- POLLNVAL
```
public static short POLLNVAL
```
  The constant POLLNVAL.
- POLLNVAL_OUT
```
public static int POLLNVAL_OUT
```
  The constant POLLNVAL_OUT.
- DC1
```
public static int DC1
```
  The constant DC1.
- DC3
```
public static int DC3
```
  The constant DC3.

Constructor Detail
- JTermios
```
public JTermios()
```

Method Detail

shutdown
```
public void shutdown()
```
Shutdown.

errno
```
public static int errno()
```
Errno int.

Returns:

the int

fcntl

public static int fcntl(int fd,
                        int cmd,
                        int arg)

Fcntl int.

Parameters:: fd - the fd; cmd - the cmd; arg - the arg
Returns:: the int

cfgetispeed
```
public static int cfgetispeed(Termios termios)
```
Cfgetispeed int.

Parameters:

termios - the termios

Returns:

the int

cfgetospeed
```
public static int cfgetospeed(Termios termios)
```
Cfgetospeed int.

Parameters:

termios - the termios

Returns:

the int

cfsetispeed

public static int cfsetispeed(Termios termios,
                              int speed)

Cfsetispeed int.

Parameters:: termios - the termios; speed - the speed
Returns:: the int

cfsetospeed

public static int cfsetospeed(Termios termios,
                              int speed)

Cfsetospeed int.

Parameters:: termios - the termios; speed - the speed
Returns:: the int

setspeed

public static int setspeed(int fd,
                           Termios termios,
                           int speed)

Sets .

Parameters:: fd - the fd; termios - the termios; speed - the speed
Returns:: the

tcflush

public static int tcflush(int a,
                          int b)

Tcflush int.

Parameters:: a - the a; b - the b
Returns:: the int

tcdrain
```
public static int tcdrain(int fd)
```
Tcdrain int.

Parameters:

fd - the fd

Returns:

the int

cfmakeraw

public static void cfmakeraw(int fd,
                             Termios termios)

Cfmakeraw.

Parameters:: fd - the fd; termios - the termios

tcgetattr

public static int tcgetattr(int fd,
                            Termios termios)

Tcgetattr int.

Parameters:: fd - the fd; termios - the termios
Returns:: the int

tcsetattr

public static int tcsetattr(int fd,
                            int cmd,
                            Termios termios)

Tcsetattr int.

Parameters:: fd - the fd; cmd - the cmd; termios - the termios
Returns:: the int

tcsendbreak

public static int tcsendbreak(int fd,
                              int duration)

Tcsendbreak int.

Parameters:: fd - the fd; duration - the duration
Returns:: the int

open

public static int open(String s,
                       int t)

Open int.

Parameters:: s - the s; t - the t
Returns:: the int

close
```
public static int close(int fd)
```
Close int.

Parameters:

fd - the fd

Returns:

the int

write

public static int write(int fd,
                        byte[] buffer,
                        int len)

Write int.

Parameters:: fd - the fd; buffer - the buffer; len - the len
Returns:: the int

read

public static int read(int fd,
                       byte[] buffer,
                       int len)

Read int.

Parameters:: fd - the fd; buffer - the buffer; len - the len
Returns:: the int

ioctl

public static int ioctl(int fd,
                        int cmd,
                        int... data)

Ioctl int.

Parameters:: fd - the fd; cmd - the cmd; data - the data
Returns:: the int

select

public static int select(int n,
                         JTermios.FDSet read,
                         JTermios.FDSet write,
                         JTermios.FDSet error,
                         TimeVal timeout)

Unlike Linux select this does not modify 'timeout' so it can be re-used.

Parameters:: n - the n; read - the read; write - the write; error - the error; timeout - the timeout
Returns:: the int

poll

public static int poll(JTermios.JTermiosInterface.Pollfd[] fds,
                       int nfds,
                       int timeout)

Poll int.

Parameters:: fds - the fds; nfds - the nfds; timeout - the timeout
Returns:: the int

canPoll
```
public static boolean canPoll()
```
Can poll boolean.

Returns:

the boolean

pipe
```
public static int pipe(int[] fds)
```
Pipe int.

Parameters:

fds - the fds

Returns:

the int

perror

public static void perror(String msg)

Perror.

Parameters:: msg - the msg

newFDSet

public static JTermios.FDSet newFDSet()

New fd set fd set.

Returns:: the fd set

FD_SET

public static void FD_SET(int fd,
                          JTermios.FDSet set)

Fd set.

Parameters:: fd - the fd; set - the set

FD_CLR

public static void FD_CLR(int fd,
                          JTermios.FDSet set)

Fd clr.

Parameters:: fd - the fd; set - the set

FD_ISSET

public static boolean FD_ISSET(int fd,
                               JTermios.FDSet set)

Fd isset boolean.

Parameters:: fd - the fd; set - the set
Returns:: the boolean

FD_ZERO

public static void FD_ZERO(JTermios.FDSet set)

Fd zero.

Parameters:: set - the set

getPortList
```
public static List<String> getPortList()
```
Gets port list.

Returns:

the port list

getPortNamePattern
```
public static Pattern getPortNamePattern(JTermios.JTermiosInterface jtermios)
```
Gets port name pattern.

Parameters:

jtermios - the jtermios

Returns:

the port name pattern

Class JTermios

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIONREAD

O_RDWR

O_NONBLOCK

O_NOCTTY

O_NDELAY

O_CREAT

F_GETFL

F_SETFL

EAGAIN

EBADF

EACCES

EEXIST

EINTR

EINVAL

EIO

EISDIR

ELOOP

EMFILE

ENAMETOOLONG

ENFILE

ENOENT

ENOSR

ENOSPC

ENOTDIR

ENXIO

EOVERFLOW

EROFS

ENOTSUP

EBUSY

ENOTTY

TIOCM_RNG

TIOCM_CAR

IGNBRK

BRKINT

IGNPAR

PARMRK

INLCR

IGNCR

ICRNL

ECHONL

IEXTEN

CLOCAL

OPOST

VSTART

TCSANOW

VSTOP

VMIN

VTIME

VEOF

TIOCMGET

TIOCM_CTS

TIOCM_DSR

TIOCM_RI

TIOCM_CD

TIOCM_DTR

TIOCM_RTS

ICANON

ECHO

ECHOE

ISIG

TIOCMSET

IXON

IXOFF

IXANY

CRTSCTS

TCSADRAIN

INPCK

ISTRIP

CSIZE

TCIFLUSH

TCOFLUSH

TCIOFLUSH

CS5