mavkit 0.3.0

Async MAVLink SDK for vehicle control, missions, and parameters
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

pub mod file;
pub mod types;

pub use file::{format_param_file, parse_param_file};
pub use types::{
    Param, ParamProgress, ParamStore, ParamTransferPhase, ParamType, ParamWriteResult,
};

use crate::Vehicle;
use crate::error::VehicleError;

/// Handle to parameter operations on a `Vehicle`.
pub struct ParamsHandle<'a> {
    vehicle: &'a Vehicle,
}

impl<'a> ParamsHandle<'a> {
    pub(crate) fn new(vehicle: &'a Vehicle) -> Self {
        Self { vehicle }
    }

    /// Download all parameters from the vehicle.
    pub async fn download_all(&self) -> Result<ParamStore, VehicleError> {
        self.vehicle
            .send_command(|reply| crate::command::Command::ParamDownloadAll { reply })
            .await
    }

    /// Write a single parameter value and return the confirmed parameter.
    pub async fn write(&self, name: String, value: f32) -> Result<Param, VehicleError> {
        self.vehicle
            .send_command(|reply| crate::command::Command::ParamWrite { name, value, reply })
            .await
    }

    /// Write multiple parameters in sequence, returning results for each.
    pub async fn write_batch(
        &self,
        params: Vec<(String, f32)>,
    ) -> Result<Vec<types::ParamWriteResult>, VehicleError> {
        self.vehicle
            .send_command(|reply| crate::command::Command::ParamWriteBatch { params, reply })
            .await
    }
}