Diff: PCF2127.h

Revision:

0:1377bcf1455e

Child:

1:700e0285cfd8

diff -r 000000000000 -r 1377bcf1455e PCF2127.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PCF2127.h	Thu Dec 04 04:58:24 2014 +0000
@@ -0,0 +1,121 @@
+/*
+ *  PCF2127 library
+ *
+ *  @author     Akifumi (Tedd) OKANO, NXP Semiconductors
+ *  @version    1.5
+ *  @date       04-Dec-2014
+ *
+ *  PCF2127 is a "real time clock (RTC)" module which is including a Xtal and TCXO
+ *  http://www.nxp.com/products/interface_and_connectivity/real_time_clocks/rtcs_with_temp_compensation/series/PCF2127.html
+ *
+ *  RTC initializing part is ported from..
+ *    http://mbed.org/users/roen/notebook/real-time/
+ *
+ *  This code is refined version of..
+ *    http://developer.mbed.org/users/okano/code/NXP_PCF2127A/
+ */
+
+#ifndef        MBED_PCF2127
+#define        MBED_PCF2127
+
+#include    "mbed.h"
+
+class PCF2127
+{
+public:
+
+    /** name of the PCF2127 registers */
+    typedef enum {
+        Control_1,
+        Control_2,
+        Control_3,
+        Seconds,
+        Minutes,
+        Hours,
+        Days,
+        Weekdays,
+        Months,
+        Years,
+        Second_alarm,
+        Minute_alarm,
+        Hour_alarm,
+        Day_alarm,
+        Weekday_alarm,
+        CLKOUT_ctl,
+        Watchdg_tim_ctl,
+        Watchdg_tim_val,
+        Timestp_ctl,
+        Sec_timestp,
+        Min_timestp,
+        Hour_timestp,
+        Day_timestp,
+        Mon_timestp,
+        Year_timestp,
+        Aging_offset
+    }
+    RegisterName;
+
+    /** Create a PCF2127 instance connected to specified I2C pins with specified address
+     *
+     *  @param I2C_sda I2C-bus SDA pin
+     *  @param I2C_scl I2C-bus SCL pin
+     *  @param vControl_1 (option) data for Control_1 register
+     *  @param vControl_2 (option) data for Control_2 register
+     *  @param vControl_3 (option) data for Control_3 register
+     */
+    PCF2127( PinName sda, PinName sdl, char vControl_1 = 0x03, char vControl_2 = 0x00, char vControl_3 = 0x60 );
+
+    /** Destractor
+     */
+    ~PCF2127();
+
+    /** Clock integrity check
+     *
+     *  @return non-zero value if the clock was stopped (means need to set the time)
+     */
+    int     is_init_required( void );
+
+    /** Set the time
+     *
+     *  @param dtp Pointer to struct tm
+     */
+    void    set_time( struct tm *dtp );
+
+    /** Set the time
+     *  @param s String data: The time information should be given in format of "YYYY MM DD HH MM SS"
+     */
+    void    set_time( char *s );
+
+    /** Get time of day
+     *
+     *  This function works similar to "time()" in standard-C-library
+     *
+     *  @param tp Pointer to time_t
+     */
+    time_t  time( time_t *tp );
+
+    /** Register access interface with integer to BCD conversion
+     *
+     *  @param addr Register address
+     *  @param Integer data. Converted to BCD before writing inot the register.
+     */
+    void    set_alarm( char addr, char s );
+
+    /** Clear interrupt flag
+     *
+     *  Clears interrupt flags by writing 0x00 into Control_2 register
+     *
+     */
+    void    clear_intr( void );
+
+private:
+    void set_register( char addr, char data );
+    char read_register( char addr );
+    char i2bcd( char n );
+    char bcd2i( char bcd );
+
+    I2C     i2c;
+    char    device_address;
+}
+;
+#endif  // end of "#ifndef MBED_PCF2127"