DateTime.h

Go to the documentation of this file.

/*
  DateTime.h - Arduino library for date and time functions
  Copyright (c) Michael Margolis.  All right reserved.


  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  Heavily rewritten for Sming Framework
*/

#pragma once

#include <time.h>
#include <WString.h>
#include "SmingLocale.h"
#include <sming_attr.h>

/*==============================================================================*/
/* Useful Constants */
#define SECS_PER_MIN (60UL)
#define SECS_PER_HOUR (3600UL)
#define SECS_PER_DAY (SECS_PER_HOUR * 24L)
#define DAYS_PER_WEEK (7L)
#define SECS_PER_WEEK (SECS_PER_DAY * DAYS_PER_WEEK)
#define SECS_PER_YEAR (SECS_PER_WEEK * 52L)
#define SECS_YR_2000 (946681200UL)

/* Useful Macros for getting elapsed time */
#define numberOfSeconds(_time_) (_time_ % SECS_PER_MIN)

#define numberOfMinutes(_time_) ((_time_ / SECS_PER_MIN) % SECS_PER_MIN)

#define numberOfHours(_time_) ((_time_ % SECS_PER_DAY) / SECS_PER_HOUR)

#define dayOfWeek(_time_) ((_time_ / SECS_PER_DAY + 4) % DAYS_PER_WEEK) // 0 = Sunday

#define elapsedDays(_time_) (_time_ / SECS_PER_DAY) // this is number of days since Jan 1 1970

#define elapsedSecsToday(_time_) (_time_ % SECS_PER_DAY) // the number of seconds since last midnight

#define previousMidnight(_time_) ((_time_ / SECS_PER_DAY) * SECS_PER_DAY) // time at the start of the given day

#define nextMidnight(_time_) (previousMidnight(_time_) + SECS_PER_DAY) // time at the end of the given day

#define elapsedSecsThisWeek(_time_) (elapsedSecsToday(_time_) + (dayOfWeek(_time_) * SECS_PER_DAY))

// todo add date math macros
/*============================================================================*/

typedef enum {
    dtSunday,   
    dtMonday,   
    dtTuesday,   
    dtWednesday, 
    dtThursday,  
    dtFriday,   
    dtSaturday   
} dtDays_t;

class DateTime
{
public:
    DateTime()
    {
    }

    DateTime(time_t time)
    {
        setTime(time);
    }

    operator time_t()
    {
        return toUnixTime();
    }

    void setTime(time_t time);

    void setTime(uint8_t sec, uint8_t min, uint8_t hour, uint8_t day, uint8_t month, uint16_t year)
    {
        Second = sec;
        Minute = min;
        Hour = hour;
        Day = day;
        Month = month;
        Year = year;
        Milliseconds = 0;
        calcDayOfYear();
    }

    bool fromHttpDate(const String& httpDate);

    bool parseHttpDate(const String& httpDate) SMING_DEPRECATED
    {
        return fromHttpDate(httpDate);
    }

    bool isNull();

    time_t toUnixTime();

    String toShortDateString();

    String toShortTimeString(bool includeSeconds = false);

    String toFullDateTimeString();

    String toISO8601();

    String toHTTPDate();

    void addMilliseconds(long add);

    // functions to convert to and from time components (hrs, secs, days, years etc) to time_t
    static void fromUnixTime(time_t timep, uint8_t* psec, uint8_t* pmin, uint8_t* phour, uint8_t* pday, uint8_t* pwday,
                             uint8_t* pmonth, uint16_t* pyear);

    static void fromUnixTime(time_t timep, int8_t* psec, int8_t* pmin, int8_t* phour, int8_t* pday, int8_t* pwday,
                             int8_t* pmonth, int16_t* pyear) SMING_DEPRECATED
    {
        fromUnixTime(timep, reinterpret_cast<uint8_t*>(psec), reinterpret_cast<uint8_t*>(pmin),
                     reinterpret_cast<uint8_t*>(phour), reinterpret_cast<uint8_t*>(pday),
                     reinterpret_cast<uint8_t*>(pwday), reinterpret_cast<uint8_t*>(pmonth),
                     reinterpret_cast<uint16_t*>(pyear));
    }

    // functions to convert to and from time components (hrs, secs, days, years etc) to time_t
    static void convertFromUnixTime(time_t timep, int8_t* psec, int8_t* pmin, int8_t* phour, int8_t* pday,
                                    int8_t* pwday, int8_t* pmonth, int16_t* pyear) SMING_DEPRECATED
    {
        fromUnixTime(timep, reinterpret_cast<uint8_t*>(psec), reinterpret_cast<uint8_t*>(pmin),
                     reinterpret_cast<uint8_t*>(phour), reinterpret_cast<uint8_t*>(pday),
                     reinterpret_cast<uint8_t*>(pwday), reinterpret_cast<uint8_t*>(pmonth),
                     reinterpret_cast<uint16_t*>(pyear));
    }

    static time_t toUnixTime(uint8_t sec, uint8_t min, uint8_t hour, uint8_t day, uint8_t month, uint16_t year);

    static time_t convertToUnixTime(uint8_t sec, uint8_t min, uint8_t hour, uint8_t day, uint8_t month,
                                    uint16_t year) SMING_DEPRECATED
    {
        return toUnixTime(sec, min, hour, day, month, year);
    }

    String format(const char* formatString);

    String format(const String& formatString)
    {
        return format(formatString.c_str());
    }

private:
    void calcDayOfYear();               // Helper function calculates day of year
    uint8_t calcWeek(uint8_t firstDay); //Helper function calculates week number based on firstDay of week

public:
    uint8_t Hour = 0;          
    uint8_t Minute = 0;        
    uint8_t Second = 0;        
    uint16_t Milliseconds = 0; 
    uint8_t Day = 0;           
    uint8_t DayofWeek = 0;   
    uint16_t DayofYear = 0; 
    uint8_t Month = 0;         
    uint16_t Year = 0;         
};