Managing the display using RS‑232

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.

The display connected to a room control system using an RS-232 cable

Important 

Use only a standard RS-232 cable. Do not use a null modem cable. 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 SMART Board interactive displays with iQ and devices running Windows, Chrome OS, Android, and iOS operating systems. For more information, see SMART Remote Management.

You must enable room control on the display before sending commands to the display.

  1. Turn on the display.

  2. Press the Settings button on the front control panel.

    The settings menu appears.

  3. Tap the Lock control icon and disable Room Control Lock.

  4. To exit the settings menu, tap the screen.

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

To configure the computer’s serial interface

  1. Turn on the display.

  2. Turn on the computer, and then start the serial communications program or terminal emulation program.

  3. Activate local echo.

  4. Configure the serial interface settings using the following values, and then press ENTER.

    Baud rate

    38400

    Data length

    8

    Parity bit

    None

    Stop bit

    1

  5. Send a carriage return character (<CR>) to the display. An error message should appear.

    Note 

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

To access display information or to adjust display settings using the room control system, type commands and send a carriage return (<CR>) character or press ENTER, and then wait for a response from the display.

A valid command will return k01y<CR> and an invalid command will return k01n<CR>.

If you type a command that the room control system doesn’t recognize, you receive an invalid command response.

Copy

Correct

k01gi000<CR>

Now ON<CR>
k01y<CR>

>

If you type a command that the room control system doesn’t recognize, you receive an invalid command response.

In the example below, the user typed k01gi00<CR> instead of k01gi000<CR>.

Copy

Incorrect

k01gi00<CR>

Now ON<CR>
k01n<CR>

>

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 a response. If there is no response, send a carriage return character (<CR>) to the display. If the display is ready to receive commands, it will show a valid or invalid response after receiving the carriage return.

To retrieve a setting’s current value

  1. Use a query command such as the following example that gets the display’s power state.

    Response when the display is on:

    Copy
    k01gi000<CR>

    Now ON

    >

    Response when the display is in Standby mode:

    Copy
    k01gi000<CR>

    Now Standby

    >

To increase or decrease the value of a setting

  1. Use this command to increase the volume in steps.

    This example increases the volume by 1 (repeat to increase further):

    Copy
    k01sP201<CR>

    k01y<CR>

    >

    This example decreases the volume by 1 (repeat to decrease further):

    Copy
    k01sP200<CR>

    k01y<CR>

    >

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:

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

STANDBY

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

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

Function

Set command

Get command

Response

Power state

k01sA00Value<CR>

Where Value is one of the following:

  • 0 (standby)

  • 1 (on)

k01gi000<CR>

Now Value<CR>

Where Value is one of the following:

  • ON

  • Standby

Input

k01sB0Value<CR>

Where Value is one of the following:

  • 00 (ATV)

  • 01 (AV)

  • 03 (YPBPR)

  • 04 (HDMI)

  • 06 (VGA)

  • 07 (OPS1)

  • 09 (Display Port)

  • 10 (DTV)

  • 0A (Home)

  • 0C USB-C

  • 14 (HDMI1)

  • 24 (HDMI2)

k01gh000<CR>

k01rhValue<CR>

Where Value is one of the following:

  • X01 (AV input)

  • X03 (YPBPR)

  • X04 (HDMI)

  • X14 (HDMI1)

  • X24 (HDMI2)

  • X07 (OPS1)

  • X09 (Display Port)

  • 10A (Home screen)

  • X1C (USB-C)

The “X” in the response can be either “0” or “1”.

“0” indicates that the video input does NOT have a video signal. “1” indicates that the video input DOES have a video signal.

Picture size

k01sM004<CR>

N/A

N/A

Volume

k01sPValue<CR>

Where Value is one of the following:

  • 0–100

    Note 

    Volume level is set by entering a number between 0 and 100

  • 200 (-1 level)

  • 201 (+1 level)

k01gf000<CR>

k01rfValue<CR>

Where Value is a number between 0 and 100.

Mute

k01sQValue<CR>

Where Value is one of the following:

  • 0 (off)

  • 1 (on)

k01gg000<CR>

k01rgValue<CR>

Where Value is one of the following:

  • 000 (off)

  • 001 (on)

Number

k01sTValue<CR>

Where Value is one of the following:

  • 0–009

    Note 

    Number value is set by entering a number between 0 and 009.

N/A

N/A

Key

k01sUValue<CR>

Where Value is one of the following:

  • 000 (up)

  • 001 (down)

  • 002 (left)

  • 003 (right)

N/A

N/A

Freeze

k01s_Value<CR>

Where Value is one of the following:

  • 000 (off)

  • 001 (on)

N/A

N/A

Device name

N/A

k01gr000<CR>

k01rrValue<CR>

Where Value is one of the following with “XX” representing the separate characters for a device name:

  • 1XX

  • 2XX

  • 3XX

Mac address

N/A

k01gs000<CR>

k01rsValue<CR>

Where Value is one of the following with “XX” representing the six separate hexadecimal bytes for a MAC address (e.g. “XX:XX:XX:XX:XX:XX”):

  • 1XX

  • 2XX

  • 3XX

  • 3XX

  • 3XX

  • 3XX

Managing the display using RS‑232

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.

The display connected to a room control system using an RS-232 cable

Important 

Use only a standard RS-232 cable. Do not use a null modem cable. 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 SMART Board interactive displays with iQ and devices running Windows, Chrome OS, Android, and iOS operating systems. 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.

  • You send the set powerstate=ready or set powerstate=on command.

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

  • =vga

  • =ops

  • =type-c1 [or usbc1]

    =type-c2 [or usbc2]

  • =dp

  • =android

input=Value

Where Value is one of the following:

  • hdmi1

  • hdmi2

  • hdmi3

  • =vga

  • =ops

  • =type-c1 [or usbc1]

    =type-c2 [or usbc2]

  • =dp

  • =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-gx065-v2

  • sbid-gx075-v2

  • sbid-gx086-v2

  • sbid-gx065-v3

  • sbid-gx075-v3

  • sbid-gx086-v3

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

  • =vga

  • =ops

  • =type-c1 [or usbc1]

    =type-c1 [or usbc1]

  • =dp

  • =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