uRTCLib.h

Go to the documentation of this file.

 
#ifndef URTCLIB
    #define URTCLIB
    #include "Arduino.h"
    #ifndef URTCLIB_WIRE
        #if defined(ARDUINO_attiny) || defined(ARDUINO_AVR_ATTINYX4) || defined(ARDUINO_AVR_ATTINYX5) || defined(ARDUINO_AVR_ATTINYX7) || defined(ARDUINO_AVR_ATTINYX8) || defined(ARDUINO_AVR_ATTINYX61) || defined(ARDUINO_AVR_ATTINY43) || defined(ARDUINO_AVR_ATTINY828) || defined(ARDUINO_AVR_ATTINY1634) || defined(ARDUINO_AVR_ATTINYX313)
            #include <TinyWireM.h>                  // I2C Master lib for ATTinys which use USI
            #define URTCLIB_WIRE TinyWireM
        #else
            #include <Wire.h>
            #define URTCLIB_WIRE Wire
        #endif
    #endif
 
    #define URTCLIB_ADDRESS 0x68
 
    /************   MODELS ***********/
    #define URTCLIB_MODEL_DS1307 1
    #define URTCLIB_MODEL_DS3231 2
    #define URTCLIB_MODEL_DS3232 3
 
 
    /************   WEEK DAYS ***********/
    #define URTCLIB_WEEKDAY_SUNDAY 1
    #define URTCLIB_WEEKDAY_MONDAY 2
    #define URTCLIB_WEEKDAY_TUESDAY 3
    #define URTCLIB_WEEKDAY_WEDNESDAY 4
    #define URTCLIB_WEEKDAY_THURSDAY 5
    #define URTCLIB_WEEKDAY_FRIDAY 6
    #define URTCLIB_WEEKDAY_SATURDAY 7
 
 
 
    /************   ALARM SELECTION: ***********/
    //Note: Not valid for DS1307!
 
    #define URTCLIB_ALARM_TYPE_1_NONE 0b00000000
 
    #define URTCLIB_ALARM_TYPE_1_ALL_S 0b00101111
 
    #define URTCLIB_ALARM_TYPE_1_FIXED_S 0b00101110
 
    #define URTCLIB_ALARM_TYPE_1_FIXED_MS 0b00101100
 
    #define URTCLIB_ALARM_TYPE_1_FIXED_HMS 0b00101000
 
    #define URTCLIB_ALARM_TYPE_1_FIXED_DHMS 0b00100000
 
    #define URTCLIB_ALARM_TYPE_1_FIXED_DOWHMS 0b00110000
 
    #define URTCLIB_ALARM_TYPE_2_NONE 0b10000000
 
    #define URTCLIB_ALARM_TYPE_2_ALL_M 0b10101110
 
    #define URTCLIB_ALARM_TYPE_2_FIXED_M 0b10101100
 
    #define URTCLIB_ALARM_TYPE_2_FIXED_HM 0b10101000
 
    #define URTCLIB_ALARM_TYPE_2_FIXED_DHM 0b10100000
 
    #define URTCLIB_ALARM_TYPE_2_FIXED_DOWHM 0b10110000
 
 
    #define URTCLIB_ALARM_1 URTCLIB_ALARM_TYPE_1_NONE
 
    #define URTCLIB_ALARM_2 URTCLIB_ALARM_TYPE_2_NONE
 
    #define URTCLIB_ALARM_ANY 0b01010101
 
 
    /************   SQWG SELECTION: ***********/
 
    #define URTCLIB_SQWG_OFF_0 0b11111111
 
    #define URTCLIB_SQWG_OFF_1 0b11111110
 
    #define URTCLIB_SQWG_1H 0b00000000
 
    #define URTCLIB_SQWG_1024H 0b00001000
 
    #define URTCLIB_SQWG_4096H 0b00010000
 
    #define URTCLIB_SQWG_8192H 0b00011000
 
    #define URTCLIB_SQWG_32768H 0b00000011
 
 
    /************   TEMPERATURE ***********/
    #define URTCLIB_TEMP_ERROR 32767
 
 
    /************   MISC  ***********/
 
 
    #define uRTCLIB_decToBcd(val) ((uint8_t) ((val / 10 * 16) + (val % 10)))
 
    #define uRTCLIB_bcdToDec(val) ((uint8_t) ((val / 16 * 10) + (val % 16)))
 
    // ESP yield function (ESP32 has no need for that on dual core, but it has on single core version)
    #if ARDUINO_ARCH_ESP8266
        #define uRTCLIB_YIELD yield();
    #else
        #if ARDUINO_ARCH_ESP32
            #define uRTCLIB_YIELD yield();
        #else
            #define uRTCLIB_YIELD
        #endif
    #endif
 
    class uRTCLib {
        public:
            /******* Constructors *******/
            uRTCLib();
            uRTCLib(const int);
            uRTCLib(const int, const uint8_t);
 
            /******* RTC functions ********/
            bool refresh();
            uint8_t second();
            uint8_t minute();
            uint8_t hour();
            uint8_t hourModeAndAmPm();
            uint8_t day();
            uint8_t month();
            uint8_t year();
            uint8_t dayOfWeek();
            int16_t temp();
            void set(const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t);
            void set_12hour_mode(const bool);
            void set_rtc_address(const int);
            void set_model(const uint8_t);
            uint8_t model();
 
            /******* Power ********/
            bool getEOSCFlag();
            bool lostPower();
            void lostPowerClear();
            bool enableBattery(); // Only DS3231 and DS3232.
            bool disableBattery(); // Only DS3231 and DS3232.
 
 
            /******** Alarms ************/
            bool alarmSet(const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t); // Seconds will be ignored on Alarm 2
            bool alarmDisable(const uint8_t);
            bool alarmClearFlag(const uint8_t);
            uint8_t alarmMode(const uint8_t);
            uint8_t alarmSecond(const uint8_t);
            uint8_t alarmMinute(const uint8_t);
            uint8_t alarmHour(const uint8_t);
            uint8_t alarmDayDow(const uint8_t);
            bool alarmTriggered(const uint8_t);
 
            /*********** SQWG ************/
            uint8_t sqwgMode();
            bool sqwgSetMode(const uint8_t);
 
 
            /************ RAM *************/
            // Only DS1307 and DS3232.
            // DS1307: Addresses 08h to 3Fh so we offset 08h positions and limit to 38h as maximum address
            // DS3232: Addresses 14h to FFh so we offset 14h positions and limit to EBh as maximum address
            byte ramRead(const uint8_t);
            bool ramWrite(const uint8_t, byte);
 
            /************ Aging *************/
            // Only DS3231 and DS3232. Address 0x10h
            int8_t agingGet();
            bool agingSet(int8_t);
 
            /************ 32K Generator pin *************/
            // Only DS3231 and DS3232. On DS1307 we map it to SqWG
            bool enable32KOut();
            bool disable32KOut();
            bool status32KOut();
 
 
        private:
            // Address
            int _rtc_address = URTCLIB_ADDRESS;
 
            // RTC read data
            uint8_t _second = 0;
            uint8_t _minute = 0;
            uint8_t _hour = 0;
            uint8_t _day = 0;
            uint8_t _month = 0;
            uint8_t _year = 0;
            uint8_t _dayOfWeek = 0;
            int16_t _temp = 9999;
 
            // Model, for alarms and RAM
            uint8_t _model = URTCLIB_MODEL_DS3232;
 
            // Alarms:
            uint8_t _a1_mode = URTCLIB_ALARM_TYPE_1_NONE;
            uint8_t _a1_second = 0;
            uint8_t _a1_minute = 0;
            uint8_t _a1_hour = 0;
            uint8_t _a1_day_dow = 0;
            //bool _a1_triggered_flag = _controlStatus  LSB Bit 0
 
            uint8_t _a2_mode = URTCLIB_ALARM_TYPE_2_NONE;
            uint8_t _a2_minute = 0;
            uint8_t _a2_hour = 0;
            uint8_t _a2_day_dow = 0;
            // bool _a2_triggered_flag = _controlStatus  Bit 1
 
            // Aging
            int8_t _aging = 0;
 
            // SQWG
            uint8_t _sqwg_mode = URTCLIB_SQWG_OFF_1;
 
            // Keep record of various Flags
            // _controlStatus  MSB Bit 7    _lost_power        = (bool) (_controlStatus & 0b10000000);
            // _controlStatus  Bit 6        _eosc              = (bool) (_controlStatus & 0b01000000);
            // _controlStatus  Bit 5        _12hrMode          = (bool) (_controlStatus & 0b00100000);
            // _controlStatus  Bit 4        _pmNotAm           = (bool) (_controlStatus & 0b00010000);    // am or pm if 12 hour mode
            // _controlStatus  Bit 3        _32k               = (bool) (_controlStatus & 0b00001000);
            // _controlStatus  Bit 2
            // _controlStatus  Bit 1        _a2_triggered_flag = (bool) (_controlStatus & 0b00000010);
            // _controlStatus  LSB Bit 0    _a1_triggered_flag = (bool) (_controlStatus & 0b00000001);
            uint8_t _controlStatus = 0x00;
 
    };
 
#endif