embedded-camsense-x1 0.1.0

Platform-agnostic Rust driver for the Camsense-X1 LiDAR sensor.
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

use crate::constants::{ANGLE_CENTER_OFFSET_DEFAULT, UPDATE_INTERVAL_DEFAULT};
use core::time::Duration;

/// Camsense-X1 LiDAR sensor driver configuration.
///
/// Use [`Config::default`] for typical sensor orientations, or construct
/// manually to correct for non-standard mounting.
///
/// # Example
/// ```rust
/// use std::time::Duration;
/// let config = Config { angle_offset: 28.5, update_interval: Duration::from_micros(10) };
/// let lidar = Camsense::with_config(uart, delay, config);
/// ```
#[derive(Debug, Clone, Copy)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Config {
    /// Angular correction applied to every point, in degrees.
    ///
    /// Added to each computed angle before storing the point, compensating
    /// for the sensor's physical mounting orientation. Defaults to [`ANGLE_CENTER_OFFSET_DEFAULT`].
    pub angle_offset: f32,
    /// Time duration between partial scans
    ///
    /// Defaults to [`UPDATE_INTERVAL_DEFAULT`].
    pub update_interval: Duration,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            angle_offset: ANGLE_CENTER_OFFSET_DEFAULT,
            update_interval: Duration::from_micros(UPDATE_INTERVAL_DEFAULT),
        }
    }
}