PCF8563.hh

Go to the documentation of this file.

#ifndef COSA_PCF8563_HH
#define COSA_PCF8563_HH

#include "Cosa/TWI.hh"
#include "Cosa/Time.hh"
#include "Cosa/IOStream.hh"

class PCF8563 : private TWI::Driver {
public:
  PCF8563() :
    TWI::Driver(0x51)
  {}

  bool get_time(time_t& now);

  bool set_time(time_t& now);

  struct alarm_t {
    uint8_t minutes;            
    uint8_t hours;              
    uint8_t date;               
    uint8_t day;                

    static const uint8_t DISABLE = 0x80;

    alarm_t()
    {
      minutes = DISABLE;
      hours = DISABLE;
      date = DISABLE;
      day = DISABLE;
    }
  };

  bool set_alarm(alarm_t& alarm);

  bool get_alarm(alarm_t& alarm);

  bool clear_alarm();

  bool pending_alarm();

protected:
  union control_status_1_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t N1:3;             
      uint8_t TESTC:1;          
      uint8_t N2:1;             
      uint8_t STOP:1;           
      uint8_t N3:1;             
      uint8_t TEST1:1;          
    };
    control_status_1_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
  };

  union control_status_2_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t TIE:1;            
      uint8_t AIE:1;            
      uint8_t TF:1;             
      uint8_t AF:1;             
      uint8_t TI_TP:1;          
      uint8_t N:3;              
    };
    control_status_2_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
  };

  union clock_control_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t FD:2;             
      uint8_t unused1:5;        
      uint8_t FE:1;             
    };
    clock_control_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
  };

  enum {
    FD_32_768_KHZ,              
    FD_1_024_KHZ,               
    FD_32_HZ,                   
    FD_1_HZ                     
  } __attribute__((packed));

  union timer_control_t {
    uint8_t as_uint8;           
    struct {                    
      uint8_t TD:2;             
      uint8_t unused1:5;        
      uint8_t TE:1;             
    };
    timer_control_t(uint8_t value = 0)
    {
      as_uint8 = value;
    }
  };

  enum {
    TD_4_096_KHZ,               
    TD_64_HZ,                   
    TD_1_HZ,                    
    TD_1v60_HZ                  
  } __attribute__((packed));

  struct rtcc_t {
    control_status_1_t cs1;     
    control_status_2_t cs2;     
    time_t clock;               
    alarm_t alarm;              
    clock_control_t cc;         
    timer_control_t tc;         
    uint8_t timer;              
  };

  int read(void* regs, uint8_t size, uint8_t pos = 0);

  int write(void* regs, uint8_t size, uint8_t pos = 0);
};

IOStream& operator<<(IOStream& cout, PCF8563::alarm_t &alarm);

#endif