From 05368a36c9df91bcc24e77232b68528e24bd011b Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Mon, 29 Oct 2018 18:51:36 +0100 Subject: [PATCH] Add some usage examples --- src/lib.rs | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 8b41fb1..eeea93b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -272,7 +272,48 @@ //! rtc.enable().unwrap(); // set clock to run //! # } //! ``` - +//! +//! ### Read the temperature +//! +//! ```no_run +//! extern crate linux_embedded_hal as hal; +//! extern crate ds323x; +//! use ds323x::Ds323x; +//! +//! # fn main() { +//! let dev = hal::I2cdev::new("/dev/i2c-1").unwrap(); +//! let mut rtc = Ds323x::new_ds3231(dev); +//! let temperature = rtc.get_temperature().unwrap(); +//! # } +//! ``` +//! +//! ### Read busy status +//! +//! ```no_run +//! extern crate linux_embedded_hal as hal; +//! extern crate ds323x; +//! use ds323x::Ds323x; +//! +//! # fn main() { +//! let dev = hal::I2cdev::new("/dev/i2c-1").unwrap(); +//! let mut rtc = Ds323x::new_ds3231(dev); +//! let is_busy = rtc.is_busy().unwrap(); +//! # } +//! ``` +//! +//! ### Set the aging offset +//! +//! ```no_run +//! extern crate linux_embedded_hal as hal; +//! extern crate ds323x; +//! use ds323x::Ds323x; +//! +//! # fn main() { +//! let dev = hal::I2cdev::new("/dev/i2c-1").unwrap(); +//! let mut rtc = Ds323x::new_ds3231(dev); +//! rtc.set_aging_offset(-15).unwrap(); +//! # } +//! ``` #![deny(unsafe_code)] #![deny(missing_docs)]