HCI Host Control Interface

Description

The Eclipse HX Host Control Interface (HCI) is an optional API protocol that empowers third-party software and automation systems to control—or be triggered by—an Eclipse HX intercom matrix. The HCI protocol is platform-agnostic, supporting application development in a wide variety of programming languages across multiple operating systems, with drivers available for various third-party control systems.

Integration & Automation

HCI provides a comprehensive command set allowing external systems to integrate seamlessly with the intercom. This includes full or partial intercom configuration capabilities, as well as the ability for external systems to assume control of intercom user station keysets. Additionally, HCI can output detailed system status and health information.

Capabilities

Crosspoint Management

• Routing: Request crosspoints to be made, broken, or inhibited.
• Status: Query the status of specific crosspoints to identify user stations or interfaces currently talking or listening.
• Level Control: Adjust specific crosspoint audio levels as well as global input/output port gain.

Partyline Control

• Membership: Add or remove interface ports as talkers or listeners within a Partyline.
• Monitoring: Request a list of all current Partyline members.
• Notifications: Receive automatic system messages when a user station or interface joins or leaves a Partyline.

IFB - Interruptible Foldback

• Assignment: Assign new sources and destinations to IFBs.
• Level & Priority: Adjust IFB interrupt (dim/duck) levels and talker priority.
• Real-Time Updates: Receive automatic notifications when IFB settings change or when audio is active on the IFB.

Trunking & Networking

• Routing: Request trunk routes between intelligently linked Eclipse HX systems.
• Confirmation: Receive automatic confirmation messages when trunks are established.

Logic & Virtual EHX Controls

• Control Actions: Trigger EHX-configured Control Actions (Virtual GPIO) ON or OFF.
• Status: Query the status of any EHX-configured Control.

Labeling & Assignments

• Key Assignment: Remotely assign keysets to user stations.
• Aliasing: Overwrite default EHX system labels with custom Aliases.

System Diagnostics & Health

• Status Messages: Request system status reports and receive automatic warnings regarding card or panel online/offline
• Maintenance: Query CPU firmware versions and perform remote matrix resets.

Third-Party Proxy Keysets

• External Panel Control: Enables third-party systems to assume control of selected Eclipse HX keysets via HCI. This includes full utilization of display text, level bars, LED tallies, and physical controls.

Note: This is an overview of the primary capabilities of the Eclipse HX HCI protocol. The protocol supports a wider range live functions and granular controls within the system. Please contact Clear-Com for further information.

Implementation Options

In addition to custom software development, HCI is supported by libraries from various control system manufacturers and system integrators. Please contact Clear-Com for optional services, such as assistance with implementation, or for development of mission-specific applications.

Licensing Options

The HCI protocol is available in two license tiers to match specific project requirements:

HCI-E-HX (Full Automation)
This license provides the full automation API for deep integration of Eclipse HX into third-party systems. It enables external systems to fully configure and control the intercom environment, whether triggered manually or via automated schedules.

HCI-LIVE-HX (Basic Control)
A streamlined subset of the full API, this license focuses on Eclipse Controls and Crosspoints. Designed for simple, networkbased “Virtual GPIO” integration, making it ideal for handling paging triggers and crosspoint routing via third-party control.