ALFAtron SMW42S Installation instructions

www.alfatronelectronics.com
ALFATRON ELECTRONICS GmbH GERMANY
Alfatron SMW42S
API Commands Guide

ALF-SMW42S API Guide
1
Contents
1 Introduction........................................................................................................... 3
1.1 Preparation ........................................................................................... 3
1.1.1 Setting IP Address in Your Computer .................................................... 3
1.1.2 Enabling Telnet Client ........................................................................... 3
1.2 Logging In to Device via Command-line Interface ................................. 3
1.3 Introduction to Terminology................................................................... 5
1.4 API Commands Overview ..................................................................... 6
1.4.1 gbconfig Commands ............................................................................. 6
1.4.2 gbcontrol Commands ............................................................................ 7
1.4.3 gblayout Commands ............................................................................. 7
1.4.4 Event Commands.................................................................................. 8
2 Command Sets..................................................................................................... 8
2.1 gbconfig Commands ............................................................................. 8
2.1.1 gbconfig --name .................................................................................... 8
2.1.2 gbconfig --output-resolution................................................................... 8
2.1.3 gbconfig --auto-switch-source ............................................................... 9
2.1.4 gbconfig --lan-info ................................................................................. 9
2.1.5 gbconfig --hdcp-enable........................................................................ 10
2.1.6 gbconfig --rs232-param........................................................................10
2.1.7 gbconfig --rs232-hex-cmd-enable.........................................................11
2.1.8 gbconfig --rs232-sinkpoweron-cmd ......................................................11
2.1.9 gbconfig --rs232-sinkpoweroff-cmd ......................................................12
2.1.10 gbconfig --auto-standby-time................................................................12
2.1.11 gbconfig --sinkpower-mode ..................................................................13
2.1.12 gbconfig --special-sink..........................................................................13
2.1.13 gbconfig --source-select .......................................................................14
2.1.14 gbconfig --media-source.......................................................................14
2.1.15 gbconfig --input-state ...........................................................................17
2.1.16 gbconfig --auido-select .........................................................................18
2.1.17 gbconfig --access-code ........................................................................18
2.1.18 gbconfig --softap-password ..................................................................19
ALF-SMW42S API Guide
2.1.19 gbconfig --show....................................................................................19

ALF-SMW42S API Guide
2
2.1.20 gbconfig --help .....................................................................................21
2.2 gbcontrol Commands ...........................................................................22
2.2.1 gbcontrol --reboot.................................................................................22
2.2.2 gbcontrol --reset-to-default ...................................................................22
2.2.3 gbcontrol --upgrade-firmware ...............................................................22
2.2.4 gbcontrol --video-source.......................................................................23
2.2.5 gbcontrol --audio-source ......................................................................23
2.2.6 gbcontrol --stop-video...........................................................................23
2.2.7 gbcontrol --sinkpower ...........................................................................23
2.2.8 gbcontrol --show-osd........................................................................... 24
2.2.9 gbcontrol --serial ................................................................................. 24
2.2.10 gbcontrol --help ................................................................................... 25
2.3 gblayout Commands ........................................................................... 25
2.3.1 gblayout --start-video .......................................................................... 25
2.3.2 gblayout --stop-video........................................................................... 26
2.3.3 gblayout --add ..................................................................................... 26
2.3.4 gblayout --del .......................................................................................27
2.3.5 gblayout --list........................................................................................28
2.3.6 gblayout --show....................................................................................28
2.3.7 gblayout --set .......................................................................................29
2.3.8 gblayout --get .......................................................................................29
2.3.9 gblayout --set-sequence.......................................................................30
2.3.10 gblayout --get-sequence.......................................................................31
2.3.11 gblayout --auto .....................................................................................31
2.3.12 gblayout --help .....................................................................................32
2.4 Event Commands.................................................................................32
2.4.1 [Event] VideoSource ............................................................................32
2.4.2 [Event] WorkMode................................................................................33
2.4.3 [Event] Layout ......................................................................................33
3

ALF-SMW42S API Guide
3
1.1 Preparation
This section takes a third party control device windows 7 as an example. You may also use other control
devices.
Telnet Port Number
Connection
Type
Telnet
Port Number
24
Username
root
Password
<blank>
1.1.1 Enabling Telnet Client
Before logging in to IP controller via the command-line interface, make sure that Telnet Client is
enabled. By default, Telnet Client is disabled in Windows 7. To turn on Telnet Client, do as follows.
1. Choose Start > Control Panel > Programs (Windows 7) or Start > Windows System >
Control Panel > Programs (Windows 10).
2. In Programs and Features area box, click Turn Windows features on or off.
3. In Windows Features dialog box, select Telnet Client check box.
1.2 Logging In to Device via Command-line
Interface
1. Choose Start > Run.

ALF-SMW42S API Guide
4
2. In the Run dialog box, enter cmd then click OK.
3. Enter telnet 192.168.5.94 24 if the device IP address is 192.168.5.94, and then press
Enter.
4. The device prompt for user name, please input root, then press Enter.
5. The device prompt for a password, currently it has no password, just press Enter.

ALF-SMW42S API Guide
5
1.3 Introduction to Terminology
The terminology used in API command description is listed as follows.
Terminology Description
Device The unit being controlled.
Airplay Mirroring
A screen mirroring approach developed by Apple, it is supported by
many Apple devices, such as Macbook, iPad and iPhone. In this document, we
use Airplay as its abbreviation.
Miracast
A screen mirroring approach developed by Wi-Fi alliance, it is supported
by all Android devices and Windows PC.
GBCast
Grandbeing proprietary screen mirroring approach with a sender
software.
BYOD Source
Airplay, Miracas and GBCast are BYOD solutions, they are named
BYOD (video ) source.
Hardware Source
A SMW42S has for hardware video input interfaces: HDMI1, HDMI2, HDMI3 and
HDMI4, they are named
hardware (video) source.
Software Source
Obtain and display the video content from a USB camera or Grandbeing IPAV
H.264 encoder, we named them software (video) source.
For the BYOD source supported, they are called
software source too.

ALF-SMW42S API Guide
6
1.4 API Commands Overview
API commands of the IP controller are mainly classified into the following types.
gbconfig: manage the configurations of the device
gbcontrol: control the device to do something
gblayout: adjust the features related to screen layout
event: unsolicited message to report that the device state changes
Every API command is supported unless there is special comment in the context.
1.4.1 gbconfig Commands
Commands Description
gbconfig --name Configure the device’s name
gbconfig --output-resolution Configure the resolution of the HDMI out
interfaces
gbconfig --auto-switch-source Configure the automatic switching feature.
gbconfig --lan-info Configure the wired Ethernet settings
gbconfig --hdcp-enable Configure whether the HDCP feature of HDMI
out the interface is enabled
gbconfig --rs232-param Configure the RS232 communication settings
used to control the external display
gbconfig --rs232-hex-cmd-enable Configure whether to set the commands used to
control the external display with
hexadecimal format
gbconfig --rs232-sinkpoweron-cmd Configure the RS232 command string used to
turn on the external display
gbconfig --rs232-sinkpoweroff-cmd Configure the RS232 command string used to
turn off the external display
gbconfig --auto-standby-time Configure the timeout of the automatic
standby feature
gbconfig --sinkpower-mode Configure the mode by which the device turn
on/off the external display
gbconfig --special-sink Configure the settings for special sink
gbconfig --source-select Control the device to display a video source
gbconfig --input-state Query the details of the video source(s)
gbconfig --media-source Manage the video sources
gbconfig --audio-select Control the device to play the audio of the
designated video source
gbconfig --access-code Configure the access code of BYOD video
source

ALF-SMW42S API Guide
7
gbconfig --softap-password Configure the password of the soft AP
gbconfig --show Query the settings of a configuration item
gbconfig --help Show a simple guide of gbconfig command
1.4.2 gbcontrol Commands
Command Description
gbcontrol --reboot Reboot the device
gbcontrol --reset-to-default Restore factory defaults
gbcontrol --upgrade-firmware Upgrade the device’s firmware
gbcontrol --serial Transparent RS232 communicaion
gbcontrol --video-source Control the device to display a video source
gbcontrol --audio-source Control the device to play the audio of the
designated video source
gbcontrol --stop-video Stop displaying a video source, do not
change the screen layout.
gbcontrol --sinkpower Turn the external display on or off
gbcontrol --show-osd Show all OSD items for ten seconds
gbcontrol --help Show a simple guide of gbconfig command
1.4.3 gblayout Commands
Command Description
gblayout --start-video Start to display a video source, the screen
the layout will be changed automatically.
gblayout --stop-video Stop displaying a video source, the screen
the layout will be changed automatically.
gblayout --add Add a screen layout for the device
gblayout --del Delete a screen layout from the device
gblayout --list List all screen layouts in the device
gblayout --show Query the detail of a screen layout
gblayout --set Designate the current screen layout
gblayout --get Query the information related to the current
screen layout
gblayout --set-sequence Designate the screen layout sequence
gblayout --get-sequence Query the screen layout sequence
gblayout --auto Config whether the device change the screen
layout automatically
gblayout --help Show a simple guide of gblayout command

ALF-SMW42S API Guide
8
1.4.4 Event Commands
Commands Description
[Event] VideoSource The state of one video source has changed
[Event] WorkMode The device work mode has changed
[Event] Layout The screen layout has changed
2 Command Sets
2.1 gbconfig Commands
2.1.1 gbconfig --name
Command gbconfig --name DeviceName
Response The device name will change to DeviceName.
Description
Configure the device’s name. As a prompt, the new name will appear on the top-
right corner of the screen if the operation is successful.
As the factory default, the device name is ALF-SMW42S.
Note:
The device name must be 1~20 characters in length, furthermore, it must
include only letters, numbers and two special character ('_' and '-').
Example:
To change the name to MeetingRoom:
Command:
gbconfig --name MeetingRoom
Response:
The device name will change to MeetingRoom.
2.1.2 gbconfig --output-resolution
Command gbconfig --output-resolution { auto | Timing }
Response The device will change its output resolution as the command designates
or automatically.
Description
If you assign “auto” as the argument, the device will select a best resolution
according to the display’s EDID. The list of all available timings is below:
3840x2160P@60 3840x2160P@50 3840x2160P@30 3840x2160P@25
3840x2160P@24 1920x1080P@60 1920x1080P@50 1920x1080P@30

ALF-SMW42S API Guide
9
1920x1080P@25 1920x1080P@24 1680x1050P@60 1600x1200P@60
1440x900P@60 1366x768P@60 1280x1024P@60 1280x720P@60
1280x720P@50 1024x768P@60 800x600P@60 720x480P@60
640x480P@60
The factory default is auto.
Example:
To use 4K@60 resolution:
Command:
gbconfig --output-resolution 3840x2160P@60
Response:
The output resolution will change to 3840x2160P@60Hz.
2.1.3 gbconfig --auto-switch-source
Command gbconfig --auto-switch-source { y | n | toggle }
Response The automatic switching feature will be enabled or disabled according to
the command
Description
Configure the automatic switching feature. If it is enabled, when a video source
becomes valid or invalid, the device will start or stop displaying this video source
automatically. If this feature is disabled, the above mechanism doesn’t work. The
argument “toggle” means to toggle this configuration.
For BYOD video sources, automatic switching feature works always, namely, this
configuration does work for BYOD video source.
As the factory default, automatic switching is enabled. Whenever
the device boots or enters stand by mode, it restores to enabled too.
Example:
To disable automatic switching:
Command:
gbconfig --auto-switch-source n
Response:
The automatic switching feature will be disabled.
2.1.4 gbconfig --lan-info
Command gbconfig --lan-info {dhcp | static ipaddr netmask gateway}
Response The settings of the wired Ethernet will be changed.
Description
The device supports two modes to obtain IP settings: DHCP and static. As a prompt,
the new IP address will appear on the bottom-right corner of the screen if the
operation is successful.
As the factory default, DHCP mode is used.
Example: