package mavsdk.rpc.shell

Get desktop application:
View/edit binary Protocol Buffers messages

Allow to communicate with the vehicle's system shell.

• rpc Send (SendRequest, SendResponse)

  shell.proto:17

  Send a command line.

  message SendRequest

  shell.proto:26

  • string command = 1

    The command line to send

  message SendResponse

  shell.proto:29

  • optional ShellResult shell_result = 1

• rpc SubscribeReceive (SubscribeReceiveRequest, stream ReceiveResponse)

  shell.proto:23

  Receive feedback from a sent command line. This subscription needs to be made before a command line is sent, otherwise, no response will be sent.

  message SubscribeReceiveRequest

  shell.proto:33

  (message has no fields)

  message ReceiveResponse

  shell.proto:34

  • string data = 1

    Received data.

Result type.

Used in: SendResponse

• ShellResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned for shell requests

Used in: ShellResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Request succeeded

• RESULT_NO_SYSTEM = 2

  No system is connected

• RESULT_CONNECTION_ERROR = 3

  Connection error

• RESULT_NO_RESPONSE = 4

  Response was not received

• RESULT_BUSY = 5

  Shell busy (transfer in progress)