2 * Copyright 2017 Jonathan McDowell <noodles@earth.li>
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 * NTP code based on https://github.com/raburton/esp8266/tree/master/ntp
18 * Those portions MIT licensed:
20 * Copyright (c) 2015 Richard A Burton (richardaburton@gmail.com)
22 * Permission is hereby granted, free of charge, to any person obtaining a copy
23 * of this software and associated documentation files (the "Software"), to deal
24 * in the Software without restriction, including without limitation the rights
25 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
26 * copies of the Software, and to permit persons to whom the Software is
27 * furnished to do so, subject to the following conditions:
29 * The above copyright notice and this permission notice shall be included in
30 * all copies or substantial portions of the Software.
32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
42 #include <user_interface.h>
49 #define NTP_SERVER "uk.pool.ntp.org"
50 #define NTP_TIMEOUT_MS 5000
52 static uint32_t sys_last_ticks;
53 static uint32_t sys_delta;
54 static os_timer_t ntp_timeout;
56 static ip_addr_t ntp_server_ip;
73 void ICACHE_FLASH_ATTR set_time(uint32_t now)
75 sys_last_ticks = system_get_time();
76 sys_delta = now - (sys_last_ticks / 1000000);
79 uint32_t ICACHE_FLASH_ATTR get_time(void)
83 sys_ticks = system_get_time();
84 if (sys_ticks < sys_last_ticks) {
85 sys_delta += (1ULL << 32ULL) / 1000000;
87 sys_last_ticks = sys_ticks;
89 return sys_ticks / 1000000 + sys_delta;
92 bool ICACHE_FLASH_ATTR is_leap(uint32_t year)
94 return year % 4 == 0 && (year % 100 != 0 || year % 400 == 0);
97 bool ICACHE_FLASH_ATTR is_dst(struct tm *time)
99 int lastsun = time->tm_mday - time->tm_wday;
101 if (time->tm_mon < 2 || time->tm_mon > 9)
103 if (time->tm_mon > 2 && time->tm_mon < 9)
107 * Starts last Sunday in March, ends last Sunday in October, which must
108 * be at least the 25th of the month. So must be past that in March, or
109 * before that in October, to be in DST.
111 if (time->tm_mon == 2)
112 return (lastsun >= 25);
113 if (time->tm_mon == 9)
114 return (lastsun < 25);
120 * Takes time, a Unix time (seconds since 1st Jan 1970) and breaks it down to:
133 * tm_wday Sunday = 0, Saturday = 6
136 void ICACHE_FLASH_ATTR breakdown_time(uint32_t time, struct tm *result)
138 uint32_t era, doe, yoe, mp;
140 /* Do the time component */
141 result->tm_sec = time % 60;
143 result->tm_min = time % 60;
145 result->tm_hour = time % 24;
148 /* Now time is the number of days since 1970-01-01 (a Thursday) */
149 result->tm_wday = (time + 4) % 7;
151 /* Below from http://howardhinnant.github.io/date_algorithms.html */
154 doe = time - era * 146097;
155 yoe = (doe - doe / 1460 + doe / 36524 - doe / 146096) / 365;
157 result->tm_year = yoe + era * 400;
158 result->tm_yday = doe - (365 * yoe + yoe / 4 - yoe / 100);
159 mp = (5 * result->tm_yday + 2) / 153;
160 result->tm_mday = result->tm_yday - (153 * mp + 2) / 5 + 1;
161 result->tm_mon = mp + (mp < 10 ? 2 : -10);
162 if (result->tm_mon <= 2)
165 /* result->tm_yday is March 1st indexed at this point; fix up */
166 result->tm_yday += 28 + 31;
167 if (is_leap(result->tm_year))
170 result->tm_isdst = is_dst(result);
171 if (result->tm_isdst)
173 if (result->tm_hour > 23) {
175 * We can ignore fixing up the date at the end of month etc.
176 * because all we're actually displaying is the time.
185 static void ICACHE_FLASH_ATTR ntp_udp_timeout(void *arg)
187 struct espconn *pCon = (struct espconn *) arg;
189 os_timer_disarm(&ntp_timeout);
190 os_printf("NTP timeout.\n");
192 // clean up connection
194 espconn_delete(pCon);
195 os_free(pCon->proto.udp);
201 static void ICACHE_FLASH_ATTR ntp_udp_recv(void *arg, char *pdata,
204 struct espconn *pCon = (struct espconn *) arg;
209 os_printf("Got NTP response.\n");
211 os_timer_disarm(&ntp_timeout);
214 ntp = (ntp_t *) pdata;
215 timestamp = ntp->trans_time[0] << 24 | ntp->trans_time[1] << 16 |
216 ntp->trans_time[2] << 8 | ntp->trans_time[3];
217 // NTP 0 is 1st Jan 1900; convert to Unix time 0 of 1st Jan 1970
218 timestamp -= 2208988800ULL;
224 breakdown_time(timestamp, &dt);
225 os_printf("%04d-%02d-%02d %02d:%02d:%02d (%u)\r\n",
226 dt.tm_year, dt.tm_mon + 1, dt.tm_mday,
227 dt.tm_hour, dt.tm_min, dt.tm_sec, timestamp);
229 // clean up connection
231 espconn_delete(pCon);
232 os_free(pCon->proto.udp);
238 void ICACHE_FLASH_ATTR ntp_got_dns(const char *name, ip_addr_t *ip, void *arg)
241 struct espconn *pCon = (struct espconn *) arg;
244 os_printf("NTP DNS request failed.\n");
249 os_printf("Sending NTP request.\n");
251 // Set up the UDP "connection"
252 pCon->type = ESPCONN_UDP;
253 pCon->state = ESPCONN_NONE;
254 pCon->proto.udp = (esp_udp *) os_zalloc(sizeof(esp_udp));
255 pCon->proto.udp->local_port = espconn_port();
256 pCon->proto.udp->remote_port = 123;
257 os_memcpy(pCon->proto.udp->remote_ip, &ip->addr, 4);
259 // Create a really simple NTP request packet
260 os_memset(&ntp, 0, sizeof(ntp_t));
261 ntp.options = 0b00100011; // leap = 0, version = 4, mode = 3 (client)
264 os_timer_disarm(&ntp_timeout);
265 os_timer_setfn(&ntp_timeout, (os_timer_func_t*) ntp_udp_timeout, pCon);
266 os_timer_arm(&ntp_timeout, NTP_TIMEOUT_MS, 0);
268 // Send the NTP request
269 espconn_create(pCon);
270 espconn_regist_recvcb(pCon, ntp_udp_recv);
271 espconn_sent(pCon, (uint8_t *) &ntp, sizeof(ntp_t));
274 void ICACHE_FLASH_ATTR ntp_get_time(void)
276 struct espconn *pCon = NULL;
278 os_printf("Sending DNS request for NTP server.\n");
279 pCon = (struct espconn *) os_zalloc(sizeof(struct espconn));
280 espconn_gethostbyname(pCon, NTP_SERVER, &ntp_server_ip, ntp_got_dns);
283 void ICACHE_FLASH_ATTR rtc_init(void)
285 sys_last_ticks = system_get_time();