Overview
The Serial Port API will allow the user to control and receive information from the serial ports of the equipment. The aim of this API is to supply functions and give an easy access to the serial ports of an equipment, independent of the serial port type.
A general outline of the Serial Port API can be observed in the following figure:
Main functionalities
The Serial Port API provides the following functionalities:
-
Get Serial Port List : It allows to get all the serial ports of the machine being used and their information. Serial port information received: Serial Port id, alias, protocol, baud rate, data bits, stop bits, parity, flow control, address, RS485 pinout, RS485 txen and allowed protocols.
-
Set Serial Port Configuration : It allows to modify the configuration of a serial port. Possible parameters to modify: alias, protocol, baud rate, data bits, stop bits, parity and flow control.
-
Send messages : It allows to send a message through a serial port.
- Subscribe to Serial Ports events : It allows to subscribe to messages received to serial port.