🔹 Quickstart

To get up and running quickly, follow these steps:

Copy the RTTaskFunctionsTemplate (found in the examples folder) into your project
Add any required global variables to src/rttaskglobals.h
Define your task functions in src/rttaskfunctions.cpp, using Increment as a template
Build the library using CMake
In your application, create a RTTaskManager and use TaskSubmit to launch your tasks

For a more detailed walkthrough, continue below.

🔹 Set up your project

The examples folder in your RMP installation includes a CMake project called RTTaskFunctionsTemplate. This serves as a starting point for building a shared library containing RTTask functions. Copy this folder into your project directory and rename it appropriately.

Here is an overview of the key files:

Directory Structure

RTTaskFunctionsTemplate/
├── src/
│   ├── rttaskglobals.h      # Defines Global variables
│   └── rttaskfunctions.cpp  # Task function implementations
│
├── CMakeLists.txt           # CMake setup for building the shared library
└── cmake/                   # CMake helper modules
    ├── RapidSoftware.cmake  # Paths for RapidCode/RMP firmware
    └── INtime/              # INtime helper scripts

How it works

The template project takes all the source files (.h, .cpp) in the src/ directory and compiles them into a shared library for platform (Windows/INtime or Linux). It automatically includes the RMP headers, links the RMP libraries, and applies necessary configuration for use with RTTasks.

By default, the resulting library is named RTTaskFunctions and is output to the default RMP install directory (e.g., /rsi or C:/RSI/X.X.X). If these paths or names are modified, you must specify them explicitly when submitting a task. Otherwise, they will be discovered automatically.

If you want to change any of the default behavior or are interested in learning more about how it works, then look at the CMakeLists.txt located in the root of the project folder.

🔹 Create an RTTask functions library

In this guide, you’ll build a simple application that moves an axis based on the value of an analog input. It will use one global variable and two RTTasks. The first task, CalculateTarget, reads the analog input and calculates a target position, storing it in the global variable targetPosition. The second task, FollowTarget, moves the axis to the specified target.

Create a global variable

Open src/rttaskglobals.h. This file is where the global variables are defined and registered.

To add a new global of type double called targetPosition:

Add RSI_GLOBAL(double, targetPosition) to the GlobalData struct
Add REGISTER_GLOBAL(targetPosition) to the GlobalMetaDataMap

The result should be:

struct GlobalData
{
  GlobalData() { std::memset(this, 0, sizeof(*this)); }
  GlobalData(GlobalData&& other) { std::memcpy(this, &other, sizeof(*this)); }
 
  // A shared integer counter
  RSI_GLOBAL(int64_t, counter);
 
  // Shared double variables
  RSI_GLOBAL(double, average);
  RSI_GLOBAL(double, targetPosition);
};
 
inline constexpr GlobalMetadataMap<RSI::RapidCode::RealTimeTasks::GlobalMaxSize> GlobalMetadata(
{
  REGISTER_GLOBAL(counter),
  REGISTER_GLOBAL(average),
  REGISTER_GLOBAL(targetPosition),
});

Create a task function

Open src/rttaskfunctions.cpp. This is the file where the task functions are defined. A task function must follow this template:

LIBRARY_EXPORT void FunctionName(GlobalData* data)
{
  ...
}

We will add a new task function called CalculateTarget that will read the analog input, scale it to a value between 0 and 1, and store it in the global created in the previous step.

// This task reads the analog input value from the network node, scales it to 
// a value between 0 and 1, and stores it in the targetPosition variable
RSI_TASK(CalculateTarget)
{
  constexpr int NODE_INDEX = 0;         // The network node with the analog input
  constexpr int ANALOG_INDEX = 0;       // The index of the analog input to use
  constexpr int ANALOG_MAX = 65536;     // Max value of the analog input
  constexpr int ANALOG_ORIGIN = 42800;  // The value to treat as the "origin" of the analog input
 
  auto networkNode = RTNetworkNodeGet(NODE_INDEX);
  
  // Read the raw analog input value
  int32_t analogInVal = networkNode->AnalogInGet(ANALOG_INDEX);
 
  // Shift the value by the origin
  int32_t shiftedVal = analogInVal - ANALOG_ORIGIN;
 
  // Make sure the value is between 0 and ANALOG_MAX using modulo
  int32_t modVal = (shiftedVal + ANALOG_MAX) % ANALOG_MAX;
 
  // Scale the value to be between 0 and 1 and store it in targetPosition
  data->targetPosition = double(modVal) / ANALOG_MAX;
}

Then we will add another task function called FollowTarget that will move the axis towards the target position.

// This task moves the axis to the target position if it is not within the tolerance
// of the target position already.
RSI_TASK(FollowTarget)
{
  constexpr int AXIS_INDEX = 1;      // The index of the axis to move
  constexpr double TOLERANCE = 0.02; // The tolerance for the position difference
 
  auto axis = RTAxisGet(AXIS_INDEX);
  // Check if the axis is within the tolerance of the target position
  if (abs(axis->ActualPositionGet() - data->targetPosition) > TOLERANCE)
  {
    // Move the axis to the target position
    axis->MoveSCurve(data->targetPosition);
  }
}

Once the task functions have been added, build the project to produce a new library.

🔹 Launch your tasks

In your application, after configuring your RapidCode objects, create an RTTaskManager instance and submit your tasks.

  RTTaskManagerCreationParameters parameters;
 
  // The path to the RMP install folder
  std::snprintf(parameters.RTTaskDirectory,
                RTTaskManagerCreationParameters::DirectoryLengthMaximum,
                RMP_DEFAULT_PATH);
 
  // On Windows/INtime, use PlatformType::INtime for real-time or PlatformType::Windows for debugging
  // On Linux, Platform does not need to be set
  #if defined(WIN32) && defined(NDEBUG)
  parameters.Platform = PlatformType::INtime;
  #endif
 
  // For INtime managers, set the node you want the manager to run on
  std::snprintf(parameters.NodeName,
                RTTaskManagerCreationParameters::NameLengthMaximum,
                "NodeA");
 
  // For Linux, set the CPU core you want the manager to run on
  parameters.CpuCore = 3;
 
  // Create the RTTaskManager
  std::optional<RTTaskManager> manager;

Next, run the Initialize task one time, to get access to RapidCode objects and initialize your global variables.

    RTTaskCreationParameters initParams("Initialize");
    initParams.Repeats = RTTaskCreationParameters::RepeatNone;
    RTTask initTask = manager->TaskSubmit(initParams);
    initTask.ExecutionCountAbsoluteWait(1, TIMEOUT_MS); // Wait for the task to execute once.

Then submit the tasks created in the previous section.

    RTTaskCreationParameters calcParams("CalculateTarget");
    calcParams.Repeats = RTTaskCreationParameters::RepeatForever;  // Repeat this task infinitely
    calcParams.Period = 10;  // Run the task every 10 samples
    RTTask calcTask = manager->TaskSubmit(calcParams);
    
    // Wait for the calculate task to start before starting the follow task
    calcTask.ExecutionCountAbsoluteWait(1, TIMEOUT_MS);
    
    RTTaskCreationParameters followParams("FollowTarget");
    followParams.Repeats = RTTaskCreationParameters::RepeatForever;
    followParams.Period = 10;
    RTTask followTask = manager->TaskSubmit(followParams);

While your tasks are running, you can use RTTask::StatusGet and RTTaskManager::GlobalValueGet to monitor your tasks.

FirmwareValue targetPosition = manager->GlobalValueGet("targetPosition");

std::cout << "Target Position: " << targetPosition.Double << std::endl;

At the end of your program, stop the tasks, manager, and axis.

    followTask.Stop();
    calcTask.Stop();
    axis->MotionDoneWait(TIMEOUT_MS); // The axis might still be moving from the task, so wait for it to finish
    axis->AmpEnableSet(false);

Table of Contents