scl3300 0.5.0

Driver for the SCL3300 inclinometer.
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
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

use embedded_hal::spi::SpiDevice;

use crate::{
  operation::{Bank, Operation, Output},
  output::{Acceleration, ComponentId, Error1, Error2, Inclination, SelfTest, Serial, Status, Temperature},
  Error, Normal, Scl3300,
};

fn transfer_with_bank<SPI, E>(
  scl: &mut Scl3300<SPI, Normal>,
  current_bank: &mut Bank,
  required_bank: Bank,
  operation: Operation,
) -> Result<u16, Error<E>>
where
  SPI: SpiDevice<u8, Error = E>,
{
  let mut last_value1 = None;

  if *current_bank != required_bank {
    last_value1 = Some(scl.transfer(Operation::SwitchBank(required_bank), None)?.data());
    *current_bank = required_bank;
  }

  let last_value2 = scl.transfer(operation, None)?.data();

  Ok(last_value1.unwrap_or(last_value2))
}

/// Types implementing this trait can be read using [`Scl3300::read`](crate::Scl3300::read).
pub trait OffFrameRead<SPI, E>: Sized
where
  SPI: SpiDevice<u8, Error = E>,
{
  /// Start an off-frame read.
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>>;

  /// Finish an off-frame read.
  fn finish_read(&mut self, last_value: u16);
}

impl<SPI, E> OffFrameRead<SPI, E> for Acceleration
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, _current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let mut acc = Acceleration { x: 0, y: 0, z: 0, mode: scl.mode.mode };

    let last_value = scl.transfer(Operation::Read(Output::AccelerationX), None)?.data();
    acc.x = scl.transfer(Operation::Read(Output::AccelerationY), None)?.data();
    acc.y = scl.transfer(Operation::Read(Output::AccelerationZ), None)?.data();
    Ok((last_value, acc))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.z = last_value;
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Inclination
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let mut inc = Inclination { x: 0, y: 0, z: 0 };
    let last_value = transfer_with_bank(scl, current_bank, Bank::Zero, Operation::Read(Output::AngleX))?;
    inc.x = scl.transfer(Operation::Read(Output::AngleY), None)?.data();
    inc.y = scl.transfer(Operation::Read(Output::AngleZ), None)?.data();
    Ok((last_value, inc))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.z = last_value;
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Temperature
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, _current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let temp = Temperature { temp: 0 };
    let last_value = scl.transfer(Operation::Read(Output::Temperature), None)?.data();
    Ok((last_value, temp))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.temp = last_value;
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for SelfTest
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, _current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let st = SelfTest { sto: 0, mode: scl.mode.mode };
    let last_value = scl.transfer(Operation::Read(Output::SelfTest), None)?.data();
    Ok((last_value, st))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.sto = last_value;
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for ComponentId
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let id = ComponentId { id: 0 };
    let last_value = transfer_with_bank(scl, current_bank, Bank::Zero, Operation::Read(Output::WhoAmI))?;
    Ok((last_value, id))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.id = last_value.to_be_bytes()[1];
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Serial
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let mut serial = Serial { part1: 0, part2: 0 };
    let last_value = transfer_with_bank(scl, current_bank, Bank::One, Operation::Read(Output::Serial1))?;
    serial.part1 = scl.transfer(Operation::Read(Output::Serial2), None)?.data();
    Ok((last_value, serial))
  }

  fn finish_read(&mut self, last_value: u16) {
    self.part2 = last_value;
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Status
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let status = Self::from_bits_retain(0);
    let last_value = transfer_with_bank(scl, current_bank, Bank::Zero, Operation::Read(Output::Status))?;
    Ok((last_value, status))
  }

  fn finish_read(&mut self, last_value: u16) {
    *self = Self::from_bits_retain(last_value)
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Error1
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let status = Self::from_bits_retain(0);
    let last_value = transfer_with_bank(scl, current_bank, Bank::Zero, Operation::Read(Output::Error1))?;
    Ok((last_value, status))
  }

  fn finish_read(&mut self, last_value: u16) {
    *self = Self::from_bits_retain(last_value)
  }
}

impl<SPI, E> OffFrameRead<SPI, E> for Error2
where
  SPI: SpiDevice<u8, Error = E>,
{
  fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
    let status = Self::from_bits_retain(0);
    let last_value = transfer_with_bank(scl, current_bank, Bank::Zero, Operation::Read(Output::Error2))?;
    Ok((last_value, status))
  }

  fn finish_read(&mut self, last_value: u16) {
    *self = Self::from_bits_retain(last_value)
  }
}

macro_rules! off_frame_read_tuple {
  ($($var:ident: $value:ident),+) => {
    impl<SPI, E, $($value),+> OffFrameRead<SPI, E> for ($($value),+)
    where
      SPI: SpiDevice<u8, Error = E>,
      $(
        $value: OffFrameRead<SPI, E>,
      )+
    {
      fn start_read(scl: &mut Scl3300<SPI, Normal>, current_bank: &mut Bank) -> Result<(u16, Self), Error<E>> {
        off_frame_read_tuple!(@start_read scl, current_bank, last_value, $($var: $value),+);
        Ok((last_value, ($($var),+)))
      }

      off_frame_read_tuple!(@finish $($var),+);
    }
  };
  (@finish $first_var:ident, $($var:ident),+) => {
    fn finish_read(&mut self, last_value: u16) {
      let ($(off_frame_read_tuple!(@_ $var)),+, last) = self;
      last.finish_read(last_value);
    }
  };
  (@_ $id:ident) => { _ };
  (@start_read
    $scl:expr, $current_bank:expr,
    $last_value:ident,
    $current_var:ident: $current_value:ident,
    $($var:ident: $value:ident),+
  ) => {
    let ($last_value, mut $current_var) = <$current_value>::start_read($scl, $current_bank)?;
    off_frame_read_tuple!(@start_read_inner $scl, $current_bank, $current_var: $current_value, $($var: $value),+);
  };
  (@start_read_inner
    $scl:expr, $current_bank:expr,
    $previous_var:ident: $previous_value:ident,
    $current_var:ident: $current_value:ident
  ) => {
    let (last_value, $current_var) = <$current_value>::start_read($scl, $current_bank)?;
    $previous_var.finish_read(last_value);
  };
  (@start_read_inner
    $scl:expr, $current_bank:expr,
    $previous_var:ident: $previous_value:ident,
    $current_var:ident: $current_value:ident,
    $($var:ident: $value:ident),+
  ) => {
    let (last_value, mut $current_var) = <$current_value>::start_read($scl, $current_bank)?;
    $previous_var.finish_read(last_value);
    off_frame_read_tuple!(@start_read_inner $scl, $current_bank, $current_var: $current_value, $($var: $value),+);
  };
}

off_frame_read_tuple!(v1: V1, v2: V2);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5, v6: V6);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5, v6: V6, v7: V7);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5, v6: V6, v7: V7, v8: V8);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5, v6: V6, v7: V7, v8: V8, v9: V9);
off_frame_read_tuple!(v1: V1, v2: V2, v3: V3, v4: V4, v5: V5, v6: V6, v7: V7, v8: V8, v9: V9, v10: V10);