A time interface class. This class replicates the normal time functions, but goes a couple of steps further. mbed library 82 and prior has a defective gmtime function. Also, this class enables access to setting the time, and adjusting the accuracy of the RTC.
Dependents: CI-data-logger-server WattEye X10Svr SSDP_Server
TimeInterface.h@8:18489e877b0b, 2016-03-26 (annotated)
- Committer:
- WiredHome
- Date:
- Sat Mar 26 20:36:02 2016 +0000
- Revision:
- 8:18489e877b0b
- Parent:
- 6:c79cfe750416
- Child:
- 10:5734dbc2f5cc
- Child:
- 12:a77f1e9e42b3
Minor update to documentation only, to improve understanding of APIs that are UTC vs. localtime.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
WiredHome | 0:61112ca9193b | 1 | |
WiredHome | 0:61112ca9193b | 2 | #ifndef TIMEINTERFACE_H |
WiredHome | 0:61112ca9193b | 3 | #define TIMEINTERFACE_H |
WiredHome | 0:61112ca9193b | 4 | #include "mbed.h" |
WiredHome | 4:9cae2da8215e | 5 | #include <ctime> |
WiredHome | 0:61112ca9193b | 6 | |
WiredHome | 6:c79cfe750416 | 7 | #include "NTPClient.h" // ver 7 Wiredhome from ver 5 Donatien Garnier |
WiredHome | 2:65e0a25c7551 | 8 | |
WiredHome | 0:61112ca9193b | 9 | // Special Registers and their usage: |
WiredHome | 0:61112ca9193b | 10 | // GPREG0: 32 bits |
WiredHome | 0:61112ca9193b | 11 | // low word: time zone offset (-720 to +720) |
WiredHome | 0:61112ca9193b | 12 | // high word: 2's complement of low word for integrity checking |
WiredHome | 0:61112ca9193b | 13 | // GPREG1: 32 bits |
WiredHome | 0:61112ca9193b | 14 | // time_t value when the clock was last set |
WiredHome | 0:61112ca9193b | 15 | |
WiredHome | 0:61112ca9193b | 16 | |
WiredHome | 0:61112ca9193b | 17 | extern "C" { |
WiredHome | 0:61112ca9193b | 18 | #include "time.h" |
WiredHome | 0:61112ca9193b | 19 | } |
WiredHome | 0:61112ca9193b | 20 | |
WiredHome | 0:61112ca9193b | 21 | struct tm_ex |
WiredHome | 0:61112ca9193b | 22 | { |
WiredHome | 0:61112ca9193b | 23 | int tm_sec; ///<! seconds, 0 to 59. |
WiredHome | 0:61112ca9193b | 24 | int tm_min; ///<! minutes, 0 to 59. |
WiredHome | 0:61112ca9193b | 25 | int tm_hour; ///<! hours, 0 to 23. |
WiredHome | 0:61112ca9193b | 26 | int tm_mday; ///<! monthday 1 to 31. |
WiredHome | 0:61112ca9193b | 27 | int tm_mon; ///<! month 0 to 11. |
WiredHome | 0:61112ca9193b | 28 | int tm_year; ///<! years since 1900. |
WiredHome | 0:61112ca9193b | 29 | int tm_wday; ///<! days since sunday 0 to 6. |
WiredHome | 0:61112ca9193b | 30 | int tm_yday; ///<! days since 1 Jan 0 to 365. |
WiredHome | 0:61112ca9193b | 31 | int tm_isdst; ///<! is daylight savings time. |
WiredHome | 0:61112ca9193b | 32 | int tm_tzo_min; ///<! localtime zone offset in minutes |
WiredHome | 0:61112ca9193b | 33 | }; |
WiredHome | 0:61112ca9193b | 34 | |
WiredHome | 0:61112ca9193b | 35 | /// TimeInterface class is much like the normal c-style time.h |
WiredHome | 0:61112ca9193b | 36 | /// interface, but is extended with time-zone support, and |
WiredHome | 0:61112ca9193b | 37 | /// clock-adjustment support (which permits tuning the clock) |
WiredHome | 0:61112ca9193b | 38 | /// for more accuracy. |
WiredHome | 0:61112ca9193b | 39 | /// |
WiredHome | 0:61112ca9193b | 40 | /// Within this class are the normal time.h methods, simply |
WiredHome | 0:61112ca9193b | 41 | /// exposed here for one consistent interface. |
WiredHome | 0:61112ca9193b | 42 | /// |
WiredHome | 0:61112ca9193b | 43 | /// @note This class uses the special battery backed registers |
WiredHome | 0:61112ca9193b | 44 | /// GPREG0 and GPREG1 for TimeInterface data. |
WiredHome | 0:61112ca9193b | 45 | /// |
WiredHome | 0:61112ca9193b | 46 | /// @note In mbed library ver 84, the gmtime method is defective, |
WiredHome | 0:61112ca9193b | 47 | /// and calls to this function return junk data. The |
WiredHome | 0:61112ca9193b | 48 | /// gmtime method in this library actually uses localtime, |
WiredHome | 0:61112ca9193b | 49 | /// but manages the time-zone offset as it does so. |
WiredHome | 0:61112ca9193b | 50 | /// |
WiredHome | 0:61112ca9193b | 51 | class TimeInterface |
WiredHome | 0:61112ca9193b | 52 | { |
WiredHome | 0:61112ca9193b | 53 | public: |
WiredHome | 0:61112ca9193b | 54 | TimeInterface(); |
WiredHome | 0:61112ca9193b | 55 | |
WiredHome | 0:61112ca9193b | 56 | ~TimeInterface(); |
WiredHome | 0:61112ca9193b | 57 | |
WiredHome | 0:61112ca9193b | 58 | /// Gets the system elapsed time in CLOCKS_PER_SEC tics. |
WiredHome | 0:61112ca9193b | 59 | /// |
WiredHome | 0:61112ca9193b | 60 | /// Divide the returned value by CLOCKS_PER_SEC to get time in seconds. |
WiredHome | 0:61112ca9193b | 61 | /// |
WiredHome | 0:61112ca9193b | 62 | /// @code |
WiredHome | 0:61112ca9193b | 63 | /// clock_t tstart, tend; |
WiredHome | 0:61112ca9193b | 64 | /// tstart = clock(); |
WiredHome | 0:61112ca9193b | 65 | /// // do something long |
WiredHome | 0:61112ca9193b | 66 | /// tend = clock(); |
WiredHome | 0:61112ca9193b | 67 | /// printf("Elapsed time is %5.3f\r\n", (float)(tend - tstart)/CLOCKS_PER_SEC); |
WiredHome | 0:61112ca9193b | 68 | /// @endcode |
WiredHome | 0:61112ca9193b | 69 | /// |
WiredHome | 0:61112ca9193b | 70 | /// @returns elapsed tics. |
WiredHome | 0:61112ca9193b | 71 | /// |
WiredHome | 0:61112ca9193b | 72 | clock_t clock(void); |
WiredHome | 0:61112ca9193b | 73 | |
WiredHome | 8:18489e877b0b | 74 | /// Gets the current time as a UTC time value, optionally writing it |
WiredHome | 0:61112ca9193b | 75 | /// to a provided buffer. |
WiredHome | 0:61112ca9193b | 76 | /// |
WiredHome | 8:18489e877b0b | 77 | /// This reads the real time clock and returns the current UTC time. |
WiredHome | 0:61112ca9193b | 78 | /// |
WiredHome | 0:61112ca9193b | 79 | /// @code |
WiredHome | 0:61112ca9193b | 80 | /// time_t t_ref1, t_ref2, t_ref3; |
WiredHome | 0:61112ca9193b | 81 | /// t_ref1 = time(NULL); t_ref2 = t.time(); t.time(&t_ref3); |
WiredHome | 0:61112ca9193b | 82 | /// @endcode |
WiredHome | 0:61112ca9193b | 83 | /// |
WiredHome | 8:18489e877b0b | 84 | /// @param[in,out] timer is an optional pointer to a time_t value that will be written. |
WiredHome | 0:61112ca9193b | 85 | /// This pointer is ignored when NULL. |
WiredHome | 8:18489e877b0b | 86 | /// @returns the UTC time value. |
WiredHome | 0:61112ca9193b | 87 | /// |
WiredHome | 0:61112ca9193b | 88 | time_t time(time_t * timer = NULL); |
WiredHome | 0:61112ca9193b | 89 | |
WiredHome | 8:18489e877b0b | 90 | /// Gets the current time as a LOCAL time value, optionally writing it |
WiredHome | 1:2ee90f546f54 | 91 | /// to a provided buffer. |
WiredHome | 1:2ee90f546f54 | 92 | /// |
WiredHome | 1:2ee90f546f54 | 93 | /// This reads the real time clock and returns the current time, adjusted |
WiredHome | 6:c79cfe750416 | 94 | /// for the local timezone and daylight savings time. |
WiredHome | 1:2ee90f546f54 | 95 | /// |
WiredHome | 1:2ee90f546f54 | 96 | /// @code |
WiredHome | 1:2ee90f546f54 | 97 | /// time_t t_ref2, t_ref3; |
WiredHome | 1:2ee90f546f54 | 98 | /// t_ref2 = t.time(); t.timelocal(&t_ref3); |
WiredHome | 1:2ee90f546f54 | 99 | /// @endcode |
WiredHome | 1:2ee90f546f54 | 100 | /// |
WiredHome | 8:18489e877b0b | 101 | /// @param[in,out] timer is an optional pointer to a time_t value that will be written. |
WiredHome | 1:2ee90f546f54 | 102 | /// This pointer is ignored when NULL. |
WiredHome | 8:18489e877b0b | 103 | /// @returns the LOCAL time value (UTC adjusted for the LOCAL time zone). |
WiredHome | 1:2ee90f546f54 | 104 | /// |
WiredHome | 1:2ee90f546f54 | 105 | time_t timelocal(time_t * timer = NULL); |
WiredHome | 1:2ee90f546f54 | 106 | |
WiredHome | 0:61112ca9193b | 107 | /// Convert a time value structure into an ASCII printable time Www Mmm dd hh:mm:ss yyyy |
WiredHome | 0:61112ca9193b | 108 | /// |
WiredHome | 0:61112ca9193b | 109 | /// @note Watch out for race conditions as this returns a pointer to a |
WiredHome | 0:61112ca9193b | 110 | /// shared buffer. |
WiredHome | 0:61112ca9193b | 111 | /// @note Unlike the standard ctime function, this version DOES NOT append |
WiredHome | 0:61112ca9193b | 112 | /// a newline character to the buffer. |
WiredHome | 0:61112ca9193b | 113 | /// |
WiredHome | 1:2ee90f546f54 | 114 | /// @param[in] timeptr is a pointer to a tm structure containing the time to convert. |
WiredHome | 0:61112ca9193b | 115 | /// @returns a pointer to a private buffer containing the string. |
WiredHome | 0:61112ca9193b | 116 | /// |
WiredHome | 0:61112ca9193b | 117 | char * ctime(const time_t * timer); |
WiredHome | 0:61112ca9193b | 118 | |
WiredHome | 0:61112ca9193b | 119 | /// Convert a tm structure into an ASCII printable time Www Mmm dd hh:mm:ss yyyy |
WiredHome | 0:61112ca9193b | 120 | /// |
WiredHome | 0:61112ca9193b | 121 | /// @note Watch out for race conditions as this returns a pointer to a |
WiredHome | 0:61112ca9193b | 122 | /// shared buffer. |
WiredHome | 0:61112ca9193b | 123 | /// @note Unlike the standard ctime function, this version DOES NOT append |
WiredHome | 0:61112ca9193b | 124 | /// a newline character to the buffer. |
WiredHome | 0:61112ca9193b | 125 | /// |
WiredHome | 1:2ee90f546f54 | 126 | /// @param[in] timeptr is a pointer to a tm structure containing the time to convert. |
WiredHome | 0:61112ca9193b | 127 | /// @returns a pointer to a private buffer containing the string. |
WiredHome | 0:61112ca9193b | 128 | /// |
WiredHome | 0:61112ca9193b | 129 | char * asctime(const struct tm_ex *timeptr); |
WiredHome | 0:61112ca9193b | 130 | |
WiredHome | 0:61112ca9193b | 131 | /// Compute the difference in seconds between two time values. |
WiredHome | 0:61112ca9193b | 132 | /// |
WiredHome | 1:2ee90f546f54 | 133 | /// @param[in] end is the end time to compare to the beginning time. |
WiredHome | 1:2ee90f546f54 | 134 | /// @param[in] beginning time is compared to the end time. |
WiredHome | 0:61112ca9193b | 135 | /// @return the difference in seconds, as a double. |
WiredHome | 0:61112ca9193b | 136 | /// |
WiredHome | 0:61112ca9193b | 137 | double difftime(time_t end, time_t beginning); |
WiredHome | 0:61112ca9193b | 138 | |
WiredHome | 0:61112ca9193b | 139 | /// Convert the referenced time_t value to a tm structure in UTC/GMT format. |
WiredHome | 0:61112ca9193b | 140 | /// |
WiredHome | 0:61112ca9193b | 141 | /// @note Watch out for race conditions as this returns a pointer to a |
WiredHome | 0:61112ca9193b | 142 | /// shared buffer. |
WiredHome | 0:61112ca9193b | 143 | /// |
WiredHome | 1:2ee90f546f54 | 144 | /// @param[in] timer is a pointer to a time_t structure to convert. |
WiredHome | 0:61112ca9193b | 145 | /// @returns pointer to a tm structure. |
WiredHome | 0:61112ca9193b | 146 | /// |
WiredHome | 0:61112ca9193b | 147 | struct tm_ex * gmtime(const time_t * timer); |
WiredHome | 0:61112ca9193b | 148 | |
WiredHome | 0:61112ca9193b | 149 | |
WiredHome | 0:61112ca9193b | 150 | /// Convert the referenced time_t value to a tm structure in local format. |
WiredHome | 0:61112ca9193b | 151 | /// |
WiredHome | 6:c79cfe750416 | 152 | /// This method leverages the time zone offset applied with @see set_tzo() |
WiredHome | 6:c79cfe750416 | 153 | /// and the daylight savings time flag applied with @see set_dst(). |
WiredHome | 0:61112ca9193b | 154 | /// |
WiredHome | 0:61112ca9193b | 155 | /// @note Watch out for race conditions as this returns a pointer to a |
WiredHome | 0:61112ca9193b | 156 | /// shared buffer. |
WiredHome | 0:61112ca9193b | 157 | /// |
WiredHome | 1:2ee90f546f54 | 158 | /// @param[in] timer is a pointer to a time_t structure to convert. |
WiredHome | 0:61112ca9193b | 159 | /// @returns pointer to a tm structure. |
WiredHome | 0:61112ca9193b | 160 | /// |
WiredHome | 0:61112ca9193b | 161 | struct tm_ex * localtime(const time_t * timer); |
WiredHome | 0:61112ca9193b | 162 | |
WiredHome | 0:61112ca9193b | 163 | /// Convert a tm_ex structure (an extended time structure) to a time_t |
WiredHome | 0:61112ca9193b | 164 | /// value. |
WiredHome | 0:61112ca9193b | 165 | /// |
WiredHome | 1:2ee90f546f54 | 166 | /// @param[in] timeptr is a pointer to a tm_ex structure. |
WiredHome | 0:61112ca9193b | 167 | /// @returns the computed time_t value. |
WiredHome | 0:61112ca9193b | 168 | /// |
WiredHome | 0:61112ca9193b | 169 | time_t mktime(struct tm_ex * timeptr); |
WiredHome | 0:61112ca9193b | 170 | |
WiredHome | 0:61112ca9193b | 171 | /// Presents a time value in a user specified format, into a user specified buffer. |
WiredHome | 0:61112ca9193b | 172 | /// |
WiredHome | 1:2ee90f546f54 | 173 | /// @param[out] ptr is a pointer to the user buffer. |
WiredHome | 1:2ee90f546f54 | 174 | /// @param[in] maxsize is the size of the user buffer. |
WiredHome | 1:2ee90f546f54 | 175 | /// @param[in] format is a pointer to the special strftime format specification. |
WiredHome | 1:2ee90f546f54 | 176 | /// @param[in] timeptr is a pointer to the tm_ex structure. |
WiredHome | 0:61112ca9193b | 177 | /// @returns the total number of characters copied into the buffer. |
WiredHome | 0:61112ca9193b | 178 | /// |
WiredHome | 0:61112ca9193b | 179 | size_t strftime(char * ptr, size_t maxsize, const char * format, const struct tm_ex * timeptr); |
WiredHome | 0:61112ca9193b | 180 | |
WiredHome | 0:61112ca9193b | 181 | // time zone functions |
WiredHome | 0:61112ca9193b | 182 | |
WiredHome | 8:18489e877b0b | 183 | /// Set the internal RTC (clock) to the time value. |
WiredHome | 8:18489e877b0b | 184 | /// |
WiredHome | 8:18489e877b0b | 185 | /// The time valueshould be UTC time along with an offset of zero, |
WiredHome | 8:18489e877b0b | 186 | /// which then permits gmtime and localtime to be used appropriately. |
WiredHome | 8:18489e877b0b | 187 | /// Alternately, the time can be in localtime, and the offset is then |
WiredHome | 8:18489e877b0b | 188 | /// used to compute UTC to set the clock. |
WiredHome | 0:61112ca9193b | 189 | /// |
WiredHome | 2:65e0a25c7551 | 190 | /// @param[in] t should be the UTC time value to set the clock to. If the available |
WiredHome | 0:61112ca9193b | 191 | /// time value is local time, the optional time zone offset can |
WiredHome | 2:65e0a25c7551 | 192 | /// be provided so the system clock is UTC. |
WiredHome | 1:2ee90f546f54 | 193 | /// @param[in] tzo is the optional time zone offset in minutes when it is in |
WiredHome | 0:61112ca9193b | 194 | /// the range of -720 to +720 (-12 hours to + 12 hours). Any |
WiredHome | 0:61112ca9193b | 195 | /// other value is illegal and no change will be made. |
WiredHome | 0:61112ca9193b | 196 | /// |
WiredHome | 0:61112ca9193b | 197 | void set_time(time_t t, int16_t tzo_min = 0); |
WiredHome | 0:61112ca9193b | 198 | |
WiredHome | 0:61112ca9193b | 199 | /// Set the time zone offset in minutes. |
WiredHome | 0:61112ca9193b | 200 | /// |
WiredHome | 0:61112ca9193b | 201 | /// This API should be used before any other methods that fetch |
WiredHome | 0:61112ca9193b | 202 | /// the RTC info. |
WiredHome | 0:61112ca9193b | 203 | /// |
WiredHome | 1:2ee90f546f54 | 204 | /// @param[in] tzo is the time zone offset in minutes when it is in |
WiredHome | 0:61112ca9193b | 205 | /// the range of -720 to +720 (-12 hours to + 12 hours). Any |
WiredHome | 0:61112ca9193b | 206 | /// other value is illegal and no change will be made. |
WiredHome | 0:61112ca9193b | 207 | /// |
WiredHome | 0:61112ca9193b | 208 | void set_tzo_min(int16_t tzo_min); |
WiredHome | 0:61112ca9193b | 209 | |
WiredHome | 0:61112ca9193b | 210 | /// Get the time zone offset in minutes. |
WiredHome | 0:61112ca9193b | 211 | /// |
WiredHome | 0:61112ca9193b | 212 | /// @returns the time zone offset value in minutes. If the tzo was |
WiredHome | 0:61112ca9193b | 213 | /// never initialized, this returns zero. |
WiredHome | 0:61112ca9193b | 214 | /// |
WiredHome | 0:61112ca9193b | 215 | int16_t get_tzo_min(void); |
WiredHome | 0:61112ca9193b | 216 | |
WiredHome | 3:49f36b489b64 | 217 | /// Set the clock for local time to report whether the current |
WiredHome | 3:49f36b489b64 | 218 | /// mode is standard or daylight savings time. |
WiredHome | 3:49f36b489b64 | 219 | /// |
WiredHome | 3:49f36b489b64 | 220 | /// return values for localtime will then be adjusted not only |
WiredHome | 3:49f36b489b64 | 221 | /// for the time zone offset, but for dst. |
WiredHome | 3:49f36b489b64 | 222 | /// |
WiredHome | 3:49f36b489b64 | 223 | /// @param[in] dst is a boolean that should be set when dst is |
WiredHome | 3:49f36b489b64 | 224 | /// the active mode. |
WiredHome | 6:c79cfe750416 | 225 | /// @returns true, always. |
WiredHome | 3:49f36b489b64 | 226 | /// |
WiredHome | 6:c79cfe750416 | 227 | bool set_dst(bool dst); |
WiredHome | 6:c79cfe750416 | 228 | |
WiredHome | 6:c79cfe750416 | 229 | /// Set the clock for auto-adjust local time based on |
WiredHome | 6:c79cfe750416 | 230 | /// changing to standard or daylight savings time. |
WiredHome | 6:c79cfe750416 | 231 | /// |
WiredHome | 6:c79cfe750416 | 232 | /// return values for localtime will then be adjusted not only |
WiredHome | 6:c79cfe750416 | 233 | /// for the time zone offset, but for dst. |
WiredHome | 6:c79cfe750416 | 234 | /// |
WiredHome | 6:c79cfe750416 | 235 | /// @param[in] dstStart is a string of the form "mm/dd,hh:mm" |
WiredHome | 6:c79cfe750416 | 236 | /// representing when DST starts. |
WiredHome | 6:c79cfe750416 | 237 | /// @param[in] dstStop is a string of the form "mm/dd,hh:mm" |
WiredHome | 6:c79cfe750416 | 238 | /// representing when DST stops. |
WiredHome | 6:c79cfe750416 | 239 | /// @returns true if the start and stop pair could be successfully |
WiredHome | 6:c79cfe750416 | 240 | /// parsed. |
WiredHome | 6:c79cfe750416 | 241 | /// |
WiredHome | 6:c79cfe750416 | 242 | bool set_dst(const char * dstStart, const char * dstStop); |
WiredHome | 3:49f36b489b64 | 243 | |
WiredHome | 3:49f36b489b64 | 244 | /// Get the current clock mode for daylight savings time. |
WiredHome | 3:49f36b489b64 | 245 | /// |
WiredHome | 3:49f36b489b64 | 246 | /// @returns true if clock is in dst mode. |
WiredHome | 3:49f36b489b64 | 247 | /// |
WiredHome | 3:49f36b489b64 | 248 | bool get_dst(void); |
WiredHome | 3:49f36b489b64 | 249 | |
WiredHome | 0:61112ca9193b | 250 | /// Get the time value when the clock was last set. This is most |
WiredHome | 0:61112ca9193b | 251 | /// often used in calibration of the clock. |
WiredHome | 0:61112ca9193b | 252 | /// |
WiredHome | 0:61112ca9193b | 253 | /// @returns time last set as a UTC time value. |
WiredHome | 0:61112ca9193b | 254 | /// |
WiredHome | 0:61112ca9193b | 255 | time_t get_timelastset(void); |
WiredHome | 0:61112ca9193b | 256 | |
WiredHome | 0:61112ca9193b | 257 | /// get_cal will return the calibration register value |
WiredHome | 0:61112ca9193b | 258 | /// |
WiredHome | 0:61112ca9193b | 259 | /// This is the raw register value as a signed 32-bit value (even though |
WiredHome | 0:61112ca9193b | 260 | /// it is actually a 17-bit unsigned value with an additional 'direction' flag). |
WiredHome | 0:61112ca9193b | 261 | /// |
WiredHome | 0:61112ca9193b | 262 | /// @returns calibration settings ranging from -131071 to +131071 |
WiredHome | 0:61112ca9193b | 263 | /// |
WiredHome | 0:61112ca9193b | 264 | int32_t get_cal(); |
WiredHome | 0:61112ca9193b | 265 | |
WiredHome | 0:61112ca9193b | 266 | /// set_cal will set the calibration register value |
WiredHome | 0:61112ca9193b | 267 | /// |
WiredHome | 0:61112ca9193b | 268 | /// This accepts a signed value to be used to set the calibration |
WiredHome | 0:61112ca9193b | 269 | /// registers. Setting the calibration value to zero disables the |
WiredHome | 0:61112ca9193b | 270 | /// calibration function. |
WiredHome | 0:61112ca9193b | 271 | /// |
WiredHome | 0:61112ca9193b | 272 | /// It is important to know the register function in order to use |
WiredHome | 0:61112ca9193b | 273 | /// this command, and this API is normally not used by external |
WiredHome | 0:61112ca9193b | 274 | /// application code. @See AdjustBySeconds for a user-friendly |
WiredHome | 0:61112ca9193b | 275 | /// API. |
WiredHome | 0:61112ca9193b | 276 | /// |
WiredHome | 1:2ee90f546f54 | 277 | /// @param[in] calibration value to use ranging from -131071 to +131071 |
WiredHome | 0:61112ca9193b | 278 | /// @returns nothing |
WiredHome | 0:61112ca9193b | 279 | /// |
WiredHome | 0:61112ca9193b | 280 | void set_cal(int32_t calibration); |
WiredHome | 0:61112ca9193b | 281 | |
WiredHome | 0:61112ca9193b | 282 | /// adjust_sec adjusts both the time and the calibration by seconds |
WiredHome | 0:61112ca9193b | 283 | /// |
WiredHome | 0:61112ca9193b | 284 | /// This will take a signed value, which is the current adjustment in seconds |
WiredHome | 0:61112ca9193b | 285 | /// to put the clock on the correct time. So, if the clock is behind by |
WiredHome | 0:61112ca9193b | 286 | /// 3 seconds, the value should be +3 to advance the clock accordingly. |
WiredHome | 0:61112ca9193b | 287 | /// It will then adjust the time, and it will attempt to adjust the |
WiredHome | 0:61112ca9193b | 288 | /// calibration factor to make the time more accurate. |
WiredHome | 0:61112ca9193b | 289 | /// |
WiredHome | 0:61112ca9193b | 290 | /// The adjustment can only be made if it has retained when the clock was |
WiredHome | 0:61112ca9193b | 291 | /// last set, in order to know by how much to adjust it. It is also most |
WiredHome | 0:61112ca9193b | 292 | /// accurate if several days have elapsed since the time was set. |
WiredHome | 0:61112ca9193b | 293 | /// |
WiredHome | 0:61112ca9193b | 294 | /// @note The current version only works if the calibration value |
WiredHome | 0:61112ca9193b | 295 | /// is zero when this adjustment is made. |
WiredHome | 0:61112ca9193b | 296 | /// |
WiredHome | 1:2ee90f546f54 | 297 | /// @param[in] adjustSeconds is the signed value by which to adjust the time to |
WiredHome | 0:61112ca9193b | 298 | /// correct it to the current actual time. |
WiredHome | 0:61112ca9193b | 299 | /// @returns true if the adjustment was made |
WiredHome | 0:61112ca9193b | 300 | /// @returns false if the adjustment could not be made |
WiredHome | 0:61112ca9193b | 301 | /// |
WiredHome | 0:61112ca9193b | 302 | bool adjust_sec(int32_t adjustSeconds); |
WiredHome | 0:61112ca9193b | 303 | |
WiredHome | 2:65e0a25c7551 | 304 | /// Set the clock from an internet source (blocking) |
WiredHome | 2:65e0a25c7551 | 305 | /// |
WiredHome | 2:65e0a25c7551 | 306 | /// This function is the interface to NTPClient. |
WiredHome | 2:65e0a25c7551 | 307 | /// Blocks until completion |
WiredHome | 2:65e0a25c7551 | 308 | /// |
WiredHome | 2:65e0a25c7551 | 309 | /// @param[in] host NTP server IPv4 address or hostname (will be resolved via DNS) |
WiredHome | 2:65e0a25c7551 | 310 | /// @param[in] port port to use; defaults to 123 |
WiredHome | 2:65e0a25c7551 | 311 | /// @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended) |
WiredHome | 2:65e0a25c7551 | 312 | /// @return 0 on success, NTP error code (<0) on failure |
WiredHome | 2:65e0a25c7551 | 313 | /// |
WiredHome | 2:65e0a25c7551 | 314 | NTPResult setTime(const char* host, uint16_t port = NTP_DEFAULT_PORT, uint32_t timeout = NTP_DEFAULT_TIMEOUT); |
WiredHome | 2:65e0a25c7551 | 315 | |
WiredHome | 2:65e0a25c7551 | 316 | // ntp interface functions |
WiredHome | 0:61112ca9193b | 317 | private: |
WiredHome | 6:c79cfe750416 | 318 | typedef struct { |
WiredHome | 6:c79cfe750416 | 319 | uint8_t MM; |
WiredHome | 6:c79cfe750416 | 320 | uint8_t DD; |
WiredHome | 6:c79cfe750416 | 321 | uint8_t hh; |
WiredHome | 6:c79cfe750416 | 322 | uint8_t mm; |
WiredHome | 6:c79cfe750416 | 323 | } dst_event_t; |
WiredHome | 6:c79cfe750416 | 324 | typedef struct { |
WiredHome | 6:c79cfe750416 | 325 | dst_event_t dst_start; |
WiredHome | 6:c79cfe750416 | 326 | dst_event_t dst_stop; |
WiredHome | 6:c79cfe750416 | 327 | } dst_event_pair_t; |
WiredHome | 6:c79cfe750416 | 328 | |
WiredHome | 6:c79cfe750416 | 329 | bool parseDSTstring(dst_event_t * result, const char * dstr); |
WiredHome | 6:c79cfe750416 | 330 | |
WiredHome | 6:c79cfe750416 | 331 | /// Performs a "simple" computation of two dates into minutes. |
WiredHome | 6:c79cfe750416 | 332 | /// |
WiredHome | 6:c79cfe750416 | 333 | /// Does not account for leap years or which month it is. Is |
WiredHome | 6:c79cfe750416 | 334 | /// useful only for comparing which date/time came first, not for |
WiredHome | 6:c79cfe750416 | 335 | /// computing the difference between them. |
WiredHome | 6:c79cfe750416 | 336 | /// |
WiredHome | 6:c79cfe750416 | 337 | /// @return "normalized" minutes since Jan 1 00:00. |
WiredHome | 6:c79cfe750416 | 338 | /// |
WiredHome | 6:c79cfe750416 | 339 | uint32_t minutesSinceJan(int mon, int day, int hr, int min); |
WiredHome | 6:c79cfe750416 | 340 | |
WiredHome | 6:c79cfe750416 | 341 | dst_event_pair_t dst_pair; |
WiredHome | 6:c79cfe750416 | 342 | bool dst; // true in dst mode |
WiredHome | 0:61112ca9193b | 343 | char result[30]; // holds the converted to text time string |
WiredHome | 0:61112ca9193b | 344 | time_t tresult; // holds the converted time structure. |
WiredHome | 0:61112ca9193b | 345 | struct tm_ex tm_ext; |
WiredHome | 0:61112ca9193b | 346 | }; |
WiredHome | 0:61112ca9193b | 347 | |
WiredHome | 0:61112ca9193b | 348 | #endif // TIMEINTERFACE_H |