UART Serial Communication

The UART Serial Communication feature allows one to send commands to affect control and functionality of the USBHub3c.

Use Cases

Affecting USBHub3c control.
Audio/Video applications.

Configuration

The default configuration of the UART Serial Communication feature is:

8 Data bits
No Parity
No Flow Control
1 Stop bit
9600 Baudrate

This feature does have some configurability through the USBHub3c UART Entity

Extron Compatible Serial Commands

The UART Serial Communication feature is capable of changing the USBHub3c upstream port, requesting the current status of the upstream/downstream connections, enable/disable of ports, and the USBHub3c part number/firmware version queries. This can be accomplished with a protocol that is compatible with Extron’s Simple Instruction Set over RS232.

Commands

The following is a list of all commands the USBHub3c supports with their arguments, descriptions, and expected responses.

Cmd

Arguments

Description

Expected Responses

!

None

Get current upstream port index

Chn #\r\n

#!

# Port

Change upstream port to # port number

Chn #\r\n

#^

# Port

Change upstream port to # port number

Chn #\r\n

I

None

Get connection status

Chn # InACT$$$$$$ OutACT$$$$$$\r\n

N

None

Get part number
S99-USBHUB-3C-PRO\r\n
S99-USBHUB-3C-LAB\r\n

Q

None

Get firmware version

<M>.<m>.<p>\r\n

#P

# Port

Get enable/disable status of # port number
Port #*0\r\n
Port #*1\r\n

#*$P
# Port
$ Enable 0/1

Set $ enable/disable of # port number

Port #*$\r\n

Error Codes

The following is a list of all error codes the USBHub3c supports with descriptions.

Code

Description

E01

invalid port number, check the port number and make sure it’s valid.

E10

invalid command, verify that you formatted the command correctly.

E13

invalid value, verify that the value is within the acceptable range for this command.

E14

invalid configuration, verify the system is in a state it can accept this command.

General Notes

All commands are ASCII strings.
\r is the ASCII character for carriage return.
\n is the ASCII character for new line.

Examples

Extron Compatible Serial Commands:

Change Upstream to Port 1

Tx: 1!
Rx: Chn 1\r\n

API Configurations:

static const int TEST_SERIAL = 0;

aUSBHub3c stem;
stem.discoverAndConnect(USB);

// Enable the port
stem.uart[TEST_SERIAL].setEnable(true);

// Change baudrate to 115200 from default 9600
stem.uart[TEST_SERIAL].setBaudRate(115200);

// Change Protocol to Extron Compatible
// 0 - Disabled/Undefined
// 1 - Extron Compatible
// 2 - Brainstem Transport
// 6 - Loopback
stem.uart[TEST_SERIAL].setProtocol(1)

// Perform a system save so the changes persist
// through power cycles
stem.system.save();

stem.disconnect();

Relevant API’s

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]