Kevin Braun / ds3232m

Library for Maxim DS3232M super-accurate, I2C based Real Time Clock chip with 234 bytes of user RAM. Library includes user RAM read/write operations along with CRC routines for accessing the user RAM area.

Dependents:   ds3232m_HelloWorld

Diff: ds3232m.h

Revision:
1:0975d4a9b513
Parent:
0:30a7faf58768
Child:
2:a9a8027a7cb2
--- a/ds3232m.h	Mon Dec 08 20:15:16 2014 +0000
+++ b/ds3232m.h	Fri Dec 19 20:22:13 2014 +0000
@@ -10,7 +10,16 @@
 
 /** Class ds3232m implements the real time clock
  *
+ * The following definition is required if RTOS is used. It
+ * locks the I2C bus while I2C accesses are utilized
+ * for the DS3232.
  *
+ * contained in main.cpp:
+ * @code
+ *
+ * Mutex MutexI2C0;              //lock/unlock I2C requests
+ *
+ * @endcode
  *
  */