Docs - thanks to @rtek1000

Author: Naguissa

contributors.txt

@@ -17,6 +17,8 @@ pk17r - https://github.com/pk17r - EOSC flag, improvements, DoW correction, docu
 pk17r - https://github.com/pk17r - Yes, again. 12/24h, improvements and bugfixes ( #27 ): PR #35
 Ben Wheeler - https://github.com/BenUniqcode - Add error check to refresh function. Now this function returns bool value, false on errors: PR #36
 Ben Wheeler - https://github.com/BenUniqcode - Access to last one byte of RTCs RAM : PR #37
+rtek1000 - https://github.com/rtek1000 - Fix doc typo - Issue #40
+rtek1000 - https://github.com/rtek1000 - I2C unlock procedure and PIC implementation - Issue #42
 
 
 

library.properties

@@ -1,5 +1,5 @@
 name=uRTCLib
-version=6.9.1
+version=6.9.2
 author=Naguissa <naguissa@foroelectro.net>
 maintainer=Naguissa <naguissa@foroelectro.net>
 sentence=Really tiny library to basic RTC functionality on Arduino. DS1307, DS3231 and DS3232 RTCs are supported. See https://github.com/Naguissa/uEEPROMLib for EEPROM support. Temperature, Alarms, SQWG, Power lost and RAM support.

src/uRTCLib.cpp

@@ -17,14 +17,20 @@
  * Note: For AtTiny you need TinyWireM library from Adafruit installed (available on library manager).
  *
  *
+ * I2C locked in unknown state
+ *
+ * If uC crashes and I2C communication is locked in a unknown state you have a procedure to unlock it.
+ * It's not implemented in this library but you can find an explanation and a PIC implementation thanks
+ * to @rtek1000 in #42 : https://github.com/Naguissa/uRTCLib/issues/42
+ *
  * @file uRTCLib.cpp
  * @copyright Naguissa
  * @author Naguissa
  * @see <a href="https://github.com/Naguissa/uRTCLib">https://github.com/Naguissa/uRTCLib</a>
  * @see <a href="https://www.foroelectro.net/librerias-arduino-ide-f29/rtclib-arduino-libreria-simple-y-eficaz-para-rtc-y-t95.html">https://www.foroelectro.net/librerias-arduino-ide-f29/rtclib-arduino-libreria-simple-y-eficaz-para-rtc-y-t95.html</a>
  * @see <a href="mailto:naguissa@foroelectro.net">naguissa@foroelectro.net</a>
  * @see <a href="https://github.com/Naguissa/uEEPROMLib">See uEEPROMLib for EEPROM support.</a>
- * @version 6.9.1
+ * @version 6.9.2
  */
 
 #include <Arduino.h>
@@ -341,7 +347,7 @@ bool uRTCLib::lostPower() {
 /**
  * \brief Clears lost power VBAT staus
  *
- * DS1307 has a 'CH' Clock Halt Bit in Register 00h ->  When cleared to 0, the oscillator is enabled and time starts incermenting
+ * DS1307 has a 'CH' Clock Halt Bit in Register 00h ->  When cleared to 0, the oscillator is enabled and the time starts to increase
  *
  * Others have a 'OSF' Oscillator Stop Flag in Register 0Fh
  */

src/uRTCLib.h

@@ -17,11 +17,18 @@
  * Note: For AtTiny you need TinyWireM library from Adafruit installed (available on library manager).
  *
  *
+ * I2C locked in unknown state
+ *
+ * If uC crashes and I2C communication is locked in a unknown state you have a procedure to unlock it.
+ * It's not implemented in this library but you can find an explanation and a PIC implementation thanks
+ * to @rtek1000 in #42 : https://github.com/Naguissa/uRTCLib/issues/42
+ *
+ *
  * @see <a href="https://github.com/Naguissa/uRTCLib">https://github.com/Naguissa/uRTCLib</a>
  * @see <a href="https://www.foroelectro.net/librerias-arduino-ide-f29/rtclib-arduino-libreria-simple-y-eficaz-para-rtc-y-t95.html">https://www.foroelectro.net/librerias-arduino-ide-f29/rtclib-arduino-libreria-simple-y-eficaz-para-rtc-y-t95.html</a>
  * @see <a href="mailto:naguissa@foroelectro.net">naguissa@foroelectro.net</a>
  * @see <a href="https://github.com/Naguissa/uEEPROMLib">See uEEPROMLib for EEPROM support.</a>
- * @version 6.9.1
+ * @version 6.9.2
  */
 /** \file uRTCLib.h
  *   \brief uRTCLib header file