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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
#![deny(missing_docs)]
#![no_std]
extern crate embedded_hal as hal;
use hal::blocking::i2c::{Write, WriteRead};
const I2C_ADDRESS: u8 = 0x0d;
#[allow(dead_code)]
#[allow(non_camel_case_types)]
#[derive(Copy, Clone)]
#[repr(u8)]
enum Register {
DATA_OUT_X_L = 0,
DATA_OUT_X_H = 1,
DATA_OUT_Y_L = 2,
DATA_OUT_Y_H = 3,
DATA_OUT_Z_L = 4,
DATA_OUT_Z_H = 5,
STATUS = 6,
TOUT_L = 7,
TOUT_H = 8,
CONTROL1 = 9,
CONTROL2 = 10,
PERIOD = 11,
CHIP_ID = 13,
}
const STATUS_OVL: u8 = 0b010;
const STATUS_DRDY: u8 = 0b001;
const MODE_CONTINUOUS: u8 = 0b01;
const CTRL2_SOFT_RST: u8 = 1 << 7;
const CTRL2_ROL_PNT: u8 = 1 << 6;
const CTRL2_INT_ENB: u8 = 1 << 0;
#[repr(u8)]
pub enum OutputDataRate {
Rate10Hz = 0,
Rate50Hz = 0b0100,
Rate100Hz = 0b1000,
Rate200Hz = 0b1100,
}
#[repr(u8)]
pub enum OversampleRate {
Rate64 = 3 << 6,
Rate128 = 1 << 7,
Rate256 = 1 << 6,
Rate512 = 0,
}
#[repr(u8)]
pub enum FieldRange {
Range2Gauss = 0,
Range8Gauss = 1 << 3,
}
#[derive(Debug, Copy, Clone)]
pub enum Error<E> {
InvalidDevice(u8),
NotReady,
Overflow,
BusError(E),
}
impl<E> core::convert::From<E> for Error<E> {
fn from(e: E) -> Self {
Error::BusError(e)
}
}
pub struct QMC5883L<I2C> {
i2c: I2C,
}
impl<I2C, E> QMC5883L<I2C>
where
I2C: WriteRead<Error = E> + Write<Error = E>,
{
pub fn new(i2c: I2C) -> Result<Self, Error<E>> {
let mut dev = QMC5883L { i2c: i2c };
let id = dev.read_u8(Register::CHIP_ID)?;
if id != 0xff {
return Err(Error::InvalidDevice(id));
}
dev.reset()?;
Ok(dev)
}
pub fn reset(&mut self) -> Result<(), E> {
self.write_u8(Register::CONTROL2, CTRL2_SOFT_RST)?;
self.write_u8(Register::CONTROL2, CTRL2_ROL_PNT | CTRL2_INT_ENB)?;
self.write_u8(Register::PERIOD, 1)
}
pub fn set_field_range(&mut self, rng: FieldRange) -> Result<(), E> {
let ctrl1 = self.read_u8(Register::CONTROL1)?;
let v = (ctrl1 & !(FieldRange::Range8Gauss as u8)) | (rng as u8);
self.write_u8(Register::CONTROL1, v)
}
pub fn set_oversample(&mut self, osr: OversampleRate) -> Result<(), E> {
let ctrl1 = self.read_u8(Register::CONTROL1)?;
let v = (ctrl1 & !(OversampleRate::Rate64 as u8)) | (osr as u8);
self.write_u8(Register::CONTROL1, v)
}
pub fn set_output_data_rate(&mut self, odr: OutputDataRate) -> Result<(), E> {
let ctrl1 = self.read_u8(Register::CONTROL1)?;
let v = (ctrl1 & !(OutputDataRate::Rate200Hz as u8)) | (odr as u8);
self.write_u8(Register::CONTROL1, v)
}
pub fn continuous(&mut self) -> Result<(), E> {
let ctrl1 = self.read_u8(Register::CONTROL1)?;
self.write_u8(Register::CONTROL1, ctrl1 | MODE_CONTINUOUS)
}
pub fn standby(&mut self) -> Result<(), E> {
let ctrl1 = self.read_u8(Register::CONTROL1)?;
self.write_u8(Register::CONTROL1, ctrl1 & !MODE_CONTINUOUS)
}
pub fn enable_interrupt(&mut self) -> Result<(), E> {
self.write_u8(Register::CONTROL2, CTRL2_ROL_PNT)
}
pub fn disable_interrupt(&mut self) -> Result<(), E> {
self.write_u8(Register::CONTROL2, CTRL2_ROL_PNT | CTRL2_INT_ENB)
}
pub fn temp(&mut self) -> Result<i16, E> {
let temp_l = self.read_u8(Register::TOUT_L)? as i16;
let temp_h = self.read_u8(Register::TOUT_H)? as i16;
Ok((temp_h << 8) | temp_l)
}
pub fn mag(&mut self) -> Result<(i16, i16, i16), Error<E>> {
let buf: &mut [u8; 7] = &mut [0; 7];
self.i2c
.write_read(I2C_ADDRESS, &[Register::STATUS as u8], buf)?;
let status = buf[0];
if (status & STATUS_DRDY) == 0 {
return Err(Error::NotReady);
} else if (status & STATUS_OVL) != 0 {
return Err(Error::Overflow);
}
let x = ((buf[2] as i16) << 8) | (buf[1] as i16);
let y = ((buf[4] as i16) << 8) | (buf[3] as i16);
let z = ((buf[6] as i16) << 8) | (buf[5] as i16);
Ok((x, y, z))
}
fn read_u8(&mut self, reg: Register) -> Result<u8, E> {
let buf: &mut [u8; 1] = &mut [0];
self.i2c.write_read(I2C_ADDRESS, &[reg as u8], buf)?;
Ok(buf[0])
}
fn write_u8(&mut self, reg: Register, v: u8) -> Result<(), E> {
self.i2c.write(I2C_ADDRESS, &[reg as u8, v])
}
}