ds323x-rs/src/ds3232.rs

71 lines
2.7 KiB
Rust
Raw Permalink Normal View History

//! Functions exclusive of DS3232
2020-07-10 20:24:29 +00:00
use crate::{
ic, interface::I2cInterface, BitFlags, Ds323x, Error, TempConvRate, CONTROL_POR_VALUE,
};
use core::marker::PhantomData;
2020-07-10 20:24:29 +00:00
use embedded_hal::blocking::i2c;
impl<I2C, E> Ds323x<I2cInterface<I2C>, ic::DS3232>
where
2020-07-10 20:24:29 +00:00
I2C: i2c::Write<Error = E> + i2c::WriteRead<Error = E>,
{
/// Create a new instance of the DS3232 device.
pub fn new_ds3232(i2c: I2C) -> Self {
2019-05-16 17:18:07 +00:00
const STATUS_POR_VALUE: u8 = BitFlags::OSC_STOP | BitFlags::BB32KHZ | BitFlags::EN32KHZ;
Ds323x {
2019-05-16 17:18:07 +00:00
iface: I2cInterface { i2c },
control: CONTROL_POR_VALUE,
status: STATUS_POR_VALUE,
2019-05-16 17:18:07 +00:00
_ic: PhantomData,
}
}
/// Destroy driver instance, return I²C bus instance.
pub fn destroy_ds3232(self) -> I2C {
self.iface.i2c
}
2018-10-31 10:07:15 +00:00
/// Enable the 32kHz output when battery-powered. (enabled per default)
///
/// Additionally, the 32kHz output needs to be enabled. See
2018-10-31 10:17:31 +00:00
/// [`enable_32khz_output()`](#method.enable_32khz_output).
///
/// Note: This is only available for DS3232 and DS3234 devices.
pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E, ()>> {
let status = self.status | BitFlags::BB32KHZ;
self.write_status_without_clearing_alarm(status)
}
/// Disable the 32kHz output when battery-powered.
///
/// The 32kHz output will still generate a wave when not battery-powered if
2018-10-31 10:17:31 +00:00
/// it enabled. See [`enable_32khz_output()`](#method.enable_32khz_output).
///
/// Note: This is only available for DS3232 and DS3234 devices.
pub fn disable_32khz_output_on_battery(&mut self) -> Result<(), Error<E, ()>> {
let status = self.status & !BitFlags::BB32KHZ;
self.write_status_without_clearing_alarm(status)
}
/// Set the temperature conversion rate.
///
/// Set how often the temperature is measured and applies compensation to
/// the oscillator. This can be used to reduce power consumption but sudden
/// temperature changes will not be compensated for.
///
/// Note: This is only available for DS3232 and DS3234 devices.
2019-05-16 17:18:07 +00:00
pub fn set_temperature_conversion_rate(
&mut self,
rate: TempConvRate,
) -> Result<(), Error<E, ()>> {
2020-05-02 10:17:49 +00:00
let status = match rate {
TempConvRate::_64s => self.status & !BitFlags::CRATE1 & !BitFlags::CRATE0,
TempConvRate::_128s => self.status & !BitFlags::CRATE1 | BitFlags::CRATE0,
TempConvRate::_256s => self.status | BitFlags::CRATE1 & !BitFlags::CRATE0,
TempConvRate::_512s => self.status | BitFlags::CRATE1 | BitFlags::CRATE0,
};
self.write_status_without_clearing_alarm(status)
}
}