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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
#[allow(dead_code)]
mod common;

use mavkit::{ParamTransferPhase, Vehicle};
use std::time::Duration;

async fn wait_for_param_progress<F>(vehicle: &Vehicle, mut predicate: F, timeout: Duration)
where
    F: FnMut(&mavkit::ParamProgress) -> bool,
{
    let mut rx = vehicle.param_progress();
    let deadline = tokio::time::sleep(timeout);
    tokio::pin!(deadline);
    loop {
        tokio::select! {
            _ = &mut deadline => panic!("timed out waiting for param progress"),
            result = rx.changed() => {
                result.expect("watch channel closed");
                let progress = rx.borrow().clone();
                if predicate(&progress) {
                    return;
                }
            }
        }
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_download_all() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        let store = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        if store.params.is_empty() {
            return Err("expected non-empty param store".into());
        }
        if store.expected_count == 0 {
            return Err("expected non-zero expected_count".into());
        }
        if store.params.len() != store.expected_count as usize {
            return Err(format!(
                "param count mismatch: got {} params but expected_count is {}",
                store.params.len(),
                store.expected_count
            ));
        }

        // Verify a param that every ArduPilot vehicle has
        if !store.params.contains_key("SYSID_THISMAV") {
            return Err("missing SYSID_THISMAV in downloaded params".into());
        }

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_write_and_readback() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        let store = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        let original = store
            .params
            .get("SR0_EXTRA1")
            .ok_or("SR0_EXTRA1 not found in params")?
            .value;

        // Toggle to a different value
        let new_value = if (original - 4.0).abs() < 0.01 {
            10.0
        } else {
            4.0
        };

        let confirmed = vehicle
            .params()
            .write("SR0_EXTRA1".into(), new_value)
            .await
            .map_err(|e| e.to_string())?;

        if (confirmed.value - new_value).abs() > 0.01 {
            return Err(format!(
                "write confirmation mismatch: requested {new_value}, got {}",
                confirmed.value
            ));
        }

        // Download again and verify persistence
        let store = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        let readback = store
            .params
            .get("SR0_EXTRA1")
            .ok_or("SR0_EXTRA1 missing after write")?
            .value;

        if (readback - new_value).abs() > 0.01 {
            return Err(format!(
                "readback mismatch: expected {new_value}, got {readback}"
            ));
        }

        // Restore original
        vehicle
            .params()
            .write("SR0_EXTRA1".into(), original)
            .await
            .map_err(|e| e.to_string())?;

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_write_batch_and_readback() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        let store = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        let params_to_write: Vec<(&str, f32)> = vec![
            ("SR0_EXTRA1", 2.0),
            ("SR0_EXTRA2", 2.0),
            ("SR0_EXTRA3", 2.0),
        ];

        // Save originals for restore
        let originals: Vec<(String, f32)> = params_to_write
            .iter()
            .map(|(name, _)| {
                let val = store
                    .params
                    .get(*name)
                    .unwrap_or_else(|| panic!("{name} not found"))
                    .value;
                (name.to_string(), val)
            })
            .collect();

        let batch: Vec<(String, f32)> = params_to_write
            .iter()
            .map(|(name, val)| (name.to_string(), *val))
            .collect();

        let results = vehicle
            .params()
            .write_batch(batch)
            .await
            .map_err(|e| e.to_string())?;

        if results.len() != params_to_write.len() {
            return Err(format!(
                "expected {} results, got {}",
                params_to_write.len(),
                results.len()
            ));
        }

        for result in &results {
            if !result.success {
                return Err(format!("batch write failed for {}", result.name));
            }
            if (result.confirmed_value - result.requested_value).abs() > 0.01 {
                return Err(format!(
                    "batch write mismatch for {}: requested {}, got {}",
                    result.name, result.requested_value, result.confirmed_value
                ));
            }
        }

        // Verify via full download
        let store = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        for (name, expected) in &params_to_write {
            let actual = store
                .params
                .get(*name)
                .ok_or(format!("{name} missing after batch write"))?
                .value;
            if (actual - expected).abs() > 0.01 {
                return Err(format!(
                    "readback mismatch for {name}: expected {expected}, got {actual}"
                ));
            }
        }

        // Restore originals
        vehicle
            .params()
            .write_batch(originals)
            .await
            .map_err(|e| e.to_string())?;

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_progress_during_download() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        let download = tokio::spawn({
            let vehicle = vehicle.clone();
            async move {
                vehicle
                    .params()
                    .download_all()
                    .await
                    .map_err(|e| e.to_string())
            }
        });

        // Wait for downloading phase to appear
        wait_for_param_progress(
            &vehicle,
            |p| p.phase == ParamTransferPhase::Downloading,
            Duration::from_secs(10),
        )
        .await;

        let store = download.await.unwrap()?;

        // After download completes, progress should reflect completion
        let progress = vehicle.param_progress().borrow().clone();
        if progress.expected == 0 {
            return Err("expected non-zero expected count in progress".into());
        }
        if progress.expected != store.expected_count {
            return Err(format!(
                "progress expected count ({}) doesn't match store ({})",
                progress.expected, store.expected_count
            ));
        }

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_store_watch_updates_on_write() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        // Populate the store first
        vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        let original = vehicle
            .param_store()
            .borrow()
            .params
            .get("SR0_EXTRA1")
            .ok_or("SR0_EXTRA1 not found")?
            .value;

        let new_value = if (original - 7.0).abs() < 0.01 {
            3.0
        } else {
            7.0
        };

        vehicle
            .params()
            .write("SR0_EXTRA1".into(), new_value)
            .await
            .map_err(|e| e.to_string())?;

        // The watch channel should reflect the updated value
        tokio::time::sleep(Duration::from_millis(200)).await;
        let store = vehicle.param_store().borrow().clone();
        let readback = store
            .params
            .get("SR0_EXTRA1")
            .ok_or("SR0_EXTRA1 missing from watch store")?
            .value;

        if (readback - new_value).abs() > 0.01 {
            return Err(format!(
                "watch store not updated: expected {new_value}, got {readback}"
            ));
        }

        // Restore
        vehicle
            .params()
            .write("SR0_EXTRA1".into(), original)
            .await
            .map_err(|e| e.to_string())?;

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}

#[tokio::test]
#[ignore = "requires ArduPilot SITL endpoint"]
async fn sitl_param_download_twice_is_consistent() {
    let vehicle = common::setup_sitl_vehicle().await;

    let result: Result<(), String> = async {
        let first = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        let second = vehicle
            .params()
            .download_all()
            .await
            .map_err(|e| e.to_string())?;

        if first.expected_count != second.expected_count {
            return Err(format!(
                "expected_count changed between downloads: {} vs {}",
                first.expected_count, second.expected_count
            ));
        }

        if first.params.len() != second.params.len() {
            return Err(format!(
                "param count changed between downloads: {} vs {}",
                first.params.len(),
                second.params.len()
            ));
        }

        // Values should be identical (no writes in between)
        for (name, param) in &first.params {
            let other = second
                .params
                .get(name)
                .ok_or(format!("{name} missing in second download"))?;
            if (param.value - other.value).abs() > 0.001 {
                return Err(format!(
                    "{name} value differs: {} vs {}",
                    param.value, other.value
                ));
            }
        }

        Ok(())
    }
    .await;

    let _ = vehicle.disconnect().await;
    if let Err(err) = result {
        panic!("{err}");
    }
}