package mavsdk.rpc.param_server

Get desktop application:
View/edit binary Protocol Buffers messages

Provide raw access to retrieve and provide server parameters.

• rpc ProvideParamCustom (ProvideParamCustomRequest, ProvideParamCustomResponse)

  param_server.proto:68

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

  message ProvideParamCustomRequest

  param_server.proto:133

  • string name = 1

    Name of the parameter to provide

  • string value = 2

    Value the parameter should be set to

  message ProvideParamCustomResponse

  param_server.proto:137

  • optional ParamServerResult param_server_result = 1

• rpc ProvideParamFloat (ProvideParamFloatRequest, ProvideParamFloatResponse)

  param_server.proto:52

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

  message ProvideParamFloatRequest

  param_server.proto:116

  • string name = 1

    Name of the parameter to provide

  • float value = 2

    Value the parameter should be set to

  message ProvideParamFloatResponse

  param_server.proto:120

  • optional ParamServerResult param_server_result = 1

• rpc ProvideParamInt (ProvideParamIntRequest, ProvideParamIntResponse)

  param_server.proto:36

  Provide an int parameter. If the type is wrong, the result will be `WRONG_TYPE`. Note that all params need to be provided upfront. Once a client has requested a param list, the indices are locked and no more params can be added.

  message ProvideParamIntRequest

  param_server.proto:100

  • string name = 1

    Name of the parameter to provide

  • int32 value = 2

    Value the parameter should be set to

  message ProvideParamIntResponse

  param_server.proto:104

  • optional ParamServerResult param_server_result = 1

• rpc RetrieveAllParams (RetrieveAllParamsRequest, RetrieveAllParamsResponse)

  param_server.proto:72

  Retrieve all parameters.

  message RetrieveAllParamsRequest

  param_server.proto:142

  (message has no fields)

  message RetrieveAllParamsResponse

  param_server.proto:144

  • optional AllParams params = 1

    Collection of all parameters

• rpc RetrieveParamCustom (RetrieveParamCustomRequest, RetrieveParamCustomResponse)

  param_server.proto:62

  Retrieve a custom parameter. If the type is wrong, the result will be `WRONG_TYPE`. Note that all params need to be provided upfront. Once a client has requested a param list, the indices are locked and no more params can be added.

  message RetrieveParamCustomRequest

  param_server.proto:124

  • string name = 1

    Name of the parameter

  message RetrieveParamCustomResponse

  param_server.proto:128

  • optional ParamServerResult param_server_result = 1

  • string value = 2

    Value of the requested parameter

• rpc RetrieveParamFloat (RetrieveParamFloatRequest, RetrieveParamFloatResponse)

  param_server.proto:46

  Retrieve a float parameter. If the type is wrong, the result will be `WRONG_TYPE`. Note that all params need to be provided upfront. Once a client has requested a param list, the indices are locked and no more params can be added.

  message RetrieveParamFloatRequest

  param_server.proto:108

  • string name = 1

    Name of the parameter

  message RetrieveParamFloatResponse

  param_server.proto:111

  • optional ParamServerResult param_server_result = 1

  • float value = 2

    Value of the requested parameter

• rpc RetrieveParamInt (RetrieveParamIntRequest, RetrieveParamIntResponse)

  param_server.proto:25

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

  message RetrieveParamIntRequest

  param_server.proto:91

  • string name = 1

    Name of the parameter

  message RetrieveParamIntResponse

  param_server.proto:95

  • optional ParamServerResult param_server_result = 1

  • int32 value = 2

    Value of the requested parameter

• rpc SetProtocol (SetProtocolRequest, SetProtocolResponse)

  param_server.proto:19

  Set param protocol. The extended param protocol is used by default. This allows to use the previous/normal one. Note that camera definition files are meant to implement/use the extended protocol.

  message SetProtocolRequest

  param_server.proto:84

  • bool extended_protocol = 1

    Use extended protocol

  message SetProtocolResponse

  param_server.proto:87

  • optional ParamServerResult param_server_result = 1

• rpc SubscribeChangedParamCustom (SubscribeChangedParamCustomRequest, stream ChangedParamCustomResponse)

  param_server.proto:81

  Subscribe to changed custom param.

  message SubscribeChangedParamCustomRequest

  param_server.proto:158

  (message has no fields)

  message ChangedParamCustomResponse

  param_server.proto:159

  • optional CustomParam param = 1

    Param that changed

• rpc SubscribeChangedParamFloat (SubscribeChangedParamFloatRequest, stream ChangedParamFloatResponse)

  param_server.proto:78

  Subscribe to changed float param.

  message SubscribeChangedParamFloatRequest

  param_server.proto:153

  (message has no fields)

  message ChangedParamFloatResponse

  param_server.proto:154

  • optional FloatParam param = 1

    Param that changed

• rpc SubscribeChangedParamInt (SubscribeChangedParamIntRequest, stream ChangedParamIntResponse)

  param_server.proto:75

  Subscribe to changed int param.

  message SubscribeChangedParamIntRequest

  param_server.proto:148

  (message has no fields)

  message ChangedParamIntResponse

  param_server.proto:149

  • optional IntParam param = 1

    Param that changed

Type collecting all integer, float, and custom parameters.

Used in: RetrieveAllParamsResponse

• 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 float parameters.

Used in: AllParams, ChangedParamCustomResponse

• string name = 1

  Name of the parameter

• string value = 2

  Value of the parameter

Type for float parameters.

Used in: AllParams, ChangedParamFloatResponse

• string name = 1

  Name of the parameter

• float value = 2

  Value of the parameter

Type for integer parameters.

Used in: AllParams, ChangedParamIntResponse

• string name = 1

  Name of the parameter

• int32 value = 2

  Value of the parameter

Result type.

Used in: ProvideParamCustomResponse, ProvideParamFloatResponse, ProvideParamIntResponse, RetrieveParamCustomResponse, RetrieveParamFloatResponse, RetrieveParamIntResponse, SetProtocolResponse

• ParamServerResult.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: ParamServerResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Request succeeded

• RESULT_NOT_FOUND = 2

  Not Found

• RESULT_WRONG_TYPE = 3

  Wrong type

• RESULT_PARAM_NAME_TOO_LONG = 4

  Parameter name too long (> 16)

• RESULT_NO_SYSTEM = 5

  No system available

• RESULT_PARAM_VALUE_TOO_LONG = 6

  Parameter name too long (> 128)

• RESULT_PARAM_PROVIDED_TOO_LATE = 7

  All parameters have to be provided upfront