SDK
SDK Overview
The Heex Software Development Kit provides a collection of tools, libraries (C++ and Python) and binaries to build your implementations and run them along Heex Agent.
Implementation communication with
Implementations and Heex Kernel communicate over TCP. The default port for implementations is 4242. The port is set in their constructor.
Heex SDKs major components
| Root Folder / File | Content |
|---|---|
| additionalAgentContent | It contains any additional files used by the Agent and the implementations. More info here |
| cmake | It contains the cmake configuration of our SDK |
| get-started | Folder contains the get-started implementation examples used for the Quick Start. |
| implementations | It is the location to put your built implementations in. Also it contains builtin implementations provided by Heex for pre-defined use cases. |
| include | It contains all the include files necessary to build the implementations. |
| kernel | It contains already compiled binaries. |
| lib | It contains the pre-compiled HeexSdk libraries. |
| samples | Folder contains from simple to more complex ready-to-use variants of those implementations to match the different scenarios of condition monitoring and smart data extraction. They also aim to demonstrate how Heex SDK most advanced features can be used to gain in modularity and scalability. |
Development pattern
Developers use Heex SDK to develop and build implementations that act either as monitors or recorders. We currently support implementations in C++ and Python.Implementation communication with Heex Kernel
Implementations and Heex Kernel communicate over TCP. The default port for implementations is 4242. The port is set in their constructor.
ℹ️ Info: If you wish to use a different port, make sure to set it in the implementation constructor and also in the Core.conf configuration file.