com.iotize.jvm.hal

Class Uart

java.lang.Object

com.iotize.jvm.hal.Uart

public class Uart
extends java.lang.Object

IoTize class to manage the UART interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CTS Helper for the flowControl parameter
static int	EVEN Helper for the parity parameter
static int	NONE Helper for the parity and flowControl parameters
static int	ODD Helper for the parity parameter
static int	RTS Helper for the flowControl parameter
static int	RTS_CTS Helper for the flowControl parameter
static int	UART_ID_HOST Helper for the uartId parameter
static int	UART_ID_TARGET Helper for the uartId parameter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Uart() Used in the derived ModbusRTU class Reserved for IoTize
	Uart(int baudRate, int dataLength, int numberOfStopBits, int parity) Creates a new UART interface, with the Tap as the UART host.
	Uart(int baudRate, int dataLength, int numberOfStopBits, int parity, int flowControl, int uartId) Creates a new UART interface, with the Tap as the UART host.

Method Summary

Modifier and Type	Method and Description
void	flushRecBuffer() Flushes the reception buffer.
void	format(java.lang.String format, java.lang.Object... args) Sends a formatted string to the UART.
int	getBytes(byte[] buffer, int maxNumberOfBytes, int timeout) Gets all data bytes until the the maximum number of bytes is reached or timeout has occured.
int	getChar() Read one char on the UART connection.
int	getCountRec()
int	sendBytes(byte[] buffer) Sends the given buffer on the UART connection.
void	sendChar(byte val) Sends one char on the UART connection
void	setMode(int baudRate, int dataLength, int numberOfStopBits, int parity, int flowControl) Sets the current UART connection with the provided communication parameters.The parity and flowControl parameters can be set with the following helpers: Parity Uart.NONE Uart.ODD Uart.EVEN Flow Control Uart.NONE Uart.RTS Uart.CTS Uart.RTS_CTS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

Helper for the parity and flowControl parameters

See Also:

Constant Field Values

ODD

public static final int ODD

Helper for the parity parameter

See Also:

Constant Field Values

EVEN

public static final int EVEN

Helper for the parity parameter

See Also:

Constant Field Values

RTS

public static final int RTS

Helper for the flowControl parameter

See Also:

Constant Field Values

CTS

public static final int CTS

Helper for the flowControl parameter

See Also:

Constant Field Values

RTS_CTS

public static final int RTS_CTS

Helper for the flowControl parameter

See Also:

Constant Field Values

UART_ID_TARGET

public static final int UART_ID_TARGET

Helper for the uartId parameter

See Also:

Constant Field Values

UART_ID_HOST

public static final int UART_ID_HOST

Helper for the uartId parameter

See Also:

Constant Field Values

Constructor Detail

Uart

public Uart(int baudRate,
            int dataLength,
            int numberOfStopBits,
            int parity)

Creates a new UART interface, with the Tap as the UART host. The parity parameter can be set with the following helpers:

• Uart.NONE
• Uart.ODD
• Uart.EVEN

Parameters:

baudRate - the baud rate of the connection

dataLength - the number of bits of data in each frame

numberOfStopBits - the number of stop bits

parity - the parity of the connection

Uart

public Uart(int baudRate,
            int dataLength,
            int numberOfStopBits,
            int parity,
            int flowControl,
            int uartId)

Creates a new UART interface, with the Tap as the UART host. The parity, flowControl and uartId parameters can be set with the following helpers:
Parity

• Uart.NONE
• Uart.ODD
• Uart.EVEN

Flow Control

• Uart.NONE
• Uart.RTS
• Uart.CTS
• Uart.RTS_CTS

uart ID

• Uart.UART_ID_TARGET
• Uart.UART_ID_HOST

Parameters:

baudRate - the baud rate of the connection

dataLength - the number of bits of data in each frame

numberOfStopBits - the number of stop bits

parity - the parity of the connection

flowControl - the flow control mode of the connection

uartId - the Id of the uart connection

Uart

protected Uart()

Used in the derived ModbusRTU class Reserved for IoTize

Method Detail

setMode

public void setMode(int baudRate,
                    int dataLength,
                    int numberOfStopBits,
                    int parity,
                    int flowControl)

Sets the current UART connection with the provided communication parameters.The parity and flowControl parameters can be set with the following helpers:
Parity

• Uart.NONE
• Uart.ODD
• Uart.EVEN

Flow Control

• Uart.NONE
• Uart.RTS
• Uart.CTS
• Uart.RTS_CTS

Parameters:

baudRate - the baud rate of the connection

dataLength - the number of bits of data in each frame

numberOfStopBits - the number of stop bits

parity - the parity of the connection

flowControl - the flow control mode of the connection

getChar

public int getChar()

Read one char on the UART connection.

Returns:

the read character

sendChar

public void sendChar(byte val)

Sends one char on the UART connection

Parameters:

val - the char to send

getBytes

public int getBytes(byte[] buffer,
                    int maxNumberOfBytes,
                    int timeout)

Gets all data bytes until the the maximum number of bytes is reached or timeout has occured.

Parameters:

buffer - the buffer that will receive the data

maxNumberOfBytes - the maximum number of bytes to read

timeout - the timeout of the command, in milliseconds

Returns:

the nulber of bytes actually read

sendBytes

public int sendBytes(byte[] buffer)

Sends the given buffer on the UART connection.

Parameters:

buffer - the buffer to bee sent

Returns:

0 if the command succeeded, an erro code otherwise

flushRecBuffer

public void flushRecBuffer()

Flushes the reception buffer.

getCountRec

public int getCountRec()

Returns:

the number of bytes in the reception buffer

format

public void format(java.lang.String format,
                   java.lang.Object... args)

Sends a formatted string to the UART.

Parameters:

format - the string template to format

args - the arguments for the formatted string