Development
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.
Heex SDKs major components
| Root Folder / File | Content |
|---|---|
| 3rd-party and libraries | Folders that contains necessary libraries to build the Heex SDK. |
| implementations | It is the location to put your built implementations. |
| kernel | It contains already compiled binaries. |
| 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. |
| sdk | It contains the source code and CMakeLists.txt to build the Heex SDK, that shall be imported in your system |
| heex | Heex CLI executable. You can use to build the SDK, and many other features. See Heex CLI. |
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 ports 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.