mirror of https://github.com/ropg/ezTime
Fix for issue #25
Added condition checking that data we got from NTP server are valid. https://github.com/ropg/ezTime/issues/25pull/33/head
BugerDread
7 years ago
committed by
GitHub
parent
50f9e78822
commit
3401a97e87
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,347 @@
|
|||||||
|
/* Extensive API documentation is at https://github.com/ropg/ezTime */
|
||||||
|
|
||||||
|
#ifndef _EZTIME_H_
|
||||||
|
#ifdef __cplusplus
|
||||||
|
#define _EZTIME_H_
|
||||||
|
|
||||||
|
|
||||||
|
// Compiles in NTP updating, timezoned fetching and caching
|
||||||
|
#define EZTIME_NETWORK_ENABLE
|
||||||
|
|
||||||
|
// Arduino Ethernet shields
|
||||||
|
// #define EZTIME_ETHERNET
|
||||||
|
|
||||||
|
// Uncomment one of the below to only put only messages up to a certain level in the compiled code
|
||||||
|
// (You still need to turn them on with setDebug(someLevel) to see them)
|
||||||
|
// #define EZTIME_MAX_DEBUGLEVEL_NONE
|
||||||
|
// #define EZTIME_MAX_DEBUGLEVEL_ERROR
|
||||||
|
// #define EZTIME_MAX_DEBUGLEVEL_INFO
|
||||||
|
|
||||||
|
// Cache mechanism, either EEPROM or NVS, not both. (See README)
|
||||||
|
#define EZTIME_CACHE_EEPROM
|
||||||
|
// #define EZTIME_CACHE_NVS
|
||||||
|
|
||||||
|
|
||||||
|
// Warranty void if edited below this point...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#if !defined(__time_t_defined) // avoid conflict with newlib or other posix libc
|
||||||
|
typedef unsigned long time_t;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <inttypes.h>
|
||||||
|
#ifndef __AVR__
|
||||||
|
#include <sys/types.h> // for __time_t_defined, but avr libc lacks sys/types.h
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if !defined(__time_t_defined) // avoid conflict with newlib or other posix libc
|
||||||
|
typedef unsigned long time_t;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
extern "C++" {
|
||||||
|
|
||||||
|
////////// Error handing
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
NO_ERROR,
|
||||||
|
LAST_ERROR, // Pseudo-error: replaced by last error
|
||||||
|
NO_NETWORK,
|
||||||
|
TIMEOUT,
|
||||||
|
CONNECT_FAILED,
|
||||||
|
DATA_NOT_FOUND,
|
||||||
|
LOCKED_TO_UTC,
|
||||||
|
NO_CACHE_SET,
|
||||||
|
CACHE_TOO_SMALL,
|
||||||
|
TOO_MANY_EVENTS,
|
||||||
|
SERVER_ERROR,
|
||||||
|
INVALID_DATA
|
||||||
|
} ezError_t;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
NONE,
|
||||||
|
ERROR,
|
||||||
|
INFO,
|
||||||
|
DEBUG
|
||||||
|
} ezDebugLevel_t;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
LOCAL_TIME,
|
||||||
|
UTC_TIME
|
||||||
|
} ezLocalOrUTC_t;
|
||||||
|
|
||||||
|
// Defines that can make your code more readable. For example, if you are looking for the first
|
||||||
|
// Thursday in a year, you could write: time.makeOrdinalTime(0, 0, 0, JANUARY, FIRST, THURSDAY, year)
|
||||||
|
|
||||||
|
#define SUNDAY 1
|
||||||
|
#define MONDAY 2
|
||||||
|
#define TUESDAY 3
|
||||||
|
#define WEDNESDAY 4
|
||||||
|
#define THURSDAY 5
|
||||||
|
#define FRIDAY 6
|
||||||
|
#define SATURDAY 7
|
||||||
|
|
||||||
|
#define JANUARY 1
|
||||||
|
#define FEBRUARI 2
|
||||||
|
#define MARCH 3
|
||||||
|
#define APRIL 4
|
||||||
|
#define MAY 5
|
||||||
|
#define JUNE 6
|
||||||
|
#define JULY 7
|
||||||
|
#define AUGUST 8
|
||||||
|
#define SEPTEMBER 9
|
||||||
|
#define OCTOBER 10
|
||||||
|
#define NOVEMBER 11
|
||||||
|
#define DECEMBER 12
|
||||||
|
|
||||||
|
#define FIRST 1
|
||||||
|
#define SECOND 2
|
||||||
|
#define THIRD 3
|
||||||
|
#define FOURTH 4
|
||||||
|
#define LAST 5
|
||||||
|
|
||||||
|
////////////////////////
|
||||||
|
|
||||||
|
|
||||||
|
#define LEAP_YEAR(Y) ( ((1970+Y)>0) && !((1970+Y)%4) && ( ((1970+Y)%100) || !((1970+Y)%400) ) )
|
||||||
|
#define SECS_PER_DAY (86400UL)
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
uint8_t Second;
|
||||||
|
uint8_t Minute;
|
||||||
|
uint8_t Hour;
|
||||||
|
uint8_t Wday; // day of week, sunday is day 1
|
||||||
|
uint8_t Day;
|
||||||
|
uint8_t Month;
|
||||||
|
uint8_t Year; // offset from 1970;
|
||||||
|
} tmElements_t;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
timeNotSet,
|
||||||
|
timeNeedsSync,
|
||||||
|
timeSet
|
||||||
|
} timeStatus_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
time_t time;
|
||||||
|
void (*function)();
|
||||||
|
} ezEvent_t;
|
||||||
|
|
||||||
|
#define MAX_EVENTS 8
|
||||||
|
|
||||||
|
#define TIME_NOW (int32_t)0x7FFFFFFF // Two special-meaning time_t values ...
|
||||||
|
#define LAST_READ (int32_t)0x7FFFFFFE // (So yes, ezTime might malfunction two seconds before everything else...)
|
||||||
|
|
||||||
|
#define NTP_PACKET_SIZE 48
|
||||||
|
#define NTP_LOCAL_PORT 4242
|
||||||
|
#define NTP_SERVER "pool.ntp.org"
|
||||||
|
#define NTP_TIMEOUT 1500 // milliseconds
|
||||||
|
#define NTP_INTERVAL 1801 // default update interval in seconds
|
||||||
|
#define NTP_RETRY 1801 // Retry after this many seconds on failed NTP
|
||||||
|
#define NTP_STALE_AFTER 3602 // If update due for this many seconds, set timeStatus to timeNeedsSync
|
||||||
|
|
||||||
|
#define TIMEZONED_REMOTE_HOST "timezoned.rop.nl"
|
||||||
|
#define TIMEZONED_REMOTE_PORT 2342
|
||||||
|
#define TIMEZONED_LOCAL_PORT 2342
|
||||||
|
#define TIMEZONED_TIMEOUT 2000 // milliseconds
|
||||||
|
|
||||||
|
#define EEPROM_CACHE_LEN 50
|
||||||
|
#define MAX_CACHE_PAYLOAD ((EEPROM_CACHE_LEN - 3) / 3) * 4 + ( (EEPROM_CACHE_LEN - 3) % 3) // 2 bytes for len and date, then 4 to 3 (6-bit) compression on rest
|
||||||
|
#define MAX_CACHE_AGE_MONTHS 6
|
||||||
|
|
||||||
|
// Various date-time formats
|
||||||
|
#define ATOM "Y-m-d\\TH:i:sP"
|
||||||
|
#define COOKIE "l, d-M-Y H:i:s T"
|
||||||
|
#define ISO8601 "Y-m-d\\TH:i:sO"
|
||||||
|
#define RFC822 "D, d M y H:i:s O"
|
||||||
|
#define RFC850 COOKIE
|
||||||
|
#define RFC1036 RFC822
|
||||||
|
#define RFC1123 RFC822
|
||||||
|
#define RFC2822 RFC822
|
||||||
|
#define RFC3339 ATOM
|
||||||
|
#define RFC3339_EXT "Y-m-d\\TH:i:s.vP"
|
||||||
|
#define RSS RFC822
|
||||||
|
#define W3C ATOM
|
||||||
|
#define ISO8601_YWD "X-\\WW-N"
|
||||||
|
#define DEFAULT_TIMEFORMAT COOKIE
|
||||||
|
|
||||||
|
namespace ezt {
|
||||||
|
void breakTime(const time_t time, tmElements_t &tm);
|
||||||
|
time_t compileTime(const String compile_date = __DATE__, const String compile_time = __TIME__);
|
||||||
|
String dayShortStr(const uint8_t month);
|
||||||
|
String dayStr(const uint8_t month);
|
||||||
|
void deleteEvent(const uint8_t event_handle);
|
||||||
|
void deleteEvent(void (*function)());
|
||||||
|
ezError_t error(const bool reset = false);
|
||||||
|
String errorString(const ezError_t err = LAST_ERROR);
|
||||||
|
void events();
|
||||||
|
time_t makeOrdinalTime(const uint8_t hour, const uint8_t minute, const uint8_t second, uint8_t ordinal, const uint8_t wday, const uint8_t month, uint16_t year);
|
||||||
|
time_t makeTime(const uint8_t hour, const uint8_t minute, const uint8_t second, const uint8_t day, const uint8_t month, const uint16_t year);
|
||||||
|
time_t makeTime(tmElements_t &tm);
|
||||||
|
bool minuteChanged();
|
||||||
|
String monthShortStr(const uint8_t month);
|
||||||
|
String monthStr(const uint8_t month);
|
||||||
|
bool secondChanged();
|
||||||
|
void setDebug(const ezDebugLevel_t level);
|
||||||
|
void setDebug(const ezDebugLevel_t level, Print &device);
|
||||||
|
timeStatus_t timeStatus();
|
||||||
|
String urlEncode(const String str);
|
||||||
|
String zeropad(const uint32_t number, const uint8_t length);
|
||||||
|
|
||||||
|
#ifdef EZTIME_NETWORK_ENABLE
|
||||||
|
bool queryNTP(const String server, time_t &t, unsigned long &measured_at);
|
||||||
|
void setInterval(const uint16_t seconds = 0);
|
||||||
|
void setServer(const String ntp_server = NTP_SERVER);
|
||||||
|
void updateNTP();
|
||||||
|
bool waitForSync(const uint16_t timeout = 0);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// T i m e z o n e c l a s s
|
||||||
|
//
|
||||||
|
|
||||||
|
class Timezone {
|
||||||
|
|
||||||
|
public:
|
||||||
|
Timezone(const bool locked_to_UTC = false);
|
||||||
|
String dateTime(const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
String dateTime(time_t t, const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
String dateTime(time_t t, const ezLocalOrUTC_t local_or_utc, const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
uint8_t day(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t dayOfYear(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
int16_t getOffset(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
String getPosix();
|
||||||
|
String getTimezoneName(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t hour(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t hourFormat12(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isAM(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isDST(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isPM(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
String militaryTZ(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t minute(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t month(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t ms(time_t t = TIME_NOW);
|
||||||
|
time_t now();
|
||||||
|
uint8_t second(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
void setDefault();
|
||||||
|
uint8_t setEvent(void (*function)(), const uint8_t hr, const uint8_t min, const uint8_t sec, const uint8_t day, const uint8_t mnth, uint16_t yr);
|
||||||
|
uint8_t setEvent(void (*function)(), time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool setPosix(const String posix);
|
||||||
|
void setTime(const time_t t, const uint16_t ms = 0);
|
||||||
|
void setTime(const uint8_t hr, const uint8_t min, const uint8_t sec, const uint8_t day, const uint8_t mnth, uint16_t yr);
|
||||||
|
time_t tzTime(time_t t = TIME_NOW, ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
time_t tzTime(time_t t, ezLocalOrUTC_t local_or_utc, String &tzname, bool &is_dst, int16_t &offset);
|
||||||
|
uint8_t weekISO(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t weekday(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t year(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t yearISO(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
private:
|
||||||
|
String _posix, _olson;
|
||||||
|
bool _locked_to_UTC;
|
||||||
|
|
||||||
|
#ifdef EZTIME_NETWORK_ENABLE
|
||||||
|
public:
|
||||||
|
bool setLocation(const String location = "GeoIP");
|
||||||
|
String getOlson();
|
||||||
|
String getOlsen();
|
||||||
|
#ifdef EZTIME_CACHE_EEPROM
|
||||||
|
public:
|
||||||
|
bool setCache(const int16_t address);
|
||||||
|
private:
|
||||||
|
int16_t _eeprom_address;
|
||||||
|
#endif
|
||||||
|
#ifdef EZTIME_CACHE_NVS
|
||||||
|
public:
|
||||||
|
bool setCache(const String name, const String key);
|
||||||
|
private:
|
||||||
|
String _nvs_name, _nvs_key;
|
||||||
|
#endif
|
||||||
|
#if defined(EZTIME_CACHE_EEPROM) || defined(EZTIME_CACHE_NVS)
|
||||||
|
public:
|
||||||
|
void clearCache(const bool delete_section = false);
|
||||||
|
private:
|
||||||
|
bool setCache();
|
||||||
|
bool writeCache(String &str);
|
||||||
|
bool readCache(String &olson, String &posix, uint8_t &months_since_jan_2018);
|
||||||
|
uint8_t _cache_month;
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
extern Timezone UTC;
|
||||||
|
extern Timezone *defaultTZ;
|
||||||
|
|
||||||
|
namespace ezt {
|
||||||
|
// These bounce through to same-named methods in defaultTZ
|
||||||
|
String dateTime(const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
String dateTime(time_t t, const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
String dateTime(time_t t, const ezLocalOrUTC_t local_or_utc, const String format = DEFAULT_TIMEFORMAT);
|
||||||
|
uint8_t day(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t dayOfYear(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
int16_t getOffset(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
String getTimezoneName(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t hour(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t hourFormat12(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isAM(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isDST(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
bool isPM(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
String militaryTZ(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t minute(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t month(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t ms(time_t t = TIME_NOW);
|
||||||
|
time_t now();
|
||||||
|
uint8_t second(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t setEvent(void (*function)(), const uint8_t hr, const uint8_t min, const uint8_t sec, const uint8_t day, const uint8_t mnth, uint16_t yr);
|
||||||
|
uint8_t setEvent(void (*function)(), time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
void setTime(const uint8_t hr, const uint8_t min, const uint8_t sec, const uint8_t day, const uint8_t month, const uint16_t yr);
|
||||||
|
void setTime(time_t t);
|
||||||
|
uint8_t weekISO(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint8_t weekday(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t year(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
uint16_t yearISO(time_t t = TIME_NOW, const ezLocalOrUTC_t local_or_utc = LOCAL_TIME);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifndef EZTIME_EZT_NAMESPACE
|
||||||
|
using namespace ezt;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
// The following defines all copied from the original Time lib to keep existing code working
|
||||||
|
|
||||||
|
/* Useful Constants */
|
||||||
|
#define SECS_PER_MIN (60UL)
|
||||||
|
#define SECS_PER_HOUR (3600UL)
|
||||||
|
#define DAYS_PER_WEEK (7UL)
|
||||||
|
#define SECS_PER_WEEK (SECS_PER_DAY * DAYS_PER_WEEK)
|
||||||
|
#define SECS_PER_YEAR (SECS_PER_WEEK * 52UL)
|
||||||
|
#define SECS_YR_2000 (946684800UL) // the time at the start of y2k
|
||||||
|
|
||||||
|
/* 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)+1) // 1 = 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
|
||||||
|
|
||||||
|
// The following macros are used in calculating alarms and assume the clock is set to a date later than Jan 1 1971
|
||||||
|
// Always set the correct time before settting alarms
|
||||||
|
#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_)-1) * SECS_PER_DAY) ) // note that week starts on day 1
|
||||||
|
#define previousSunday(_time_) (_time_ - elapsedSecsThisWeek(_time_)) // time at the start of the week for the given time
|
||||||
|
#define nextSunday(_time_) ( previousSunday(_time_)+SECS_PER_WEEK) // time at the end of the week for the given time
|
||||||
|
|
||||||
|
/* Useful Macros for converting elapsed time to a time_t */
|
||||||
|
#define minutesToTime_t ((M)) ( (M) * SECS_PER_MIN)
|
||||||
|
#define hoursToTime_t ((H)) ( (H) * SECS_PER_HOUR)
|
||||||
|
#define daysToTime_t ((D)) ( (D) * SECS_PER_DAY) // fixed on Jul 22 2011
|
||||||
|
#define weeksToTime_t ((W)) ( (W) * SECS_PER_WEEK)
|
||||||
|
|
||||||
|
|
||||||
|
} // extern "C++"
|
||||||
|
#endif // __cplusplus
|
||||||
|
#endif //_EZTIME_H_
|
||||||
Loading…
Reference in new issue