SDK Overview
The Heex Software Development Kit provides a collection of tools, libraries (C++ and Python), and binaries to build your agents and run them alongside Heex Agents.
Heex SDKs Major Components
| Root Folder / File | Content |
|---|---|
| 3rd-party and libraries | Folders that contain necessary libraries to build the Heex SDK. |
| agents | The recommended location to store your built agents if you plan to use the Heex Runtime Environment. |
| kernel | Contains precompiled binaries. |
| samples | This folder contains ready-to-use simple to more complex variants of agents to match different scenarios of condition monitoring and smart data extraction. They also aim to demonstrate how Heex SDK’s most advanced features can be used to enhance modularity, effectiveness, and scalability in your workflow of planning, implementing, and running your custom agents. |
| sdk | Contains the source code and CMakeLists.txt to build your agent or import the Heex SDK library into your build system. |
| heex | The Heex CLI executable, which you can use to build the SDK. |
Development Pattern
Developers use the Heex SDK to develop and build agents that act either as monitors or recorders.
We currently support agents in C++ and Python.
Timestamps
Using Monitors and Recorders requires manipulating timestamp values. For more details regarding format specifications and possible time format conversions, refer to the Timestamp page.
Agent Communication with Agent Kernel
Your custom agents communicate through TCP with Agent Kernel.
The default port for monitors and recorders is 4242. This port is set in the constructor of the agents.
If you wish to use different ports, make sure to set them in the agent constructor API and also in the Core.conf configuration file.