Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
auterion::RunOptions Struct Reference

Options for SDK run() method. More...

#include <auterion_sdk/auterion.hpp>

Public Member Functions

RunOptionswithSkipFlightControllerConnectionCheck (bool skip)
 Skip the check for flight controller connection.
 
RunOptionswithSkipMessageCompatibilityCheck (bool skip)
 Skip the check for message compatibility.
 
RunOptionswithFlightControllerConnectionTimeout (std::chrono::seconds timeout)
 Set the timeout for the flight controller connection check.
 
void validate () const
 

Public Attributes

bool skip_flight_controller_connection_check {false}
 
bool skip_message_compatibility_check {true}
 
std::chrono::seconds flight_controller_connection_timeout {15}
 

Detailed Description

Options for SDK run() method.

This class allows to configure the behavior of the SDK when running.

Member Function Documentation

◆ withFlightControllerConnectionTimeout()

RunOptions & auterion::RunOptions::withFlightControllerConnectionTimeout ( std::chrono::seconds  timeout)
inline

Set the timeout for the flight controller connection check.

On cold boot, DDS endpoint discovery can take longer than expected, causing the default timeout to be insufficient. Increase this if the app restarts due to "Timed out waiting for FMU" errors during boot.

Default: 15s.

Parameters
timeoutThe timeout duration.

◆ withSkipFlightControllerConnectionCheck()

RunOptions & auterion::RunOptions::withSkipFlightControllerConnectionCheck ( bool  skip)
inline

Skip the check for flight controller connection.

This check is enabled by default.

Parameters
skipIf true, the flight controller connection check is skipped.

◆ withSkipMessageCompatibilityCheck()

RunOptions & auterion::RunOptions::withSkipMessageCompatibilityCheck ( bool  skip)
inline

Skip the check for message compatibility.

Skipping this check makes sense for devices using the translation node, which allows applications and the flight controller to communicate despite mismatched message definitions.

Enabling this check requires that the flight controller check is enabled.

This check is disabled by default.

Parameters
skipIf true, the message compatibility check is skipped.

The documentation for this struct was generated from the following file: