wpilib-hal 0.1.1

Low-level bindings to WPILib's HAL. DO NOT USE THIS YET. THIS IS JUST TO SECURE THE NAME.
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

use ::raw::*;

#[allow(missing_docs)]
pub type RawAccelerometerRange = HAL_AccelerometerRange;

/// The range of g-force the accelerometer will output. `Max4G` means that it will
/// output a maximum value of 4g
#[derive(Debug, Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Hash)]
pub enum AccelerometerRange {
    /// 8g maximum output
    Max8G,
    /// 4g maximum output
    Max4G,
    /// 2g maximum output
    Max2G,
}

impl AccelerometerRange {
    /// Converts the enum back to the FFI enum
    pub fn into_raw(&self) -> RawAccelerometerRange {
        match *self {
            AccelerometerRange::Max8G => HAL_AccelerometerRange::HAL_AccelerometerRange_k2G,
            AccelerometerRange::Max4G => HAL_AccelerometerRange::HAL_AccelerometerRange_k4G,
            AccelerometerRange::Max2G => HAL_AccelerometerRange::HAL_AccelerometerRange_k8G
        }
    }
}

impl From<RawAccelerometerRange> for AccelerometerRange {
    fn from(raw: RawAccelerometerRange) -> Self {
        match raw {
            HAL_AccelerometerRange::HAL_AccelerometerRange_k2G => AccelerometerRange::Max8G,
            HAL_AccelerometerRange::HAL_AccelerometerRange_k4G => AccelerometerRange::Max4G,
            HAL_AccelerometerRange::HAL_AccelerometerRange_k8G => AccelerometerRange::Max2G
        }
    }
}

/// Set the accelerometer to active or standby mode.  It must be in standby
/// mode to change any configuration.
pub fn set_accelerometer_active(active: bool) {
    unsafe { HAL_SetAccelerometerActive(active as HAL_Bool) }
}

/// Set the range of values that can be measured (either 2, 4, or 8 g-forces).
/// The accelerometer should be in standby mode when this is called.
pub fn set_accelerometer_range(range: AccelerometerRange) {
    unsafe { HAL_SetAccelerometerRange(range.into_raw()) }
}

/// Gets the acceleromenter's X (Left/right) value. Returns a value in units of 1 g-force.
pub fn get_accelerometer_x() -> f64 {
    unsafe { HAL_GetAccelerometerX() }
}

/// Gets the acceleromenter's Y (Front/back) value. Returns a value in units of 1 g-force.
pub fn get_accelerometer_y() -> f64 {
    unsafe { HAL_GetAccelerometerY() }
}

/// Gets the acceleromenter's Z (Top/bottom) value. Returns a value in units of 1 g-force.
pub fn get_accelerometer_z() -> f64 {
    unsafe { HAL_GetAccelerometerZ() }
}