Managing the display using RS‑232

You can connect an RS-232 cable from a computer’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.

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’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

    19200

    Data length

    8

    Parity bit

    None

    Stop bit

    1

    A command prompt (>) appears on the following line, and the display can now accept commands from the computer.

    Note 

    If no message appears or an error 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 after the command prompt (>) and wait for the response from the display.

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

  • =standby

Note 

If the display is in UPDATEON or UPDATEREADY state, it might not change power states after receiving the command.

powerstate=Value

Where Value is one of the following:

  • on

  • ready

  • standby

  • update

The display has six 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 convenience panel or the remote control.

  • A user picks up a pen or the eraser.

  • You send the set powerstate=on command.

  • The proximity sensors detect people in the room.

  • The display receives a video signal.

STANDBY

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

  • The proximity sensors detect people in the room.

  • A user presses the Power button on the convenience 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 a non-EU location.

Note 

The EU uses “networked standby” to describe this power state.

POWERSAVE

The screen is off, and the display is 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 convenience 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.

UPDATEON

The display is updating firmware. Do not turn off the display.

UPDATEREADY

The display is updating firmware while the screen is off. Do not turn off the display.

With the exception of get powerstate and set powerstate, commands are available only when the display is in READY or ON power state.

Get command

Set command

Response

get input

set inputValue

Where Value is one of the following:

  • =hdmi1

  • =hdmi2

  • =hdmi3

  • =hdmi4

  • =vga1

  • =ops1

  • =usb1

  • =usbc

  • =android

input=Value

Where Value is one of the following:

  • hdmi1

  • hdmi2

  • hdmi3

  • hdmi4

  • vga1

  • ops1

  • usb1

  • usbc

  • android

  • none

Get command

Set command

Response

get brightness

set brightnessValue

Where Value is one of the following:

  • +Value

  • -Value

  • =5–100

brightness=Value

Where Value is a number between 5 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 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.

Get command

Set command

Response

get statereporting

set statereportingValue

Where Value is one of the following:

  • =on

  • =off

statereporting=Value

Where Value is one of the following:

  • on

  • off

Set command

Response

set factoryreset=Value

Where Value is the serial number.

factoryreset=Value

Where Value is the serial number.

Related documents