Diff: PCF2127.h

Revision:

1:700e0285cfd8

Parent:

0:1377bcf1455e

Child:

2:db76c68f998f

diff -r 1377bcf1455e -r 700e0285cfd8 PCF2127.h
--- a/PCF2127.h	Thu Dec 04 04:58:24 2014 +0000
+++ b/PCF2127.h	Tue Dec 09 07:21:13 2014 +0000
@@ -2,8 +2,8 @@
  *  PCF2127 library
  *
  *  @author     Akifumi (Tedd) OKANO, NXP Semiconductors
- *  @version    1.5
- *  @date       04-Dec-2014
+ *  @version    1.6
+ *  @date       09-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
@@ -54,17 +54,38 @@
         Aging_offset
     }
     RegisterName;
-
+    
+    /** Error code */
+    typedef enum {
+        NO_ERROR                = 0,
+        CLOCK_INTEGRITY_FAIL    = 1,
+        I2C_ACCESS_FAIL         = 2,
+        TIME_FUNC_ERROR         = ((time_t)-1)
+    }
+    ErrorNum;
+    
     /** 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_1 (option) data for Control_1 register (default setting generates interrupts by second and minute)
      *  @param vControl_2 (option) data for Control_2 register
-     *  @param vControl_3 (option) data for Control_3 register
+     *  @param vControl_3 (option) data for Control_3 register (default setting of battery switch-over function as standard mode)
+     *  @param vCLKOUT_ctl (option) data for CLKOUT_ctl register (default setting 1Hz output on CLKOUT pin)
+     CLKOUT_ctl
      */
-    PCF2127( PinName sda, PinName sdl, char vControl_1 = 0x03, char vControl_2 = 0x00, char vControl_3 = 0x60 );
+    PCF2127( PinName sda, PinName sdl, char vControl_1 = Cntl1, char vControl_2 = Cntl2, char vControl_3 = Cntl1, char vCLKOUT_ctl = ClkOut );
 
+    /** Create a PCF2127 instance connected to specified I2C pins with specified address
+     *
+     *  @param i2c I2C object (instance)
+     *  @param vControl_1 (option) data for Control_1 register (default setting generates interrupts by second and minute)
+     *  @param vControl_2 (option) data for Control_2 register
+     *  @param vControl_3 (option) data for Control_3 register (default setting of battery switch-over function as standard mode)
+     *  @param vCLKOUT_ctl (option) data for CLKOUT_ctl register (default setting 1Hz output on CLKOUT pin)
+     */
+    PCF2127( I2C &i2c, char vControl_1 = Cntl1, char vControl_2 = Cntl2, char vControl_3 = Cntl1, char vCLKOUT_ctl = ClkOut );
+    
     /** Destractor
      */
     ~PCF2127();
@@ -79,12 +100,18 @@
      *
      *  @param dtp Pointer to struct tm
      */
-    void    set_time( struct tm *dtp );
+    int     set_time( struct tm *dtp );
+    
+    /** Set the time
+     *
+     *  @param tp pointer to time_t
+     */
+    int     set_time( time_t *tp );
 
     /** 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 );
+    int     set_time( char *s );
 
     /** Get time of day
      *
@@ -99,22 +126,33 @@
      *  @param addr Register address
      *  @param Integer data. Converted to BCD before writing inot the register.
      */
-    void    set_alarm( char addr, char s );
+    int     set_alarm( char addr, char s );
 
     /** Clear interrupt flag
      *
      *  Clears interrupt flags by writing 0x00 into Control_2 register
      *
      */
-    void    clear_intr( void );
+    int     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;
+    typedef enum {
+        Cntl1   = 0x03,
+        Cntl2   = 0x00,
+        Cntl3   = 0x00,
+        ClkOut  = 0x46
+    }
+    DefaultRegParam;
+    
+    int     init( char vControl_1, char vControl_2, char vControl_3, char vCLKOUT_ctl );
+    int     set_register( char addr, char data );
+    int     read_register( char addr );
+    char    i2bcd( char n );
+    char    bcd2i( char bcd );
+
+    I2C     *i2c_p;
+    I2C     &i2c;
     char    device_address;
 }
 ;