TimeService update/refactor #353

pennam · 2023-02-16T13:40:44Z

TCP boards

NTP sync is enabled by default with 24h interval from startup. Interval can be configured calling:

TimeService.setSyncInterval(unsigned long seconds);

To force and trigger a manual sync call:

TimeServicesync();

LoRa boards

At boot EPOCH_AT_COMPILE_TIME is stored inside RTC. To change its value afterwards is possible to call:

TimeSerivce.setTime(unsigned long time )

If a time source is available is possible to configure a custom sync function that will be called periodically (each 24h by default) by the TimeSerivceClass.

TimeService.setSyncFunction(syncTimeFunctionPtr sync_func);

Tests and benchmarks

Board	Update time	NTP sync time
NANO RP 2040 Connect	80-180ms	250ms
MKR WIFi 1010	70-140ms	250ms
PORTENTA [ETH]	1ms	250ms
PORTENTA [WiFi]	1ms	250ms
ESP32	1ms	40ms
NICLA VISION	1ms	70ms
OPTA [ETH]	1ms	250ms
MKR WAN [DS3232]	2-105ms	1ms
MKR WAN [ETH]	2-105ms	90ms

Tests sketch

/*
  This sketch demonstrates how to exchange data between your board and the Arduino IoT Cloud.

  * Connect a potentiometer (or other analog sensor) to A0.
  * When the potentiometer (or sensor) value changes the data is sent to the Cloud.
  * When you flip the switch in the Cloud dashboard the onboard LED lights gets turned ON or OFF.

  IMPORTANT:
  This sketch works with WiFi, GSM, NB, Ethernet and Lora enabled boards supported by Arduino IoT Cloud.
  On a LoRa board, if it is configured as a class A device (default and preferred option), values from Cloud dashboard are received
  only after a value is sent to Cloud.

  The full list of compatible boards can be found here:
   - https://github.com/arduino-libraries/ArduinoIoTCloud#what
*/

#include "arduino_secrets.h"
#include "thingProperties.h"
#include <TimeLib.h>
#ifdef BOARD_HAS_LORA
#include <SPI.h>
#include <Ethernet.h>
#include <EthernetUdp.h>
#include <Arduino_NTP.h>
byte mac[] = {
  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
};
EthernetUDP Udp;

#include <DS3232RTC.h>
DS3232RTC dsRTC;
#endif

#if !defined(LED_BUILTIN)
static int const LED_BUILTIN = 2;
#endif

#ifdef BOARD_HAS_LORA
unsigned long getTimeFrom() {
  // LoRa + Ethernet -> get time from NTP
  return NTPUtils::getTime(Udp);
  // Lora + DS3232 -> get time from external RTC module
  //return dsRTC.get();
}
#endif

int time_to_print = 0;
int update_start = 0;
int update_end = 0;
int update_time = 0;

void printTime(unsigned long const time) {
  if(hour(time) < 10) {
    Serial.print("0");
  }
  Serial.print(hour(time));
  Serial.print(":");
  if(minute(time) < 10) {
    Serial.print("0");
  }
  Serial.print(minute(time));
  Serial.print(":");
  if(second(time) < 10) {
    Serial.print("0");
  }
  Serial.print(second(time));
  Serial.println("");
}

void setup() {
  /* Initialize serial and wait up to 5 seconds for port to open */
  Serial.begin(9600);
  for(unsigned long const serialBeginTime = millis(); !Serial && (millis() - serialBeginTime > 5000); ) { }

  /* Configure LED pin as an output */
  pinMode(LED_BUILTIN, OUTPUT);

#ifdef BOARD_HAS_LORA
  /* Setup ethernet shield */
  Ethernet.init(5);
  if (Ethernet.begin(mac) == 0) {
    Serial.println("Failed to configure Ethernet using DHCP");
    // Check for Ethernet hardware present
    if (Ethernet.hardwareStatus() == EthernetNoHardware) {
      Serial.println("Ethernet shield was not found.  Sorry, can't run without hardware. :(");
    } else if (Ethernet.linkStatus() == LinkOFF) {
      Serial.println("Ethernet cable is not connected.");
    }
    // no point in carrying on, so do nothing forevermore:
    while (true) {
      delay(1);
    }
  }

  dsRTC.begin();
#endif

  /* This function takes care of connecting your sketch variables to the ArduinoIoTCloud object */
  initProperties();

  /* Initialize Arduino IoT Cloud library */
  ArduinoCloud.begin(ArduinoIoTPreferredConnection);

  /* Setup NTP sync timeout */
  TimeService.setSyncInterval(60);

#ifdef BOARD_HAS_LORA
  TimeService.setSyncFunction(getTimeFrom);
  TimeService.setTimeZoneData(3600, 1679792400);
#endif

  ArduinoCloud.addCallback(ArduinoIoTCloudEvent::SYNC, doThisOnSync);

  setDebugMessageLevel(4);
  ArduinoCloud.printDebugInfo();
}

void loop() {

  update_start = millis();
  ArduinoCloud.update();
  update_end = millis();

  update_time = update_end - update_start;

  local = ArduinoCloud.getLocalTime();
  utc = ArduinoCloud.getInternalTime();

  if(millis() - time_to_print > 1000) {
    printTime(local);
    time_to_print = millis();

    Serial.print("Update execution time: ");
    Serial.println(update_time);
  }

#ifndef BOARD_HAS_LORA
  if(calendar.isActive()) {
    Serial.print("Led is Active: ");
    printTime(local);
  }
#endif
}

#ifndef BOARD_HAS_LORA
/*
 * 'onCalendarChange' is called when the "led" property of your Thing changes
 */
void onCalendarChange() {
  Serial.println("calendar changed:");

  Schedule schedule = calendar.getValue();
  Serial.print("calendar starts: ");
  printTime(schedule.frm);
}
#endif

void doThisOnSync(){
  /* add your custom code here */
  Serial.println("Thing Properties synchronised");
#ifndef BOARD_HAS_LORA
  Schedule schedule = calendar.getValue();
  Serial.print("led frm: ");
  Serial.println(schedule.frm);
  Serial.print("led to: ");
  Serial.println(schedule.to);
  Serial.print("led len: ");
  Serial.println(schedule.len);
  Serial.print("led msk: ");
  Serial.println(schedule.msk);
#endif
}

Rename TimeService into TimeServiceClass and use a more standard way to instantiate it.

github-actions · 2023-02-16T13:59:11Z

Memory usage change @ 3c06977

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nanorp2040connect	🔺 +132 - +149	0.0 - 0.0	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_nicla:nicla_vision	🔺 +80 - +176	0.0 - +0.01	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_opta:opta	🔺 +144 - +176	+0.02 - +0.02	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_portenta:envie_m7	🔺 +80 - +144	+0.01 - +0.02	🔺 +8 - +8	0.0 - 0.0
arduino:samd:mkr1000	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrgsm1400	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrnb1500	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrwan1300	🔺 +192 - +192	+0.07 - +0.07	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrwifi1010	🔺 +152 - +176	+0.06 - +0.07	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:nano_33_iot	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
esp32:esp32:esp32	🔺 +1040 - +7080	+0.08 - +0.54	🔺 +108 - +276	+0.03 - +0.08
esp8266:esp8266:huzzah	🔺 +196 - +200	+0.02 - +0.02	🔺 0 - +12	0.0 - +0.01

Click for full report table

Board	examples/ArduinoIoTCloud-Advanced flash	%	examples/ArduinoIoTCloud-Advanced RAM for global variables	%	examples/ArduinoIoTCloud-Basic flash	%	examples/ArduinoIoTCloud-Basic RAM for global variables	%	examples/utility/ArduinoIoTCloud_Travis_CI flash	%	examples/utility/ArduinoIoTCloud_Travis_CI RAM for global variables	%	examples/utility/Provisioning flash	%	examples/utility/Provisioning RAM for global variables	%	examples/utility/SelfProvisioning flash	%	examples/utility/SelfProvisioning RAM for global variables	%
arduino:mbed_nano:nanorp2040connect	132	0.0	8	0.0	132	0.0	8	0.0	132	0.0	8	0.0	149	0.0	8	0.0	149	0.0	8	0.0
arduino:mbed_nicla:nicla_vision	136	0.01	8	0.0	80	0.0	8	0.0	80	0.0	8	0.0	176	0.01	8	0.0
arduino:mbed_opta:opta	144	0.02	8	0.0	144	0.02	8	0.0	144	0.02	8	0.0	176	0.02	8	0.0
arduino:mbed_portenta:envie_m7	144	0.02	8	0.0	80	0.01	8	0.0	144	0.02	8	0.0	112	0.01	8	0.0
arduino:samd:mkr1000	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrgsm1400	160	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrnb1500	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrwan1300	192	0.07	8	0.02	192	0.07	8	0.02	192	0.07	8	0.02
arduino:samd:mkrwifi1010	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02	176	0.07	8	0.02
arduino:samd:nano_33_iot	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02	168	0.06	8	0.02
esp32:esp32:esp32	7080	0.54	276	0.08	1040	0.08	108	0.03	7032	0.54	276	0.08
esp8266:esp8266:huzzah	196	0.02	0	0.0	200	0.02	12	0.01	200	0.02	4	0.0

Click for full report CSV

Board,examples/ArduinoIoTCloud-Advanced<br>flash,%,examples/ArduinoIoTCloud-Advanced<br>RAM for global variables,%,examples/ArduinoIoTCloud-Basic<br>flash,%,examples/ArduinoIoTCloud-Basic<br>RAM for global variables,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>flash,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>RAM for global variables,%,examples/utility/Provisioning<br>flash,%,examples/utility/Provisioning<br>RAM for global variables,%,examples/utility/SelfProvisioning<br>flash,%,examples/utility/SelfProvisioning<br>RAM for global variables,%
arduino:mbed_nano:nanorp2040connect,132,0.0,8,0.0,132,0.0,8,0.0,132,0.0,8,0.0,149,0.0,8,0.0,149,0.0,8,0.0
arduino:mbed_nicla:nicla_vision,136,0.01,8,0.0,80,0.0,8,0.0,80,0.0,8,0.0,176,0.01,8,0.0,,,,
arduino:mbed_opta:opta,144,0.02,8,0.0,144,0.02,8,0.0,144,0.02,8,0.0,176,0.02,8,0.0,,,,
arduino:mbed_portenta:envie_m7,144,0.02,8,0.0,80,0.01,8,0.0,144,0.02,8,0.0,112,0.01,8,0.0,,,,
arduino:samd:mkr1000,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrgsm1400,160,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrnb1500,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrwan1300,192,0.07,8,0.02,192,0.07,8,0.02,192,0.07,8,0.02,,,,,,,,
arduino:samd:mkrwifi1010,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,176,0.07,8,0.02
arduino:samd:nano_33_iot,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,168,0.06,8,0.02
esp32:esp32:esp32,7080,0.54,276,0.08,1040,0.08,108,0.03,7032,0.54,276,0.08,,,,,,,,
esp8266:esp8266:huzzah,196,0.02,0,0.0,200,0.02,12,0.01,200,0.02,4,0.0,,,,,,,,

github-actions · 2023-02-17T10:16:32Z

Memory usage change @ 77ea16d

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nanorp2040connect	🔺 +132 - +149	0.0 - 0.0	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_nicla:nicla_vision	🔺 +80 - +176	0.0 - +0.01	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_opta:opta	🔺 +144 - +176	+0.02 - +0.02	🔺 +8 - +8	0.0 - 0.0
arduino:mbed_portenta:envie_m7	🔺 +80 - +144	+0.01 - +0.02	🔺 +8 - +8	0.0 - 0.0
arduino:samd:mkr1000	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrgsm1400	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrnb1500	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrwan1300	🔺 +192 - +192	+0.07 - +0.07	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:mkrwifi1010	🔺 +152 - +176	+0.06 - +0.07	🔺 +8 - +8	+0.02 - +0.02
arduino:samd:nano_33_iot	🔺 +152 - +168	+0.06 - +0.06	🔺 +8 - +8	+0.02 - +0.02
esp32:esp32:esp32	🔺 +680 - +724	+0.05 - +0.06	0 - 0	0.0 - 0.0
esp8266:esp8266:huzzah	🔺 +8 - +136	0.0 - +0.01	🔺 0 - +12	0.0 - +0.01

Click for full report table

Board	examples/ArduinoIoTCloud-Advanced flash	%	examples/ArduinoIoTCloud-Advanced RAM for global variables	%	examples/ArduinoIoTCloud-Basic flash	%	examples/ArduinoIoTCloud-Basic RAM for global variables	%	examples/utility/ArduinoIoTCloud_Travis_CI flash	%	examples/utility/ArduinoIoTCloud_Travis_CI RAM for global variables	%	examples/utility/Provisioning flash	%	examples/utility/Provisioning RAM for global variables	%	examples/utility/SelfProvisioning flash	%	examples/utility/SelfProvisioning RAM for global variables	%
arduino:mbed_nano:nanorp2040connect	132	0.0	8	0.0	132	0.0	8	0.0	132	0.0	8	0.0	149	0.0	8	0.0	149	0.0	8	0.0
arduino:mbed_nicla:nicla_vision	136	0.01	8	0.0	80	0.0	8	0.0	80	0.0	8	0.0	176	0.01	8	0.0
arduino:mbed_opta:opta	144	0.02	8	0.0	144	0.02	8	0.0	144	0.02	8	0.0	176	0.02	8	0.0
arduino:mbed_portenta:envie_m7	144	0.02	8	0.0	80	0.01	8	0.0	144	0.02	8	0.0	112	0.01	8	0.0
arduino:samd:mkr1000	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrgsm1400	160	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrnb1500	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02
arduino:samd:mkrwan1300	192	0.07	8	0.02	192	0.07	8	0.02	192	0.07	8	0.02
arduino:samd:mkrwifi1010	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02	176	0.07	8	0.02
arduino:samd:nano_33_iot	152	0.06	8	0.02	152	0.06	8	0.02	152	0.06	8	0.02	168	0.06	8	0.02	168	0.06	8	0.02
esp32:esp32:esp32	724	0.06	0	0.0	680	0.05	0	0.0	688	0.05	0	0.0
esp8266:esp8266:huzzah	8	0.0	0	0.0	136	0.01	12	0.01	12	0.0	4	0.0

Click for full report CSV

Board,examples/ArduinoIoTCloud-Advanced<br>flash,%,examples/ArduinoIoTCloud-Advanced<br>RAM for global variables,%,examples/ArduinoIoTCloud-Basic<br>flash,%,examples/ArduinoIoTCloud-Basic<br>RAM for global variables,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>flash,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>RAM for global variables,%,examples/utility/Provisioning<br>flash,%,examples/utility/Provisioning<br>RAM for global variables,%,examples/utility/SelfProvisioning<br>flash,%,examples/utility/SelfProvisioning<br>RAM for global variables,%
arduino:mbed_nano:nanorp2040connect,132,0.0,8,0.0,132,0.0,8,0.0,132,0.0,8,0.0,149,0.0,8,0.0,149,0.0,8,0.0
arduino:mbed_nicla:nicla_vision,136,0.01,8,0.0,80,0.0,8,0.0,80,0.0,8,0.0,176,0.01,8,0.0,,,,
arduino:mbed_opta:opta,144,0.02,8,0.0,144,0.02,8,0.0,144,0.02,8,0.0,176,0.02,8,0.0,,,,
arduino:mbed_portenta:envie_m7,144,0.02,8,0.0,80,0.01,8,0.0,144,0.02,8,0.0,112,0.01,8,0.0,,,,
arduino:samd:mkr1000,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrgsm1400,160,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrnb1500,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,,,,
arduino:samd:mkrwan1300,192,0.07,8,0.02,192,0.07,8,0.02,192,0.07,8,0.02,,,,,,,,
arduino:samd:mkrwifi1010,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,176,0.07,8,0.02
arduino:samd:nano_33_iot,152,0.06,8,0.02,152,0.06,8,0.02,152,0.06,8,0.02,168,0.06,8,0.02,168,0.06,8,0.02
esp32:esp32:esp32,724,0.06,0,0.0,680,0.05,0,0.0,688,0.05,0,0.0,,,,,,,,
esp8266:esp8266:huzzah,8,0.0,0,0.0,136,0.01,12,0.01,12,0.0,4,0.0,,,,,,,,

pennam added 18 commits February 16, 2023 10:34

Add private and arch specific functions to init/get/set RTC

b3ab0f9

Add RTC implementation based on millis for ESP8266

ec338dd

getTimeFromSting cosmetic changes

bfde58c

Avoid to store EPOCH_AT_COMPILE_TIME inside RTC register

01cc777

Add sync method

e7120b4

Declare and use RTC for ESP8266

c862434

Move includes on top of file

2e48a0e

Extend NTP synch to all platforms

82699bb

Make use of initRTC and sync functions

9471ee0

Make sync interval configurable

ada180c

setTimeZoneData cosmetic changes

8439b01

Fix debug prints reporting the wrong class name

1836f23

Do not build code not compatible with LORA devices

56de2c1

Config RTC for LoRa devices using EPOCH_AT_COMPILE_TIME

7cd0f63

Add function to set internal time

a51b2d5

Add possibility to configure a custom time sync function

c9cfdbe

Switch to TimeServiceClass

fa22ff8

Rename TimeService into TimeServiceClass and use a more standard way to instantiate it.

Check Timezone offset boundaries

3c06977

This was referenced Feb 16, 2023

TimeService update/refactor #318

Closed

Minor: TimeService debug and formatting #302

Closed

per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Feb 16, 2023

NTPUtils use hardware random number generator for ESP boards

77ea16d

pennam requested a review from mirkokurt February 20, 2023 12:30

pennam marked this pull request as ready for review February 20, 2023 12:30

mirkokurt approved these changes Feb 20, 2023

View reviewed changes

pennam merged commit 8784783 into arduino-libraries:master Feb 28, 2023

pennam deleted the time_service_refactor branch May 17, 2024 09:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

TimeService update/refactor #353

TimeService update/refactor #353

Uh oh!

pennam commented Feb 16, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Feb 16, 2023

Uh oh!

github-actions bot commented Feb 17, 2023

Uh oh!

Uh oh!

TimeService update/refactor #353

TimeService update/refactor #353

Uh oh!

Conversation

pennam commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 16, 2023

Uh oh!

github-actions bot commented Feb 17, 2023

Uh oh!

Uh oh!

pennam commented Feb 16, 2023 •

edited

Loading