Subscribe to Our Youtube Channel
Related Manuals for ALFAtron SMW42S
Summary of Contents for ALFAtron SMW42S
- Page 1 ALFATRON ELECTRONICS GmbH GERMANY Alfatron SMW42S API Commands Guide...
-
Page 2: Table Of Contents
ALF-SMW42S API Guide Contents Introduction ......................3 Preparation ................... 3 1.1.1 Setting IP Address in Your Computer ............ 3 1.1.2 Enabling Telnet Client ................3 Logging In to Device via Command-line Interface ......... 3 Introduction to Terminology ..............5 API Commands Overview ..............6 1.4.1... - Page 3 ALF-SMW42S API Guide gbconfig --help ..................21 2.1.20 gbcontrol Commands ................22 2.2.1 gbcontrol --reboot .................22 2.2.2 gbcontrol --reset-to-default ..............22 gbcontrol --upgrade-firmware ...............22 2.2.3 2.2.4 gbcontrol --video-source ...............23 gbcontrol --audio-source ..............23 2.2.5 2.2.6 gbcontrol --stop-video................23 2.2.7 gbcontrol --sinkpower ................23 2.2.8 gbcontrol --show-osd ................
-
Page 4: Introduction
ALF-SMW42S API Guide 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 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. - Page 5 ALF-SMW42S API Guide In the Run dialog box, enter cmd then click OK. Enter telnet 192.168.5.94 24 if the device IP address is 192.168.5.94, and then press Enter. The device prompt for user name, please input root, then press Enter.
-
Page 6: Introduction To Terminology
Airplay, Miracas and GBCast are BYOD solutions, they are named BYOD Source BYOD (video ) source. A SMW42S has for hardware video input interfaces: HDMI1, HDMI2, HDMI3 and Hardware Source HDMI4, they are named hardware (video) source. Obtain and display the video content from a USB camera or Grandbeing IPAV H.264 encoder, we named them software (video) source. -
Page 7: Api Commands Overview
ALF-SMW42S API Guide 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 ... -
Page 8: Gbcontrol Commands
ALF-SMW42S API Guide 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... -
Page 9: Event Commands
The device name will change to DeviceName. 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. Description Note: The device name must be 1~20 characters in length, furthermore, it must include only letters, numbers and two special character ('_' and '-'). -
Page 10: Gbconfig --Auto-Switch-Source
ALF-SMW42S API Guide 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... -
Page 11: Gbconfig --Hdcp-Enable
ALF-SMW42S API Guide To use 192.168.1.88/24 as IP address and 192.168.1.1 as default gateway: Command: Gbconfig --lan-info static 192.168.1.88 255.255.255.0 192.168.1.1 Response: The IP address will change. 2.1.5 gbconfig --hdcp-enable Command gbconfig --hdcp-enable { y | n } Response The HDCP feature of the HDMI out interface will be enabled or disabled Configure whether the HDCP feature of HDMI out interface is enabled. -
Page 12: Gbconfig --Rs232-Hex-Cmd-Enable
ALF-SMW42S API Guide 2.1.7 gbconfig --rs232-hex-cmd-enable Command gbconfig --rs232-hex-cmd-enable { y | n } Response The setting will be saved. The device can send a command string through the built-in RS232 port when it wants to turn the external display on or off. The user can designate these two command strings separately. -
Page 13: Gbconfig --Rs232-Sinkpoweroff-Cmd
ALF-SMW42S API Guide The command string is saved. 2.1.9 gbconfig --rs232-sinkpoweroff-cmd Command gbconfig --rs232-sinkpoweroff-cmd PowerOffCmd Response The string will be saved. Configure the command string used to turn off the external display through RS232 port. To get the requirements for the format of the argument Description PowerOffCmd, please refer to the previous chapter. -
Page 14: Gbconfig --Sinkpower-Mode
ALF-SMW42S API Guide Example 2: To disable automatic standby: Command: gbconfig --auto-standby-time 0 Response: The device will never sleep. 2.1.11 gbconfig --sinkpower-mode Command gbconfig --sinkpower-mode { cec | rs232 | both } Response The settings will be saved. The device can turn on/off the external display by two approaches: 1. -
Page 15: Gbconfig --Source-Select
ALF-SMW42S API Guide display (maybe a TV or a project). Its unit is second and the valid range is [0,200]. As the factory default, the timeout is 8. Example: To change the timeout to 2 minutes: Command: gbconfig --special-sink 120... - Page 16 ALF-SMW42S API Guide 2.1.14.1 Assign or modify alias of video source Command gbconfig --media-source alias VideoName Alias Response The alias of the designated video source will be saved or updated. Assign or modify the alias of a video source. Two arguments are supported: VideoName is the name of the video source whose alias will be configured.
- Page 17 ALF-SMW42S API Guide As the factory default, no IPAV video source is configured. Example 1: To assign the TX 341B00FFABCD to IPAV02: Command: gbconfig --media-source ipav 2 34:1B:00:FF:AB:CD Example 2: To assign the TX 341B00FFAB01 to IPAV11 with disabled state: Command:...
-
Page 18: Gbconfig --Input-State
ALF-SMW42S API Guide HDMI1 ClassRoom IPAV0 34:1B:00:FF:AB:C enabled test IPAV1 SamsunDV 34:1B:00:FF:AB:8 enabled 2.1.14.5 Delete video source Command gbconfig --media-source del { VideoName | all } Response The designated video source is deleted The only argument is the name of the video source to be delete, if the argument is all, it means to delete all video sources. -
Page 19: Gbconfig --Auido-Select
ALF-SMW42S API Guide The queried video source has a valid signal Command: gbconfig --input-state hdmi1 Response: 3840x2160P@30 YUV444 Example 3: Queried all video sources Command: gbconfig --input-state Response: HDMI1 3840x2160P@30 YUV444 HDMI2 NoSignal HDMI3 1920x1080P@60 YUV422 HDMI4 NoSignal IPAV01 1920x1080P@60 H.264 2.1.16... -
Page 20: Gbconfig --Softap-Password
ALF-SMW42S API Guide will be clear and the access code mechanism will be disabled. As the factory default, no access code is designated. Note: This API is supported by FSC600-000 only. Example: To use 1234 as the access code Command:... - Page 21 ALF-SMW42S API Guide MS330 Example 2: To query wired Ethernet settings and state: Command: gbconfig -s lan-info Response: If DHCP mode works: dhcp 192.168.0.105 255.255.240.0 192.168.2.1 192.168.3.1 192.168.3.2 202.96.134.33 The contents following “dhcp” are state information whose format is IPAddress NetMask Gateway [Dns1 [Dns2 [Dns3…]]].
-
Page 22: Gbconfig --Help
ALF-SMW42S API Guide 2.1.20 gbconfig --help Command gbconfig { --help | -h } Response A simple description of the gbconfig command is shown. Description Show a simple guide of gbconfig command... -
Page 23: Gbcontrol Commands
ALF-SMW42S API Guide 2.2 gbcontrol Commands 2.2.1 gbcontrol --reboot Command gbcontrol --reboot Response The device will reboot. Description Reboot the device manually Example: Command: gbcontrol --reboot Response: The device start to reboot. 2.2.2 gbcontrol --reset-to-default Command gbcontrol --reset-to-default The device will reboot to recovery mode to restore factory defaults, then Response reboot again for normal usage. -
Page 24: Gbcontrol --Video-Source
ALF-SMW42S API Guide Response: The device reboots to the recovery mode, then use the OTA package /cache/update.zip to upgrade its firmware. 2.2.4 gbcontrol --video-source Command gbcontrol --video-source { VideoName } [ WinNo ] Response The device displays the video source with the designated mode. -
Page 25: Gbcontrol --Show-Osd
ALF-SMW42S API Guide out interface. The corresponding RS232 command through the built-in RS232 port. Make the device to or escape from standby (sleep) state manually, Description control the external display at the same time. Example: To make the device start sleeping: Command:... -
Page 26: Gbcontrol --Help
ALF-SMW42S API Guide RS232 port will be print as hexadecimal format. The unit is mini-second and its default is 0, it means that no response data will be received. command string is the data to be sent. size is the size of the response data received before the command returns. -
Page 27: Gblayout --Stop-Video
ALF-SMW42S API Guide windows firstly, then start to display the video source. If there is neither free window nor screen layout having more windows, the device stops displaying the “oldest” video source so to get a free window for the video source. -
Page 28: Gblayout --Del
ALF-SMW42S API Guide -no LayoutNo is optional to designated the number of the added layout. Only the lowest byte of LayoutNo is meaningful, the device always use 0x02 as the high byte of the number of a screen layout which is added by a user manually. -
Page 29: Gblayout --List
ALF-SMW42S API Guide Note: The current screen layout can not be deleted. The built-in preset screen layout (the high byte of its number is 0x01) can not be deleted. Example: To delete the layout whose number is 0x202: Command: gblayout --del 0x202 2.3.5 gblayout --list... -
Page 30: Gblayout --Set
ALF-SMW42S API Guide Response: Layout #: 0x0100 Name:layout0 windows 1 1 6 0 0 0 9000 Example 2: To query the detail of a layout having main windows: Command: gblayout -- show 0x202 Response: Layout #: 0x0202 Name:LeftRight 2 windows... -
Page 31: Gblayout --Set-Sequence
ALF-SMW42S API Guide If the argument detail is used, except the above information, the device prints the position and size of every window and the video source displayed in the window. Example 1: To query the brief of the current screen layout and the device is enabled to change the screen layout... -
Page 32: Gblayout --Get-Sequence
ALF-SMW42S API Guide Command: gblayout --set-sequence 0x0100 0x0101 0x0103 2.3.10 gblayout --get-sequence Command gblayout --get-sequence Response The device outputs the screen layout sequence. Query the screen layout sequence, the device prints the numbers of all Description layouts in the sequence. -
Page 33: Gblayout --Help
ALF-SMW42S API Guide Example: To disable the device to change the screen layout automatically Command: gblayout --auto n 2.3.12 gblayout --help Command gblayout { --help | -h } Response A simple description of the gblayout command is shown. Description Show a simple guide of gblayout command 2.4 Event Commands... -
Page 34: Event] Workmode
ALF-SMW42S API Guide 2.4.2 [Event] WorkMode Command [Event] WorkMode { Normal | Sleep } This message means that the device work mode has changed. The only Description argument is the new state. Example: The device transitioned to standby state. Message: [Event] WorkMode Sleep 2.4.3 [Event] Layout...
Need help?
Do you have a question about the SMW42S and is the answer not in the manual?
Questions and answers