Wyrestorm EX-SW-0301-H2 User manual

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
3:1 HDMI/VGA/DP Switching Extender
with Scaling Receiver, Relay Triggering and HDCP 2.2
EX-SW-0301-H2
Application Programming Interface
Document Revision:
1.1
Document Date:
June 19th 2018
Supported Firmware:
1.0.0 or higher

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
2 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
Contents
1. Overview........................................................................................................................................................................................3
1.1 Before You Begin...................................................................................................................................................................................................3
2. Wiring and Communication Configuration......................................................................................................................................4
2.1 RS-232 Connections.............................................................................................................................................................................................4
2.2 Serial and IP Settings............................................................................................................................................................................................4
3. Command Overview.......................................................................................................................................................................4
4. Switch Configuration .....................................................................................................................................................................5
4.1 Configuring a Static IP Address ..........................................................................................................................................................................5
4.2 Configuring Video..................................................................................................................................................................................................5
Configuring RX Output Resolution .....................................................................................................................................................................5
Configuring Input EDIDs.......................................................................................................................................................................................5
Enable/Disable HDCP Support............................................................................................................................................................................6
Query Current HDCP Support Level ...................................................................................................................................................................6
4.3 Configuring Device Switching .............................................................................................................................................................................6
Default Device (TX/RX).........................................................................................................................................................................................6
Auto Switch Mode .................................................................................................................................................................................................6
4.4 Configuring Relays ................................................................................................................................................................................................6
Relay Power............................................................................................................................................................................................................6
Relay mode.............................................................................................................................................................................................................6
Relay Timing ..........................................................................................................................................................................................................7
4.5 Configuring CEC ....................................................................................................................................................................................................7
CEC Power On/Off.................................................................................................................................................................................................7
CEC AUTO POWER ON/OFF.................................................................................................................................................................................7
CEC POWER Delay Time ......................................................................................................................................................................................7
4.6 Configuring the Serial Port and Command Structure .....................................................................................................................................8
Serial Port Properties ............................................................................................................................................................................................8
Serial Port Data Type ............................................................................................................................................................................................8
Serial Command End Character .........................................................................................................................................................................8
Edit Serial Command in ASCII String .................................................................................................................................................................8
Edit Serial Command in HEX String....................................................................................................................................................................8
Configure Serial Power On/Off for Display........................................................................................................................................................9
Configure Serial Auto Power On/Off for Display ..............................................................................................................................................9
Configure Serial Power Delay Time....................................................................................................................................................................9
5. Switching Inputs.......................................................................................................................................................................... 10
6. Troubleshooting .......................................................................................................................................................................... 11
Query Firmware Version.....................................................................................................................................................................................11
Reboot Device......................................................................................................................................................................................................11
Restore Factory Defaults ...................................................................................................................................................................................11
7. Contacting Technical Support...................................................................................................................................................... 12
8. Revision History .......................................................................................................................................................................... 12
Publication Disclaimer........................................................................................................................................................................ 13

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
3 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
1. Overview
The following document contains the Application Program Interface (API) commands to control the SW-0501-HDBT and SW-1001-
HDBT presentation switchers via serial and IP commands. Read this document in its entirety before starting any communication
with the product.
1.1 Before You Begin
Verify that the following items are on hand and that all documentation is reviewed before continuing.
EX-SW-0301-H2......................................................................................................................................................................................
Control System and Control System Documentation .......................................................................................................................
PC or Mac for Configuring Product and Telnet Communications...................................................................................................
Visit the Product Page on WyreStorm.com to download firmware and additional product information .................................

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
4 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
2. Wiring and Communication Configuration
WyreStorm recommends that all wiring for the installation is run and terminated prior to making connections to the switcher. Read
through this section in this entirety before running or terminating the wires to ensure proper operation and to avoid damaging
equipment.
2.1 RS-232 Connections
The following wiring diagrams show the pinouts for the switcher. While not shown, connect the TX (transmit) to RX (receive) pins at
the control system or PC side of the cable. Most control systems and computers are configured for Digital Terminal Equipment
(DTE) where pin 2 is RX and pin 3 is TX This can vary from device to device, refer to the documentation for the connected device for
pin functionally to ensure that the connect connections can be made.
2.2 Serial and IP Settings
Baud rate:
115200
Data Bits:
8bits
Parity:
None
Stop Bits:
1bit
Flow Control:
None
Default IP Address:
192.168.11.43
Default IP Port:
23
3. Command Overview
Command Type:
ASCII
Key Words:
Case Sensitive
[Prm]:
optional parameters
[Input]:
Video Input (HDMI/HDBaseT)
Command termination:
<CR><LF>

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
5 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
4. Switch Configuration
4.1 Configuring a Static IP Address
By default, the switcher is set to a static IP of 192.168.11.043. We recommend changing this as it shared with other WyreStorm
products and may cause improper communication if left unchanged. Connect to the RX via RS-232 and send the following
command to set the IP address.
Set Static IP Address
SET IPADDR STATIC ip4addr [IP Address] netmask [Netmask]<CR><LF>
Example: SET IPADDR STATIC ip4addr 192.168.11.243 netmask 255.255.255.0 <CR><LF>
Response: IPADDR STATIC ip4addr 192.168.11.243 netmask 255.255.255.0 <CR><LF>
Query IP Address
GET IPADDR<CR><LF>
Response: IPADDR STATIC ip4addr xx.xx.xx.xx netmask xx.xx.xx.xx <CR><LF>
Example: GET IPADDR<CR><LF>
Response: IPADDR STATIC ip4addr 192.168.11.243 netmask 255.255.255.0 <CR><LF>
Note: This command can only be sent to the receivers (RX) RS-232 port.
4.2 Configuring Video
Configuring RX Output Resolution
By default, the RX is set to Auto Scale to the resolution of the connected display. However, this can be configured to suit the
installation.
Set Output Resolution
SET RES all [Resolution] rx<CR><LF>
Example:
SET RES all Fix:1920x1200@60 rx<CR><LF>
Response:
RES SET all Fix:1920x1200@60 rx<CR><LF>
[Resolution]=
AutoScaler
Fix:1024x768@60
Fix:1280x720@60
Fix:1280x800@60
Fix:1280x1024@60
Fix:1920x1080@60
Fix:1920x1200@60
Fix:3840x2160@30
Fix:3840x2160@60
Query Output Resolution
GET RES_OUT all rx<CR><LF>
Example:
GET RES_OUT all rx<CR><LF>
Response:
RES GET all Fix:1920x1200@60 rx<CR><LF>
AutoScaler
Fix:1024x768@60
Fix:1280x720@60
Fix:1280x800@60
Fix:1280x1024@60
Fix:1920x1080@60
Fix:1920x1200@60
Fix:3840x2160@30
Fix:3840x2160@60
Auto:[Resolution] | Resolution=Scaled resolution based of connected display
Configuring Input EDIDs
By default, all inputs are set to an EDID of 1920x1080@60Hz 2CH. However, this can be configured to suit the installation.
Set Input EDID
SET EDID [Input] [Resolution]<CR><LF>
Example:
SET EDID hdmi_tx 1920x1080@60Hz<CR><LF>
Response:
EDID SET hdmi_tx 1920x1080@60Hz<CR><LF>
Query Input EDID
GET EDID [Input]<CR><LF>
Example: GET EDID hdmi_tx<CR><LF>
Response
EDID GET hdmi_tx 1920x1080@60Hz <CR><LF>
[Input]=hdmi_tx | dp_tx | vga_tx | hdbt_rx | hdmi_rx
[Resolution]=
3840x2160@30Hz/1920x1200@60Hz
1920x1080@60Hz
1680x1050@60Hz
1600x900@60Hz
1440x900@60Hz
1360x768@60Hz
1280x720@60Hz
1024x768@60Hz

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
6 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
Enable/Disable HDCP Support
Set HDCP Support On/Off
SET HDCP_S [Input] [Prm]<CR><LF>
Response: HDCP_S SET [Input] [Prm]<CR><LF>
Example: SET HDCP_S hdmi_tx on<CR><LF>
Response: HDCP_S SET hdmi_tx on<CR><LF>
Query HDCP Support On/Off Status
GET HDCP_S [Input]<CR><LF>
Response: HDCP_S GET [Input] [Prm]<CR><LF>
Example: GET HDCP_S hdmi_tx<CR><LF>
Response: HDCP_S GET hdmi_tx on <CR><LF>
[Input]= hdmi_tx | hdbt_rx | hdmi_rx
[Prm]=on | off
Query Current HDCP Support Level
GET HDCP_IN [Input]<CR><LF>
Response: GET HDCP_IN GET [Input] [Prm]<CR><LF>
Example: SET HDCP_S hdmi_tx<CR><LF>
Response: HDCP_IN GET hdmi_tx hdcp1.4 tx<CR><LF>
[Input]= hdmi_tx | dp_tx | vga_tx | hdbt_rx | hdmi_rx
[Prm]= hdcp1.4 | hdcp2.2 | off
4.3 Configuring Device Switching
Default Device (TX/RX)
Set Default Device
SET DEFDEVICE [Device]<CR><LF>
Response: DEFDEVICE SET [Device]<CR><LF>
Example: SET DEFDEVICE tx<CR><LF>
Response: DEFDEVICE SET tx<CR><LF>
Query Default Device
GET DEFDEVICE<CR><LF>
Response: DEFDEVICE GET [Device]<CR><LF>
Example: GET DEFDEVICE<CR><LF>
Response: DEFDEVICE GET tx<CR><LF>
[Device] = tx | rx
Auto Switch Mode
Enable/Disable Auto Switch Mode
SET AUTOSW_FN [Prm] [Device]<CR><LF>
Response: AUTOSW_FN SET [Prm] [Device]<CR><LF>
Example: SET AUTOSW_FN on tx<CR><LF>
Response: AUTOSW_FN SET on tx<CR><LF>
Query Auto Switch Mode Status
GET AUTOSW_FN [Device]<CR><LF>
Response: AUTOSW_FN GET [Prm] [Device]<CR><LF>
Example: SET AUTOSW_FN on tx<CR><LF>
Response: AUTOSW_FN SET on tx<CR><LF>
[Prm] = on | off
[Device] = tx | rx | all
4.4 Configuring Relays
Relay Power
SET RELAY_PWR [Prm] rx<CR><LF>
Response: RELAY_PWR SET [Prm] rx<CR><LF>
Example: SET RELAY_PWR on rx<CR><LF>
Response: RELAY_PWR SET on rx<CR><LF>
[Prm] = on | off
Relay mode
Set Relay Mode
SET RELAY_M [Prm] rx <CR><LF>
Response: RELAY_M SET [Prm] [Device]<CR><LF>
Example: SET RELAY_M latch rx<CR><LF>
Response: RELAY_M SET latch rx<CR><LF>
Query Relay Mode
GET RELAY_M rx<CR><LF>
Response: RELAY_M GET [Prm] [Device]<CR><LF>
Example: GET RELAY_M rx<CR><LF>
Response: RELAY_M GET latch rx<CR><LF>
[Prm] = latch | momentary

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
7 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
Relay Timing
Set Momentary Time
SET MOMENT_T [Prm] rx<CR><LF>
Response: MOMENT_T SET [Prm] [Device]<CR><LF>
Example: SET MOMENT_T 8 rx<CR><LF>
Response: MOMENT_T SET 8 rx<CR><LF>
Query Momentary Time
GET MOMENT_T rx <CR><LF>
Response: MOMENT_T GET [Prm] rx<CR><LF>
Example: GET MOMENT_T rx<CR><LF>
Response: MOMENT_T GET 8 rx<CR><LF>
[Prm] = 1 ~ 10 // seconds | default is 3s
4.5 Configuring CEC
CEC Power On/Off
Set CEC Power On/Off
SET CEC_PWR all [Prm] rx<CR><LF>
Response: CEC_PWR SET all [Prm] [Device]<CR><LF>
Example: SET CEC_PWR all on rx<CR><LF>
Response: CEC_PWR SET all on rx<CR><LF>
[Prm] = on | off
CEC AUTO POWER ON/OFF
Set CEC AUTO POWER ON/OFF
SET AUTOCEC_FN all [Prm] rx<CR><LF>
Response: AUTOCEC_FN SET all [Prm] rx<CR><LF>
Example: SET AUTOCEC_FN all on tx<CR><LF>
Response: AUTOCEC_FN SET all on tx<CR><LF>
Query CEC AUTO POWER ON/OFF
GET AUTOCEC_FN all rx<CR><LF>
Response: AUTOCEC_FN GET all [Prm] rx<CR><LF>
Example: GET AUTOCEC_FN all rx<CR><LF>
Response: AUTOCEC_FN GET all on rx<CR><LF>
[Prm] = on | off
CEC POWER Delay Time
Set CEC POWER Delay Time
SET AUTOCEC_D all [Prm] rx<CR><LF>
Response: AUTOCEC_D SET all [Prm] rx<CR><LF>
Example: SET AUTOCEC_D all 2 rx<CR><LF>
Response: AUTOCEC_D SET all 2 rx<CR><LF>
Query CEC POWER Delay Time Status
GET AUTOCEC_D all rx<CR><LF>
Response: AUTOCEC_D GET all [Prm] rx<CR><LF>
Example: GET AUTOCEC_D all rx<CR><LF>
Response: AUTOCEC_D GET all 2 rx<CR><LF>
[Prm] = 1~30 In Minutes with a default of 2min

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
8 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
4.6 Configuring the Serial Port and Command Structure
Note: Conditions on sending commands exist based on how the devices will be used in a system.
•When used together as a TX and RX commands can only be sent to the RX.
•When TX is used with a different HDBT receiver commands can only be sent to the TX.
Serial Port Properties
Set Serial Port Properties
SET UART_INFO [Prm] dev<CR><LF>
Response: UART_INFO SET [Prm] dev<CR><LF>
Example: SET UART_INFO 115200 tx<CR><LF>
Response: UART_INFO SET 115200 tx<CR><LF>
Query Serial Port Properties
GET UART_INFO rx<CR><LF>
Response: UART_INFO GET [Prm] rx<CR><LF>
Example: GET UART_INFO rx<CR><LF>
Response: UART_INFO GET 115200 rx<CR><LF>
[Prm] = 9600 | 38400 | 57600 | 115200
//[PRM] is the baudrate.
Serial Port Data Type
Set Serial Data Type
SET UART_DATATYPE [Prm] rx<CR><LF>
Response: SET UART_DATATYPE [Prm] rx<CR><LF>
Example: SET UART_DATATYPE str rx<CR><LF>
Response: UART_DATATYPE SET str rx<CR><LF>
Query Serial Data Type
GET UART_DATATYPE rx<CR><LF>
Response: UART_DATATYPE GET [Prm] rx<CR><LF>
Example: GET UART_DATATYPE rx<CR><LF>
Response: UART_DATATYPE GET str rx<CR><LF>
[Prm] = str | hex
//str in [Prm] = ASCII string
Serial Command End Character
Set Serial Command End Character
SET UART_E [Prm] rx<CR><LF>
Response: UART_E SET [Prm] rx<CR><LF>
Example: SET UART_E crlf rx<CR><LF>
Response: UART_E SET crlf rx<CR><LF>
Query Serial Command End Character
GET UART_E rx<CR><LF>
Response: UART_E GET [Prm] rx<CR><LF>
Example: GET UART_E rx<CR><LF>
Response: UART_E GET crlf rx<CR><LF>
[Prm] = null | cr | lf | crlf
cr: carriage Response, ascii code is 0x0D.
lf: line feed, ascii code is 0x0A.
Edit Serial Command in ASCII String
Set Serial Command ASCII String
SET UART_STR [Prm1] [Prm2]<CR><LF>
Response: UART_STR SET [Prm1] [Prm2]<CR><LF>
Example: SET UART_STR on xxxx<CR><LF>
Response: UART_STR SET on xxxx<CR><LF>
Query Serial Command ASCII String
GET UART_STR [Prm1]<CR><LF>
Response: UART_STR GET [Prm1] [Prm2]<CR><LF>
Example: GET UART_STR on<CR><LF>
Response: UART_STR GET on xxxx<CR><LF>
[Prm1] = on | off
[Prm2] = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
//PRM2 is the original command according to device
guidelines
Edit Serial Command in HEX String
Set Serial Command HEX String
SET UART_HEX [Prm] [Hex String]<CR><LF>
Response: UART_HEX SET [Prm] [Hex String] <CR><LF>
Example: SET UART_HEX on 31 32 33 34 35 36<CR><LF>
Response: UART_HEX SET on 31 32 33 34 35 36<CR><LF>
Query Serial Command HEX String
GET UART_HEX [Prm1]<CR><LF>
Response: UART_HEX GET [Prm1] [Hex1] [Hex2] hex3 …. <CR><LF>
Example: GET UART_HEX on<CR><LF>
Response: UART_HEX GET on xx xx xx xx ….<CR><LF>
[Prm] = on | off
[Hex String] = Hex string up to 64bytes
// [Hex1] | [Hex2] | … is ascii string of hex value. For
example, string "123", convert to correct format string
is“31 32 33”.

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
9 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
Configure Serial Power On/Off for Display
SET UART_PWR all [Prm] rx<CR><LF>
Response: UART_PWR SET all [Prm] rx<CR><LF>
Example: SET UART_PWR all on rx<CR><LF>
Response: UART_PWR SET all on rx<CR><LF>
[Prm] = on | off
Configure Serial Auto Power On/Off for Display
Set Serial Auto Power On/Off
SET UARTPWR_FN all [Prm] rx<CR><LF>
Response: UARTPWR_FN SET all [Prm] rx<CR><LF>
Example: SET UARTPWR_FN all on rx<CR><LF>
Response: UARTPWR_FN SET all on rx<CR><LF>
Query Serial Auto Power On/Off
GET UARTPWR_FN all dev<CR><LF>
Response: UARTPWR_FN GET all [Prm] rx<CR><LF>
Example: GET UARTPWR_FN all rx<CR><LF>
Response: UARTPWR_FN GET all on rx<CR><LF>
[Prm] = on | off
Configure Serial Power Delay Time
Set Serial Power Delay Time
SET UARTPWR_D all [Prm] rx<CR><LF>
Response: UARTPWR_D SET all [Prm] rx<CR><LF>
Example: SET UARTPWR_D all 2 rx<CR><LF>
Response: UARTPWR_D SET all 2 rx<CR><LF>
Query Serial Power Delay Time
GET UARTPWR_D all dev<CR><LF>
Response: UARTPWR_D GET all [Prm] rx<CR><LF>
Example: GET UARTPWR_D all rx<CR><LF>
Response: UARTPWR_D GET all 2 rx<CR><LF>
[Prm] = 1~30 In Minutes with a default of 2min
Note: Setting the UART POWER Delay Time via RS232 allows the sink to be powered off at a specific period of time when there’s no source input and
be powered on immediately once detecting an input.

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
10 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
5. Switching Inputs
Select Input Mapping
SET SW [Input] all<CR><LF>
Response: SW SET [Input] all<CR><LF>
Example: SET SW hdmi_tx all<CR><LF>
Response: SW SET hdmi_tx all<CR><LF>
Query Selected Input Mapping
GET MP all<CR><LF>
Response: MP GET [Input] all<CR><LF>
Example: GET MP all<CR><LF>
Response: MP GET hdmi_tx all<CR><LF>
[Input]= hdmi_tx | dp_tx | vga_tx | hdbt_rx | hdmi_rx

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
11 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
6. Troubleshooting
Query Firmware Version
GET VER [Target] [Device]<CR><LF>
Response: VER GET [Target] [Prm] [Device]<CR><LF>]
Example: GET VER all tx<CR><LF>
Response:
VER GET MCU 1.2 tx<CR><LF>
VER GET ARM 1.4 tx<CR><LF>
[Device] = tx | rx | all
[Target]=all | MCU | ARM
[Prm] =x.x// according to actual firmware version
Reboot Device
SET RESET [Device]<CR><LF>
Response: RESET SET [Device]<CR><LF>
Example: SET RESET tx<CR><LF>
Response: RESET SET tx<CR><LF>
[Device] = tx | rx | all
Restore Factory Defaults
SET RESET [Device]<CR><LF>
Response: RESET SET [Device]<CR><LF>
Example: SET RESET tx<CR><LF>
Response: RESET SET tx<CR><LF>
[Device] = tx | rx | all

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
12 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: [phone]
Email: [e-mail]
7. Contacting Technical Support
Should further clarification of the content in this document or assistance on troubleshooting be required, please contact WyreStorm
technical support.
Phone: UK: [phone] | ROW: 844.280.WYRE (9973)
Contact Request: http://wyrestorm.com/contact-tech-support
8. Revision History
v1.1 – June 2018
All Sections
Commands updated to proper syntax to match the current FW.
v1.0 – May 2018
All Sections
Initial Release of Document

WyreStorm Technical Support
UK:- [phone]
US/ROW: +1 844-280-WYRE (9973)
Email: [email protected]
WyreStorm Offices
North America: 23 Wood Road, Round Lake, NY 12151
Tel: [phone]
EMEA: Unit 22, Ergo Business Park, Swindon, Wiltshire, SN3 3JW, UK
Tel: [phone]
WyreStorm Technologies reserves the right to change the physical appearance or technical specification of this product at any
time. Visit wyrestorm.com for the latest product information.
Publication Disclaimer
The material contained in this document consists of information that is the sole property of WyreStorm. This document is intended to
provide information to allow interfacing to the relevant WyreStorm equipment by third party products.
WYRESTORM IS NOT RESPONSIBLE FOR MALFUNCTIONS AND/OR THE IN-OPERABILITY WHICH MAY BE CAUSED BY THE
APPLICATION OF THIS INFORMATION, WHETHER EXPECTED OR NOT.
WyreStorm reserves the right to change software, control codes and specifications without notice.
WyreStorm will not be liable for any use of this information or any changes it may make to those products. The use of this information
constitutes an agreement by the user to these limitations and exclusions.