Wyrestorm NHD-SW-0501 Manual Download Page 2

Page: 2 / 18

WyreStorm.com

Presentation Switcher API | 180618-1621

2 of 18

North America: 844.280.WYRE (9973) | UK/EMEA: +44 (0) 1793 343

Email:

[email protected]

Contents

Overview........................................................................................................................................................................................ 3

Before You Begin ................................................................................................................................................................................................... 3

Network Connections for IP Control ............................................................................................................................................... 4

RS-232 Connections ...................................................................................................................................................................... 5

Simple Method - Individual Ports for Switcher and Device Control .............................................................................................................. 5

Complex Method - Shared Port for Switcher and Remote Device Control .................................................................................................. 6

Communication Configuration ....................................................................................................................................................... 7

Communicating via RS-232 ................................................................................................................................................................................ 7

Communicating via IP .......................................................................................................................................................................................... 7

Commands Strings ........................................................................................................................................................................ 9

Source Switching Commands............................................................................................................................................................................. 9

Source Selection (Source Connections) .................................................................................................................................................................... 9

ScreenLink Start Page .................................................................................................................................................................................................. 9

Query Current Source ................................................................................................................................................................................................... 9

Set Audio Output Volume Level (Discrete) .............................................................................................................................................................. 10

Increase Volume Level................................................................................................................................................................................................ 10

Decrease Volume Level .............................................................................................................................................................................................. 10

Set Audio Output Volume Level (Incremental)........................................................................................................................................................ 10

Query Audio Output Volume Level ............................................................................................................................................................................ 11

Mute Audio Output ...................................................................................................................................................................................................... 11

Query Audio Output Mute State ................................................................................................................................................................................ 11

Link Audio In to Video Input ....................................................................................................................................................................................... 11

Query Audio In link to Video Input ............................................................................................................................................................................. 11

Video Commands ........................................................................................................................................................................ 12

Configure Video Output Resolution .......................................................................................................................................................................... 12

Query Video Output Resolution ................................................................................................................................................................................. 12

Control Commands ...................................................................................................................................................................... 13

Power On (Wake Up) CEC Enabled Device .............................................................................................................................................................. 13

Power Off (Sleep) CEC Enabled Device .................................................................................................................................................................... 13

Enable/Disable Auto Switching ................................................................................................................................................................................. 13

Query Auto Switching State (Enabled/Disabled) .................................................................................................................................................... 13

Switcher Reboot .......................................................................................................................................................................................................... 13

Restore Factory Defaults............................................................................................................................................................................................ 14

3rd Party Device Control (RS-232 2 Port)................................................................................................................................................................ 15

Contacting Support...................................................................................................................................................................... 16

Revision History .......................................................................................................................................................................... 16

Publication Disclaimer ........................................................................................................................................................................ 17

Summary of Contents for NHD-SW-0501

Page 1: ... 343 Email Support WyreStorm com Presentation Switchers NHD SW 0501 SW 0501 HDBT SW 1001 HDBT Application Programming Interface Document Revision v1 2 See Revision History for Updates Document Date June 18th 2018 Minimum Supported Firmware SW 0501 HDBT v3 2 0 SW 1001 HDBT v1 0 0 NHD SW 0501 HDBT v3 2 0 ...

Page 2: ...tions 9 ScreenLink Start Page 9 Query Current Source 9 Set Audio Output Volume Level Discrete 10 Increase Volume Level 10 Decrease Volume Level 10 Set Audio Output Volume Level Incremental 10 Query Audio Output Volume Level 11 Mute Audio Output 11 Query Audio Output Mute State 11 Link Audio In to Video Input 11 Query Audio In link to Video Input 11 6 Video Commands 12 Configure Video Output Resolu...

Page 3: ...ion with the product Note This document is intended to provide the information required to control a configured and installed Presentation Switcher Configure and install the switcher before performing the steps contained in this document Before You Begin Verify that the following items are on hand and that all documentation is reviewed before continuing NHD SW 0501 SW 0501 HDBT or SW 1001 HDBT Con...

Page 4: ...mail Support WyreStorm com 2 Network Connections for IP Control The network connections on the switchers vary from model to model and some have additional ports that are used for other purposes Connection the switcher to a network using the appropriate ports as defined below SW 0501 HDBT and NHD SW 0501 Network Connection SW 1001 HDBT Network Connection ...

Page 5: ...tation for the connected device for pin functionally to ensure that the connect connections can be made The RS 232 connections vary based on the product and the type of control that is being used Follow each sub section below based on the product and type of control being used Switcher Control Ports RS 232 1 Control of the switcher using a 4 pin phoenix connector RS 232 2 Control of local devices ...

Page 6: ...le on the control system This method can only be used if the switcher will not be controlling a local device using RS 232 2 as the port will be used to jump the signal to the HDBaseT RS 232 Note that this method is not applicable for the NHD SW 0501 as there is no port for remote device control Use Simple Method Individual Ports for Switcher and Device Control to control the switcher local and rem...

Page 7: ... Data Bit 8 Stop Bit 1 Communicating via IP Enabling Telnet Client in the PC By default the Telnet client is disabled within Windows Follow the steps below to enable the Telnet client 1 Navigate to Control Panel Programs 2 In Programs and Features area box click Turn Windows features on or off 3 In the Windows Features dialog box select the Telnet Client check box Logging into the Switcher The swi...

Page 8: ... 44 0 1793 343 Email Support WyreStorm com 3 Enter telnet 192 168 1 1 24 if the switchers IP address is 192 168 1 1 and then press Enter 4 Enter user name root and press Enter When the following screen information appears connection to switcher is successful API commands to control the switcher may be entered in the command line interface ...

Page 9: ...I4 HDMI5 HDMI6 DP VGA1 VGA2 HDBT Example Command gbconfig source select HDMI3 Response none ScreenLink Start Page Note ScreenLink is not available on the SW 1001 HDBT and was added to the SW 0501 HDBT Ensure that the latest version of firmware is installed before using this command Refer to the ScreenLink Installation App Note for details Syntax gbset vi NULL Description Switches to the ScreenLink...

Page 10: ...one Increase Volume Level Syntax gbconfig line out 1 level up Description Increases volume by a single step Accepted Values NA Example Command gbconfig line out 1 level up Response none Decrease Volume Level Syntax gbconfig line out 1 level down Description Decreases volume by a single step Accepted Values NA Example Command gbconfig line out 1 level down Response none Set Audio Output Volume Leve...

Page 11: ...esponse none Query Audio Output Mute State Syntax gbconfig show line out 1 mute Description Queries that the output of AUDIO OUT port is muted or not Accepted Values n a Example Command gbconfig show line out 1 mute Response Y Audio output muted N Audio output unmuted Link Audio In to Video Input Syntax gbconfig audio in bind Source Description Links audio from the audio in with video from a desig...

Page 12: ...1080P_60 1080P_50 1080P_30 1080P_25 1080P_24 720P_60 720P_50 576P_50 480P_60 640X480_60 800X600_60 1024X768_60 1280X720_60 1280X768_60 1280X800_60 1280X1024_60 1366X768_60 1440X900_60 1600X1200_60 1680X1050_60 1920X1080_60 1920X1200_60 Example Command gbset fvo 1920X1080_60 Response none Query Video Output Resolution Syntax gbget fvo Description Obtains the resolution set for HDMI and HDBT outputs...

Page 13: ...nabled device such as a display device connected through HDMI or HDBT port enter standby mode Accepted Values Example Command e e_cec_system_standby Response none Enable Disable Auto Switching Syntax gbconfig plug detect Value Description Enables or disables auto switching Accepted Values Y Auto switching enabled N Auto switching disabled Example Command gbconfig plug detect y Response none Query ...

Page 14: ... EMEA 44 0 1793 343 Email Support WyreStorm com Example Command reboot Response none Restore Factory Defaults Syntax reset_to_default sh Description Restores SWITCHER to its factory defaults Note The switcher requires a manual reboot cycle power after restoring defaults Accepted Values Example Command reset_to_default sh Response none ...

Page 15: ...e e Even or o Odd Stop Bits 1 1 for short chosen from 1 or 2 r automatically adds a carriage return in the end of this command for execution Used if needed H indicates CONTENT are equivalent hexadecimal representations of a command of a controlled third party device Used if needed For details see s below s sends a command to a controlled third party device for controlling it If H is not added the ...

Page 16: ...er Source Selection Command Source Selection Added NULL as a value for selection to allow for selecting a blank screen Query Current Source Added NULL and ScreenLink as returned values and active inactive status of the connection Requires v3 2 0 or higher Audio Commands Added Increase and Decrease volume commands Added Link Audio In to Video and Query Audio In link to Video Requires v3 2 0 or high...

Page 17: ...formation 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 informati...

Page 18: ... 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 ...

Search results

Summary of Contents for NHD-SW-0501

Reviews:

Related manuals for NHD-SW-0501

Brands by name

Popular brands

Wyrestorm NHD-SW-0501, Manual

Search results

Summary of Contents for NHD-SW-0501

Reviews:

Related manuals for NHD-SW-0501

Brands by name

Popular brands