flipperzero 0.16.0

Rust for Flipper Zero
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

//! Furi Power service.

use core::ffi::CStr;
use core::mem;

use flipperzero_sys as sys;
use flipperzero_sys::furi::UnsafeRecord;

pub type PowerBootMode = sys::PowerBootMode;
pub type PowerInfo = sys::PowerInfo;

/// Handle to the Power service.
#[derive(Clone)]
pub struct Power {
    record: UnsafeRecord<sys::Power>,
}

impl Power {
    pub const NAME: &CStr = c"power";

    /// Open handle to Power service.
    pub fn open() -> Self {
        Self {
            record: unsafe { UnsafeRecord::open(Self::NAME) },
        }
    }

    /// Get handle to raw [`sys::Power`] record.
    ///
    /// This pointer must not be `free`d or otherwise invalidated.
    /// It must not be referenced after [`Power`] has been dropped.
    #[inline]
    pub fn as_ptr(&self) -> *mut sys::Power {
        self.record.as_ptr()
    }

    /// Power off device.
    pub fn power_off(&self) {
        unsafe { sys::power_off(self.as_ptr()) }
    }

    /// Reboot device.
    pub fn reboot(&self, mode: PowerBootMode) {
        unsafe { sys::power_reboot(self.as_ptr(), mode) }
    }

    /// Get power info.
    pub fn get_info(&self) -> PowerInfo {
        unsafe {
            let mut power_info = mem::zeroed();
            sys::power_get_info(self.as_ptr(), &raw mut power_info);

            power_info
        }
    }

    /// Check battery health.
    pub fn is_battery_healthy(&self) -> bool {
        unsafe { sys::power_is_battery_healthy(self.as_ptr()) }
    }

    /// Enable or disable battery low level notification message.
    pub fn enable_low_battery_level_notification(&self, enable: bool) {
        unsafe {
            sys::power_enable_low_battery_level_notification(self.as_ptr(), enable);
        }
    }
}