From 2b86ac70d2637257089cb8f84ae700e9a4ad4d98 Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Mon, 29 Oct 2018 18:48:07 +0100 Subject: [PATCH] Update driver capabilities --- README.md | 7 +++++++ src/lib.rs | 24 +++++++++++++++++++++--- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 774d85f..db252fc 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,13 @@ This driver allows you to: - Read and set date and time in 12-hour and 24-hour format. See: `get_datetime`. - Read and set date and time elements. For example, see: `get_year`. - Enable and disable the real-time clock. See: `enable`. +- Read the temperature. See `get_temperature`. +- Force a temperature conversion and time compensation. See `convert_temperature`. +- Read the busy status. See `is_busy`. +- Read whether the oscillator is or has been stopped. See `has_been_stopped`. +- Clear the has-been-stopped flag. See `clear_has_been_stopped_flag`. +- Enable/disable the 32kHz output. See `enable_32khz_output`. +- Set the aging offset. See `set_aging_offset`. ## The devices diff --git a/src/lib.rs b/src/lib.rs index 940cd88..8b41fb1 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,9 +4,27 @@ //! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal //! //! This driver allows you to: -//! - Read and set date and time in 12-hour and 24-hour format. See: `get_datetime`. -//! - Read and set date and time elements. For example, see: `get_year`. -//! - Enable and disable the real-time clock. See: `enable`. +//! - Read and set date and time in 12-hour and 24-hour format. See: [`get_datetime`]. +//! - Read and set date and time elements. For example, see: [`get_year`]. +//! - Enable and disable the real-time clock. See: [`enable`]. +//! - Read the temperature. See [`get_temperature`]. +//! - Force a temperature conversion and time compensation. See [`convert_temperature`]. +//! - Read the busy status. See [`is_busy`]. +//! - Read whether the oscillator is or has been stopped. See [`has_been_stopped`]. +//! - Clear the has-been-stopped flag. See [`clear_has_been_stopped_flag`]. +//! - Enable/disable the 32kHz output. See [`enable_32khz_output`]. +//! - Set the aging offset. See [`set_aging_offset`]. +//! +//! [`get_datetime`]: struct.Ds323x.html#method.get_datetime +//! [`get_year`]: struct.Ds323x.html#method.get_year +//! [`enable`]: struct.Ds323x.html#method.enable +//! [`get_temperature`]: struct.Ds323x.html#method.get_temperature +//! [`convert_temperature`]: struct.Ds323x.html#method.convert_temperature +//! [`is_busy`]: struct.Ds323x.html#method.is_busy +//! [`has_been_stopped`]: struct.Ds323x.html#method.has_been_stopped +//! [`clear_has_been_stopped_flag`]: struct.Ds323x.html#method.clear_has_been_stopped_flag +//! [`enable_32khz_output`]: struct.Ds323x.html#method.enable_32khz_output +//! [`set_aging_offset`]: struct.Ds323x.html#method.set_aging_offset //! //! ## The devices //!