tmag5170 0.1.0

A platform agnostic driver to interface with the TMAG5170-Q1 (3D hall 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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/// Selects a safety diagnostic mode run
pub enum DiagSel {
    /// Run all data path diagnostics all together (default)
    AllData = 0x00,

    /// Run only enabled data path diagnostics all together
    EnabledData = 0x01,

    /// Run all data path diagnostics in sequence
    AllDataInSeq = 0x02,

    /// Run only enabled data path diagnostics in sequence
    EnabledDataInSeq = 0x03,
}

/// Selects a condition which initiates a single conversion
#[allow(non_camel_case_types)]
pub enum TriggerMode {
    /// Conversion Start at SPI Command Bits (default)
    Spi = 0x00,

    /// nCS Sync Pulse
    Cs = 0x01,

    /// ALERT Sync Pulse
    Alert = 0x02,
}

/// Data Type to be accessed from results registers via SPI
#[allow(non_camel_case_types)]
pub enum DataType {
    /// Default 32-bit Register Access
    Default = 0x00,

    /// 12-Bit XY Data Access
    XY = 0x01,

    /// 12-Bit XZ Data Access
    XZ = 0x02,

    /// 12-Bit ZY Data Access
    ZY = 0x03,

    /// 12-Bit XT Data Access
    XT = 0x04,

    /// 12-Bit YT Data Access
    YT = 0x05,

    /// 12-Bit ZT Data Access
    ZT = 0x06,

    /// 12-Bit AM Data Access
    AM = 0x07,
}

/// Configure Device Operation Modes - SYSTEM_CONFIG
pub struct SystemConfig {
    config: u16,
}

impl SystemConfig {
    /// Creates default config
    pub fn new() -> Self {
        let config = 0x00;
        SystemConfig { config }
    }

    /// Creates config from u16 value
    pub fn form_u16(config: u16) -> Self {
        SystemConfig { config }
    }

    /// Convert config to u16 value
    pub fn to_u16(&self) -> u16 {
        self.config
    }

    /// Set AngleEn field
    pub fn set_diag_sel(mut self, diag_sel: DiagSel) -> Self {
        self.config = self.config & !(0b11 << 12) | ((diag_sel as u16) << 12);
        self
    }

    /// Set SleepTime field
    pub fn set_trigger_mode(mut self, trigger_mode: TriggerMode) -> Self {
        self.config = self.config & !(0b11 << 9) | ((trigger_mode as u16) << 9);
        self
    }

    /// Set AngleEn field
    pub fn set_data_type(mut self, data_type: DataType) -> Self {
        self.config = self.config & !(0b111 << 6) | ((data_type as u16) << 6);
        self
    }

    /// Enables AFE Diagnostic Tests to be executed
    pub fn set_diag_en(mut self, diag_en: bool) -> Self {
        self.config = self.config & !(0b1 << 5) | ((diag_en as u16) << 5);
        self
    }

    /// Enables magnetic field limit check on Z axis
    pub fn set_t_z_limit_check(mut self, z_limit_check: bool) -> Self {
        self.config = self.config & !(0b1 << 2) | ((z_limit_check as u16) << 2);
        self
    }

    /// Enables magnetic field limit check on Y axis
    pub fn set_t_y_limit_check(mut self, y_limit_check: bool) -> Self {
        self.config = self.config & !(0b1 << 1) | ((y_limit_check as u16) << 1);
        self
    }

    /// Enables magnetic field limit check on X axis
    pub fn set_t_x_limit_check(mut self, x_limit_check: bool) -> Self {
        self.config = self.config & !(0b1) | (x_limit_check as u16);
        self
    }
}

impl Default for SystemConfig {
    fn default() -> Self {
        SystemConfig::new()
    }
}