Quick Start Guide
Introduction
Experience the power of Heex’s Smart-Data platform! This quick start guide will have you creating your first scenario-driven data collection event in just a few easy steps. Learn how to leverage Agents deployed on your Systems (robots, drones, etc.), to monitor data streams and automatically trigger recordings based on predefined conditions (Triggers). You’ll configure Recorders to capture specific Signals, generating tagged Events that encapsulate key moments and data insights.
To make the most of this tutorial, we highly recommend reviewing the Key Concepts, including Smart-Data, Agents, Triggers, Recorders, and the overall architecture. Heex is compatible with Ubuntu, and works great in virtual machines and Docker environments (including WSL).
Configure your system
Create your first system
The first step is to create a system. Here is how to do it.
📝 Note:
Click on the blinking blue dot at each step of the interactive images to explore the application and see how it all comes together.
Create a Data Source in the created system
Now that you’ve created your system, you should add a Data Source, to describe what signals you can monitor and record on your system.
Create trigger
The next step is to create a trigger, with condition on signals you’ve just created.
Request implementation
Now, you can request necessary implementation for the Heex Agent to work and read your systems’ signal. Here, it is fake signals.
Configure your sdk
Setting Up Your Heex Environment
Get an API key to download and use the cli
- Go to Account settings
- Create an API key
- You can now copy it
Get the Heex CLI
- Download the CLI with the following command:
Replace API_KEY with your API key
- Now you can use the CLI with the
./heex
command.
For more details, go to the following page CLI
Get the Heex SDK
Download the Heex SDK with the following command:
For more details, go to the following page SDK
Generate your first event
Code implementations
Go to getStarted Python directory.
Create monitor
- Open the Monitor source file.
- Replace the
monitorUuid
(monitor_uuid
in python) variable with the implementation ID of your monitor.
Create recorder
- Open the recorder source file.
- Replace the
recorder_uuid
variable with the implementation ID you get on the cloud for the recorder. - Add a label: In the
generateRequestedLabels
function add as many labels as you want as shown by the example. - Add a recording: Create a recording sample by using
echo "This is Smart Data!" > file.txt
. Provide the path of this file in thegenerateRequestedFilePaths
function (filepath = "/path/get-started/python/file.txt"
).
Go to getStarted Python directory.
Create monitor
- Open the Monitor source file.
- Replace the
monitorUuid
(monitor_uuid
in python) variable with the implementation ID of your monitor.
Create recorder
- Open the recorder source file.
- Replace the
recorder_uuid
variable with the implementation ID you get on the cloud for the recorder. - Add a label: In the
generateRequestedLabels
function add as many labels as you want as shown by the example. - Add a recording: Create a recording sample by using
echo "This is Smart Data!" > file.txt
. Provide the path of this file in thegenerateRequestedFilePaths
function (filepath = "/path/get-started/python/file.txt"
).
Go to getStarted C++ directory.
Create monitor
- Open the Monitor source file.
- Replace the
monitorUuid
variable with the implementation ID of your monitor.
Create recorder
- Open the recorder source file.
- Replace the
recorderUuid
variable with the implementation ID you get on the cloud for the recorder. - Add a label: In the
generateRequestedLabels
function add as many labels as you want as shown by the example. - Add a recording: Create a recording sample by using
echo "This is Smart Data!" > file.txt
. Provide the path of this file in thegenerateRequestedFilePaths
function (filepath = "/path/get-started/cpp/file.txt"
).
Build
Then run the following CLI commands from the root SDK directory:
You can also build directly using CMake using the following commands in the get-started/cpp
directory:
Notify your implementations to deploy
Go to the web platform and validate your implementations in the developer’s page. Now your system should be in state “To deploy”.
Launch the Heex Agent
- Download the systemConf of your system (This step will be made automatically in your production systems). Run the following command from the Heex_SDK directory:
- Add credentials for your system:
- Launch Heex: go inside the Heex_SDK folder and run:
Go in the get-started/python
directory and open two terminals:
-
On the first one, start the Recorder using:
ℹ️ Note: It is important to start the recorder first.
-
On the second terminal, start the Monitor using:
🎉 Congratulations! You have just generated 1 event!
Go in the get-started/python
directory and open two terminals:
-
On the first one, start the Recorder using:
ℹ️ Note: It is important to start the recorder first.
-
On the second terminal, start the Monitor using:
🎉 Congratulations! You have just generated 1 event!
Go in the get-started/cpp
directory and open two terminals:
-
On the first one, start the Recorder using:
📝 Note: It is important to start the recorder first.
-
On the second terminal, start the Monitor using:
🎉 Congratulations! You just generated 1 event!
Find your event on the web application, in the Smart Data Events page.