DS3231.hh

Go to the documentation of this file.

#ifndef COSA_DS3231_HH
#define COSA_DS3231_HH

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

class DS3231 : private TWI::Driver {
public:
  struct alarm1_t {
    enum {
      ONCE_PER_SEC = 0x0f,
      WHEN_SEC_MATCH = 0x0e,
      WHEN_MIN_SEC_MATCH = 0x0c,
      WHEN_TIME_MATCH = 0x08,
      WHEN_DATE_TIME_MATCH = 0x00,
      WHEN_DAY_TIME_MATCH = 0x10
    } __attribute__ ((packed));
    uint8_t seconds;
    uint8_t minutes;
    uint8_t hours;
    union {
      uint8_t day;
      uint8_t date;
    };

    void to_binary()
    {
      ::to_binary(&seconds, sizeof(alarm1_t));
    }

    void to_bcd()
    {
      ::to_bcd(&seconds, sizeof(alarm1_t));
    }
  };

  struct alarm2_t {
    enum {
      ONCE_PER_MIN = 0x07,
      WHEN_MIN_MATCH = 0x06,
      WHEN_TIME_MATCH = 0x04,
      WHEN_DATE_TIME_MATCH = 0x00,
      WHEN_DAY_TIME_MATCH = 0x08
    } __attribute__ ((packed));
    uint8_t minutes;
    uint8_t hours;
    union {
      uint8_t day;
      uint8_t date;
    };

    void to_binary()
    {
      ::to_binary(&minutes, sizeof(alarm2_t));
    }

    void to_bcd()
    {
      ::to_bcd(&minutes, sizeof(alarm2_t));
    }
  };

  union control_t {
    uint8_t as_uint8;
    struct {
      uint8_t a1ie:1;           
      uint8_t a2ie:1;           
      uint8_t intcn:1;          
      uint8_t rs:2;             
      uint8_t conv:1;           
      uint8_t bbsqw:1;          
      uint8_t eosc:1;           
    };
  };

  enum {
    RS_1_HZ = 0,
    RS_1024_HZ = 1,
    RS_4096_HZ = 2,
    RS_8192_HZ = 3
  };

  union status_t {
    uint8_t as_uint8;
    struct {
      uint8_t a1f:1;            
      uint8_t a2f:1;            
      uint8_t bsy:1;            
      uint8_t en32khz:1;        
      uint8_t reserved:3;       
      uint8_t osf:1;            
    };
  };

  struct timekeeper_t {
    time_t clock;               
    alarm1_t alarm1;            
    alarm2_t alarm2;            
    control_t control;          
    status_t status;            
    int8_t aging;               
    int16_t temp;               
  };

  DS3231() : TWI::Driver(0x68) {}

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

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

  bool get_time(time_t& now)
    __attribute__((always_inline))
  {
    return (read(&now, sizeof(now)) == sizeof(now));
  }

  bool set_time(time_t& now)
    __attribute__((always_inline))
  {
    return (write(&now, sizeof(now)) == sizeof(now));
  }

  bool get_alarm1(alarm1_t& alarm, uint8_t& mask)
    __attribute__((always_inline))
  {
    return (get(&alarm, sizeof(alarm), offsetof(timekeeper_t, alarm1), mask));
  }

  bool set_alarm1(alarm1_t& alarm, uint8_t mask)
    __attribute__((always_inline))
  {
    return (set(&alarm, sizeof(alarm), offsetof(timekeeper_t, alarm1), mask));
  }

  bool get_alarm2(alarm2_t& alarm, uint8_t& mask)
    __attribute__((always_inline))
  {
    return (get(&alarm, sizeof(alarm), offsetof(timekeeper_t, alarm2), mask));
  }

  bool set_alarm2(alarm2_t& alarm, uint8_t mask)
    __attribute__((always_inline))
  {
    return (set(&alarm, sizeof(alarm), offsetof(timekeeper_t, alarm2), mask));
  }

  int16_t temperature();

  bool square_wave(bool flag);

private:
  bool get(void* alarm, uint8_t size, uint8_t offset, uint8_t& mask);

  bool set(void* alarm, uint8_t size, uint8_t offset, uint8_t mask);
};

IOStream& operator<<(IOStream& outs, DS3231::alarm1_t& t);

IOStream& operator<<(IOStream& outs, DS3231::alarm2_t& t);

IOStream& operator<<(IOStream& outs, DS3231::timekeeper_t& t);

#endif