public void setReceiveTimeout(int ms) {
// Set receive timeout to allow breaking out of polling loop during
// input handling.
try {
m_SerialPort.enableReceiveTimeout(ms);
} catch (UnsupportedCommOperationException e) {
logger.error("Failed to set receive timeout: {}", e.getMessage());
}
} // setReceiveTimeout
/**
* Sets the connection parameters to the setting in the parameters object. If set fails return the
* parameters object to origional settings and throw exception.
*
* @throws Exception if the configured parameters cannot be set properly on the port.
*/
public void setConnectionParameters() throws Exception {
// Save state of parameters before trying a set.
int oldBaudRate = m_SerialPort.getBaudRate();
int oldDatabits = m_SerialPort.getDataBits();
int oldStopbits = m_SerialPort.getStopBits();
int oldParity = m_SerialPort.getParity();
int oldFlowControl = m_SerialPort.getFlowControlMode();
// Set connection parameters, if set fails return parameters object
// to original state.
try {
m_SerialPort.setSerialPortParams(
m_Parameters.getBaudRate(),
m_Parameters.getDatabits(),
m_Parameters.getStopbits(),
m_Parameters.getParity());
} catch (UnsupportedCommOperationException e) {
m_Parameters.setBaudRate(oldBaudRate);
m_Parameters.setDatabits(oldDatabits);
m_Parameters.setStopbits(oldStopbits);
m_Parameters.setParity(oldParity);
final String errMsg = "Unsupported parameter";
logger.debug(
"{} failed to set up one of [baudRate, dataBits, stopBits, parity]: {}",
errMsg,
e.getMessage());
throw new Exception(errMsg);
}
// Set flow control.
try {
m_SerialPort.setFlowControlMode(
m_Parameters.getFlowControlIn() | m_Parameters.getFlowControlOut());
} catch (UnsupportedCommOperationException e) {
final String errMsg = "Unsupported flow control";
logger.debug("{}: {}", errMsg, e.getMessage());
throw new Exception(errMsg);
}
} // setConnectionParameters
/**
* Opens the communication port.
*
* @throws Exception if an error occurs.
*/
public void open() throws Exception {
// If this is Linux then first of all we need to check that
// device file exists. Otherwise call to m_PortIdentifyer.open()
// method will crash JVM.
// It is ugly patch but it is too late...
if (SystemUtils.IS_OS_LINUX) {
File portDevFile = new File(m_Parameters.getPortName());
if (!portDevFile.exists()) {
throw new Exception(
"Modbus serial device " + m_Parameters.getPortName() + " doesn't exist!");
}
}
// 1. obtain a CommPortIdentifier instance
try {
m_PortIdentifyer = CommPortIdentifier.getPortIdentifier(m_Parameters.getPortName());
} catch (NoSuchPortException e) {
final String errMsg =
"Could not get port identifier, maybe insufficient permissions. " + e.getMessage();
logger.debug(errMsg);
throw new Exception(errMsg);
}
logger.trace("Got Port Identifier");
// 2. open the port, wait for given timeout
try {
m_SerialPort = (SerialPort) m_PortIdentifyer.open("Modbus Serial Master", 30000);
} catch (PortInUseException e) {
logger.debug("open port failed: " + e.getMessage());
throw new Exception(e.getMessage());
}
logger.trace("Got Serial Port");
// 3. set the parameters
try {
setConnectionParameters();
} catch (Exception e) {
// ensure it is closed
m_SerialPort.close();
logger.debug("parameter setup failed: " + e.getMessage());
throw e;
}
if (Modbus.SERIAL_ENCODING_ASCII.equals(m_Parameters.getEncoding())) {
m_Transport = new ModbusASCIITransport();
} else if (Modbus.SERIAL_ENCODING_RTU.equals(m_Parameters.getEncoding())) {
m_Transport = new ModbusRTUTransport();
setReceiveTimeout(m_Parameters.getReceiveTimeout()); // just here for the moment.
} else if (Modbus.SERIAL_ENCODING_BIN.equals(m_Parameters.getEncoding())) {
m_Transport = new ModbusBINTransport();
}
m_Transport.setEcho(m_Parameters.isEcho());
// Open the input and output streams for the connection. If they won't
// open, close the port before throwing an exception.
try {
m_SerialIn = m_SerialPort.getInputStream();
m_Transport.setCommPort(m_SerialPort);
// m_Transport.prepareStreams(m_SerialIn,
// m_SerialPort.getOutputStream());
} catch (IOException e) {
m_SerialPort.close();
logger.debug(e.getMessage());
throw new Exception("Error opening i/o streams");
}
logger.trace("i/o Streams prepared");
// Add this object as an event listener for the serial port.
try {
m_SerialPort.addEventListener(this);
} catch (TooManyListenersException e) {
m_SerialPort.close();
final String errMsg = "too many listeners added";
logger.debug("{}: {}", errMsg, e.getMessage());
throw new Exception(errMsg);
}
// Set notifyOnBreakInterrup to allow event driven break handling.
m_SerialPort.notifyOnBreakInterrupt(true);
m_Open = true;
} // open