Wyrestorm SW-130-TX Guide de l'utilisateur
Application Programming Interface
Product Model
SW-130-TX
Document Revision
V1.0
Document Date
June 2020
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
2 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Contents
Overview .......................................................................................................................................... 3
Wiring and Communication Configuration ........................................................................................3
Command Overview .........................................................................................................................4
Switching Inputs .............................................................................................................................. 5
Controlling Display Power via CEC.................................................................................................... 6
Troubleshooting............................................................................................................................... 8
Contacting Technical Support ..........................................................................................................9
Document Revision History .............................................................................................................. 9
Publication Disclaimer ...................................................................................................................10
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
3 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Overview
The following contains the connection info and commands to control the SW-130-TX In-Wall HDBaseT switcher. By
following the content contained in this document the switcher can be controlled and configured via a 3rd party RS-232
control system.
Before You Begin
Verify that the following items are on hand and that all documentation is reviewed before continuing:
Connected and operational SW-130-TX..................................................................................................................................
Control System and Control System Documentation...........................................................................................................
PC or Mac for Configuring Product...........................................................................................................................................
Wiring and Communication Configuration
WyreStorm recommends that all wiring for the installation is run and terminated prior to making connections to the
switcher. Before running or terminating the wires, read through this section in its entirety to ensure proper operation and to
avoid damaging equipment.
RS-232 Connection
The following wiring diagram shows the pinout for the WyreStorm device. 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.
RS-232 Port Settings
Baud rate:
115200bps
Data Bits:
8bits
Parity:
None
Stop Bits:
1bit
Flow Control:
None
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
4 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Command Overview
Command Delimiter for Sent Commands
When sending commands using the RS-232 API channel, all command lines sent from the 3rd-party controller to the
switcher should end with a specific character. This signifies when the command is processed by the switcher. This is
usually specified in 3rd-party control software as the “command delimiter,” “stop character,” or “line terminator.”
Accepted delimiter characters are:
Character Shorthand Hex Notation Escape Notation Decimal Notation
Line Feed
LF
0A
\n
10
Carriage Return + Line Feed
CR LF
0D 0A
\r\n
13 10
Note: Most 3rd-party control software will either append these characters automatically or an option to specify
them will be present. It is important that the last delimiter character is LF and not CR.
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
5 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Switching Inputs
Switching Video Inputs
Command structure:
SET SW <INPUT>
<INPUT> = hdmi1 | hdmi2 | usbc
Response Syntax:
SW <INPUT>
Example Command:
SET SW hdmi1
Example Response:
SW hdmi1
Query Active Input
Command structure:
GET SW
Response Syntax:
<INPUT>
Example Command:
GET SW
Example Response:
hdmi1
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
6 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Controlling Display Power via CEC
CEC Display Power
Command structure:
SET CEC_PWR <PRM>
<PRM> = on | off
Response Syntax:
CEC_PWR <PRM>
Example Command:
SET CEC_PWR on
Example Response:
CEC_PWR on
Set CEC Auto Trigger
Command structure:
SET AUTOCEC_M <PRM>
<PRM> = on | off
Response Syntax:
AUTOCEC_M <PRM>
Example Command:
SET AUTOCEC_M on
Example Response:
AUTOCEC_M on
The switcher can automatically send a CEC Power On command through its output when an input signal is detected. CEC
Power Off commands can also automatically be sent after a predetermined amount of time passes and when a signal
detection is lost. See “Set CEC Auto Power Off Delay” section for details.
Query CEC Auto Trigger
Command structure:
GET AUTOCEC_M
Response Syntax:
AUTOCEC_M <PRM>
Example Command:
GET AUTOCEC_M
Example Response:
AUTOCEC_M on
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
7 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Set CEC Auto Power Off Delay
Command structure:
SET AUTOCEC_D <PRM>
<PRM> = 1~30
Response Syntax:
AUTOCEC_D <PRM>
Example Command:
SET AUTOCEC_D 5
Example Response:
AUTOCEC_D 5
Note: <PRM> is in minutes. A value of 5 is equal to a 5-minute delay.
Query CEC Auto Power Off Delay
Command structure:
GET AUTOCEC_D
Response Syntax:
AUTOCEC_D <PRM>
Example Command:
GET AUTOCEC_D
Example Response:
AUTOCEC_D 5
Note: <PRM> is in minutes. A value of 5 is equal to a 5-minute delay.
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
8 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Troubleshooting
Enable Long Reach Mode
Command structure:
SET LR_FN <PRM>
<PRM> = on | off
Response Syntax:
LR_FN <PRM>
Example Command:
SET LR_FN on
Example Response:
LR_FN on
Query Firmware Version
Command:
GET SW_VERSION
<PRM> = current installed firmware version
Response Syntax:
<PRM>
Reboot Switcher
Command:
REBOOT
No Parameters
Response:
REBOOT
Restore Factory Defaults
Command:
RESET
No Parameters
Response:
RESET
Copyright © 2020 WyreStorm Technologies | WyreStorm.com
SW-130-TX API | 200706
9 of 10
UK: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
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: +44 (0) 1793 230 343 | ROW: 844.280.WYRE (9973)
Contact Request: http://wyrestorm.com/contact-tech-support
Document Revision History
V1.0 – June 2020
All
Initial release of document
WyreStorm Offices
North America: 23 Wood Road, Round Lake, NY 12151
Tel: +1 518-289-1293
EMEA: Unit 22, Ergo Business Park, Swindon, Wiltshire, SN3 3JW, UK
Tel: +44 (0) 1793 230 343
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.
Table des matières
Autres manuels Wyrestorm Changer
Wyrestorm
Wyrestorm SW-0201-4K Manuel utilisateur
Wyrestorm
Wyrestorm NHD-400-RX Manuel utilisateur
Wyrestorm
Wyrestorm MX-0404-POH-KIT Manuel utilisateur
Wyrestorm
Wyrestorm SW-540-TX-W Manuel utilisateur
Wyrestorm
Wyrestorm SW-220-TX-W Manuel utilisateur
Wyrestorm
Wyrestorm SW-540-TX-W Manuel utilisateur
Wyrestorm
Wyrestorm SW-0401-HDBT Manuel utilisateur
Wyrestorm
Wyrestorm MX-0404-H2 Manuel utilisateur
Wyrestorm
Wyrestorm SW-1001-HDBT Manuel utilisateur
Wyrestorm
Wyrestorm SW-740-TX Manuel utilisateur
Wyrestorm
Wyrestorm EXP-MX0402-010 Manuel utilisateur
Wyrestorm
Wyrestorm MX0404-HDC Manuel utilisateur
Wyrestorm
Wyrestorm MX-0404-PP-KIT Manuel utilisateur
Wyrestorm
Wyrestorm MX-0808-HDBT Manuel utilisateur
Wyrestorm
Wyrestorm NHD-SW-0501 Manuel utilisateur
Wyrestorm
Wyrestorm SW-0501-HDBT Manuel utilisateur
Wyrestorm
Wyrestorm NHD-000-CTL Manuel utilisateur
Wyrestorm
Wyrestorm SW-0402-MV-HDBT Manuel utilisateur
Wyrestorm
Wyrestorm SW-0201-POH Manuel utilisateur
Wyrestorm
Wyrestorm SW-0501-HDBT Manuel utilisateur
