0% found this document useful (0 votes)
6 views14 pages

AT-OME-ST31 API Command Guide

The document provides an application programming interface (API) for the AT-OME-ST31, a 4K/UHD three-input switcher with HDMI and USB-C inputs. It includes version information, command syntax, and descriptions for various commands that can be executed via RS-232 or Telnet. Key commands include power management, input status, network configuration, and device control features.

Uploaded by

svorobovicp
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
6 views14 pages

AT-OME-ST31 API Command Guide

The document provides an application programming interface (API) for the AT-OME-ST31, a 4K/UHD three-input switcher with HDMI and USB-C inputs. It includes version information, command syntax, and descriptions for various commands that can be executed via RS-232 or Telnet. Key commands include power management, input status, network configuration, and device control features.

Uploaded by

svorobovicp
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

4K / UHD Three-Input Switcher for

HDMI and USB-C with HDBaseT and HDMI Outputs


Application Programming Interface
1.0.05

AT-OME-ST31 Atlona Manuals


Switchers
Version Information
Version Release Date Notes
1 Dec 2018 Initial release
2 May 2019 Updated for firmware version 1.0.05; added RHostName, SHostName, IP802.1x,
RepCmdTime, and RepeatCmd commands.

AT-OME-ST31 2
Commands
The following tables provide an alphabetical list of commands available for AT-OME-ST31. Commands are case-
sensitive. If the command fails or is entered incorrectly, then the feedback is “Command FAILED”. Commands can
be sent using RS-232 or Telnet. There should be a 500 millisecond delay between each command sent to the unit.
The default port for Telnet is 23.

IMPORTANT: Each command is terminated with a carriage-return (0x0d) and the feedback is
terminated with a carriage-return and line-feed (0x0a).

Command Description
Blink Enables or disables blinking of the POWER button on the front panel
CommaWait Enables or disables a comma adding a 5 second delay between commands
DispBtn Simulates pressing the DISPLAY button on the front panel
help Displays a list of available help commands
InputStatus Displays the status for each input
IP802.1x Sets the security authentication type
IPCFG Displays IP address configuration
IPDHCP Turns DHCP on / off
IPStatic Sets a static IP address
Lock Locks the buttons on the front panel
Mreset Sets the unit back to default settings
PWOFF Execute this command to power-off the unit
PWON Execute this command to power-on the unit
PWSTA Displays the power state of the unit
RepCmdTime Sets the number of times a command is repeated
RepeatCmd Enables or disabled the RepCmdTime feature
RHostName Displays the host name for the AT-OME-ST31
RS232zone Triggers the unit to send the RS-232 command to the display connected to the
HDBaseT receiver’s RS-232 port
SHostName Sets the host name for the unit
Status Displays the routing state of the unit
Type Displays the model of the unit
Unlock Unlocks the buttons on the front panel
Version Displays the current firmware version of the unit
VOUTMute Mutes the output volume for the specified output
xY$ Mutes/Unmutes AV signals for the specified output channel
xYAVxZ Switches the specified input to the specified output

AT-OME-ST31 3
Commands

Blink
Enables or disables blinking of the POWER button on the front panel. When set to on, the POWER button will flash
blue, and can be used to physically identify the unit on a network. The POWER button will flash until the Blink off
command is executed. on = enables blinking; off = disables blinking; sta = displays the current setting. The default
setting is off.

Syntax

Blink X

Parameter Description Range

X Value on, off, sta

Example Feedback
Blink on Blink on

CommaWait
Adds a 5 second delay between commands, when a comma is included

Syntax

CommaWait X

Parameter Description Range

X Value on, off, sta

Example Feedback
CommaWait on CommaWait on

DispBtn
Sets the command triggered through display control (set in the webGUI).

Syntax

DispBtn X

Parameter Description Range

X State on, off, tog, sta

Example
Feedback
DispBtn on
DispBtn on

NOTE: The feedback will display channel status: 0 is no signal detected and 1 is signal detected.

AT-OME-ST31 4
Commands

help
Displays the list of available commands. To obtain help on a specific command, enter the help command followed
by the name of the command.

Syntax

help [X]

Parameter Description Range

X Command name (optional) Command

Example Feedback
help Blink
CommaWait
DispBtn
System
IPCFG
IPStatic
...
...

InputStatus
Displays the status of the specified input as either a 0 or 1. If a source is detected on the input, then a 1 will be
displayed. Inputs with no source connected will display a 0.

Syntax

InputStatus

This command does not require any parameters


Example Feedback
InputStatus InputStatus 010

AT-OME-ST31 5
Commands

IP802.1x
Sets the security setting for use with RADIUS server authentication. Use the sta argument to display the current
setting.

Syntax

IP802.1x X

Parameter Description Range

X Security setting disable, PEAP, TTLS, TLS, sta

Example Feedback
IP802.1x TTLS IP802.1x TTLS

IPCFG
Displays the current network settings for the unit.

Syntax

IPCFG

This command does not require any parameters

Example Feedback
IPCFG Mac Addr: B8:98:B0:05:DF:F7
IP Addr: [Link]
Netmask: [Link]
Gateway: [Link]
Telnet Port: 23
HTTP Port: 80

AT-OME-ST31 6
Commands

IPDHCP
Enables or disables DHCP mode on the unit. on = enables DHCP mode; off = disables DHCP mode; sta = displays
the current setting. If this feature is disabled, then a static IP address must be specified for the unit. Refer to the
IPStatic command for more information.

Syntax

IPDHCP X

Parameter Description Range

X Value on, off, sta

Example Feedback
IPDHCP on IPDHCP on

IPStatic
Sets the static IP address, subnet mask, and gateway (router) address of the unit. Before using this command,
DHCP must be disabled on the unit. Refer to the IPDHCP command for more information. Each argument must be
entered in dot-decimal notation and separated by a space. The default static IP address is [Link].

Syntax

IPStatic X Y Z

Parameter Description Range

X IP address 0 ... 255 (per byte)

Y Subnet mask 0 ... 255 (per byte)

Z Gateway (router) 0 ... 255 (per byte)

Example Feedback
IPStatic [Link] [Link] [Link] IPStatic [Link] [Link] [Link]

Lock
Locks the buttons on the front panel. This feature is useful when the unit is installed in a rack environment or other
remote location, to prevent unauthorized tampering or accidental pressing of the front-panel buttons. Also refer to
the Unlock command.

Syntax

Lock

This command does not require any parameters

Example Feedback
Lock Lock

AT-OME-ST31 7
Commands

Mreset
Resets the unit to factory-default settings.

Syntax

Mreset

This command does not require any parameters

Example Feedback
Mreset Mreset

PWOFF
Executing this command will power-off the unit. Execute the PWON command to power-on the unit.

Syntax

PWOFF

This command does not require any parameters

Example Feedback
PWOFF PWOFF

PWON
Executing this command will power-on the unit. Use the PWOFF command to power-off the unit.

Syntax

PWON

This command does not require any parameters

Example Feedback
PWON PWON

AT-OME-ST31 8
Commands

PWSTA
Displays the current power state of the unit.

Syntax

PWSTA

This command does not require any parameters

Example Feedback
PWSTA PWON

RepCmdTime
Sets the number of time a command will be sent. Specify the sta argument to display the current setting.

Syntax

RepCmdTime X

Parameter Description Range

X Times to repeat command 2 ... 4, sta

Example Feedback
RepCmdTime 3 RepCmdTime 3

RepeatCmd
Enables / disables the RepCmdTime feature. Specify the sta argument to display the current setting.

Syntax

RepeatCmd X

Parameter Description Range

X Status on, off, sta

Example Feedback
RepeatCmd on RepeatCmd on

AT-OME-ST31 9
Commands

RHostName
Displays the hostname of the unit.

Syntax

RHostName

This command does not require any parameters

Example Feedback
RHostName RHostName OMEST31-010C90

RS232zone
Sends commands to the HDBaseT device. Refer to the User Manual of the display device for a list of available
commands. Brackets must be used when specifying the command argument. The command line must not contain
any spaces. Since the AT-OME-ST31A has only one HDBaseT output (zone), “1” must be specified as the first
argument.

Syntax

RS232zoneX[Y]

Parameter Description Range

X Zone 1

Y Command String

Example Feedback
RS232zone1[command] RS232zone1[command]

SHostName
Sets the hostname of the unit. The string name must not contain any spaces.

Syntax

SHostName X

Parameter Description Range

X Name String

Example Feedback
SHostName AT-OME-ST31_Huddle1 SHostName AT-OME-ST31_Huddle1

AT-OME-ST31 10
Commands

Status
Displays which input is routed to which output. Refer to the xYAVxZ command for more information.

Syntax

Status

This command does not require any parameters

Example Feedback
Status x2AVx1,x2AVx2

Type
Displays the model information of the unit.

Syntax

Type

This command does not require any parameters

Example Feedback
Type AT-OME-ST31

Unlock
Unlocks the buttons on the front panel. Also refer to the Lock command.

Syntax

Unlock

This command does not require any parameters

Example Feedback
Unlock Unlock

AT-OME-ST31 11
Commands

Version
Displays the current firmware version of the unit.

Syntax

Version

This command does not require any parameters

Example Feedback
Version 1.0.05

VOUTMute
Mutes / unmutes the output volume for the specified output. The first argument references the output: 1 = HDMI,
2 = HDBaseT.

Syntax

VOUTMute X Y

Parameter Description Range

X Output 1, 2

Y State on, off, sta

Example Feedback
VOUTMute 2 off VOUTMute 2 off

xY$
Enables / disables video for the specified output. The first argument references the output: 1 = HDMI, 2 = HDBaseT.

Syntax

xY$ Z

Parameter Description Range

Y Output 1, 2

Z State on, off, sta

Example Feedback
x2$ off x2$ off

AT-OME-ST31 12
Commands

xYAVxZ
Switches the specified input to the specified output. The first argument references the input: 1 = USB-C,
2 = HDMI 1, 3 = HDMI 2. The second argument must always be 1. Both HDMI and HDBaseT outputs will output
the same source signal. Note that the feedback will display that the specified input is being routed to both output 1
(HDMI) and output 2 (HDBaseT), as shown below.

Syntax

xYAVxZ

Parameter Description Range

Y Input 1 ... 3

Z Output 1

Example Feedback
x3AVx1 x3AVx1

AT-OME-ST31 13
Toll free US International
[Link] • 877.536.3976 • 41.43.508.4321

© 2019 Atlona Inc. All rights reserved. “Atlona” and the Atlona logo are registered trademarks of Atlona Inc. All other brand names and trademarks or registered trademarks are the property of their respective owners. Pricing, specifications and
availability subject to change without notice. Actual products, product images, and online product images may vary from images shown here.

You might also like