pololu_tic 0.2.0-beta.3

An embedded-hal driver to control the Tic series of stepper motor controllers created by Pololu.
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

//! I2C interface to a Tic motor driver board.

use embedded_hal::{delay::DelayNs, i2c::{Error, I2c}};

use crate::{
    base::{communication::TicCommunication, TicBase},
    TicCommand, TicHandlerError, TicProduct,
};

/// I2C interface to a Tic board.
pub struct TicI2C<I2C: I2c, D: DelayNs> {
    address: u8,
    i2c: I2C,
    product: TicProduct,
    delay: D,
}

impl<I2C: I2c, D: DelayNs> TicI2C<I2C, D> {
    const DEFAULT_ADDR: u8 = 14;

    pub const fn new_default(i2c: I2C, product: TicProduct, delay: D) -> Self {
        Self {
            address: Self::DEFAULT_ADDR,
            i2c,
            product,
            delay,
        }
    }

    pub const fn new_with_address(i2c: I2C, product: TicProduct, delay: D, address: u8) -> Self {
        Self {
            address,
            i2c,
            product,
            delay,
        }
    }

    pub const fn get_address(&self) -> u8 {
        self.address
    }
}

impl<I2C: I2c, D: DelayNs> TicCommunication for TicI2C<I2C, D> {
    fn command_quick(&mut self, cmd: TicCommand) -> Result<(), TicHandlerError> {
        self.i2c
            .write(self.address, &[cmd as u8])
            .map_err(|e| TicHandlerError::I2cError(e.kind()))?;
        Ok(())
    }

    fn command_w32(&mut self, cmd: TicCommand, val: u32) -> Result<(), TicHandlerError> {
        let mut data = [0u8; 5];
        data[0] = cmd as u8;
        data[1..5].copy_from_slice(&val.to_le_bytes());
        self.i2c
            .write(self.address, &data)
            .map_err(|e| TicHandlerError::I2cError(e.kind()))?;
        Ok(())
    }

    fn command_w7(&mut self, cmd: TicCommand, val: u8) -> Result<(), TicHandlerError> {
        let mut data = [0u8; 2];
        data[0] = cmd as u8;
        data[1] = val & 0x7F;
        self.i2c
            .write(self.address, &data)
            .map_err(|e| TicHandlerError::I2cError(e.kind()))?;
        Ok(())
    }

    fn block_read(
        &mut self,
        cmd: TicCommand,
        offset: u8,
        buffer: &mut [u8],
    ) -> Result<(), TicHandlerError> {
        let data = [cmd as u8, offset];
        self.i2c
            .write_read(self.address, &data, buffer)
            .map_err(|e| TicHandlerError::I2cError(e.kind()))?;
        Ok(())
    }
}

impl<I2C: I2c, D: DelayNs> TicBase for TicI2C<I2C, D> {
    fn product(&self) -> TicProduct {
        self.product
    }

    fn delay(&mut self, delay: core::time::Duration) {
        self.delay.delay_ns(delay.as_nanos() as u32);
    }
}

impl From<embedded_hal::i2c::ErrorKind> for TicHandlerError {
    fn from(err: embedded_hal::i2c::ErrorKind) -> Self {
        Self::I2cError(err)
    }
}