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

Update docs

pull/9/head
Diego Barrios Romero 2022-02-20 10:19:50 +01:00
parent 774b3cf527
commit 92e6de6c47
1 changed files with 11 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/lib.rs
View File

@ -56,16 +56,18 @@
//! This driver is compatible with the DS3231 and DS3232 I2C devices and the //! This driver is compatible with the DS3231 and DS3232 I2C devices and the
//! DS3234 SPI device. //! DS3234 SPI device.
//! //!
//! ### DS3231 //! These devices are low-cost temperature-compensated crystal oscillator (TCXO)
//! The DS3231 is a low-cost, extremely accurate I2C real-time clock (RTC) with //! with a very accurate, temperature-compensated, integrated real-time clock
//! an integrated temperature-compensated crystal oscillator (TCXO) and crystal. //! (RTC) including 236/256 bytes of battery-backed SRAM, depending on the model.
//! //!
//! The device incorporates a battery input, and maintains accurate timekeeping //! ### DS3231 and DS3232 details
//! when main power to the device is interrupted. The integration of the //!
//! crystal resonator enhances the long-term accuracy of the device as well as //! The devices incorporate a battery input, and maintain accurate timekeeping
//! when main power to the devices is interrupted. The integration of the
//! crystal resonator enhances the long-term accuracy of the devices as well as
//! reduces the piece-part count in a manufacturing line. //! reduces the piece-part count in a manufacturing line.
//! The DS3231 is available in commercial and industrial temperature ranges, //! The devices are available in commercial and industrial temperature ranges,
//! and is offered in a 16-pin, 300-mil SO package. //! and are offered in a 16-pin, 300-mil SO package.
//! //!
//! The RTC maintains seconds, minutes, hours, day, date, month, and year //! The RTC maintains seconds, minutes, hours, day, date, month, and year
//! information. The date at the end of the month is automatically adjusted for //! information. The date at the end of the month is automatically adjusted for
@ -81,36 +83,7 @@
//! necessary. Additionally, the RST pin is monitored as a pushbutton //! necessary. Additionally, the RST pin is monitored as a pushbutton
//! input for generating a μP reset. //! input for generating a μP reset.
//! //!
//! ### DS3232 //! ### DS3234 details
//! The DS3232 is a low-cost temperature-compensated crystal oscillator (TCXO)
//! with a very accurate, temperature-compensated, integrated real-time clock
//! (RTC) and 236 bytes of battery-backed SRAM.
//!
//! Additionally, the DS3232 incorporates a battery input and maintains
//! accurate timekeeping when main power to the device is interrupted. The
//! integration of the crystal resonator enhances the long-term accuracy of the
//! device as well as reduces the piece-part count in a manufacturing line.
//! The DS3232 is available in commercial and industrial temperature ranges,
//! and is offered in an industry-standard 20-pin, 300-mil SO package.
//!
//! The RTC maintains seconds, minutes, hours, day, date, month, and year
//! information. The date at the end of the month 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 an AM/PM
//! indicator. Two programmable time-of-day alarms and a programmable
//! square-wave output are provided. Address and data are transferred serially
//! through an I2C bidirectional bus.
//!
//! A precision temperature-compensated voltage reference and comparator
//! circuit monitors the status of VCC to detect power failures, to provide a
//! reset output, and to automatically switch to the backup supply when
//! necessary. Additionally, the RST pin is monitored as a pushbutton input for
//! generating a μP reset.
//!
//! ### DS3234
//! The DS3234 is a low-cost, extremely accurate SPI bus real-time clock (RTC)
//! with an integrated temperature-compensated crystal oscillator (TCXO) and
//! crystal.
//! //!
//! The DS3234 incorporates a precision, temperature-compensated voltage //! The DS3234 incorporates a precision, temperature-compensated voltage
//! reference and comparator circuit to monitor VCC. When VCC drops below the //! reference and comparator circuit to monitor VCC. When VCC drops below the