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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
extern crate byteorder;
use byteorder::{
ByteOrder,
LittleEndian,
};
extern crate i2cdev;
use i2cdev::core::*;
use i2cdev::linux::{LinuxI2CDevice, LinuxI2CError};
#[macro_use]
extern crate ndarray;
use ndarray::prelude::*;
use std::thread;
use std::time;
const MEAS_RANGE: f32 = 4912.0;
fn get_i2c_bus_path(i2c_bus: i32) -> String {
format!("/dev/i2c-{}", i2c_bus)
}
#[derive(Clone, Copy)]
pub enum Ak8963Reg {
St1 = 0x02,
Hxl = 0x03,
Cntl1 = 0x0a,
Asax = 0x10,
}
impl Ak8963Reg {
pub fn addr(&self) -> u8 {
*self as u8
}
}
#[derive(Clone, Copy)]
enum RegCntl1 {
PowerDn = 0,
ContMeas1 = 0x02,
ContMeas2 = 0x06,
FuseRom = 0x0f,
Sensitivity16bit = 1 << 4,
}
impl RegCntl1 {
fn mask(&self) -> u8 {
*self as u8
}
}
#[derive(Clone, Copy, Debug)]
pub enum SampleRate {
Opt8Hz,
Opt100Hz,
}
#[derive(Clone, Copy, Debug)]
pub enum Sensitivity {
Opt14bit,
Opt16bit,
}
impl Sensitivity {
fn scalar(&self) -> f32 {
MEAS_RANGE / match *self {
Sensitivity::Opt14bit => 8192.0,
Sensitivity::Opt16bit => 32768.0,
}
}
}
#[derive(Clone, Debug)]
pub struct Ak8963Sample {
pub mag: Array1<f32>,
pub mag_raw: Array1<i16>,
pub data_overrun: bool,
}
#[derive(Debug)]
pub enum ReadSampleError {
DataNotReady,
I2c(LinuxI2CError),
}
pub struct Ak8963 {
i2c_dev: LinuxI2CDevice,
pub factory_adjust: Array1<f32>,
pub sensitivity: Sensitivity,
}
impl Ak8963 {
pub fn new(
i2c_bus: i32, i2c_addr: Option<u16>, sensitivity: Sensitivity,
sample_rate: SampleRate)
-> Result<Ak8963, LinuxI2CError> {
let mut i2c_dev = LinuxI2CDevice::new(
get_i2c_bus_path(i2c_bus), i2c_addr.unwrap_or(0x0c))?;
let factory_adjust = Ak8963::read_sensitivity_adjustment(&mut i2c_dev)?;
let mut ak = Ak8963 {
i2c_dev,
factory_adjust,
sensitivity,
};
ak.initialize(sensitivity, sample_rate)?;
Ok(ak)
}
pub fn read_sensitivity_adjustment(i2c_dev: &mut LinuxI2CDevice) -> Result<Array1<f32>, LinuxI2CError> {
i2c_dev.write(&[Ak8963Reg::Cntl1.addr(), RegCntl1::PowerDn.mask()])?;
thread::sleep(time::Duration::from_millis(1));
i2c_dev.write(&[Ak8963Reg::Cntl1.addr(), RegCntl1::FuseRom.mask()])?;
thread::sleep(time::Duration::from_millis(1));
let mut buf: [u8; 3] = [0u8; 3];
i2c_dev.write(&[Ak8963Reg::Asax.addr()])?;
i2c_dev.read(&mut buf)?;
let factory_adjust = array![
((buf[0] - 128) as f32)/256.0 + 1.0,
((buf[1] - 128) as f32)/256.0 + 1.0,
((buf[2] - 128) as f32)/256.0 + 1.0,
];
i2c_dev.write(&[Ak8963Reg::Cntl1.addr(), RegCntl1::PowerDn.mask()])?;
thread::sleep(time::Duration::from_micros(100));
Ok(factory_adjust)
}
fn initialize(
&mut self, sensitivity: Sensitivity, sample_rate: SampleRate)
-> Result<(), LinuxI2CError> {
let mut cntl1_byte = 0u8;
match sensitivity {
Sensitivity::Opt14bit => {},
Sensitivity::Opt16bit => {
cntl1_byte |= RegCntl1::Sensitivity16bit.mask()
}
}
match sample_rate {
SampleRate::Opt8Hz => {
cntl1_byte |= RegCntl1::ContMeas1.mask()
},
SampleRate::Opt100Hz => {
cntl1_byte |= RegCntl1::ContMeas2.mask()
},
}
self.i2c_dev.write(&[Ak8963Reg::Cntl1.addr(), cntl1_byte])?;
thread::sleep(time::Duration::from_micros(100));
return Ok(())
}
pub fn read_sample(&mut self) -> Result<Option<Ak8963Sample>, ReadSampleError> {
let mut buf1: [u8; 1] = [0u8; 1];
self.i2c_dev.write(&[Ak8963Reg::St1.addr()])
.map_err(|e| ReadSampleError::I2c(e))?;
self.i2c_dev.read(&mut buf1)
.map_err(|e| ReadSampleError::I2c(e))?;
if (buf1[0] & 1) == 0 {
return Err(ReadSampleError::DataNotReady);
}
let mut buf: [u8; 7] = [0u8; 7];
self.i2c_dev.write(&[Ak8963Reg::Hxl.addr()])
.map_err(|e| ReadSampleError::I2c(e))?;
self.i2c_dev.read(&mut buf)
.map_err(|e| ReadSampleError::I2c(e))?;
let mut sample = Ak8963::parse_sample_helper(
&buf,
self.sensitivity,
&self.factory_adjust);
if let Some(sample_unwrapped) = sample.as_mut() {
if (buf1[0] & (1 << 1)) != 0 {
sample_unwrapped.data_overrun = true;
}
}
Ok(sample)
}
fn parse_sample_helper(
data: &[u8], sensitivity: Sensitivity,
factory_adjust: &Array1<f32>) -> Option<Ak8963Sample> {
if (data[6] & (1 << 3)) > 0 {
return None;
}
let mag_raw = array![
LittleEndian::read_i16(&data[0 .. 2]),
LittleEndian::read_i16(&data[2 .. 4]),
LittleEndian::read_i16(&data[4 .. 6]),
];
let mag = sensitivity.scalar() * factory_adjust *
mag_raw.map(|e| *e as f32);
Some(Ak8963Sample {
mag_raw,
mag,
data_overrun: false,
})
}
pub fn parse_sample_data(&mut self, data: &[u8]) -> Option<Ak8963Sample> {
Ak8963::parse_sample_helper(data, self.sensitivity, &self.factory_adjust)
}
}
#[cfg(test)]
mod tests {
use super::{Ak8963, SampleRate, Sensitivity};
use std::env;
fn get_i2c_bus() -> i32 {
match env::var("AK8963_I2C_BUS") {
Ok(bus_string) => {
bus_string.parse().expect(
"Could not convert AK8963_I2C_BUS env var to i32.")
},
Err(_) => 1,
}
}
fn get_i2c_addr() -> Option<u16> {
match env::var("AK8963_I2C_ADDR") {
Ok(addr_string) => {
Some(addr_string.parse().expect(
"Could not convert AK8963_I2C_ADDR env var to u16."))
},
Err(_) => None,
}
}
#[test]
fn basic() {
let mut ak8963 = Ak8963::new(
get_i2c_bus(), get_i2c_addr(), Sensitivity::Opt16bit,
SampleRate::Opt100Hz).unwrap();
ak8963.read_sample().unwrap();
}
}