com.symbol.emdk.serialcomm

Class SerialComm

java.lang.Object

com.symbol.emdk.EMDKBase

com.symbol.emdk.serialcomm.SerialComm

public class SerialComm
extends EMDKBase

This is the primary object to access the serial communication feature to communicate with remote device wither via USB/Serial. This class design allows to communicate with only remote device at time.

 {@code
 
        
        public class MainActivity extends Activity implements EMDKListener {
        
                SerialComm serialComm;
                EMDKManager emdkManager;

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerialComm.ControlSignal List of control signals

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PORT_NAME

Method Summary

Modifier and Type	Method and Description
void	disable() This method disables USB/serial channel to communicate with the remote device.
void	enable() This method enables the channel for the application to communicate with the remote device via USB/Serial.
SerialCommConfig	getConfig() Gets the current configuration settings of serial comm channel.
SerialPortInfo	getPortInfo() Returns the serial port info used for communication.
boolean	getSignalState(SerialComm.ControlSignal signal) This method can be used to query the signal status of DTR, DCD, DSR, RI, RTS, CTS.
boolean	isEnabled() Gets whether the communication port is enabled or not.
byte[]	read(int readTimeOut) This method reads the available data and returns immediately.
void	setConfig(SerialCommConfig config) Sets the serial comm settings for the currently choosen port.
void	setSignalState(SerialComm.ControlSignal controlSignal, boolean signalStatus) This method allows the application to set the status of control signal.
int	write(byte[] data, int bytesToWrite) Writes a specified number of bytes from buffer to the opened communication channel.

Methods inherited from class com.symbol.emdk.EMDKBase

getType

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT_NAME

public static final java.lang.String DEFAULT_PORT_NAME

See Also:

Constant Field Values

Method Detail

isEnabled

public boolean isEnabled()

Gets whether the communication port is enabled or not.

enable

public void enable()
            throws SerialCommException

This method enables the channel for the application to communicate with the remote device via USB/Serial.

Throws:

SerialCommException

disable

public void disable()
             throws SerialCommException

This method disables USB/serial channel to communicate with the remote device.

Throws:

SerialCommException

write

public int write(byte[] data,
                 int bytesToWrite)
          throws SerialCommException

Writes a specified number of bytes from buffer to the opened communication channel. This method returns the numbers bytes written. Exception will be thrown in case of any errors. This is synchronous call and may block the main thread depending on the time taken to send the data to the remote device. The maximum number of bytes to written at a time can't exceed more than 4096 Bytes and if the application passes more will lead to error.

Parameters:

data - The byte array that contains the data to write.

bytesToWrite - The number of bytes to write.

Returns:

Data bytes written.

Throws:

SerialCommException

read

public byte[] read(int readTimeOut)
            throws SerialCommException

This method reads the available data and returns immediately. If no data is available, waits till the timeout occurs. Null will be returned if there is no data available. Exception will be thrown in case of any errors. The maximum data can be received is 4096 Bytes at a time. The newly arrived data will be lost if the received data in the read buffer is greater 4096 byes when the data arrives from the remote devices client. The application must handshake with remote device's client to avoid the data loss. This is synchronous method, depending on the read timeout, it may block the application's main thread and might lead to ANR. The application should call this method on a separate thread to avoid the ANR problems.

Parameters:

readTimeOut - Wait for data until timeout. The timeout unit is milli seconds. A timeout of zero means the calling read will wait forever unless interrupted by disable or release.

Returns:

Read data buffer. Null will be returned if no data available.

Throws:

SerialCommException

getConfig

public SerialCommConfig getConfig()
                           throws SerialCommException

Gets the current configuration settings of serial comm channel. If modifications are made to the returned SerialCommConfig object, the SerialComm.setConfig(SerialCommConfig) must be called to take effect. SerialComm object must be enabled before calling getConfig() and setConfig() methods.

Returns:

Returns the SerialCommConfig object with the current port settings.

Throws:

SerialCommException -

Supported in EMDK v6.1.0 or higher.Not supported on all BSP eventhough the EMDK provides this interface. Refer to release notes for more details.

 
 Example Usage:
 SerialCommConfig config = serialComm.getConfig();
 
 

setConfig

public void setConfig(SerialCommConfig config)
               throws SerialCommException

Sets the serial comm settings for the currently choosen port. If the value is not supported or not valid, the exception will be thrown with the error code and exact message which describes what is failed. SerialComm object must be enabled before calling getConfig() and setConfig() methods.

Parameters:

config - object which specifies the settings for the current instance of serial communication

Throws:

SerialCommException -

Supported in EMDK v6.1.0 or higher.Not supported on all BSP eventhough the EMDK provides this interface. Refer to release notes for more details.

 
 Example Usage:
 SerialCommConfig config = serialComm.getConfig();
 config.baudRate = BaudRates.BR_19200;
 config.parity = ParityBits.EVEN;
 serialComm.setConfig(config);
 
 

getSignalState

public boolean getSignalState(SerialComm.ControlSignal signal)
                       throws SerialCommException

This method can be used to query the signal status of DTR, DCD, DSR, RI, RTS, CTS.

Parameters:

signal -

Returns:

Throws:

SerialCommException -

Supported in EMDK v6.1.0 or higher.Not supported on all BSP eventhough the EMDK provides this interface. Refer to release notes for more details.

 
 Example Usage:
 boolean signalStatus = serialComm.getSignalState(ControlSignal.RTS)
 
 

setSignalState

public void setSignalState(SerialComm.ControlSignal controlSignal,
                           boolean signalStatus)
                    throws SerialCommException

This method allows the application to set the status of control signal. Only the RTS, DTR are allowed set. For other it should return error as read only.

Parameters:

controlSignal - Control Signal Type

signalStatus - Status of the control signal

Throws:

SerialCommException -

Supported in EMDK v6.1.0 or higher.Not supported on all BSP eventhough the EMDK provides this interface. Refer to release notes for more details.

 
 Example Usage:
 boolean signalStatus = serialComm.setSignalState(ControlSignal.RTS, false)
 
 

getPortInfo

public SerialPortInfo getPortInfo()

Returns the serial port info used for communication. If the method is not supported on any device, it returns empty value.

Returns:

Returns the serial port information.

Supported in EMDK v6.1.0 or higher.Not supported on all BSP eventhough the EMDK provides this interface. Refer to release notes for more details.