Struct ds1307::Ds1307

pub struct Ds1307<I2C> { /* fields omitted */ }

DS1307 driver

Methods

impl<I2C, E> Ds1307<I2C> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

pub fn read_ram(
    &mut self,
    address_offset: u8,
    data: &mut [u8]
) -> Result<(), Error<E>>

Read a data array from the user RAM starting at the given offset.

There is a total of 56 bytes of user RAM available so the valid ranges for the parameters are: address_offset: [0-55] and data array length: [0-56].

Will return an Error::InvalidInputData if attempting to access a position not available or if attempting to read too much data.

pub fn write_ram(
    &mut self,
    address_offset: u8,
    data: &[u8]
) -> Result<(), Error<E>>

Write a data array to the user RAM starting at the given offset.

There is a total of 56 bytes of user RAM available so the valid ranges for the parameters are: address_offset: [0-55] and data array length: [0-56].

Will return an Error::InvalidInputData if attempting to access a position not available or if attempting to write too much data.

impl<I2C, E> Ds1307<I2C> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

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

Read if the clock is running.

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

Set the clock to run (default on power-on). (Does not alter the device register if already running).

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

Halt the clock. (Does not alter the device register if already halted).

impl<I2C, E> Ds1307<I2C> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

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

Read whether the square-wave output is enabled.

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

Enable the square-wave output. (Does not alter the device register if already enabled).

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

Disable the square-wave output. (Does not alter the device register if already disabled).

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

Read status of square-wave output level control bit.

pub fn set_square_wave_output_level(
    &mut self,
    level: SqwOutLevel
) -> Result<(), Error<E>>

Set square-wave output level. (Does not alter the device register if same level is already configured).

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

Read square-wave output rate control bits.

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

Set square-wave output rate.

impl<I2C, E> Ds1307<I2C> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

pub fn new(i2c: I2C) -> Self

Create a new instance.

pub fn destroy(self) -> I2C

Destroy driver instance, return I²C bus instance.

Trait Implementations

impl<I2C: Debug> Debug for Ds1307<I2C>

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

Formats the value using the given formatter.

impl<I2C: Default> Default for Ds1307<I2C>

fn default() -> Ds1307<I2C>

Returns the "default value" for a type.

impl<I2C, E> Rtcc for Ds1307<I2C> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

type Error = Error<E>

Error type

fn get_seconds(&mut self) -> Result<u8, Self::Error>

Read the seconds.

fn get_minutes(&mut self) -> Result<u8, Self::Error>

Read the minutes.

fn get_hours(&mut self) -> Result<Hours, Self::Error>

Read the hours.

fn get_weekday(&mut self) -> Result<u8, Self::Error>

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

fn get_day(&mut self) -> Result<u8, Self::Error>

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

fn get_month(&mut self) -> Result<u8, Self::Error>

Read the month [1-12].

fn get_year(&mut self) -> Result<u16, Self::Error>

Read the year (e.g. 2000).

fn get_date(&mut self) -> Result<NaiveDate, Self::Error>

Read the date.

fn get_time(&mut self) -> Result<NaiveTime, Self::Error>

Read the time.

fn get_datetime(&mut self) -> Result<NaiveDateTime, Self::Error>

Read the date and time.

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

Set the seconds [0-59].

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

Set the minutes [0-59].

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

Set the hours.

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

Set the day of week [1-7].

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

Set the day of month [1-31].

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

Set the month [1-12].

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

Set the year. (e.g. 2000)

fn set_date(&mut self, date: &NaiveDate) -> Result<(), Self::Error>

Set the date.

fn set_time(&mut self, time: &NaiveTime) -> Result<(), Self::Error>

Set the time.

fn set_datetime(&mut self, datetime: &NaiveDateTime) -> Result<(), Self::Error>

Set the date and time.