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)
 
enum dtDays_t {
    dtSunday,
    dtMonday,
    dtTuesday,
    dtWednesday,
    dtThursday,
    dtFriday,
    dtSaturday,
};
 
enum dtMonth_t {
    dtJanuary,
    dtFebruary,
    dtMarch,
    dtApril,
    dtMay,
    dtJune,
    dtJuly,
    dtAugust,
    dtSeptember,
    dtOctober,
    dtNovember,
    dtDecember,
};
 
/* Useful functions for getting elapsed time */
 
inline constexpr uint8_t numberOfSeconds(time_t time)
{
    return time % SECS_PER_MIN;
}
 
inline constexpr uint8_t numberOfMinutes(time_t time)
{
    return (time / SECS_PER_MIN) % SECS_PER_MIN;
}
 
inline constexpr uint8_t numberOfHours(time_t time)
{
    return (time % SECS_PER_DAY) / SECS_PER_HOUR;
}
 
inline constexpr dtDays_t dayOfWeek(time_t time)
{
    return dtDays_t((time / SECS_PER_DAY + 4) % DAYS_PER_WEEK);
}
 
inline constexpr uint8_t elapsedDays(time_t time)
{
    return time / SECS_PER_DAY;
}
 
inline constexpr unsigned elapsedSecsToday(time_t time)
{
    return time % SECS_PER_DAY;
}
 
inline constexpr time_t previousMidnight(time_t time)
{
    return (time / SECS_PER_DAY) * SECS_PER_DAY;
}
 
inline constexpr time_t nextMidnight(time_t time)
{
    return previousMidnight(time) + SECS_PER_DAY;
}
 
inline constexpr unsigned elapsedSecsThisWeek(time_t time)
{
    return elapsedSecsToday(time) + dayOfWeek(time) * SECS_PER_DAY;
}
 
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 fromISO8601(const String& datetime);
 
    bool isNull() const;
 
    time_t toUnixTime() const;
 
    String toShortDateString() const;
 
    String toShortTimeString(bool includeSeconds = false) const;
 
    String toFullDateTimeString() const;
 
    String toISO8601() const;
 
    String toHTTPDate() const;
 
    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);
 
    // functions to convert to and from time components (hrs, secs, days, years etc) to time_t
 
    static time_t toUnixTime(int sec, int min, int hour, int day, uint8_t month, uint16_t year);
 
    String format(const char* formatString) const;
 
    String format(const String& formatString) const
    {
        return format(formatString.c_str());
    }
 
    static bool isLeapYear(uint16_t year);
    static uint8_t getMonthDays(uint8_t month, uint16_t year);
    static String getLocaleDayName(uint8_t day);
    static String getLocaleMonthName(uint8_t month);
    static String getIsoDayName(uint8_t day);
    static String getIsoMonthName(uint8_t month);
    static uint16_t getDaysInYear(uint16_t year);
 
private:
    // Helper methods
    void calcDayOfYear();                     // Calculate day of year
    uint8_t calcWeek(uint8_t firstDay) const; // Calculate 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;         
};