ComponentInformationServer

class mavsdk.component_information_server.ComponentInformationServer(async_plugin_manager)

Bases: AsyncBase

Provide component information such as parameters.

Generated by dcsdkgen - MAVSDK ComponentInformationServer API

async float_param()

Subscribe to float param updates.

Yields:

param_update (FloatParamUpdate) – A param update

name = 'ComponentInformationServer'
async provide_float_param(param)

Provide a param of type float.

Parameters:

param (FloatParam) – Float param definition

Raises:

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

exception mavsdk.component_information_server.ComponentInformationServerError(result, origin, *params)

Bases: Exception

Raised when a ComponentInformationServerResult is a fail code

class mavsdk.component_information_server.ComponentInformationServerResult(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

DUPLICATE_PARAM

Duplicate param

INVALID_PARAM_START_VALUE

Invalid start param value

INVALID_PARAM_DEFAULT_VALUE

Invalid default param value

INVALID_PARAM_NAME

Invalid param name

NO_SYSTEM

No system is connected

DUPLICATE_PARAM = 2
INVALID_PARAM_DEFAULT_VALUE = 4
INVALID_PARAM_NAME = 5
INVALID_PARAM_START_VALUE = 3
NO_SYSTEM = 6
SUCCESS = 1
UNKNOWN = 0
class mavsdk.component_information_server.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_server.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