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

Fix links

pull/4/head
Diego Barrios Romero 2018-10-31 11:17:31 +01:00
parent 10ac7e4b7c
commit 34f74f7c60
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/ds3232.rs
View File

@ -32,7 +32,7 @@ where
/// Enable the 32kHz output when battery-powered. (enabled per default) /// Enable the 32kHz output when battery-powered. (enabled per default)
/// ///
/// Additionally, the 32kHz output needs to be enabled. See /// Additionally, the 32kHz output needs to be enabled. See
/// [`enable_32khz_output`](#method.enable_32khz_output). /// [`enable_32khz_output()`](#method.enable_32khz_output).
/// ///
/// Note: This is only available for DS3232 and DS3234 devices. /// Note: This is only available for DS3232 and DS3234 devices.
pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> { pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> {
@ -43,7 +43,7 @@ where
/// Disable the 32kHz output when battery-powered. /// Disable the 32kHz output when battery-powered.
/// ///
/// The 32kHz output will still generate a wave when not battery-powered if /// The 32kHz output will still generate a wave when not battery-powered if
/// it enabled. See [`enable_32khz_output`](#method.enable_32khz_output). /// it enabled. See [`enable_32khz_output()`](#method.enable_32khz_output).
/// ///
/// Note: This is only available for DS3232 and DS3234 devices. /// Note: This is only available for DS3232 and DS3234 devices.
pub fn disable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> { pub fn disable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> {

4
src/ds3234.rs
View File

@ -33,7 +33,7 @@ where
/// Enable the 32kHz output when battery-powered. (enabled per default) /// Enable the 32kHz output when battery-powered. (enabled per default)
/// ///
/// Additionally, the 32kHz output needs to be enabled. See /// Additionally, the 32kHz output needs to be enabled. See
/// [`enable_32khz_output`](#method.enable_32khz_output). /// [`enable_32khz_output()`](#method.enable_32khz_output).
/// ///
/// Note: This is only available for DS3232 and DS3234 devices. /// Note: This is only available for DS3232 and DS3234 devices.
pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> { pub fn enable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> {
@ -44,7 +44,7 @@ where
/// Disable the 32kHz output when battery-powered. /// Disable the 32kHz output when battery-powered.
/// ///
/// The 32kHz output will still generate a wave when not battery-powered if /// The 32kHz output will still generate a wave when not battery-powered if
/// it enabled. See [`enable_32khz_output`](#method.enable_32khz_output). /// it enabled. See [`enable_32khz_output()`](#method.enable_32khz_output).
/// ///
/// Note: This is only available for DS3232 and DS3234 devices. /// Note: This is only available for DS3232 and DS3234 devices.
pub fn disable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> { pub fn disable_32khz_output_on_battery(&mut self) -> Result<(), Error<E>> {

2
src/ds323x/status.rs
View File

@ -26,7 +26,7 @@ where
/// This allows a better assessment of the validity of the timekeeping data. /// This allows a better assessment of the validity of the timekeeping data.
/// ///
/// Once this is true, it will stay as such until cleared with /// Once this is true, it will stay as such until cleared with
/// [`clear_has_been_stopped_flag`](#method.clear_has_been_stopped_flag) /// [`clear_has_been_stopped_flag()`](#method.clear_has_been_stopped_flag)
pub fn has_been_stopped(&mut self) -> Result<bool, Error<E>> { pub fn has_been_stopped(&mut self) -> Result<bool, Error<E>> {
let status = self.iface.read_register(Register::STATUS)?; let status = self.iface.read_register(Register::STATUS)?;
Ok((status & BitFlags::OSC_STOP) != 0) Ok((status & BitFlags::OSC_STOP) != 0)

12
src/lib.rs
View File

@ -31,12 +31,12 @@
//! [`clear_has_been_stopped_flag`]: struct.Ds323x.html#method.clear_has_been_stopped_flag //! [`clear_has_been_stopped_flag`]: struct.Ds323x.html#method.clear_has_been_stopped_flag
//! [`set_aging_offset`]: struct.Ds323x.html#method.set_aging_offset //! [`set_aging_offset`]: struct.Ds323x.html#method.set_aging_offset
//! [`enable_32khz_output`]: struct.Ds323x.html#method.enable_32khz_output //! [`enable_32khz_output`]: struct.Ds323x.html#method.enable_32khz_output
//! [`use_int_sqw_output_as_interrupt`]: Struct.Ds323x.html#method.use_int_sqw_output_as_interrupt //! [`use_int_sqw_output_as_interrupt`]: struct.Ds323x.html#method.use_int_sqw_output_as_interrupt
//! [`enable_square_wave`]: Struct.Ds323x.html#method.enable_square_wave //! [`enable_square_wave`]: struct.Ds323x.html#method.enable_square_wave
//! [`set_square_wave_frequency`]: Struct.Ds323x.html#method.set_square_wave_frequency //! [`set_square_wave_frequency`]: struct.Ds323x.html#method.set_square_wave_frequency
//! [`enable_32khz_output_on_battery`]: Struct.Ds323x.html#method.enable_32khz_output_on_battery //! [`enable_32khz_output_on_battery`]: struct.Ds323x.html#method.enable_32khz_output_on_battery
//! [`set_temperature_conversion_rate`]: Struct.Ds323x.html#method.set_temperature_conversion_rate //! [`set_temperature_conversion_rate`]: struct.Ds323x.html#method.set_temperature_conversion_rate
//! [`enable_temperature_conversions_on_battery`]: Struct.Ds323x.html#method.enable_temperature_conversions_on_battery //! [`enable_temperature_conversions_on_battery`]: struct.Ds323x.html#method.enable_temperature_conversions_on_battery
//! //!
//! ## The devices //! ## The devices
//! //!