package mavsdk.rpc.param

Get desktop application:
View/edit binary Protocol Buffers messages

Provide raw access to get and set parameters.

• rpc GetAllParams (GetAllParamsRequest, GetAllParamsResponse)

  param.proto:51

  Get all parameters.

  message GetAllParamsRequest

  param.proto:109

  (message has no fields)

  message GetAllParamsResponse

  param.proto:111

  • optional AllParams params = 1

    Collection of all parameters

• rpc GetParamCustom (GetParamCustomRequest, GetParamCustomResponse)

  param.proto:41

  Get a custom parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message GetParamCustomRequest

  param.proto:93

  • string name = 1

    Name of the parameter

  message GetParamCustomResponse

  param.proto:96

  • optional ParamResult param_result = 1

  • string value = 2

    Value of the requested parameter

• rpc GetParamFloat (GetParamFloatRequest, GetParamFloatResponse)

  param.proto:29

  Get a float parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message GetParamFloatRequest

  param.proto:77

  • string name = 1

    Name of the parameter

  message GetParamFloatResponse

  param.proto:80

  • optional ParamResult param_result = 1

  • float value = 2

    Value of the requested parameter

• rpc GetParamInt (GetParamIntRequest, GetParamIntResponse)

  param.proto:17

  Get an int parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message GetParamIntRequest

  param.proto:60

  • string name = 1

    Name of the parameter

  message GetParamIntResponse

  param.proto:64

  • optional ParamResult param_result = 1

  • int32 value = 2

    Value of the requested parameter

• rpc SelectComponent (SelectComponentRequest, SelectComponentResponse)

  param.proto:57

  Select component ID of parameter component to talk to and param protocol version. Default is the autopilot component (1), and Version (0).

  message SelectComponentRequest

  param.proto:119

  • int32 component_id = 1

    MAVLink component Id of component to select

  • ProtocolVersion protocol_version = 2

    Protocol version

  message SelectComponentResponse

  param.proto:115

  • optional ParamResult param_result = 1

• rpc SetParamCustom (SetParamCustomRequest, SetParamCustomResponse)

  param.proto:47

  Set a custom parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message SetParamCustomRequest

  param.proto:101

  • string name = 1

    Name of the parameter to set

  • string value = 2

    Value the parameter should be set to

  message SetParamCustomResponse

  param.proto:105

  • optional ParamResult param_result = 1

• rpc SetParamFloat (SetParamFloatRequest, SetParamFloatResponse)

  param.proto:35

  Set a float parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message SetParamFloatRequest

  param.proto:85

  • string name = 1

    Name of the parameter to set

  • float value = 2

    Value the parameter should be set to

  message SetParamFloatResponse

  param.proto:89

  • optional ParamResult param_result = 1

• rpc SetParamInt (SetParamIntRequest, SetParamIntResponse)

  param.proto:23

  Set an int parameter. If the type is wrong, the result will be `WRONG_TYPE`.

  message SetParamIntRequest

  param.proto:69

  • string name = 1

    Name of the parameter to set

  • int32 value = 2

    Value the parameter should be set to

  message SetParamIntResponse

  param.proto:73

  • optional ParamResult param_result = 1

Type collecting all integer, float, and custom parameters.

Used in: GetAllParamsResponse

• repeated IntParam int_params = 1

  Collection of all parameter names and values of type int

• repeated FloatParam float_params = 2

  Collection of all parameter names and values of type float

• repeated CustomParam custom_params = 3

  Collection of all parameter names and values of type custom

Type for custom parameters

Used in: AllParams

• string name = 1

  Name of the parameter

• string value = 2

  Value of the parameter (max len 128 bytes)

Type for float parameters.

Used in: AllParams

• string name = 1

  Name of the parameter

• float value = 2

  Value of the parameter

Type for integer parameters.

Used in: AllParams

• string name = 1

  Name of the parameter

• int32 value = 2

  Value of the parameter

Result type.

Used in: GetParamCustomResponse, GetParamFloatResponse, GetParamIntResponse, SelectComponentResponse, SetParamCustomResponse, SetParamFloatResponse, SetParamIntResponse

• ParamResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned for param requests.

Used in: ParamResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Request succeeded

• RESULT_TIMEOUT = 2

  Request timed out

• RESULT_CONNECTION_ERROR = 3

  Connection error

• RESULT_WRONG_TYPE = 4

  Wrong type

• RESULT_PARAM_NAME_TOO_LONG = 5

  Parameter name too long (> 16)

• RESULT_NO_SYSTEM = 6

  No system connected

• RESULT_PARAM_VALUE_TOO_LONG = 7

  Param value too long (> 128)

• RESULT_FAILED = 8

  Operation failed.

• RESULT_DOES_NOT_EXIST = 9

  Parameter does not exist

• RESULT_VALUE_OUT_OF_RANGE = 10

  Parameter value does not fit within accepted range

• RESULT_PERMISSION_DENIED = 11

  Caller is not permitted to set the value of this parameter

• RESULT_COMPONENT_NOT_FOUND = 12

  Unknown component specified

• RESULT_READ_ONLY = 13

  Parameter is read-only

• RESULT_TYPE_UNSUPPORTED = 14

  Parameter data type is not supported by flight stack

• RESULT_TYPE_MISMATCH = 15

  Parameter type does not match expected type

• RESULT_READ_FAIL = 16

  Parameter exists but reading failed

Parameter version

Used in: SelectComponentRequest

• PROTOCOL_VERSION_V1 = 0

  Original v1 version

• PROTOCOL_VERSION_EXT = 1

  Extended param version