ComponentInformation

class mavsdk.component_information.ComponentInformation(async_plugin_manager)

Bases: AsyncBase

Access component information such as parameters.

Generated by dcsdkgen - MAVSDK ComponentInformation API

async access_float_params()

List available float params.

Returns:

params – Float param definitions

Return type:

[FloatParam]

Raises:

ComponentInformationError – If the request fails. The error contains the reason for the failure.

async float_param()

Subscribe to float param changes/updates.

Yields:

param_update (FloatParamUpdate) – A param update

name = 'ComponentInformation'
exception mavsdk.component_information.ComponentInformationError(result, origin, *params)

Bases: Exception

Raised when a ComponentInformationResult is a fail code

class mavsdk.component_information.ComponentInformationResult(result, result_str)

Bases: object

Result type.

Parameters:

  • result (Result) – Result enum value

  • result_str (std::string) – Human-readable English string describing the result

class Result(value)

Bases: Enum

Possible results returned for param requests.

Values

UNKNOWN

Unknown result

SUCCESS

Request succeeded

NO_SYSTEM

No system is connected

NO_SYSTEM = 2
SUCCESS = 1
UNKNOWN = 0
class mavsdk.component_information.FloatParam(name, short_description, long_description, unit, decimal_places, start_value, default_value, min_value, max_value)

Bases: object

Meta information for parameter of type float.

Parameters:

  • name (std::string) – Name (max 16 chars)

  • short_description (std::string) – Short description

  • long_description (std::string) – Long description

  • unit (std::string) – Unit

  • decimal_places (int32_t) – Decimal places for user to show

  • start_value (float) – Current/starting value

  • default_value (float) – Default value

  • min_value (float) – Minimum value

  • max_value (float) – Maximum value

class mavsdk.component_information.FloatParamUpdate(name, value)

Bases: object

A float param that has been updated.

Parameters:

  • name (std::string) – Name of param that changed

  • value (float) – New value of param