mavlink-core 0.17.1

Implements the MAVLink data interchange format for UAVs.
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

use core::fmt::Display;

/// MAVLink address for a serial connection
///
/// # Example
///
/// ```ignore
/// use mavlink::{Connectable, SerialConfig};
///
/// let config = SerialConfig::new("/dev/ttyTHS1".to_owned(), 115200);
/// config.connect::<mavlink::ardupilotmega::MavMessage>();
/// ```
#[derive(Debug, Clone)]
pub struct SerialConfig {
    pub(crate) port_name: String,
    pub(crate) baud_rate: u32,
    read_buffer_capacity: usize,
}

impl SerialConfig {
    /// Creates a serial connection address with port name and baud rate.
    pub fn new(port_name: String, baud_rate: u32) -> Self {
        // Calculate a sane default buffer capacity based on the baud rate.
        let default_capacity = (baud_rate / 100).clamp(1024, 1024 * 8) as usize;

        Self {
            port_name,
            baud_rate,
            read_buffer_capacity: default_capacity,
        }
    }

    /// Updates the read buffer capacity.
    pub fn with_read_buffer_capacity(mut self, capacity: usize) -> Self {
        self.read_buffer_capacity = capacity;
        self
    }

    /// Returns the configured read buffer capacity.
    pub fn buffer_capacity(&self) -> usize {
        self.read_buffer_capacity
    }
}

impl Display for SerialConfig {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "serial:{}:{}", self.port_name, self.baud_rate)
    }
}