UART

API Documentation: [cpp] [python] [.NET] [CCA] [REST]

The UART entity is a class which allows a user to configure and control an arbitrary stream of serial data. These streams can represent a number of different transports, including a RS232 external interface, a virtual COM port, and onboard UART interfaces from system components. This entity allows each transport to be configured as either an endpoint, or as a passthrough between transports, similar to a switchboard of a telephone operator.


Extron Control

The USBHub3c has the ability to be controlled through an RS232 interface on the external expansion connector of the USBHub3c. The USBHub3c also supports VCOM (Virtual COM port) channels for USB-based serial communication. For additional information about the serial protocol, reference USBHub3c Serial Communication Feature

UART Entity Indices

The USBHub3c provides the following UART entity indices:

UART Entity Indices

Index

Description

0

Hardware RS232 (External Expansion Connector)

1

VCOM_0 (Virtual COM port channel)

For additional information about the serial protocol, reference USBHub3c Serial Communication Feature

UART APIs

The USBHub3c has four protocol values enumerated.

Value

Description

0

Disabled/Undefined

1

Extron Compatible Protocol

2

Brainstem Transport

6

Loopback

Uarts are controlled through the following APIs:

stem.uart[x].setEnable()[cpp][python][NET][CCA] [REST]
stem.uart[x].getEnable()[cpp][python][NET][CCA] [REST]
stem.uart[x].setBaudRate()[cpp][python][NET][CCA] [REST]
stem.uart[x].getBaudRate()[cpp][python][NET][CCA] [REST]
stem.uart[x].setProtocol()[cpp][python][NET][CCA] [REST]
stem.uart[x].getProtocol()[cpp][python][NET][CCA] [REST]
stem.uart[x].setLinkChannel()[cpp][python][NET][CCA] [REST]
stem.uart[x].getLinkChannel()[cpp][python][NET][CCA] [REST]
stem.uart[x].setStopBits()[cpp][python][NET][CCA] [REST]
stem.uart[x].getStopBits()[cpp][python][NET][CCA] [REST]
stem.uart[x].setParity()[cpp][python][NET][CCA] [REST]
stem.uart[x].getParity()[cpp][python][NET][CCA] [REST]
stem.uart[x].setDataBits()[cpp][python][NET][CCA] [REST]
stem.uart[x].getDataBits()[cpp][python][NET][CCA] [REST]
stem.uart[x].getCapableProtocols()[cpp][python][NET][CCA] [REST]
stem.uart[x].getAvailableProtocols()[cpp][python][NET][CCA] [REST]