Struct mav_sdk::grpc::mission::MissionServiceClient

pub struct MissionServiceClient<T> { /* fields omitted */ }

Enable waypoint missions.

Implementations

impl MissionServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> MissionServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + Send + Sync + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>(
    inner: T,
    interceptor: F
) -> MissionServiceClient<InterceptedService<T, F>> where
    F: Interceptor,
    T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
    <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync, 

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn upload_mission(
    &mut self,
    request: impl IntoRequest<UploadMissionRequest>
) -> Result<Response<UploadMissionResponse>, Status>

Upload a list of mission items to the system.

The mission items are uploaded to a drone. Once uploaded the mission can be started and executed even if the connection is lost.

pub async fn cancel_mission_upload(
    &mut self,
    request: impl IntoRequest<CancelMissionUploadRequest>
) -> Result<Response<CancelMissionUploadResponse>, Status>

Cancel an ongoing mission upload.

pub async fn download_mission(
    &mut self,
    request: impl IntoRequest<DownloadMissionRequest>
) -> Result<Response<DownloadMissionResponse>, Status>

Download a list of mission items from the system (asynchronous).

Will fail if any of the downloaded mission items are not supported by the MAVSDK API.

pub async fn cancel_mission_download(
    &mut self,
    request: impl IntoRequest<CancelMissionDownloadRequest>
) -> Result<Response<CancelMissionDownloadResponse>, Status>

Cancel an ongoing mission download.

pub async fn start_mission(
    &mut self,
    request: impl IntoRequest<StartMissionRequest>
) -> Result<Response<StartMissionResponse>, Status>

Start the mission.

A mission must be uploaded to the vehicle before this can be called.

pub async fn pause_mission(
    &mut self,
    request: impl IntoRequest<PauseMissionRequest>
) -> Result<Response<PauseMissionResponse>, Status>

Pause the mission.

Pausing the mission puts the vehicle into HOLD mode. A multicopter should just hover at the spot while a fixedwing vehicle should loiter around the location where it paused.

pub async fn clear_mission(
    &mut self,
    request: impl IntoRequest<ClearMissionRequest>
) -> Result<Response<ClearMissionResponse>, Status>

Clear the mission saved on the vehicle.

pub async fn set_current_mission_item(
    &mut self,
    request: impl IntoRequest<SetCurrentMissionItemRequest>
) -> Result<Response<SetCurrentMissionItemResponse>, Status>

Sets the mission item index to go to.

By setting the current index to 0, the mission is restarted from the beginning. If it is set to a specific index of a mission item, the mission will be set to this item.

Note that this is not necessarily true for general missions using MAVLink if loop counters are used.

pub async fn is_mission_finished(
    &mut self,
    request: impl IntoRequest<IsMissionFinishedRequest>
) -> Result<Response<IsMissionFinishedResponse>, Status>

Check if the mission has been finished.

pub async fn subscribe_mission_progress(
    &mut self,
    request: impl IntoRequest<SubscribeMissionProgressRequest>
) -> Result<Response<Streaming<MissionProgressResponse>>, Status>

Subscribe to mission progress updates.

pub async fn get_return_to_launch_after_mission(
    &mut self,
    request: impl IntoRequest<GetReturnToLaunchAfterMissionRequest>
) -> Result<Response<GetReturnToLaunchAfterMissionResponse>, Status>

Get whether to trigger Return-to-Launch (RTL) after mission is complete.

Before getting this option, it needs to be set, or a mission needs to be downloaded.

pub async fn set_return_to_launch_after_mission(
    &mut self,
    request: impl IntoRequest<SetReturnToLaunchAfterMissionRequest>
) -> Result<Response<SetReturnToLaunchAfterMissionResponse>, Status>

Set whether to trigger Return-to-Launch (RTL) after the mission is complete.

This will only take effect for the next mission upload, meaning that the mission may have to be uploaded again.

pub async fn import_qgroundcontrol_mission(
    &mut self,
    request: impl IntoRequest<ImportQgroundcontrolMissionRequest>
) -> Result<Response<ImportQgroundcontrolMissionResponse>, Status>

Import a QGroundControl (QGC) mission plan.

The method will fail if any of the imported mission items are not supported by the MAVSDK API.

Trait Implementations

impl<T: Clone> Clone for MissionServiceClient<T>

fn clone(&self) -> MissionServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for MissionServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.