Struct ds323x::Ds323x

pub struct Ds323x<DI, IC> { /* private fields */ }

DS3231, DS3232 and DS3234 RTC driver

Implementations

impl<DI, IC, E> Ds323x<DI, IC>where
    DI: ReadData<Error = E> + WriteData<Error = E>,

pub fn enable(&mut self) -> Result<(), Error<E>>

Enable the oscillator (set the clock running) (default).

pub fn disable(&mut self) -> Result<(), Error<E>>

Disable the oscillator (stops the clock).

pub fn convert_temperature(&mut self) -> Result<(), Error<E>>

Force a temperature conversion and time compensation with TXCO algorithm.

The busy status should be checked before doing this. See is_busy()

pub fn enable_32khz_output(&mut self) -> Result<(), Error<E>>

Enable the 32kHz output. (enabled per default)

pub fn disable_32khz_output(&mut self) -> Result<(), Error<E>>

Disable the 32kHz output.

pub fn set_aging_offset(&mut self, offset: i8) -> Result<(), Error<E>>

Set the aging offset.

pub fn get_aging_offset(&mut self) -> Result<i8, Error<E>>

Read the aging offset.

pub fn use_int_sqw_output_as_interrupt(&mut self) -> Result<(), Error<E>>

Set the interrupt/square-wave output to be used as interrupt output.

pub fn use_int_sqw_output_as_square_wave(&mut self) -> Result<(), Error<E>>

Set the interrupt/square-wave output to be used as square-wave output. (default)

pub fn enable_square_wave(&mut self) -> Result<(), Error<E>>

Enable battery-backed square wave generation.

pub fn disable_square_wave(&mut self) -> Result<(), Error<E>>

Disable battery-backed square wave generation.

pub fn set_square_wave_frequency(
    &mut self,
    freq: SqWFreq
) -> Result<(), Error<E>>

Set the square-wave output frequency.

pub fn enable_alarm1_interrupts(&mut self) -> Result<(), Error<E>>

Enable Alarm1 interrupts.

pub fn disable_alarm1_interrupts(&mut self) -> Result<(), Error<E>>

Disable Alarm1 interrupts.

pub fn enable_alarm2_interrupts(&mut self) -> Result<(), Error<E>>

Enable Alarm2 interrupts.

pub fn disable_alarm2_interrupts(&mut self) -> Result<(), Error<E>>

Disable Alarm2 interrupts.

impl<DI, IC, E> Ds323x<DI, IC>where
    DI: ReadData<Error = E> + WriteData<Error = E>,

pub fn is_running(&mut self) -> Result<bool, Error<E>>

Read whether the oscillator is running

pub fn is_busy(&mut self) -> Result<bool, Error<E>>

Read the busy status

pub fn has_been_stopped(&mut self) -> Result<bool, Error<E>>

Read whether the oscillator is stopped or has been stopped at some point.

This allows a better assessment of the validity of the timekeeping data.

Once this is true, it will stay as such until cleared with clear_has_been_stopped_flag()

pub fn clear_has_been_stopped_flag(&mut self) -> Result<(), Error<E>>

Clear flag signalling whether the oscillator is stopped or has been stopped at some point.

See also: has_been_stopped()

pub fn has_alarm1_matched(&mut self) -> Result<bool, Error<E>>

Read whether the Alarm1 has matched at some point.

Once this is true, it will stay as such until cleared with clear_alarm1_matched_flag()

pub fn clear_alarm1_matched_flag(&mut self) -> Result<(), Error<E>>

Clear flag signalling whether the Alarm1 has matched at some point.

See also: has_alarm1_matched()

pub fn has_alarm2_matched(&mut self) -> Result<bool, Error<E>>

Read whether the Alarm2 has matched at some point.

Once this is true, it will stay as such until cleared with clear_alarm2_matched_flag()

pub fn clear_alarm2_matched_flag(&mut self) -> Result<(), Error<E>>

Clear flag signalling whether the Alarm2 has matched at some point.

See also: has_alarm2_matched()

pub fn get_temperature(&mut self) -> Result<f32, Error<E>>

Read the temperature.

Note: It is possible to manually force a temperature conversion with convert_temperature()

impl<DI, IC, E> Ds323x<DI, IC>where
    DI: ReadData<Error = E> + WriteData<Error = E>,

pub fn set_alarm1_day(
    &mut self,
    when: DayAlarm1,
    matching: Alarm1Matching
) -> Result<(), Error<E>>

Set Alarm1 for day of the month.

Will return an Error::InvalidInputData if any of the parameters is out of range.

pub fn set_alarm1_weekday(
    &mut self,
    when: WeekdayAlarm1,
    matching: Alarm1Matching
) -> Result<(), Error<E>>

Set Alarm1 for weekday.

Will return an Error::InvalidInputData if any of the parameters is out of range.

pub fn set_alarm2_day(
    &mut self,
    when: DayAlarm2,
    matching: Alarm2Matching
) -> Result<(), Error<E>>

Set Alarm2 for date (day of month).

Will return an Error::InvalidInputData if any of the parameters is out of range.

pub fn set_alarm2_weekday(
    &mut self,
    when: WeekdayAlarm2,
    matching: Alarm2Matching
) -> Result<(), Error<E>>

Set Alarm2 for weekday.

Will return an Error::InvalidInputData if any of the parameters is out of range.

impl<DI, IC, E> Ds323x<DI, IC>where
    DI: ReadData<Error = E> + WriteData<Error = E>,

pub fn get_seconds(&mut self) -> Result<u8, Error<E>>

Read the seconds.

pub fn get_minutes(&mut self) -> Result<u8, Error<E>>

Read the minutes.

pub fn get_hours(&mut self) -> Result<Hours, Error<E>>

Read the hours.

pub fn get_weekday(&mut self) -> Result<u8, Error<E>>

Read the day of the week [1-7].

pub fn get_day(&mut self) -> Result<u8, Error<E>>

Read the day of the month [1-31].

pub fn get_month(&mut self) -> Result<u8, Error<E>>

Read the month [1-12].

pub fn get_year(&mut self) -> Result<u16, Error<E>>

Read the year [2000-2100].

pub fn get_datetime(&mut self) -> Result<DateTime, Error<E>>

Read the date and time.

pub fn set_seconds(&mut self, seconds: u8) -> Result<(), Error<E>>

Set the seconds [0-59].

Will return an Error::InvalidInputData if the seconds are out of range.

pub fn set_minutes(&mut self, minutes: u8) -> Result<(), Error<E>>

Set the minutes [0-59].

Will return an Error::InvalidInputData if the minutes are out of range.

pub fn set_hours(&mut self, hours: Hours) -> Result<(), Error<E>>

Set the hours.

Changes the operating mode to 12h/24h depending on the parameter.

Will return an Error::InvalidInputData if the hours are out of range.

pub fn set_weekday(&mut self, weekday: u8) -> Result<(), Error<E>>

Set the day of week [1-7].

Will return an Error::InvalidInputData if the day is out of range.

pub fn set_day(&mut self, day: u8) -> Result<(), Error<E>>

Set the day of month [1-31].

Will return an Error::InvalidInputData if the day is out of range.

pub fn set_month(&mut self, month: u8) -> Result<(), Error<E>>

Set the month [1-12].

Will return an Error::InvalidInputData if the month is out of range.

pub fn set_year(&mut self, year: u16) -> Result<(), Error<E>>

Set the year [2000-2100].

Will return an Error::InvalidInputData if the year is out of range.

pub fn set_datetime(&mut self, datetime: &DateTime) -> Result<(), Error<E>>

Set the date and time.

Will return an Error::InvalidInputData if any of the parameters is out of range.

impl<I2C, E> Ds323x<I2cInterface<I2C>, DS3231>where
    I2C: Write<Error = E> + WriteRead<Error = E>,

pub fn new_ds3231(i2c: I2C) -> Self

Create a new instance of the DS3231 device.

pub fn destroy_ds3231(self) -> I2C

Destroy driver instance, return I²C bus instance.

impl<I2C, E> Ds323x<I2cInterface<I2C>, DS3232>where
    I2C: Write<Error = E> + WriteRead<Error = E>,

pub fn new_ds3232(i2c: I2C) -> Self

Create a new instance of the DS3232 device.

pub fn destroy_ds3232(self) -> I2C

Destroy driver instance, return I²C bus instance.

pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>>

Enable the 32kHz output when battery-powered. (enabled per default)

Additionally, the 32kHz output needs to be enabled. See 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>>

Disable the 32kHz output when battery-powered.

The 32kHz output will still generate a wave when not battery-powered if it enabled. See enable_32khz_output().

Note: This is only available for DS3232 and DS3234 devices.

pub fn set_temperature_conversion_rate(
    &mut self,
    rate: TempConvRate
) -> Result<(), Error<E>>

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.

impl<SPI, CS, E> Ds323x<SpiInterface<SPI, CS>, DS3234>where
    SPI: Transfer<u8, Error = E> + Write<u8, Error = E>,
    CS: OutputPin,

pub fn new_ds3234(spi: SPI, chip_select: CS) -> Self

Create a new instance.

pub fn destroy_ds3234(self) -> (SPI, CS)

Destroy driver instance, return SPI bus instance and CS output pin.

pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>>

Enable the 32kHz output when battery-powered. (enabled per default)

Additionally, the 32kHz output needs to be enabled. See 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>>

Disable the 32kHz output when battery-powered.

The 32kHz output will still generate a wave when not battery-powered if it enabled. See enable_32khz_output().

Note: This is only available for DS3232 and DS3234 devices.

pub fn set_temperature_conversion_rate(
    &mut self,
    rate: TempConvRate
) -> Result<(), Error<E>>

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.

pub fn enable_temperature_conversions_on_battery(
    &mut self
) -> Result<(), Error<E>>

Enable the temperature conversions when battery-powered. (enabled per default)

Note: This is only available for DS3234 devices.

pub fn disable_temperature_conversions_on_battery(
    &mut self
) -> Result<(), Error<E>>

Disable the temperature conversions when battery-powered.

Note: This is only available for DS3234 devices.

Trait Implementations

impl<DI: Debug, IC: Debug> Debug for Ds323x<DI, IC>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<DI: Default, IC: Default> Default for Ds323x<DI, IC>

fn default() -> Ds323x<DI, IC>

Returns the “default value” for a type.