Table of Contents
Advertisement
Quick Links
Advertisement
Table of Contents
Related Manuals for Hall Technologies HT-MERCURY
Summary of Contents for Hall Technologies HT-MERCURY
- Page 1 Hall Technologies • 1234 Lakeshore Dr Suite #150 Coppell, TX 75019 • halltechav.com HT-MERCURY All-in-one meeting collaboration with ultra-wide angle 4KAI camera, microphone and speaker features, along with wired and wireless screen casting capability. API Command List Version: V1.0...
- Page 2 Introduction ....................3 Preparation ..................3 Setting IP Address in Your Computer ..........3 1.1.1 Enabling Telnet Client ..............3 1.1.2 Logging In via Command-line Interface ........... 4 Introduction to Terminology ..............5 API Commands Overview ..............5 Command Sets ..................8 gbconfig Commands ................
-
Page 3: Table Of Contents
gbconfig --anc ................. 19 2.1.29 gbconfig -s anc ................ 19 2.1.30 gbconfig --agc ................. 20 2.1.31 gbconfig -s agc ................ 20 2.1.32 gbcontrol Commands ..............21 gbcontrol --help ................21 2.2.1 gbcontrol --reboot ................ 21 2.2.2 gbcontrol --reset-to-default ............. 21 2.2.3 gbcontrol --reset-web-passwd ............ - Page 4 If needed, change the IP address on your PC to be in the same IP range and same subnet as the HT-MERCURY. You can find out the IP address of the HT-MERCURY by looking in the bottom right corner of the Guide Screen (you will need to connect the HT-MERCURY to a display).
- Page 5 Logging In via Command-line Interface Choose Start > Run. In the Run dialog box, enter cmd then click OK. 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 port communication to 23.) The device will display a # as the command prompt.
- Page 6 Now, the device is ready to execute the CLI API commands. Introduction to Terminology The terminology used in the API command’s description is listed as follows. Terminology Description Device The unit being controlled. A screen mirroring approach developed by Apple, it is Airplay Mirroring supported by many Apple devices, such as MacBook, iPad and iPhone.
- Page 7 gbcontrol: controls the device ² gblayout: adjusts the features related to screen layout ² Event: message from the device to report that the device state changes ² Every API command is supported by all models unless there is special comment in the context.
- Page 8 gbconfig --mic-mute Mutes all microphones Displays the status of the microphone gbconfig -s mic-mute mute. Adjusts audio volume gbconfig --autovolume (increase/decrease) gbconfig --aec Enables/disables AEC Displays if the AEC mode is gbconfig -s aec enabled/disabled. gbconfig --anc Enables/disables ANC Displays if the ANC mode is gbconfig -s anc enabled/disabled.
- Page 9 command Start to display a video source, the gblayout --start-video screen layout will be changed automatically. Stop displaying a video source, the screen gblayout --stop-video layout will be changed automatically. gblayout --show Query the detail of a screen layout gblayout --set Designate the current screen layout Query the information related to the gblayout --get...
- Page 10 HT-MERCURY. Example: To display the total number of expansion microphones connected: Command: gbconfig --get-cascade-mic-online-num Response: One expansion microphone is connected to HT-MERCURY. Camera: 2.1.4 gbconfig --camera-mode Command gbconfig --camera-mode {normal | autoframing | speakertracking | presentertracking} Response The device name will change to the specified tracking mode.
- Page 11 Set the camera’s zoom. The available values range from 100% (1x) to the camera’s maximum physical zoom. Description For the HT-MERCURY the camera’s maximum physical zoom is 500 and so the available range of the zoom is [100, 500] (1x to 5x) Example: To set the camera’s zoom to 100:...
- Page 12 Description This command displays the zoom the camera is set to. Example: To display what the camera’s zoom is set to: Command: gbconfig -s camera-zoom Response: If the zoom is set to 100. 2.1.8 gbconfig --camera-savecoord Command gbconfig --camera-savecoord {1 | 2} Response Current coordinates of the camera will be stored to preset 1 or preset Description...
- Page 13 2.1.10 gbconfig --camera-loadcoord Command gbconfig --camera-loadcoord {1 | 2} Response The specified preset will be loaded to the camera (preset recall). Description This command loads preset 1 or 2 to the camera. Example: To recall preset 1 to the camera: Command: gbconfig --camera-loadcoord 1 Response:...
- Page 14 The camera mirroring mode is turned on. 2.1.13 gbconfig --camera-powerfreq Command gbconfig --camera-powerfreq {50 | 60} Response The refresh frequency of the camera will be changed to 50 or 60 (Hz). To change the powerline frequency to prevent flicker in the video: •...
- Page 15 To show information about the ePTZ camera: Command: gbconfig --camera-geteptz Response: {“result” : {“autozoomunit” :1, “phymaxzoom” : 800, “xmax” : 108000, “xmin” : -108000, “xstep” : 3600, “ymax” : 108000, “ymin” : -108000, “ystep” : 3600, “zoom” : 500}} Video: 2.1.16 gbconfig --hdcp-enable Command...
- Page 16 The HDCP of HDMI out is turned off. 2.1.18 gbconfig --cec-enable Command gbconfig --cec-enable Response The CEC will be turned on or off. Set the CEC on/off • Description n: Turn off CEC. • y: Turn on CEC. Example: To turn on CEC: Command: gbconfig --cec-enable y Response:...
- Page 17 To configure and save the CEC command “40 04” to turn on a display: Command: gbconfig --cec-cmd hdmi on 4004 Response: The CEC command “40 04” to turn on the display is saved to HT-MERCURY. 2.1.22 gbconfig -s cec-cmd Command...
- Page 18 gbconfig -s cec-cmd Response: HDMI ON: 4004 HDMI OFF: ff36 Displays the saved CEC commands for turning on and off the display. 2.1.23 gbconfig --send-cmd hdmi Command gbcontrol --send-cmd hdmi {CmdStr} Response The CEC command {CmdStr} will be sent to the display for testing. This command tests CEC commands {CmdStr} to turn the display on or off.
- Page 19 2.1.25 gbconfig -s mic-mute Command gbconfig -s mic-mute Response Displays the status of the microphones, muted or unmuted. • Description n: mute off. • y: mute on. Example: To get the status of the microphones: Command: gbconfig -s mic-mute Response: The microphones are unmuted.
-
Page 20: Gbconfig --Anc
To turn off AEC: Command: gbconfig --aec n Response: The AEC is disabled in HT-MERCURY. 2.1.28 gbconfig -s aec Command gbconfig -s aec Response Displays the status of the AEC, enabled or disabled. • Description n: AEC disabled. • y: AEC enabled. -
Page 21: Gbconfig --Agc
• y: ANC enabled. Example: To get the status of the ANC: Command: gbconfig -s anc Response: The ANC is disabled in HT-MERCURY. 2.1.31 gbconfig --agc Command gbconfig --agc Response Enables or disables AGC This command enables/disables AGC (Automatic Gain Control) on the microphones. -
Page 22: Gbcontrol Commands
Response: The device will start to reboot. 2.2.3 gbcontrol --reset-to-default Command gbcontrol --reset-to-default The HT-MERCURY will reboot to recovery mode to restore factory Response defaults, and then reboot again for normal usage. Description This command restores the HT-MERCURY to its factory defaults. -
Page 23: Gbcontrol --Reset-Web-Passwd
This command restores the HT-MERCURY’s Web UI password to the Description factory default (admin). Example: To reset the Web UI password of the HT-MERCURY to the factory default: Command: gbconfig --reset-web-passwd Response: The Web UI password is reset to the factory default. -
Page 24: Gbcontrol --Show-Osd
2.2.8 gbcontrol --show-osd Command gbcontrol --show-osd Response The HT-MERCURY displays the OSD for ten seconds. This command displays the OSD for ten seconds. This allows users to Description see the OSD for access code or soft AP password when video is displayed. -
Page 25: Gblayout --Stop-Video
Start to display a video source. Some details are below: If the video source is displayed already, the device does nothing. Ø If there is no free window (view) which can be used to display Ø the video source, the device switches to a screen layout which has more windows firstly, then start to display the video source. -
Page 26: Gblayout --Set
Example: To use the layout 0x0101: Command: gblayout --set 0x101 Response: The HT-MERCURY starts using the layout whose number is 0x0101 as the current screen layout. 2.3.6 gblayout --get Command gblayout --get [detail] The HT-MERCURY outputs the information about the current screen Response layout. -
Page 27: Gblayout --Set-Sequence
MERCURY is enabled to change the screen layout automatically. If this part of the command is used, the HT-MERCURY prints the Ø position and size of every window and the video source displayed in the window. Example 1: To display basic information of the current screen layout:... -
Page 28: Gblayout --Auto
The second part of the command “runtimeonly” is optional, and temporarily sets the change. When this command is sent, the change will not be saved to the file system, and once the HT-MERCURY reboots or goes into standby mode, the device will reload this configuration from the file system. -
Page 29: Gblayout --List
0x101 layout1 Event Commands Event commands are not API commands that can be sent by the controller. These are messages sent by the HT-MERCURY to announce that a certain state of the device has changed. 2.4.1 [Event] VideoSource [Event] VideoSource VideoName { NoSignal | { VideoTiming { YUV444 | Command YUV422 | RGB888 | MJPEG | H.264 | H.265 }}... -
Page 30: Event] Workmode
[Event] VideoSource HDMI NoSignal 2.4.2 [Event] WorkMode Command [Event] WorkMode { Normal | Sleep } This message means that the HT-MERCURY’s work mode has Description changed. Example: The HT-MERCURY went into standby mode: Message: [Event] WorkMode Sleep 2.4.3 [Event] Layout...