Karl Zweimüller
Library for Real Time Clock module MCP97410 based on Library for DS1307
Fork of
RTC-DS1307
by 
Henry Leinen
Diff: Rtc_Mcp97410.h
- Revision:
- 11:ef48dcb888c9
- Parent:
- 10:780027029afe
- Child:
- 12:88f82e47b6a1
--- a/Rtc_Mcp97410.h Wed Jan 07 21:46:02 2015 +0000
+++ b/Rtc_Mcp97410.h Fri Jan 16 20:44:51 2015 +0000
@@ -30,6 +30,78 @@
#define __RTC_MCP97410_H__
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// GLOBAL CONSTANTS RTCC - ADDRESSES
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#define ADDR_EEPROM 0xaf // DEVICE ADDR for EEPROM
+#define ADDR_RTCC 0xdf // DEVICE ADDR for RTCC MCHP
+//.................................................................................
+#define SRAM_PTR 0x20 // pointer of the SRAM area (RTCC)
+#define ADDR_EEPROM_SR 0xff // STATUS REGISTER in the EEPROM
+//.................................................................................
+#define ADDR_SEC 0x00 // address of SECONDS register
+#define ADDR_MIN 0x01 // address of MINUTES register
+#define ADDR_HOUR 0x02 // address of HOURS register
+#define ADDR_DAY 0x03 // address of DAY OF WK register
+#define ADDR_STAT 0x03 // address of STATUS register
+#define ADDR_DATE 0x04 // address of DATE register
+#define ADDR_MNTH 0x05 // address of MONTH register
+#define ADDR_YEAR 0x06 // address of YEAR register
+#define ADDR_CTRL 0x07 // address of CONTROL register
+#define ADDR_CAL 0x08 // address of CALIB register
+#define ADDR_ULID 0x09 // address of UNLOCK ID register
+//.................................................................................
+#define ADDR_ALM0SEC 0x0a // address of ALARMO SEC register
+#define ADDR_ALM0MIN 0x0b // address of ALARMO MIN register
+#define ADDR_ALM0HR 0x0c // address of ALARMO HOUR register
+#define ADDR_ALM0CTL 0x0d // address of ALARM0 CONTR register
+#define ADDR_ALM0DAT 0x0e // address of ALARMO DATE register
+#define ADDR_ALM0MTH 0x0f // address of ALARMO MONTH register
+//.................................................................................
+#define ADDR_ALM1SEC 0x11 // address of ALARM1 SEC register
+#define ADDR_ALM1MIN 0x12 // address of ALARM1 MIN register
+#define ADDR_ALM1HR 0x13 // address of ALARM1 HOUR register
+#define ADDR_ALM1CTL 0x14 // address of ALARM1 CONTR register
+#define ADDR_ALM1DAT 0x15 // address of ALARM1 DATE register
+#define ADDR_ALM1MTH 0x16 // address of ALARM1 MONTH register
+//.................................................................................
+#define ADDR_SAVtoBAT_MIN 0x18 // address of T_SAVER MIN(VDD->BAT)
+#define ADDR_SAVtoBAT_HR 0x19 // address of T_SAVER HR (VDD->BAT)
+#define ADDR_SAVtoBAT_DAT 0x1a // address of T_SAVER DAT(VDD->BAT)
+#define ADDR_SAVtoBAT_MTH 0x1b // address of T_SAVER MTH(VDD->BAT)
+//..................................................................................
+#define ADDR_SAVtoVDD_MIN 0x1c // address of T_SAVER MIN(BAT->VDD)
+#define ADDR_SAVtoVDD_HR 0x1d // address of T_SAVER HR (BAT->VDD)
+#define ADDR_SAVtoVDD_DAT 0x1e // address of T_SAVER DAT(BAT->VDD)
+#define ADDR_SAVtoVDD_MTH 0x1f // address of T_SAVER MTH(BAT->VDD)
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// GLOBAL CONSTANTS RTCC - INITIALIZATION
+//..................................................................................
+#define START_32KHZ 0x80 // start crystal: ST = b7 (ADDR_SEC)
+#define LP 0x20 // mask for the leap year bit(MONTH REG)
+#define HOUR_12 0x40 // 12 hours format (ADDR_HOUR)
+#define PM 0x20 // post-meridian bit (ADDR_HOUR)
+#define OUT_PIN 0x80 // = b7 (ADDR_CTRL)
+#define SQWE 0x40 // SQWE = b6 (ADDR_CTRL)
+#define ALM_NO 0x00 // no alarm activated (ADDR_CTRL)
+#define ALM_0 0x10 // ALARM0 is activated (ADDR_CTRL)
+#define ALM_1 0x20 // ALARM1 is activated (ADDR_CTRL)
+#define ALM_01 0x30 // both alarms are activated (ADDR_CTRL)
+#define MFP_01H 0x00 // MFP = SQVAW(01 HERZ) (ADDR_CTRL)
+#define MFP_04K 0x01 // MFP = SQVAW(04 KHZ) (ADDR_CTRL)
+#define MFP_08K 0x02 // MFP = SQVAW(08 KHZ) (ADDR_CTRL)
+#define MFP_32K 0x03 // MFP = SQVAW(32 KHZ) (ADDR_CTRL)
+#define MFP_64H 0x04 // MFP = SQVAW(64 HERZ) (ADDR_CTRL)
+#define ALMx_POL 0x80 // polarity of MFP on alarm (ADDR_ALMxCTL)
+#define ALMxC_SEC 0x00 // ALARM compare on SEC (ADDR_ALMxCTL)
+#define ALMxC_MIN 0x10 // ALARM compare on MIN (ADDR_ALMxCTL)
+#define ALMxC_HR 0x20 // ALARM compare on HOUR (ADDR_ALMxCTL)
+#define ALMxC_DAY 0x30 // ALARM compare on DAY (ADDR_ALMxCTL)
+#define ALMxC_DAT 0x40 // ALARM compare on DATE (ADDR_ALMxCTL)
+#define ALMxC_ALL 0x70 // ALARM compare on all param(ADDR_ALMxCTL)
+#define ALMx_IF 0x08 // MASK of the ALARM_IF (ADDR_ALMxCTL)
+#define OSCON 0x20 // state of the oscillator(running or not)
+#define VBATEN 0x08 // enable battery for back-up
/** Class Rtc_Mcp97410 implements the real time clock module MCP97410
*
@@ -63,9 +135,10 @@
RS8kHz = 2,
RS32kHz = 3
} SqwRateSelect_t;
+
protected:
- I2C* m_rtc;
+ I2C* _i2c;
static const char *m_weekDays[];
@@ -137,10 +210,79 @@
* @return true if the operation was successful or false otherwise
*/
bool setSquareWaveOutput(bool ena, SqwRateSelect_t rs);
+
+ /** enable write-Operations to EEPROM
+ *
+ *
+ */
+ bool enableEEPROMWrite();
+
+ /** disable write-Operations to EEPROM
+ *
+ *
+ */
+ bool disableEEPROMWrite();
+
+
+ /** read from EEPROM
+ * address from 0x00 to 0x7F
+ * all 128 Bytes can be read in one chunk
+ *
+ * @param address : start address to read from
+ *
+ * @param *buffer : buffer of char to write the result to. Be sure to have enough storage
+ *
+ * @param len : number of bytes to read
+ **/
+ bool readEEPROM(int address, char* buffer, int len);
+
+ /** write to EEPROM
+ * address from 0x00 to 0x7F
+ * only maximum 8 Bytes can be written in one chunk
+ *
+ * @param address : start address to write
+ *
+ * @param *buffer : buffer of chars to write
+ *
+ * @param len : number of bytes to write
+ **/
+ bool writeEEPROM(int address, char* buffer, int len);
+
+
+
+ /** read 6Byte EUI-48 address from EEPROM
+ *
+ * @param eui48 : array to hold 6 Bytes of EUI48
+ *
+ */
+ bool readEUI48(uint8_t* eui48);
+
+ /** write 6Byte EUI-48 address to EEPROM
+ *
+ * be sure to enable EUI-write-Operation (UNLOCK) before
+ * @param eui48 : array with 6 Bytes of EUI48
+ *
+ */
+ bool writeEUI48(uint8_t* eui48);
+
+ /** unlock the EUI area in the EEPROM
+ *
+ * write operation must immediatly follow the unlock procedure
+ * after a write the EEPROM is automatically locked again
+ *
+ */
+ bool unlockEUI();
private:
- bool read(int address, char* buffer, int len);
- bool write(int address, char* buffer, int len);
+ // read from a memory area RTC/SRAM or EEPROM. specify correct control_byte
+ bool read(int control_byte, int address, char* buffer, int len);
+ // write to a memory area RTC/SRAM or EEPROM. specify correct control_byte
+ bool write(int control_byte, int address, char* buffer, int len);
+ // read from RTC/SRAM
+ bool readRTC(int address, char* buffer, int len);
+ //wrtie to RTC/SRAM
+ bool writeRTC(int address, char* buffer, int len);
+
static int bcdToDecimal(int bcd) {
return ((bcd&0xF0)>>4)*10 + (bcd&0x0F);