mavsdk::Mavsdk::Configuration Class Reference

#include: mavsdk.h


Possible configurations.

Public Types

Type Description
enum UsageType UsageTypes of configurations, used for automatic ID setting.

Public Member Functions

Type Name Description
  Configuration (uint8_t system_id, uint8_t component_id, bool always_send_heartbeats) Create new Configuration via manually configured system and component ID.
  Configuration (UsageType usage_type) Create new Configuration using a usage type. In this mode, the system and component ID will be automatically chosen.
  Configuration ()=delete
  ~Configuration ()=default
uint8_t get_system_id () const Get the system id of this configuration.
void set_system_id (uint8_t system_id) Set the system id of this configuration.
uint8_t get_component_id () const Get the component id of this configuration.
void set_component_id (uint8_t component_id) Set the component id of this configuration.
bool get_always_send_heartbeats () const Get whether to send heartbeats by default.
void set_always_send_heartbeats (bool always_send_heartbeats) Set whether to send heartbeats by default.
UsageType get_usage_type () const Usage type of this configuration, used for automatic ID set.
void set_usage_type (UsageType usage_type) Set the usage type of this configuration.

Constructor & Destructor Documentation

Configuration()

mavsdk::Mavsdk::Configuration::Configuration(uint8_t system_id, uint8_t component_id, bool always_send_heartbeats)

Create new Configuration via manually configured system and component ID.

Parameters

  • uint8_t system_id - the system id to store in this configuration
  • uint8_t component_id - the component id to store in this configuration
  • bool always_send_heartbeats - send heartbeats by default even without a system connected

Configuration()

mavsdk::Mavsdk::Configuration::Configuration(UsageType usage_type)

Create new Configuration using a usage type. In this mode, the system and component ID will be automatically chosen.

Parameters

  • UsageType usage_type - the usage type, used for automatically choosing ids.

Configuration()

mavsdk::Mavsdk::Configuration::Configuration()=delete

~Configuration()

mavsdk::Mavsdk::Configuration::~Configuration()=default

Member Enumeration Documentation

enum UsageType

UsageTypes of configurations, used for automatic ID setting.

Value Description
Autopilot SDK is used as an autopilot.
GroundStation SDK is used as a ground station.
CompanionComputer SDK is used as a companion computer on board the MAV.
Custom the SDK is used in a custom configuration, no automatic ID will be provided

Member Function Documentation

get_system_id()

uint8_t mavsdk::Mavsdk::Configuration::get_system_id() const

Get the system id of this configuration.

Returns

 uint8_t - uint8_t the system id stored in this configuration, from 1-255

set_system_id()

void mavsdk::Mavsdk::Configuration::set_system_id(uint8_t system_id)

Set the system id of this configuration.

Parameters

  • uint8_t system_id -

get_component_id()

uint8_t mavsdk::Mavsdk::Configuration::get_component_id() const

Get the component id of this configuration.

Returns

 uint8_t - uint8_t the component id stored in this configuration,from 1-255

set_component_id()

void mavsdk::Mavsdk::Configuration::set_component_id(uint8_t component_id)

Set the component id of this configuration.

Parameters

  • uint8_t component_id -

get_always_send_heartbeats()

bool mavsdk::Mavsdk::Configuration::get_always_send_heartbeats() const

Get whether to send heartbeats by default.

Returns

 bool - whether to always send heartbeats

set_always_send_heartbeats()

void mavsdk::Mavsdk::Configuration::set_always_send_heartbeats(bool always_send_heartbeats)

Set whether to send heartbeats by default.

Parameters

  • bool always_send_heartbeats -

get_usage_type()

UsageType mavsdk::Mavsdk::Configuration::get_usage_type() const

Usage type of this configuration, used for automatic ID set.

Returns

UsageType -

set_usage_type()

void mavsdk::Mavsdk::Configuration::set_usage_type(UsageType usage_type)

Set the usage type of this configuration.

Parameters

© Dronecode 2017-2020. License: CC BY 4.0            Updated: 2021-03-12 08:31:05

results matching ""

    No results matching ""