ev3dev-lang-rust 0.16.0

Rust language bindings for ev3dev
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

//! # Container module for sensor types

mod sensor;
pub use self::sensor::Sensor;

mod color_sensor;
pub use self::color_sensor::ColorSensor;

mod hi_technic_color_sensor;
pub use self::hi_technic_color_sensor::HiTechnicColorSensor;

mod ir_seeker_sensor;
pub use self::ir_seeker_sensor::IrSeekerSensor;

mod compass_sensor;
pub use self::compass_sensor::CompassSensor;

mod light_sensor;
pub use self::light_sensor::LightSensor;

mod gyro_sensor;
pub use self::gyro_sensor::GyroSensor;

mod infrared_sensor;
pub use self::infrared_sensor::BeaconSeeker;
pub use self::infrared_sensor::InfraredSensor;
pub use self::infrared_sensor::RemoteControl;

mod touch_sensor;
pub use self::touch_sensor::TouchSensor;

mod ultrasonic_sensor;
pub use self::ultrasonic_sensor::UltrasonicSensor;

use crate::Ev3Result;
use crate::LegoPort;
use crate::{port_constants, Port};

/// EV3 ports `in1` to `in4`
#[derive(Debug, Copy, Clone)]
pub enum SensorPort {
    /// EV3 `in1` port
    In1,
    /// EV3 `in2` port
    In2,
    /// EV3 `in3` port
    In3,
    /// EV3 `in4` port
    In4,
}

impl SensorPort {
    /// Try to format a device name path to a  port name.
    pub fn format_name(name: &str) -> String {
        match name {
            "sensor0" => SensorPort::In1.address(),
            "sensor1" => SensorPort::In2.address(),
            "sensor2" => SensorPort::In3.address(),
            "sensor3" => SensorPort::In4.address(),
            _ => name.to_owned(),
        }
    }
}

impl Port for SensorPort {
    fn address(&self) -> String {
        match self {
            SensorPort::In1 => port_constants::INPUT_1.to_owned(),
            SensorPort::In2 => port_constants::INPUT_2.to_owned(),
            SensorPort::In3 => port_constants::INPUT_3.to_owned(),
            SensorPort::In4 => port_constants::INPUT_4.to_owned(),
        }
    }

    fn get_lego_port(&self) -> Ev3Result<LegoPort> {
        LegoPort::get(*self)
    }
}

#[macro_export]
/// Add a sensor mode constant with getter and setter
macro_rules! sensor_mode {
    ($value:expr, $const_name:ident, $docstring:expr, $setter:ident, $getter:ident) => {
        #[doc = $docstring]
        pub const $const_name: &'static str = $value;

        #[doc = $docstring]
        pub fn $setter(&self) -> Ev3Result<()> {
            self.set_mode(Self::$const_name)
        }

        #[doc = $docstring]
        pub fn $getter(&self) -> Ev3Result<bool> {
            Ok(self.get_mode()? == Self::$const_name)
        }
    };
}