Hall Technologies HT-CALIPSO User manual

Hall Technologies March 30, 2023 Page 1 of 10
Hall Technologies • 1234 Lakeshore Dr Suite #150 Coppell, TX 75019 • halltechav.com
HT-CALIPSO
All-in-one meeting collaboration bar.
API Command List
Version: 1.0

Hall Technologies March 30, 2023 Page 2 of 10
COMMAND LIST TABLE OF CONTENTS
Connecting to the HT-CALIPSO ................................................................................................................... 3
IP Address ....................................................................................................................................... 3
Enabling Telent Client ..................................................................................................................... 3
Logging in Via Command Prompt ................................................................................................... 4
Terminology & API Commands Overview ................................................................................................... 5
Terminology .................................................................................................................................... 5
API Commands Overview ............................................................................................................... 5
API Commands ........................................................................................................................................... 6
gbconfig Commands ....................................................................................................................... 6
gbcontrol Commands ..................................................................................................................... 8
gblayout Commands ....................................................................................................................... 8
Events ............................................................................................................................................. 9

Hall Technologies March 30, 2023 Page 3 of 10
Connecting to the HT-CALIPSO
IP ADDRESS
To connect to and communicate with the HT-CALIPSO, the controlling device needs to be on the same
network. If needed, change the IP address on your PC to be in the same IP range and same subnet as
the HT-CALIPSO. You can find out the IP address of the HT- CALIPSO by looking in the bottom right
corner of the Guide Screen (you will need to connect the HT- CALIPSO to a display).
ENABLING TELNET CLIENT
Before logging in to IP controller via command-line interface, make sure that Telnet Client is enabled.
By default, Telnet Client is disabled in Windows OS. To turn on Telnet Client, do as follows.
1. Choose Start > Control Panel > Programs
2. In the Programs and Features area, click Turn Windows features on or off.
3. In the Windows Features window, select Telnet Client check box.

Hall Technologies March 30, 2023 Page 4 of 10
LOGGING IN VIA COMMAND-LINE INTERFACE
1. Choose Start > Run
2. In the Run dialog box, enter cmd and then click OK.
3. Enter telnet 192.168.0.109 23 if the device’s IP address is 192.168.0.109 and then press Enter.
(The 23 on the end changes the port communication to 23).
4. The device will display a # as the command prompt. The device is now ready to execute the API
commands.
E:\Users\Hornet>telnet 192.168.0.109 24
username : admin
password :
Welcome to HT-CALIPSO.
~ # |

Hall Technologies March 30, 2023 Page 5 of 10
Terminology & API Commands Overview
TERMINOLOGY
The terminology used in the API command’s description is listed as follows:
• Device: the unit being controlled
• AirPlay Mirroring: A screen mirroring approach developed by Apple and is supported by many
Apple devices such as MacBooks, iPads, and iPhones.
• Miracast: A screen mirroring approach developed by Wi-Fi alliance and is supported by all
Android devices and Windows PCs.
• BYOD Source: AirPlay and Miracast are BYOD solutions.
• Hardware Source: The physical hardware interface on the device, such as HDMI or USB Type-C.
• Software Source: Certain devices can display video content from a USB camera.
API COMMANDS OVERVIEW
API commands are mainly classified into the following types.
• gbconfig: manages the configurations of the device
• gbcontrol: controls the device
• gblayout: adjusts the features related to the screen layout
• Event: message from the device to report that the device’s state changed
Command syntax uses the command type followed by a space, two dashes, and then the command
plus the argument (as needed). For example:
gbconfig --camera-mode normal
Type
space
dash dash
Command
space
Argument
gbconfig
--
camera-mode
normal
This example changes the device’s configuration to be “normal” for the mode of the camera.
Note: For the “show” command there is only a single dash: gbconfig -s camera-mode

Hall Technologies March 30, 2023 Page 6 of 10
API Commands
GBCONFIG COMMANDS
Command
Argument(s)
Description
gbconfig --help
Displays a list of all available gbconfig commands.
gbconfig --cascade-mic-num
{1 ~ 7}
Sets the number of cascaded expansion HT-Satellite-EXT
microphones.
gbconfig --get-cascade-mic-
online-num
Displays the total number of cascaded HT-Satellite-EXT
microphones connected to the HT-CALIPSO.
gbconfig --camera-mode
{normal | autoframing
| speakertracking |
presentertracking}
Changes the camera’s tracking mode.
Normal: User’s adjust the pan, tilt, zoom manually.
Auto Framing: The camera automatically tracks the people
based on face recognition.
Speaker Tracking: The camera automatically tracks the
speaker based on speech recognition.
Presenter Tracking: The camera tracks a single presenter.
gbconfig -s camera-mode
Displays the camera’s tracking mode setting.
gbconfig --camera-zoom
{100 ~ phymaxzoom}
Set the camera’s zoom. The available values range from
100% (1x) to the camera’s max physical zoom.
gbconfig -s camera-zoom
Displays the camera’s zoom setting.
gbconfig --camera-savecoord
{1 | 2}
Saves current coordinates to a specified preset for easy
recall. (Preset 1 or Preset 2)
gbconfig -s camera-savecoord
{1 | 2}
Displays if the current coordinates of the camera are saved
to a certain preset. (Returns “true” or “false”)
gbconfig --camera-loadcoord
{1 | 2}
Recalls Preset 1 or Preset 2.
gbconfig --camera-mirror
{y | n}
Turns on (y) or off (n) the camera mirroring function.
gbconfig -s camera-mirror
Displays the camera’s setting for mirroring mode.
gbconfig --camera-powerfreq
{50 | 60}
Sets the refresh frequency to prevent flicker in the video
(50Hz, 60Hz)
gbconfig -s camera-powerfreq
Displays the refresh frequency setting.
bconfig --camera-geteptz
Displays detailed information about the ePTZ camera.
gbconfig --hdcp-enable hdmi
{n | auto | hdcp14 |
hdcp22}
Configures the HDCP capability for the HDMI output.
N: turns off HDCP
Auto: HDCP will be turned on/off automatically
HDCP14: Sets HDCP to 1.4

Hall Technologies March 30, 2023 Page 7 of 10
HDCP22: Sets HDCP to 2.2
gbconfig -s hdcp-enable
Displays the status of the HDCP for HDMI output.
gbconfig --cec-enable
{y | n}
Turns on (y) or off (n) CEC mode.
gbconfig -s cec-enable
Displays the status of CEC mode.
gbconfig --sinkpower
{on | off}
Turns on/off the ability to send a CEC command to the
display to turn it on/off.
gbconfig --cec-cmd hdmi
{on | off} {CmdStr}
Enters the command string to turn on/off the connected
display.
CmdStr: The CEC command in string or hex format. For
example, the command to turn on the display could be “40
04”: CmdStr = 4004
gbconfig -s cec-cmd
Displays the command set for the on/off command.
gbconfig --send-cmd hdmi
{CmdStr}
Tests C EC commands to tur n d isp lays on/off. This is onl y for
testing and is not stored to the device.
gbconfig --mic-mute
{y | n}
Sets all microphones, including cascaded microphones, to
mute on (y) or off (n).
gbconfig -s mic-mute
{y | n}
Displays the status of the microphone mute state.
gbconfig --autovolume
{inc | dec}
Increases or decreases the volume. Each increase/decrease
is 2 level steps.
gbconfig --aec
{y | n}
Enables (y) or disables (n) AEC (Acoustic Echo Cancellation)
on the microphones.
gbconfig -s aec
Displays the AEC state.
gbconfig --anc
{y | n}
Enables (y) or disables (n) ANC (Active Noise Cancellation)
on the microphones.
gbconfig -s anc
Displays the ANC state.
gbconfig --agc
{y | n}
Enables (y) or disables (n) AGC (Automatic Gain Control) on
the microphones.
gbconfig -s agc
Displays the AGC state.

Hall Technologies March 30, 2023 Page 8 of 10
GBCONTROL COMMANDS
Command
Argument(s)
Description
gbcontrol --help
Displays a list of all available gbcontrol commands.
gbconfig --reboot
Reboots the device.
gbcontrol --reset-to-default
Restores the device to the factory defaults.
gbcontrol --reset-web-passwd
Resets the UI password to the factory default (admin).
gbcontrol --video-source
{VideoName} {WinNo}
Displays the selected video source to the desired window.
gbcontrol --audio-source
{VideoName}
Selects the desired audio source.
gbcontrol --stop-video
{VideoName}
Stops displaying the desired video source.
gbcontrol --show-osd
Displays the OSD for ten seconds.
gbcontrol --device-info
Displays information about the device.
GBLAYOUT COMMANDS
Command
Argument(s)
Description
gblayout --help
Displays a list of all available gblayout commands.
gblayout --start-video
{VideoName}
Starts the designated video and returns a list of the video
sources being displayed.
• If the video source is displayed already, the device
does nothing.
• If there is no free window, the device switches to a
screen layout which has more windows
• If there is no free window nor screen layout having
more windows, the device stops playing the “oldest”
video source.
Note: If the device is disabled to change the screen layout
automatically, this command will not work. Refer to the
gblayout --auto command.
gblayout --stop-video
{VideoName} {WinNo}
Stops the designated video.
gblayout –-show
{LayoutNo}
Displays the detail of a screen layout.
gblayout --set
{LayoutNo}
Sets the current screen layout to the desired number.
gblayout --get
detail
Displays information related to the current screen layout.
Adding detail to the command provides the position and
size of every window and the video source displayed in the
window.

Hall Technologies March 30, 2023 Page 9 of 10
gblayout --set-sequence
{Layout1No}
{Layout2No}
Designates the screen layout sequence (either full or dual
view)
gblayout --get-sequence
Displays the numbers of all layouts in the sequence.
gblayout --auto
{y | n} {runtimeonly}
Enables (y) or disables (n) automatic screen layout. Adding
runtimeonly to the command temporarily sets the change
until device reboot or standby mode.
gblayout --list
Displays all screen layouts in the device.
EVENTS
Events are not API commands that can be sent by the controller. These are messages sent by the device
to announce that a certain state of the device has change.
Command
Description
[Event] VideoSource VideoName
This message means that the state of one video source has changed.
[Event] WorkMode
This message means that the device’s work mode has changed.
[Event] Layout
This message means that the screen layout has changed and includes the
layout ID and its name.

Hall Technologies March 30, 2023 Page 10 of 10
© Copyright 2022. Hall Technologies
All rights reserved.
1234 Lakeshore Drive, Coppell, TX 75019
halltechav.com / [email protected]
[phone]