ds1307 0.6.0

Platform-agnostic Rust driver for the DS1307 real-time clock.
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

use crate::{Ds1307, Error};
use embedded_hal::i2c::I2c;

pub struct Register;
impl Register {
    pub const SECONDS: u8 = 0x00;
    pub const MINUTES: u8 = 0x01;
    pub const HOURS: u8 = 0x02;
    pub const DOW: u8 = 0x03;
    pub const DOM: u8 = 0x04;
    pub const MONTH: u8 = 0x05;
    pub const YEAR: u8 = 0x06;
    pub const SQWOUT: u8 = 0x07;
    pub const RAM_BEGIN: u8 = 0x08;
    pub const RAM_END: u8 = 0x3F;
}

pub struct BitFlags;
impl BitFlags {
    pub const H24_H12: u8 = 0b0100_0000;
    pub const AM_PM: u8 = 0b0010_0000;
    pub const CH: u8 = 0b1000_0000;
    pub const SQWE: u8 = 0b0001_0000;
    pub const OUTLEVEL: u8 = 0b1000_0000;
    pub const OUTRATERS0: u8 = 0b0000_0001;
    pub const OUTRATERS1: u8 = 0b0000_0010;
}

pub const ADDR: u8 = 0b110_1000;

impl<I2C, E> Ds1307<I2C>
where
    I2C: I2c<Error = E>,
{
    pub(crate) fn register_bit_flag_high(
        &mut self,
        address: u8,
        bitmask: u8,
    ) -> Result<bool, Error<E>> {
        let data = self.read_register(address)?;
        Ok((data & bitmask) != 0)
    }

    pub(crate) fn set_register_bit_flag(
        &mut self,
        address: u8,
        bitmask: u8,
    ) -> Result<(), Error<E>> {
        let data = self.read_register(address)?;
        if (data & bitmask) == 0 {
            self.write_register(address, data | bitmask)
        } else {
            Ok(())
        }
    }

    pub(crate) fn clear_register_bit_flag(
        &mut self,
        address: u8,
        bitmask: u8,
    ) -> Result<(), Error<E>> {
        let data = self.read_register(address)?;
        if (data & bitmask) != 0 {
            self.write_register(address, data & !bitmask)
        } else {
            Ok(())
        }
    }

    pub(crate) fn write_register(&mut self, register: u8, data: u8) -> Result<(), Error<E>> {
        let payload: [u8; 2] = [register, data];
        self.i2c.write(ADDR, &payload).map_err(Error::I2C)
    }

    pub(crate) fn read_register(&mut self, register: u8) -> Result<u8, Error<E>> {
        let mut data = [0];
        self.i2c
            .write_read(ADDR, &[register], &mut data)
            .map_err(Error::I2C)
            .and(Ok(data[0]))
    }
}