time/pcf8563/SensorPCF8563.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "../../SensorBuildOpt.h"
#if !SENSORLIB_EXCLUDE_PCF8563
 
#include "../../platform/comm/I2CDeviceNoHal.hpp"
#include "../SensorRTC.h"
 
static const uint8_t PCF8563_SLAVE_ADDRESS = 0x51;
 
class SensorPCF8563 : public SensorRTC, public I2CDeviceNoHal
{
public:
    using SensorRTC::setDateTime;
    using SensorRTC::getDateTime;
    using I2CDeviceNoHal::begin;
 
    enum ClockHz {
        CLK_32768HZ, 
        CLK_1024HZ,  
        CLK_32HZ,    
        CLK_1HZ,     
        CLK_DISABLE, 
    };
 
    SensorPCF8563() = default;
 
    ~SensorPCF8563() = default;
 
#if defined(ARDUINO)
    bool begin(TwoWire &wire, int sda = -1, int scl = -1)
    {
        return I2CDeviceNoHal::begin(wire, PCF8563_SLAVE_ADDRESS, sda, scl);
    }
#elif defined(ESP_PLATFORM)
 
#if defined(SENSORLIB_USE_I2C_LEGACY)
    bool begin(i2c_port_t port_num, int sda = -1, int scl = -1)
    {
        return I2CDeviceNoHal::begin(port_num, PCF8563_SLAVE_ADDRESS, sda, scl);
    }
#else
    bool begin(i2c_master_bus_handle_t handle)
    {
        return I2CDeviceNoHal::begin(handle, PCF8563_SLAVE_ADDRESS);
    }
#endif  // SENSORLIB_USE_I2C_LEGACY
#endif  // ESP_PLATFORM
 
    bool begin(SensorCommCustom::CustomCallback callback)
    {
        return I2CDeviceNoHal::begin(callback, PCF8563_SLAVE_ADDRESS);
    }
 
    void setDateTime(RTC_DateTime datetime) override
    {
        uint8_t buffer[7];
        buffer[0] = DEC2BCD(datetime.getSecond()) & 0x7F;
        buffer[1] = DEC2BCD(datetime.getMinute());
        buffer[2] = DEC2BCD(datetime.getHour());
        buffer[3] = DEC2BCD(datetime.getDay());
        buffer[4] = getDayOfWeek(datetime.getDay(), datetime.getMonth(), datetime.getYear());
        buffer[5] = DEC2BCD(datetime.getMonth());
        buffer[6] = DEC2BCD(datetime.getYear() % 100);
 
        // Set century bit according to year.
        if ((2000 % datetime.getYear()) == 2000) {
            buffer[5] &= 0x7F;
        } else {
            buffer[5] |= 0x80;
        }
        writeRegBuff(SEC_REG, buffer, 7);
    }
 
    RTC_DateTime getDateTime() override
    {
        uint8_t buffer[7];
        readRegBuff(SEC_REG, buffer, 7);
        uint8_t second = BCD2DEC(buffer[0] & 0x7F);
        uint8_t minute = BCD2DEC(buffer[1] & 0x7F);
        uint8_t hour   = BCD2DEC(buffer[2] & 0x3F);
        uint8_t day    = BCD2DEC(buffer[3] & 0x3F);
        uint8_t week   = BCD2DEC(buffer[4] & 0x07);
        uint8_t month  = BCD2DEC(buffer[5] & 0x1F);
        uint16_t year  = BCD2DEC(buffer[6]);
 
        // Century: 0 = 1900, 1 = 2000.
        year += (buffer[5] & CENTURY_MASK) ? 1900 : 2000;
        return RTC_DateTime(year, month, day, hour, minute, second, week);
    }
 
    bool isClockIntegrityGuaranteed()
    {
        return getRegBit(SEC_REG, 7) == 0;
    }
 
    RTC_Alarm getAlarm()
    {
        uint8_t buffer[4];
        readRegBuff(ALRM_MIN_REG, buffer, 4);
        buffer[0] = BCD2DEC(buffer[0] & 0x80); // minute
        buffer[1] = BCD2DEC(buffer[1] & 0x40); // hour
        buffer[2] = BCD2DEC(buffer[2] & 0x40); // day
        buffer[3] = BCD2DEC(buffer[3] & 0x08); // weekday
        // RTC_Alarm(uint8_t hour, uint8_t minute, uint8_t second, uint8_t day, uint8_t week)
        return RTC_Alarm(buffer[1], buffer[0], 0, buffer[2], buffer[3]);
    }
 
    void enableAlarm()
    {
        setRegBit(STAT2_REG, 1);
    }
 
    void disableAlarm()
    {
        clrRegBit(STAT2_REG, 1);
    }
 
    void resetAlarm()
    {
        clrRegBit(STAT2_REG, 3);
    }
 
    bool isAlarmActive()
    {
        return getRegBit(STAT2_REG, 3);
    }
 
    void setAlarm(RTC_Alarm alarm)
    {
        setAlarm(alarm.getHour(), alarm.getMinute(), alarm.getDay(), alarm.getWeek());
    }
 
    void setAlarm(uint8_t hour, uint8_t minute, uint8_t day, uint8_t week)
    {
        uint8_t buffer[4] = {0};
 
        RTC_DateTime datetime = getDateTime();
 
        uint8_t daysInMonth = getDaysInMonth(datetime.getMonth(), datetime.getYear());
 
        if (minute != NO_ALARM) {
            if (minute > 59) {
                minute = 59;
            }
            buffer[0] = DEC2BCD(minute);
            buffer[0] &= ~ALARM_ENABLE;
        } else {
            buffer[0] = ALARM_ENABLE;
        }
 
        if (hour != NO_ALARM) {
            if (hour > 23) {
                hour = 23;
            }
            buffer[1] = DEC2BCD(hour);
            buffer[1] &= ~ALARM_ENABLE;
        } else {
            buffer[1] = ALARM_ENABLE;
        }
        if (day != NO_ALARM) {
            buffer[2] = DEC2BCD(((day) < (1) ? (1) : ((day) > (daysInMonth) ? (daysInMonth) : (day))));
            buffer[2] &= ~ALARM_ENABLE;
        } else {
            buffer[2] = ALARM_ENABLE;
        }
        if (week != NO_ALARM) {
            if (week > 6) {
                week = 6;
            }
            buffer[3] = DEC2BCD(week);
            buffer[3] &= ~ALARM_ENABLE;
        } else {
            buffer[3] = ALARM_ENABLE;
        }
        writeRegBuff(ALRM_MIN_REG, buffer, 4);
    }
 
    void setAlarmByMinutes(uint8_t minute)
    {
        setAlarm(NO_ALARM, minute, NO_ALARM, NO_ALARM);
    }
 
    void setAlarmByDays(uint8_t day)
    {
        setAlarm(NO_ALARM, NO_ALARM, day, NO_ALARM);
    }
 
    void setAlarmByHours(uint8_t hour)
    {
        setAlarm(hour, NO_ALARM, NO_ALARM, NO_ALARM);
    }
 
    void setAlarmByWeekDay(uint8_t week)
    {
        setAlarm(NO_ALARM, NO_ALARM, NO_ALARM, week);
    }
 
    bool isCountdownTimerEnable()
    {
        uint8_t buffer[2];
        buffer[0] = readReg(STAT2_REG);
        buffer[1] = readReg(TIMER1_REG);
        if (buffer[0] & TIMER_TIE) {
            return buffer[1] & TIMER_TE ? true : false;
        }
        return false;
    }
 
    bool isCountdownTimerActive()
    {
        return getRegBit(STAT2_REG, 2);
    }
 
    void enableCountdownTimer()
    {
        setRegBit(STAT2_REG, 0);
    }
 
    void disableCountdownTimer()
    {
        clrRegBit(STAT2_REG, 0);
    }
 
    void setCountdownTimer(uint8_t val, uint8_t freq)
    {
        uint8_t buffer[3];
        buffer[1] = readReg(TIMER1_REG);
        buffer[1] |= (freq & TIMER_TD10);
        buffer[2] = val;
        writeReg(TIMER1_REG, buffer[1]);
        writeReg(TIMER2_REG, buffer[2]);
    }
 
    void clearCountdownTimer()
    {
        uint8_t val;
        val = readReg(STAT2_REG);
        val &= ~(TIMER_TF | TIMER_TIE);
        val |= ALARM_AF;
        writeReg(STAT2_REG, val);
        writeReg(TIMER1_REG, (uint8_t)0x00);
    }
 
    void setClockOutput(ClockHz freq)
    {
        if (freq == CLK_DISABLE) {
            clrRegBit(SQW_REG, 7);
        } else {
            writeReg(SQW_REG, freq | CLK_ENABLE);
        }
    }
 
    const char *getChipName() override
    {
        return "PCF8563";
    }
 
    void reset() override
    {
    }
 
private:
    bool initImpl(uint8_t param) override
    {
        // Check device is online.
        int ret = readReg(SEC_REG);
        if (ret < 0) {
            return false;
        }
        if (BCD2DEC(ret & 0x7F) > 59) {
            return false;
        }
        return true;
    }
 
protected:
    // Register addresses
    static constexpr uint8_t STAT1_REG = 0x00;
    static constexpr uint8_t STAT2_REG = 0x01;
    static constexpr uint8_t SEC_REG = 0x02;
    static constexpr uint8_t MIN_REG = 0x03;
    static constexpr uint8_t HR_REG = 0x04;
    static constexpr uint8_t DAY_REG = 0x05;
    static constexpr uint8_t WEEKDAY_REG = 0x06;
    static constexpr uint8_t MONTH_REG = 0x07;
    static constexpr uint8_t YEAR_REG = 0x08;
    static constexpr uint8_t ALRM_MIN_REG = 0x09;
    static constexpr uint8_t SQW_REG = 0x0D;
    static constexpr uint8_t TIMER1_REG = 0x0E;
    static constexpr uint8_t TIMER2_REG = 0x0F;
 
    // Mask values
    static constexpr uint8_t VOL_LOW_MASK = 0x80;
    static constexpr uint8_t MINUTES_MASK = 0x7F;
    static constexpr uint8_t HOUR_MASK = 0x3F;
    static constexpr uint8_t WEEKDAY_MASK = 0x07;
    static constexpr uint8_t CENTURY_MASK = 0x80;
    static constexpr uint8_t DAY_MASK = 0x3F;
    static constexpr uint8_t MONTH_MASK = 0x1F;
    static constexpr uint8_t TIMER_CTL_MASK = 0x03;
 
    // Alarm and Timer flags
    static constexpr uint8_t ALARM_AF = 0x08;
    static constexpr uint8_t TIMER_TF = 0x04;
    static constexpr uint8_t ALARM_AIE = 0x02;
    static constexpr uint8_t TIMER_TIE = 0x01;
    static constexpr uint8_t TIMER_TE = 0x80;
    static constexpr uint8_t TIMER_TD10 = 0x03;
 
    // Other constants
    static constexpr uint8_t NO_ALARM = 0xFF;
    static constexpr uint8_t ALARM_ENABLE = 0x80;
    static constexpr uint8_t CLK_ENABLE = 0x80;
};
 
#endif