Skip to content

Commit c2cca46

Browse files
aentingeraentinger
authored
Merge pull request #92 from arduino-libraries/cleanup-time-provision
Encapsulate provision of time within one single object
2 parents 278b0eb + 47e0f90 commit c2cca46

8 files changed

+369
-129
lines changed

‎src/ArduinoIoTCloudTCP.cpp

+4-21
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,14 @@
1818

1919
#ifdef HAS_TCP
2020
#include <ArduinoIoTCloudTCP.h>
21+
#include "utility/time/TimeService.h"
2122
#ifdef BOARD_HAS_ECCX08
2223
#include "utility/ECCX08Cert.h"
2324
#include "utility/BearSSLTrustAnchor.h"
2425
#include <ArduinoECCX08.h>
2526
#endif
2627

27-
#ifdef ARDUINO_ARCH_SAMD
28-
#include <RTCZero.h>
29-
RTCZero rtc;
30-
#endif
28+
TimeService time_service;
3129

3230
#ifdef BOARD_HAS_ECCX08
3331
const static int keySlot = 0;
@@ -41,20 +39,7 @@ const static int CONNECT_FAILURE = 0;
4139
const static int CONNECT_FAILURE_SUBSCRIBE = -1;
4240

4341
static unsigned long getTime() {
44-
if (!ArduinoCloud.getConnection()) {
45-
return 0;
46-
}
47-
TcpIpConnectionHandler * connection = ArduinoCloud.getConnection();
48-
unsigned long time = connection->getTime();
49-
Debug.print(DBG_DEBUG, "NTP time: %lu", time);
50-
if (!NTPUtils::isTimeValid(time)) {
51-
Debug.print(DBG_ERROR, "Bogus NTP time from API, fallback to UDP method");
52-
time = NTPUtils(connection->getUDP()).getTime();
53-
}
54-
#ifdef ARDUINO_ARCH_SAMD
55-
rtc.setEpoch(time);
56-
#endif
57-
return time;
42+
return time_service.getTime();
5843
}
5944

6045
ArduinoIoTCloudTCP::ArduinoIoTCloudTCP():
@@ -92,9 +77,7 @@ int ArduinoIoTCloudTCP::begin(TcpIpConnectionHandler & connection, String broker
9277
_connection = &connection;
9378
_brokerAddress = brokerAddress;
9479
_brokerPort = brokerPort;
95-
#ifdef ARDUINO_ARCH_SAMD
96-
rtc.begin();
97-
#endif
80+
time_service.begin(&connection);
9881
return begin(_connection->getClient(), _brokerAddress, _brokerPort);
9982
}
10083

‎src/ArduinoIoTCloudTCP.h

-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@
3030

3131
#include <ArduinoMqttClient.h>
3232

33-
#include "utility/NTPUtils.h"
34-
3533

3634
static char const DEFAULT_BROKER_ADDRESS_SECURE_AUTH[] = "mqtts-sa.iot.arduino.cc";
3735
static uint16_t const DEFAULT_BROKER_PORT_SECURE_AUTH = 8883;

‎src/utility/NTPUtils.cpp

-83
This file was deleted.

‎src/utility/NTPUtils.h

-23
This file was deleted.

‎src/utility/time/NTPUtils.cpp

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
/*
2+
This file is part of ArduinoIoTCloud.
3+
4+
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
5+
6+
This software is released under the GNU General Public License version 3,
7+
which covers the main part of arduino-cli.
8+
The terms of this license can be found at:
9+
https://www.gnu.org/licenses/gpl-3.0.en.html
10+
11+
You can be released from the requirements of the above licenses by purchasing
12+
a commercial license. Buying such a license is mandatory if you want to modify or
13+
otherwise use the software for commercial activities involving the Arduino
14+
software without disclosing the source code of your own applications. To purchase
15+
a commercial license, send an email to [email protected].
16+
*/
17+
18+
/**************************************************************************************
19+
* INCLUDE
20+
**************************************************************************************/
21+
22+
#include "../../ArduinoIoTCloud_Defines.h"
23+
#ifndef HAS_LORA
24+
25+
#include "NTPUtils.h"
26+
27+
#include <Arduino.h>
28+
29+
/**************************************************************************************
30+
* PUBLIC MEMBER FUNCTIONS
31+
**************************************************************************************/
32+
33+
unsigned long NTPUtils::getTime(UDP & udp)
34+
{
35+
udp.begin(NTP_LOCAL_PORT);
36+
37+
sendNTPpacket(udp);
38+
39+
bool is_timeout = false;
40+
unsigned long const start = millis();
41+
do
42+
{
43+
is_timeout = (millis() - start) >= NTP_TIMEOUT_MS;
44+
} while(!is_timeout && !udp.parsePacket());
45+
46+
if(is_timeout) {
47+
udp.stop();
48+
return 0;
49+
}
50+
51+
uint8_t ntp_packet_buf[NTP_PACKET_SIZE];
52+
udp.read(ntp_packet_buf, NTP_PACKET_SIZE);
53+
udp.stop();
54+
55+
unsigned long const highWord = word(ntp_packet_buf[40], ntp_packet_buf[41]);
56+
unsigned long const lowWord = word(ntp_packet_buf[42], ntp_packet_buf[43]);
57+
unsigned long const secsSince1900 = highWord << 16 | lowWord;
58+
unsigned long const seventyYears = 2208988800UL;
59+
unsigned long const epoch = secsSince1900 - seventyYears;
60+
61+
return epoch;
62+
}
63+
64+
/**************************************************************************************
65+
* PRIVATE MEMBER FUNCTIONS
66+
**************************************************************************************/
67+
68+
void NTPUtils::sendNTPpacket(UDP & udp)
69+
{
70+
uint8_t ntp_packet_buf[NTP_PACKET_SIZE] = {0};
71+
72+
ntp_packet_buf[0] = 0b11100011;
73+
ntp_packet_buf[1] = 0;
74+
ntp_packet_buf[2] = 6;
75+
ntp_packet_buf[3] = 0xEC;
76+
ntp_packet_buf[12] = 49;
77+
ntp_packet_buf[13] = 0x4E;
78+
ntp_packet_buf[14] = 49;
79+
ntp_packet_buf[15] = 52;
80+
81+
udp.beginPacket(NTP_TIME_SERVER, NTP_TIME_SERVER_PORT);
82+
udp.write(ntp_packet_buf, NTP_PACKET_SIZE);
83+
udp.endPacket();
84+
}
85+
86+
#endif /* #ifndef HAS_LORA */

‎src/utility/time/NTPUtils.h

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/*
2+
This file is part of ArduinoIoTCloud.
3+
4+
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
5+
6+
This software is released under the GNU General Public License version 3,
7+
which covers the main part of arduino-cli.
8+
The terms of this license can be found at:
9+
https://www.gnu.org/licenses/gpl-3.0.en.html
10+
11+
You can be released from the requirements of the above licenses by purchasing
12+
a commercial license. Buying such a license is mandatory if you want to modify or
13+
otherwise use the software for commercial activities involving the Arduino
14+
software without disclosing the source code of your own applications. To purchase
15+
a commercial license, send an email to [email protected].
16+
*/
17+
18+
#ifndef __NTP_UTILS__
19+
#define __NTP_UTILS__
20+
21+
#include "../../ArduinoIoTCloud_Defines.h"
22+
#ifndef HAS_LORA
23+
24+
/*
25+
This Utility Class is derived from the example code found here https://www.arduino.cc/en/Tutorial/UdpNTPClient
26+
For more information on NTP (Network Time Protocol) you can refer to this Wikipedia article https://en.wikipedia.org/wiki/Network_Time_Protocol
27+
*/
28+
29+
/**************************************************************************************
30+
* INCLUDE
31+
**************************************************************************************/
32+
33+
#include <Udp.h>
34+
35+
/**************************************************************************************
36+
* CLASS DECLARATION
37+
**************************************************************************************/
38+
39+
class NTPUtils
40+
{
41+
public:
42+
43+
static unsigned long getTime(UDP & udp);
44+
45+
private:
46+
47+
static size_t const NTP_PACKET_SIZE = 48;
48+
static int const NTP_TIME_SERVER_PORT = 123;
49+
static int const NTP_LOCAL_PORT = 8888;
50+
static unsigned long const NTP_TIMEOUT_MS = 1000;
51+
static char constexpr * NTP_TIME_SERVER = "time.arduino.cc";
52+
53+
static void sendNTPpacket(UDP & udp);
54+
55+
};
56+
57+
#endif /* #ifndef HAS_LORA */
58+
59+
#endif

0 commit comments

Comments
 (0)