ClockSupport.h file

Classes

class epochTime

A class for dealing with different definitions of the start of the epoch.

class loggerClock

A class for the clock attached to the logger.

Enums

enum class epochStart: time_t { unix_epoch = 2208988800, y2k_epoch = 2208988800 + 946684800, gps_epoch = 2208988800 + 315964800, nist_epoch = 0 }

Set the epoch start value.

Defines

#define MS_USE_DS3231

Select DS3231 as the RTC for the EnviroDIY Mayfly.

#define MS_CLOCK_NAME = "DS3231"

A text description of the clock.

#define CLOCK_INTERRUPT_MODE = FALLING

The mode for the interrupt on the wake/RTC pin; must be one of HIGH, LOW, FALLING, RISING, or CHANGE.

#define EPOCH_NIST_TO_UNIX = 2208988800

The difference in seconds between the epoch value returned by the NIST Network Time Protocol and the Unix epoch.

#define EPOCH_UNIX_TO_Y2K = 946684800

The epoch starting Jan 1, 2000, as some RTC's and Arduinos do (946684800s ahead of UNIX epoch)

#define EPOCH_UNIX_TO_GPS = 315964800

The GPS epoch starting Jan 5, 1980 (was 315964800s ahead of UNIX epoch at founding, has drifted farther apart due to leap seconds)

#define NUMBER_LEAP_SECONDS = 18

The number of announced leap seconds as of February 24, 2025.

#define LEAP_SECONDS = {46828800, 78364801, 109900802, 173059203, 252028804, 315187205, \ 346723206, 393984007, 425520008, 457056009, 504489610, 551750411, \ 599184012, 820108813, 914803214, 1025136015, 1119744016, 1167264017}

The GPS epoch equivalent for each of the announced leap seconds as of February 24, 2025.

Enum documentation

Define documentation