Crate ds1307

This is a platform agnostic Rust driver for the DS1307 real-time clock, based on the embedded-hal traits.

This driver allows you to:

• Read and set date and time in 12-hour and 24-hour format. See: datetime().
• Enable and disable the real-time clock. See: set_running().
• Read and write user RAM. See: read_ram().
• Control square-wave output. See: enable_square_wave_output().

The device

The DS1307 serial real-time clock (RTC) is a low-power, full binary-coded decimal (BCD) clock/calendar plus 56 bytes of NV SRAM. Address and data are transferred serially through an I2C, bidirectional bus.

The clock/calendar provides seconds, minutes, hours, day, date, month, and year information. The end of the month date is automatically adjusted for months with fewer than 31 days, including corrections for leap year. The clock operates in either the 24-hour or 12-hour format with AM/PM indicator.

The DS1307 has a built-in power-sense circuit that detects power failures and automatically switches to the backup supply. Timekeeping operation continues while the part operates from the backup supply.

Datasheet: DS1307

Usage examples (see also examples folder)

Please find additional examples using hardware in this repository: driver-examples

Set and get the current date and time all at once

Calling the datetime/ set_datetime methods is recommended to avoid inconsistencies when reading date/time parts and combining them as time passes.

use linux_embedded_hal as hal;
use ds1307::{Ds1307, NaiveDate, DateTimeAccess};

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);
let datetime = NaiveDate::from_ymd(2020, 5, 2).and_hms(19, 59, 58);
rtc.set_datetime(&datetime).unwrap();
// ...
let datetime = rtc.datetime().unwrap();
println!("{}", datetime);
// This will print something like: 2020-05-02 19:59:58

Get the year

Similar methods exist for month, day, weekday, hours, minutes and seconds.

Calling the datetime/ set_datetime methods instead of these is recommended to avoid inconsistencies when reading date/time parts and combining them as time passes.

use linux_embedded_hal as hal;
use ds1307::{Ds1307, Rtcc};

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);
let year = rtc.year().unwrap();
println!("Year: {}", year);

Set the year

Similar methods exist for month, day, weekday, hours, minutes and seconds.

Calling the datetime/ set_datetime methods instead of these is recommended to avoid inconsistencies when reading date/time parts and combining them as time passes.

use linux_embedded_hal as hal;
use ds1307::{Ds1307, Rtcc};

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);
rtc.set_year(2018).unwrap();

Get the current date

Similar methods exist for setting the date and for setting getting the time.

use linux_embedded_hal as hal;
use ds1307::{Ds1307, Rtcc};

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);
let date = rtc.date().unwrap();
println!("{}", date);

Read and write user RAM

use linux_embedded_hal as hal;
use ds1307::Ds1307;

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);

let data = [171; 3];
rtc.write_ram(2, &data).unwrap();

let mut data = [0; 3];
rtc.read_ram(2, &mut data).unwrap();

println!("{}, {}, {}", data[0], data[1], data[2]);
// This will print: 171, 171, 171

Enable square-wave output and select rate

use linux_embedded_hal as hal;
use ds1307::{Ds1307, SqwOutRate};

let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut rtc = Ds1307::new(dev);

rtc.enable_square_wave_output().unwrap();
let rate = SqwOutRate::Khz32_768;
rtc.set_square_wave_output_rate(rate).unwrap();

Structs

Ds1307

DS1307 driver

NaiveDate

ISO 8601 calendar date without timezone. Allows for every proleptic Gregorian date from Jan 1, 262145 BCE to Dec 31, 262143 CE. Also supports the conversion from ISO 8601 ordinal and week date.

NaiveDateTime

ISO 8601 combined date and time without timezone.

NaiveTime

ISO 8601 time without timezone. Allows for the nanosecond precision and optional leap second representation.

Enums

Error

All possible errors in this crate

Hours

Hours in either 12-hour (AM/PM) or 24-hour format

SqwOutLevel

Square-wave output level

SqwOutRate

Square-wave output rate

Traits

DateTimeAccess

Real-Time Clock / Calendar DateTimeAccess trait to read/write a complete date/time.

Datelike

The common set of methods for date component.

Rtcc

Real-Time Clock / Calendar trait

Timelike

The common set of methods for time component.