RS232 Serial Communication¶
The RS232 Serial Communication feature allows one to send commands to control and configure USBExt3c.
Use Cases
Affecting USBExt3c control.Audio/Video applications.
Configuration¶
The default configuration of the RS232 Serial Communication feature is:
8 Data bitsNo ParityNo Flow Control1 Stop bit9600 Baudrate
This feature does have some configurability through the USBExt3c UART Entity
Extron Compatible Serial Commands¶
The RS232 Serial Communication feature is capable of changing the USBExt3c upstream port, requesting the current status of the upstream/downstream connections, enable/disable of ports, and the USBExt3c 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 USBExt3c supports with their arguments, descriptions, and expected responses.
Error Codes¶
The following is a list of all error codes the USBExt3c supports with descriptions.
Code |
Description |
|---|---|
|
invalid port number, check the port number and make sure it’s valid. |
|
invalid command, verify that you formatted the command correctly. |
|
invalid value, verify that the value is within the acceptable range for this command. |
|
invalid configuration, verify the system is in a state it can accept this command. |
General Notes¶
All commands are ASCII strings.\ris the ASCII character for carriage return.\nis the ASCII character for new line.
Examples¶
Extron Compatible Serial Commands:
1!Chn 1\r\nIChn 1 InACT010000 OutACT001000\r\n3*0PPort 3*0\r\nAPI Configurations:
static const int TEST_SERIAL = 0;
aUSBext3c 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();
TEST_SERIAL = 0
stem = brainstem.stem.USBext3c()
stem.discoverAndConnect(brainstem.link.Spec.USB)
# Enable the port
stem.uart[TEST_SERIAL].setEnable(1)
# 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()
# Configure UART[0] for loopback testing
# Data sent to the UART will be echoed back
TEST_SERIAL = 0
stem = brainstem.stem.USBext3c()
stem.discoverAndConnect(brainstem.link.Spec.USB)
stem.uart[TEST_SERIAL].setEnable(1)
stem.uart[TEST_SERIAL].setBaudRate(115200)
stem.uart[TEST_SERIAL].setProtocol(6) # Loopback protocol
# Now any data sent to UART[0] will be echoed back
stem.system.save()
stem.disconnect()
# Link VCOM channel (UART[4]) to hardware RS232 (UART[0])
# This allows USB serial communication to be forwarded to RS232
stem = brainstem.stem.USBext3c()
stem.discoverAndConnect(brainstem.link.Spec.USB)
# Enable both channels
stem.uart[0].setEnable(1) # Hardware RS232
stem.uart[4].setEnable(1) # VCOM_0 channel
# Configure matching baud rates
stem.uart[0].setBaudRate(115200)
stem.uart[4].setBaudRate(115200)
# Link VCOM to hardware UART
stem.uart[0].setLinkChannel(4)
stem.uart[4].setLinkChannel(0)
# Data received on VCOM will now be forwarded to RS232,
# and data received on RS232 will be forwarded to VCOM
stem.system.save()
stem.disconnect()
// Configure UART[0] for loopback testing
// Data sent to the UART will be echoed back
static const int TEST_SERIAL = 0;
aUSBext3c stem;
stem.discoverAndConnect(USB);
stem.uart[TEST_SERIAL].setEnable(true);
stem.uart[TEST_SERIAL].setBaudRate(115200);
stem.uart[TEST_SERIAL].setProtocol(6); // Loopback protocol
// Now any data sent to UART[0] will be echoed back
stem.system.save();
stem.disconnect();
// Link VCOM channel (UART[4]) to hardware RS232 (UART[0])
// This allows USB serial communication to be forwarded to RS232
aUSBext3c stem;
stem.discoverAndConnect(USB);
// Enable both channels
stem.uart[0].setEnable(true); // Hardware RS232
stem.uart[4].setEnable(true); // VCOM_0 channel
// Configure matching baud rates
stem.uart[0].setBaudRate(115200);
stem.uart[4].setBaudRate(115200);
// Link VCOM to hardware UART
stem.uart[0].setLinkChannel(4);
stem.uart[4].setLinkChannel(0);
// Data received on VCOM will now be forwarded to RS232,
// and data received on RS232 will be forwarded to VCOM
stem.system.save();
stem.disconnect()