Serial port

Represents a serial communication channel, configurable according to the protocol used by the controller, to create request/response-type or event-type protocols

BrowseName
SerialPort
SuperType
Object(BaseObjectType)

Properties

Name BrowseName DataType Description
Port name PortName String Number of the COM serial port to use for the Bridging service on which the modem is connected
Baudrate Baudrate UInt32 Serial communication speed (Baud Rate). The communication speed value should be set to match that of the device with which you intend to communicate
Data size DataSize Byte Number of bytes required by the communication protocol concerned
Parity Parity Parity Parity type required by the communication protocol concerned
Stop bits StopBits Stop bits Number of Stop bits required by the communication protocol concerned
Flow control FlowControl Flow control Data flow control type for the communication type used. In particular, it makes it possible to adapt the communication according to the needs required at low level by the serial port of the connected device. By default, the driver sets None, that is, no flow control; however, depending on the device, it may be necessary to select a type of Flow Control (for example, in the event of an error message with code 1). The possible selections are: None: No flow control. The control is not required by the protocol. Hardware: The Flow control is managed by the serial line electrical signals (for example, RTS, CTS, and so on). XON/XOFF: the data flow control is XON/XOFF
Timeout Timeout Duration Maximum wait time in milliseconds to receive a response from the controller
Low latency LowLatency Boolean If enabled, minimizes the receive latency of an FTDI serial device
Communication status CommunicationStatus Communication status Status of the serial communication

Methods

Open

BrowseName
Open

Open the serial communication

Close

BrowseName
Close

Closes the serial communication

Read

BrowseName
Read

Read data from the serial communciation

Table 1. InputArguments
Name DataType Description
Count UInt32 Byte number
Table 2. OutputArguments
Name DataType Description
Buffer Byte Buffer

Read

BrowseName
ReadUntil

Read data from the serial communication

Table 3. InputArguments
Name DataType Description
Delimiter String Delimiter
Table 4. OutputArguments
Name DataType Description
Buffer Byte Buffer

Write

BrowseName
Write

Write data to the serial communication

Table 5. InputArguments
Name DataType Description
Buffer Byte Buffer

Cancel read

BrowseName
CancelRead

Cancel the current read