Managing the display using RS‑232

RS-232 connection

You can connect an RS-232 cable from a computer or a control system’s serial output to the display’s RS-232 In connector to remotely select video inputs, turn the display on or off, and get information about the display’s current settings, such as volume and power state.

Important 

Use only a null modem RS-232 cable (or converter). Null modem cables typically have ends of the same type.

Tip 

SMART also offers SMART Remote Management cloud-based device-management software, which you can use to manage the display. For more information, see SMART Remote Management.

Configure the computer or control system’s serial interface before sending commands to the display.

  1. Turn on the display.

  2. If you’re using a terminal application on a computer, activate local echo to see what you’re typing and sending to the display.

  3. Configure the serial interface settings with the following values:

    Baud rate

    19200

    Data length

    8

    Parity bit

    None

    Stop bit

    1

  4. Send a carriage return character (<CR>) to the display. The display will show a command prompt (>) to indicate that the display can now accept commands.

    Note 

    • If you’re using a terminal application on a computer, pressing ENTER should send a carriage return character (<CR>) but might also send a line feed character (<LF>), depending on your terminal application configuration.

    • If no message appears or an error message appears, the serial interface isn’t configured correctly. Repeat steps 3 and 4.

    • If you’re using a terminal app on a PC, keep your screen legible by configuring the terminal app’s settings to add a line feed <LF> after sending or receiving a carriage return <CR>. For example, in the PUTTY app, enable terminal option Implicit LF in every CR.

When using a control system program instead of terminal program, all the lines output from the display are preceded by a carriage return character (<CR>) and line feed character (<LF>) and then followed by a carriage return character (<CR>) and line feed character (<LF>), as shown in the example below. Refer to an ASCII table for more information about character codes if needed. 

>set volume=0<CR>
<CR><LF>
volume=0<CR><LF>
>

To access display information or to adjust display settings using the room control system, send a command after the command prompt (>), send a carriage return character or press ENTER, and then wait for the response from the display. Responses are preceded by a carriage return character (<CR>) and line feed character (<LF>) and then followed by a carriage return character (<CR>) and line feed character (<LF>). If no command prompt is present, send a carriage return character to the display. If the display is ready to receive commands, it will show a command prompt (>) when the carriage return is received. See the example below.

Copy

Correct

>get volume

volume=55

>

In the example below, the user used =-50 instead of -50.

Copy

Incorrect

>set volume=-50

invalid cmd: setvolume=-50

>

Notes 

  • Use ASCII formatted commands.

  • Commands aren’t case-sensitive and extra spacing is ignored.

  • In many terminal applications on a computer, you can use the BACKSPACE key when typing commands.

  • Review each entry carefully before sending a command to the display.

  • Don’t send another command until you receive the response and the next command prompt (>). If no command prompt is present, send a carriage return character (<CR>) to the display. If the display is ready to receive commands, it will show a command prompt after receiving the carriage return.

To retrieve a setting’s current value

  1. Use a get command.

    This example shows how to get the volume:

    Copy
    >get volume

    volume=55

    >

To assign a value to a setting

  1. Use a set command.

    This example sets the volume to 65:

    Copy
    >set volume=65

    volume=65

    >

To increase or decrease the value of a setting

  1. Use the set command to increase or decrease the value by a designated number.

    This example increases the volume by 5:

    Copy
    >set volume+5

    volume=70

    >

    This example decreases the volume by 15:

    Copy
    >set volume-15

    volume=55

    >

Get command

Set command

Response

get powerstate

set powerstateValue

Where Value is one of the following:

  • =on

  • =ready

  • =powersave

powerstate=Value

Where Value is one of the following:

  • on

  • ready

  • powersave

The display has three power states:

Power state

Description

ON

The display is in normal operating mode.

READY

The screen is off, but the display is ready to turn on when one of the following occurs:

  • A user presses the Power button on the front control panel or the remote control.

  • You send the set powerstate=on command.

  • The display receives a video signal.

POWERSAVE

The screen is off, and the display is in a very low power state. The display enters READY or ON state when one of the following occurs:

  • A user presses the Power button on the front control panel or the remote control.

  • The display receives a video signal.

This power state is the default energy saving mode for displays set to an EU location.

Note 

The EU uses “Standby” to describe this power state.

Get command

Set command

Response

get input

set inputValue

Where Value is one of the following:

  • =hdmi1

  • =hdmi2

  • =hdmi3

  • =vga1

  • =ops1

  • =typec1 [or usbc1]

    =typec2 [or usbc2]

  • =dp1

  • =android

input=Value

Where Value is one of the following:

  • hdmi1

  • hdmi2

  • hdmi3

  • vga1

  • ops1

  • usbc1

    usbc2

  • dp1

  • android

Get command

Set command

Response

get brightness

set brightnessValue

Where Value is one of the following:

  • +Value

  • -Value

  • =0–100

brightness=Value

Where Value is a number between 0 and 100

Get command

Set command

Response

get videofreeze

set videofreezeValue

Where Value is one of the following:

  • =on

  • =off

videofreeze=Value

Where Value is one of the following:

  • on

  • off

Get command

Set command

Response

get screenshade

set screenshadeValue

Where Value is one of the following:

  • =on

  • =off

screenshade=Value

Where Value is one of the following:

  • on

  • off

Get command

Set command

Response

get volume

set volumeValue

Where Value is one of the following:

  • +Value

  • -Value

  • =0–100

volume=Value

Where Value is a number between 0 and 100

Get command

Set command

Response

get mute

set muteValue

Where Value is one of the following:

  • =on

  • =off

mute=Value

Where Value is one of the following:

  • on

  • off

Get command

Response

get fwversion

fwversion=Value

Where Value is the firmware version.

Get command

Response

get modelnum

modelnum=Value

Where Value is one of the following:

  • SBID-GX065N-V4

  • SBID-GX075N-V4

  • SBID-GX086N-V4

Get command

Response

get serialnum

serialnum=Value

Where Value is the serial number.

Get command

Response

get partnum

partnum=Value

Where Value is the part number, including the revision.

The display sends an asynchronous message when the front control panel, Settings app, or remote control are used to change a display’s setting that can be controlled by RS-232. The display will also send an asynchronous message if the display’s power state changes. Asynchronous messages are identified by a pound sign (#) before the message and aren’t followed by a command prompt (>).

Change

Asyncronous message

display power state

#powerstate=Value

Where Value is one of the following:

  • on

  • ready

  • powersave

Input selection

#input=Value

Where Value is one of the following:

  • =hdmi1

  • =hdmi2

  • =hdmi3

  • =vga1

  • =ops1

  • =usbc1

  • =usbc2

  • =dp1

  • =android

Brightness

#brightness=Value

Where Value is a number between 5 and 100

Freeze frame

#videofreeze=Value

Where Value is one of the following:

  • on

  • off

Screen shade

#screenshade=Value

Where Value is one of the following:

  • on

  • off

Volume increase or decrease

#volume=Value

Where Value is a number between 0 and 100

Volume mute

#mute=Value

Where Value is one of the following:

  • on

  • off

Related documents