Com (posapplib 1.10.0 API)

All Known Implementing Classes:: SerialCommunication

public interface Com

The Com interface provide methods that enables the use of the serial communication port.
Implementation of the Com interface is provided in the class SerialCommunication.
To start using the serial communication an instance of the class SerialCommunication needs to be created.
Below examples show how to connect to the serial communication port,
setup callback to get notification when data is available for reading and method to write data.

Create instance of the SerialCommunication class and do connect.

         ...
         
           SerialCommunication = _serialCommunication = new SerialCommunication();
           if (_serialCommunication.connect(_baudRate)) {
             setDataAvailableCallback();
             Toast.makeText(SerialComActivity.this, "Successful connect!", Toast.LENGTH_SHORT).show();
           } else {
             Toast.makeText(SerialComActivity.this, "Unsuccessful connect!", Toast.LENGTH_SHORT).show();
           }
         
         ...

Setup data available callback and read data when it is available.

         
           private void setDataAvailableCallback() {
             _serialCommunication.setDataAvailableCallback(new DataAvailable()  {
               Override
               public void onDataAvailable(SerialCommunication.EventTypes event) {
                 if (event == SerialCommunication.EventTypes.DATA_AVAILABLE) {
                   byte [] buffer = new byte[MAX_BUFFER_SIZE];
                   _serialCommunication.read(buffer, buffer.length);
                 }
               }
             });
           }

Write to the serial port.

         ...
         
           byte[] buffer = text.getBytes();
           _serialCommunication.write(buffer, buffer.length);
         
         ...

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Com.BaudRates` Baud rates
`static class`	`Com.DataBits` Number of data bits.
`static class`	`Com.EventTypes` Event types.
`static class`	`Com.Parity` Parity.
`static class`	`Com.StopBits` Stop bits.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`connect(Com.BaudRates baudRate)` Open and connect to the serial port.
`boolean`	`connect(Com.BaudRates baudRate, Com.StopBits stopBits, Com.DataBits dataBits, Com.Parity parity)` Open and connect to the serial port.
`void`	`disconnect()` Disconnect the connected port.
`boolean`	`isOpened()` Check if serial communication port is open.
`int`	`read(byte[] data, int length)` Read data from the serial communication port.
`int`	`read(byte[] data, int length, int timeout)` Read data from the serial communication port.
`void`	`setDataAvailableCallback(DataAvailable dataAvailable)` Set data available callback for the application layer.
`int`	`write(byte[] data, int length)` Write data to the serial communication port.
`int`	`write(byte[] data, int length, int timeout)` Write data to the serial communication port.

- Method Detail
  - connect
```
boolean connect(Com.BaudRates baudRate)
```
    Open and connect to the serial port.
    
    Parameters:
    
    baudRate - Baud rate to use.
    
    Returns:
    
    boolean - true success, false otherwise.
  - connect
```
boolean connect(Com.BaudRates baudRate,
                Com.StopBits stopBits,
                Com.DataBits dataBits,
                Com.Parity parity)
```
    Open and connect to the serial port.
    
    Parameters:
    
    baudRate - Baud rate to use.
    
    stopBits - Number of stop bits.
    
    dataBits - Number of data bits per byte.
    
    parity - Enable parity generation and detection.
    
    Returns:
    
    boolean - true success, false otherwise.
  - disconnect
```
void disconnect()
```
    Disconnect the connected port.
  - read
```
int read(byte[] data,
         int length)
```
    Read data from the serial communication port. Timeout default 3 seconds.
    
    Parameters:
    
    data - Read buffer.
    
    length - Length to read.
    
    Returns:
    
    int - Number of bytes read.
  - read
```
int read(byte[] data,
         int length,
         int timeout)
```
    Read data from the serial communication port.
    
    Parameters:
    
    data - Read buffer.
    
    length - Length to read.
    
    timeout - Timeout for the read operation.
    
    Returns:
    
    int - Number of bytes read.
  - write
```
int write(byte[] data,
          int length)
```
    Write data to the serial communication port. Timeout default 3 seconds.
    
    Parameters:
    
    data - Write buffer.
    
    length - Length to read.
    
    Returns:
    
    int - Number of bytes written.
  - write
```
int write(byte[] data,
          int length,
          int timeout)
```
    Write data to the serial communication port.
    
    Parameters:
    
    data - Write buffer.
    
    length - Length to read.
    
    timeout - Timeout for the write operation. Default 3 seconds.
    
    Returns:
    
    int - Number of bytes written.
  - isOpened
```
boolean isOpened()
```
    Check if serial communication port is open.
    
    Returns:
    
    boolean - true if the serial port is open, false otherwise.
  - setDataAvailableCallback
```
void setDataAvailableCallback(DataAvailable dataAvailable)
```
    Set data available callback for the application layer.
    
    Parameters:
    
    dataAvailable - Callback object that is called when data is available.

Interface Com

Nested Class Summary

Method Summary

Method Detail

connect

connect

disconnect

read

read

write

write

isOpened

setDataAvailableCallback