kirbylife
/
ds323x-rs
mirror of https://github.com/eldruin/ds323x-rs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update driver capabilities

pull/4/head
Diego Barrios Romero 2018-10-29 18:48:07 +01:00
parent b01c258e60
commit 2b86ac70d2
2 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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 in 12-hour and 24-hour format. See: `get_datetime`.
- Read and set date and time elements. For example, see: `get_year`. - Read and set date and time elements. For example, see: `get_year`.
- Enable and disable the real-time clock. See: `enable`. - 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 ## The devices

24
src/lib.rs
View File

@ -4,9 +4,27 @@
//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal //! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
//! //!
//! This driver allows you to: //! 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 in 12-hour and 24-hour format. See: [`get_datetime`].
//! - Read and set date and time elements. For example, see: `get_year`. //! - Read and set date and time elements. For example, see: [`get_year`].
//! - Enable and disable the real-time clock. See: `enable`. //! - 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 //! ## The devices
//! //!