Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.heex.io/llms.txt

Use this file to discover all available pages before exploring further.

This section outlines how developers will receive their task list. In order to begin capturing Smart-Data, you will need to create monitors and recorders, and their implementations deployed on Agent. The system administrator will request one or more implementations to be developed, and the embedded software developer will be responsible for creating the code and binaries. Implementations Once development is complete, the developer can access this screen to let other team members know the implementation is done. This will update the implementation’s status across all systems where it is waiting to be deployed.

​
Understanding Implementation Statuses

Implementations carry two status fields depending on the page you look at.

​
On the Implementations list (developer page)

The list shows where each implementation stands in the development workflow:
  • Requested: An implementation has been requested but the binary is not yet built.
  • Ready: The developer has marked the implementation as ready for deployment. This transition is manual, the developer flips the status from the UI or runs heex implementation validate from the CLI.
Unlike most other statuses in Heex, this one is not updated automatically. It reflects a deliberate handover from development to operations.

​
On a system detail page

For each implementation attached to a system, the system page shows a second status reflecting deployment progress on that specific machine:
  • Requested: The implementation is not yet Ready on the developer page.
  • To Deploy: The implementation is Ready on the developer page but has not yet been pulled by the Heex Agent on this machine.
  • Ready: The implementation is present in the Agent currently running on this system.
  • Running: The implementation is deployed and actively executing on the Agent.
The To Deploy to Ready transition is driven by the Heex Agent on the machine, not by the API. The Agent pulls the latest configuration via OTA. A system stuck in To Deploy typically means the Heex Agent is not connected, see Heex Installer Mode.
For consumers of the CLI, GraphQL, or MCP APIs, see the Status lifecycles reference for the underlying enum values and the per-signal granularity used internally.