Class TCustomPortUART

Reference to TCustomSystemCore currently being used by UART port.

Default sleep time while waiting during transmission between multiple attempts.

Default buffer size used when reading and writing strings.

Creates UART (serial) port instance associated with a specific instace of TCustomSystemCore. Note that ASystemCore parameter is required as it is used for timeout calculations.

Reads data buffer from UART (serial) port.

Parameters

Buffer

Pointer to data buffer where the data will be written to.

BufferSize

Number of bytes to read.

Timeout

Maximum time (in milliseconds) to wait while attempting to read the buffer. If this parameter is set to zero, then the function will block indefinitely, attempting to read until the specified number of bytes have been read.

Returns

Number of bytes that were actually read.

Attempts to read a byte from UART (serial) port. Timeout defines maximum time (in milliseconds) to wait while attempting to do so; if this parameter is set to zero, then the function will block indefinitely until the byte has been read. True is returned when the operation was successful and False when the byte could not be read.

Reads string from UART (serial) port.

Parameters

Text

String that will hold the incoming data.

MaxCharacters

Maximum number of characters to read. Once this number of characters has been read, the function immediately returns, even if there is more data to read. When this parameter is set to zero, then the function will continue to read the data, depending on value of Timeout.

Timeout

Maximum time (in milliseconds) to wait while attempting to read the buffer. If this parameter is set to zero, then the function will read only as much data as fits in readable FIFO buffers (or fail when such buffers are not supported).

Returns

Number of bytes that were actually read.

Writes data buffer to UART (serial) port.

Parameters

Buffer

Pointer to data buffer where the data will be read from.

BufferSize

Number of bytes to write.

Timeout

Maximum time (in milliseconds) to wait while attempting to write the buffer. If this parameter is set to zero, then the function will block indefinitely, attempting to write until the specified number of bytes have been written.

Returns

Number of bytes that were actually written.

Attempts to write a byte to UART (serial) port. Timeout defines maximum time (in milliseconds) to wait while attempting to do so; if this parameter is set to zero, then the function will block indefinitely until the byte has been written. True is returned when the operation was successful and False when the byte could not be written.

Attempts to write multiple bytes to UART (serial) port. Timeout defines maximum time (in milliseconds) to wait while attempting to do so; if this parameter is set to zero, then the function will block indefinitely, attempting to write until the specified bytes have been written. True is returned when the operation was successful and False when not all bytes could be written.

Writes string to UART (serial) port.

Parameters

Text

String that should be sent.

Timeout

Maximum time (in milliseconds) to wait while attempting to write the buffer. If this parameter is set to zero, then the function will write only what fits in writable FIFO buffers (or fail when such buffers are not supported).

Returns

Number of bytes that were actually read.

Returns currently set baud rate.

Returns current number of bits per word.

Returns current parity check type.

Returns current number of stop bits.

Flushes UART (serial) port read and write FIFO buffers.

Sets new baud rate.

Sets new number of bits per word.

Sets new parity check type.

Sets new number of stop bits.

Currently used baud rate in terms of bits per second. Note that to calculate the actual speed of transmission, it is necessary to take into account start and stop bits among other things; for typical situations, the actual transmission speed may be something like BaudRate / 10 bytes per second or less.

Number of bits per message (or "word") used in the transmission. Typically this equals to 8 bits, which means one byte is sent at a time. Accepted values usually range between 5 and 8 bits. Lower values, especially when combined with parity checks may result in less and/or easier to detect errors.

Number of parity (error detection) bits used in the transmission. This means that additional bits will be added to the tail of transmission that indicate whether the number of ones in the message is odd or even; if the received number of bits does not match this hint, the message will be discarded.

Number of stop bits used in the transmission. Although normally only one stop bit is necessary, it may be difficult to detect in hardware when transmission channel is noisy; therefore, additional stop bits may help alleviate the problem.

Reference to TCustomSystemCore associated with this UART port instance.