TiUART

java.lang.Object
- tijos.framework.devicecenter.TiUART

```
public class TiUART
extends Object
```
The TiUART for devicecenter of framework.

Author:

Andy.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BUFF_READ` Read buffer
`static int`	`BUFF_WR` Write and read buffer
`static int`	`BUFF_WRITE` Write buffer
`static int`	`CONTROL_HARDWARE` Flow control hardware
`static int`	`CONTROL_NONE` Flow control none
`static int`	`CONTROL_SOFTWARE` Flow control software
`static int`	`PARITY_EVEN` Even parity mode
`static int`	`PARITY_NONE` None parity mode
`static int`	`PARITY_ODD` Odd parity mode
`static int`	`STOPBIT_0_5` 0.5 bit stop bit
`static int`	`STOPBIT_1` 1 bit stop bit
`static int`	`STOPBIT_1_5` 1.5 bits stop bit
`static int`	`STOPBIT_2` 2 bits stop bit

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()` Check read available
`void`	`clear(int buffer)` Clear the data buffer
`void`	`close()` Close the port of current object
`int`	`getPort()` Gets the port id of current object
`static TiUART`	`open(int portID)` Open the TiUART port by port id, and return the object NOTE1: control is CONTROL_NONE, that is default flow control type NOTE2: remapID is 0, that is default location
`static TiUART`	`openRemap(int portID, int control, int remapID)` Open the TiUART port by port id, flow control type and remap id, and return the object
`static int`	`portNumber()` Maximum number of port supported
`int`	`read(byte[] data, int offset, int len)` Read date from receive data buffer
`void`	`setWorkParameters(int dataBitNum, int stopBitNum, int parity, int baudRate)` Set work parameters
`int`	`write(byte[] data, int offset, int len)` Write date to send data buffer

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

- Field Detail
  - BUFF_READ
```
public static final int BUFF_READ
```
    Read buffer
    
    See Also:
    
    Constant Field Values
  - BUFF_WR
```
public static final int BUFF_WR
```
    Write and read buffer
    
    See Also:
    
    Constant Field Values
  - BUFF_WRITE
```
public static final int BUFF_WRITE
```
    Write buffer
    
    See Also:
    
    Constant Field Values
  - CONTROL_HARDWARE
```
public static final int CONTROL_HARDWARE
```
    Flow control hardware
    
    See Also:
    
    Constant Field Values
  - CONTROL_NONE
```
public static final int CONTROL_NONE
```
    Flow control none
    
    See Also:
    
    Constant Field Values
  - CONTROL_SOFTWARE
```
public static final int CONTROL_SOFTWARE
```
    Flow control software
    
    See Also:
    
    Constant Field Values
  - PARITY_EVEN
```
public static final int PARITY_EVEN
```
    Even parity mode
    
    See Also:
    
    Constant Field Values
  - PARITY_NONE
```
public static final int PARITY_NONE
```
    None parity mode
    
    See Also:
    
    Constant Field Values
  - PARITY_ODD
```
public static final int PARITY_ODD
```
    Odd parity mode
    
    See Also:
    
    Constant Field Values
  - STOPBIT_0_5
```
public static final int STOPBIT_0_5
```
    0.5 bit stop bit
    
    See Also:
    
    Constant Field Values
  - STOPBIT_1
```
public static final int STOPBIT_1
```
    1 bit stop bit
    
    See Also:
    
    Constant Field Values
  - STOPBIT_1_5
```
public static final int STOPBIT_1_5
```
    1.5 bits stop bit
    
    See Also:
    
    Constant Field Values
  - STOPBIT_2
```
public static final int STOPBIT_2
```
    2 bits stop bit
    
    See Also:
    
    Constant Field Values
- Method Detail
  - available
```
public int available()
              throws IOException
```
    Check read available
    
    Returns:
    
    available length
    
    Throws:
    
    IOException - If a TiUART error occurs
  - clear
```
public void clear(int buffer)
           throws IOException
```
    Clear the data buffer
    
    Parameters:
    
    buffer - data buffer type,
    BUFF_READ: read buffer
    BUFF_WRITE: write buffer
    BUFF_WR: write and read buffer
    
    Throws:
    
    IOException - If a TiUART error occurs
  - close
```
public void close()
           throws IOException
```
    Close the port of current object
    
    Throws:
    
    IOException - If a TiUART error occurs
  - getPort
```
public int getPort()
```
    Gets the port id of current object
    
    Returns:
    
    the port id
  - open
```
public static TiUART open(int portID)
                   throws IOException
```
    Open the TiUART port by port id, and return the object
    NOTE1: control is CONTROL_NONE, that is default flow control type
    NOTE2: remapID is 0, that is default location
    
    Parameters:
    
    portID - port id
    
    Returns:
    
    TiUART object
    
    Throws:
    
    IOException - If a TiUART error occurs
  - openRemap
```
public static TiUART openRemap(int portID,
                               int control,
                               int remapID)
                        throws IOException
```
    Open the TiUART port by port id, flow control type and remap id, and return the object
    
    Parameters:
    
    portID - port id
    
    control - flow control type,
    CONTROL_NONE: none, default
    CONTROL_HARDWARE: RTS/CTS(hardware mode)
    FCONTROL_SOFTWARE: xON/xOFF(software mode)
    
    remapID - the remap Id, range:0-3
    
    Returns:
    
    the opened TiUART object
    
    Throws:
    
    IOException - If a TiUART error occurs
  - portNumber
```
public static int portNumber()
```
    Maximum number of port supported
    
    Returns:
    
    number
  - read
```
public int read(byte[] data,
                int offset,
                int len)
         throws IOException
```
    Read date from receive data buffer
    
    Parameters:
    
    data - data array
    
    offset - data offset
    
    len - data length
    
    Returns:
    
    read length, >0 data length, 0:none
    
    Throws:
    
    IOException - If a TiUART error occurs
    
    NullPointerException - If data is null
    
    ArrayIndexOutOfBoundsException - If array index out of range
  - setWorkParameters
```
public void setWorkParameters(int dataBitNum,
                              int stopBitNum,
                              int parity,
                              int baudRate)
                       throws IOException
```
    Set work parameters
    
    Parameters:
    
    dataBitNum - data bit number,
    5:5bits
    6:6bits
    7:7bits
    8:8bits, default
    9:9bits
    
    stopBitNum - stop bit number,
    STOPBIT_1, default
    STOPBIT_2,
    STOPBIT_0_5,
    STOPBIT_1_5
    
    parity - data parity type,
    PARITY_NONE: none, default
    PARITY_ODD: odd
    PARITY_EVEN: even
    
    baudRate - data baud rate
    1200:1200bps
    2400:2400bps
    4800:4800bps
    9600:9600bps, default
    19200:19200bps
    ....:....
    
    Throws:
    
    IOException - If a TiUART error occurs
  - write
```
public int write(byte[] data,
                 int offset,
                 int len)
          throws IOException
```
    Write date to send data buffer
    
    Parameters:
    
    data - data array
    
    offset - data offset
    
    len - data length
    
    Returns:
    
    write length
    
    Throws:
    
    IOException - If a TiUART error occurs
    
    NullPointerException - If data is null
    
    ArrayIndexOutOfBoundsException - If array index out of range

Class TiUART

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUFF_READ

BUFF_WR

BUFF_WRITE

CONTROL_HARDWARE

CONTROL_NONE

CONTROL_SOFTWARE

PARITY_EVEN

PARITY_NONE

PARITY_ODD

STOPBIT_0_5

STOPBIT_1

STOPBIT_1_5

STOPBIT_2

Method Detail

available

clear

close

getPort

open

openRemap

portNumber

read

setWorkParameters

write