Date: Sun, 14 Feb 2021 13:29:22 +0100
Subject: [PATCH] Update docs
---
docs/html/ESPNtpClient_8cpp.html | 2 +-
docs/html/ESPNtpClient_8cpp_source.html | 14 +-
docs/html/ESPNtpClient_8h.html | 6 +-
docs/html/ESPNtpClient_8h_source.html | 222 +++++++++---------
docs/html/LICENSE_8md.html | 2 +-
docs/html/NTPEventTypes_8h.html | 2 +-
docs/html/NTPEventTypes_8h_source.html | 2 +-
docs/html/TZdef_8h.html | 2 +-
docs/html/TZdef_8h_source.html | 2 +-
docs/html/advancedExample_8ino.html | 2 +-
docs/html/advancedExample_8ino_source.html | 8 +-
docs/html/annotated.html | 2 +-
docs/html/basicExample_8ino.html | 2 +-
docs/html/basicExample_8ino_source.html | 4 +-
docs/html/classNTPClient-members.html | 125 +++++-----
docs/html/classNTPClient.html | 111 ++++++---
docs/html/classes.html | 2 +-
.../dir_0d6b40dbde7c6c9f2060803eac07ada5.html | 2 +-
.../dir_4ca067c292177ffb05bf07af46c5153e.html | 2 +-
.../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +-
.../dir_85c1138c83e96e3b74bb52bc2e804813.html | 2 +-
.../dir_d28a4824dc47e487b107a5db32ef43c4.html | 2 +-
.../dir_d5c269f8312cfb5985e008c4866477dc.html | 2 +-
docs/html/files.html | 2 +-
docs/html/functions.html | 9 +-
docs/html/functions_func.html | 9 +-
docs/html/functions_vars.html | 2 +-
docs/html/globals.html | 2 +-
docs/html/globals_defs.html | 2 +-
docs/html/globals_enum.html | 2 +-
docs/html/globals_eval.html | 2 +-
docs/html/globals_func.html | 2 +-
docs/html/globals_type.html | 2 +-
docs/html/globals_vars.html | 2 +-
docs/html/index.html | 5 +-
docs/html/ledFlasher_8ino.html | 2 +-
docs/html/ledFlasher_8ino_source.html | 4 +-
docs/html/main_8cpp.html | 2 +-
docs/html/main_8cpp_source.html | 8 +-
docs/html/md_LICENSE.html | 2 +-
docs/html/pages.html | 2 +-
docs/html/readme_8md.html | 2 +-
docs/html/search/all_10.js | 20 +-
docs/html/search/all_11.js | 6 +-
docs/html/search/all_12.js | 4 +-
docs/html/search/all_13.js | 2 +-
docs/html/search/all_14.js | 4 +-
docs/html/search/all_15.js | 2 +-
docs/html/search/all_7.js | 11 +-
docs/html/search/all_8.js | 8 +-
docs/html/search/all_9.js | 20 +-
docs/html/search/all_a.js | 18 +-
docs/html/search/all_b.js | 48 ++--
docs/html/search/all_c.js | 18 +-
docs/html/search/all_d.js | 18 +-
docs/html/search/all_e.js | 24 +-
docs/html/search/all_f.js | 66 +++---
docs/html/search/classes_0.js | 10 +-
docs/html/search/classes_1.js | 4 +-
docs/html/search/defines_0.js | 4 +-
docs/html/search/defines_1.js | 2 +-
docs/html/search/defines_2.js | 2 +-
docs/html/search/defines_3.js | 2 +-
docs/html/search/defines_4.js | 2 +-
docs/html/search/defines_5.js | 4 +-
docs/html/search/enums_0.js | 4 +-
docs/html/search/enumvalues_0.js | 2 +-
docs/html/search/enumvalues_1.js | 2 +-
docs/html/search/enumvalues_2.js | 4 +-
docs/html/search/enumvalues_3.js | 2 +-
docs/html/search/enumvalues_4.js | 4 +-
docs/html/search/enumvalues_5.js | 4 +-
docs/html/search/enumvalues_6.js | 6 +-
docs/html/search/enumvalues_7.js | 2 +-
docs/html/search/enumvalues_8.js | 2 +-
docs/html/search/files_0.js | 2 +-
docs/html/search/files_1.js | 2 +-
docs/html/search/files_2.js | 4 +-
docs/html/search/files_3.js | 4 +-
docs/html/search/files_4.js | 2 +-
docs/html/search/files_5.js | 2 +-
docs/html/search/files_6.js | 2 +-
docs/html/search/files_7.js | 2 +-
docs/html/search/functions_0.js | 2 +-
docs/html/search/functions_1.js | 2 +-
docs/html/search/functions_2.js | 2 +-
docs/html/search/functions_3.js | 4 +-
docs/html/search/functions_4.js | 6 +-
docs/html/search/functions_5.js | 4 +-
docs/html/search/functions_6.js | 31 +--
docs/html/search/functions_7.js | 2 +-
docs/html/search/functions_8.js | 4 +-
docs/html/search/functions_9.js | 2 +-
docs/html/search/functions_a.js | 4 +-
docs/html/search/functions_b.js | 6 +-
docs/html/search/functions_c.js | 30 +--
docs/html/search/functions_d.js | 2 +-
docs/html/search/pages_0.js | 2 +-
docs/html/search/pages_1.html | 36 ---
docs/html/search/pages_1.js | 4 -
docs/html/search/typedefs_0.js | 2 +-
docs/html/search/typedefs_1.js | 2 +-
docs/html/search/variables_0.js | 2 +-
docs/html/search/variables_1.js | 2 +-
docs/html/search/variables_10.js | 2 +-
docs/html/search/variables_2.js | 26 +-
docs/html/search/variables_3.js | 2 +-
docs/html/search/variables_4.js | 8 +-
docs/html/search/variables_5.js | 4 +-
docs/html/search/variables_6.js | 10 +-
docs/html/search/variables_7.js | 12 +-
docs/html/search/variables_8.js | 24 +-
docs/html/search/variables_9.js | 10 +-
docs/html/search/variables_a.js | 8 +-
docs/html/search/variables_b.js | 18 +-
docs/html/search/variables_c.js | 28 +--
docs/html/search/variables_d.js | 12 +-
docs/html/search/variables_e.js | 4 +-
docs/html/search/variables_f.js | 4 +-
docs/html/structNTPEvent__t-members.html | 2 +-
docs/html/structNTPEvent__t.html | 2 +-
docs/html/structNTPFlags__t-members.html | 2 +-
docs/html/structNTPFlags__t.html | 2 +-
docs/html/structNTPPacket__t-members.html | 2 +-
docs/html/structNTPPacket__t.html | 2 +-
.../structNTPSyncEventInfo__t-members.html | 2 +-
docs/html/structNTPSyncEventInfo__t.html | 2 +-
docs/html/structtimestamp32__t-members.html | 2 +-
docs/html/structtimestamp32__t.html | 2 +-
docs/html/structtimestamp64__t-members.html | 2 +-
docs/html/structtimestamp64__t.html | 2 +-
docs/html/structtimestamp__t-members.html | 82 -------
docs/html/structtimestamp__t.html | 137 -----------
133 files changed, 657 insertions(+), 845 deletions(-)
delete mode 100644 docs/html/search/pages_1.html
delete mode 100644 docs/html/search/pages_1.js
delete mode 100644 docs/html/structtimestamp__t-members.html
delete mode 100644 docs/html/structtimestamp__t.html
diff --git a/docs/html/ESPNtpClient_8cpp.html b/docs/html/ESPNtpClient_8cpp.html
index 1e65f02..456098e 100644
--- a/docs/html/ESPNtpClient_8cpp.html
+++ b/docs/html/ESPNtpClient_8cpp.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/ESPNtpClient_8cpp_source.html b/docs/html/ESPNtpClient_8cpp_source.html
index 4f39fc5..7ebe229 100644
--- a/docs/html/ESPNtpClient_8cpp_source.html
+++ b/docs/html/ESPNtpClient_8cpp_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -1134,7 +1134,7 @@
-time_t getLastNTPSync()
Gets last successful sync time in UNIX format.
+time_t getLastNTPSync()
Gets last successful sync time in UNIX format.
unsigned int shortInterval
Interval to set periodic time sync until first synchronization.
uint32_t fraction
32-bit fraction field resolving 232 picoseconds (1/2^32)
@@ -1143,7 +1143,7 @@
constexpr auto SECS_PER_HOUR
unsigned int longInterval
Interval to set periodic time sync.
uint8_t refID[4]
32-bit code identifying the particular server or reference clock
-char * getTimeDateString()
Converts current time and date to a char string.
+char * getTimeDateString()
Converts current time and date to a char string.
uint maxNumSyncRetry
Number of resync repetitions if minimum accuracy has not been reached.
onSyncEvent_t onSyncEvent
Event handler callback.
timeval origin
Time at the client when the request departed for the server.
@@ -1175,11 +1175,11 @@
timeval reference
Time when the system clock was last set or corrected.
uint maxDispersionErrors
Number of resync repetitions if server has a dispersion value bigger than offset absolute value.
-NTPStatus_t syncStatus()
Returns sync status.
+NTPStatus_t syncStatus()
Returns sync status.
unsigned long uptime
Time since boot.
int li
2-bit integer warning of an impending leap second to be inserted or deleted in the last minute of the...
float dispersion
Total dispersion to the reference clock.
-int64_t millis()
Gets milliseconds since 1-Jan-1970 00:00 UTC.
+int64_t millis()
Gets milliseconds since 1-Jan-1970 00:00 UTC.
long minSyncAccuracyUs
Timeout configuration to wait for NTP response.
int16_t flipInt16(int16_t number)
@@ -1209,7 +1209,7 @@
int vers
3-bit integer representing the NTP version number, currently 4
boolean sendNTPpacket()
Sends NTP request to server.
-char * getTimeDateStringUs()
Converts current time and date to a char string.
+char * getTimeDateStringUs()
Converts current time and date to a char string.
int64_t offsetAve
Average calculated value.
IPAddress ntpServerIPAddress
IP address of NTP server on Internet or LAN.
@@ -1241,7 +1241,7 @@
int32_t secondsOffset
32-bit seconds field spanning 136 years since 1-Jan-1900 00:00 UTC
NTPClient NTP
Singleton NTPClient instance.
timeval lastSyncd
Stored time of last successful sync.
-time_t getUptime()
Gets uptime in UNIX format, time since MCU was last rebooted.
+time_t getUptime()
Gets uptime in UNIX format, time since MCU was last rebooted.
static void s_recvPacket(void *arg, struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *addr, u16_t port)
Static method that calls recvPacket. Used in receiver task.
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32.
diff --git a/docs/html/ESPNtpClient_8h.html b/docs/html/ESPNtpClient_8h.html
index a3edff4..8f05ddb 100644
--- a/docs/html/ESPNtpClient_8h.html
+++ b/docs/html/ESPNtpClient_8h.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -197,8 +197,8 @@
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32.
-
- Version
- 0.2.2
-
- Date
- 13/12/2020
+
- Version
- 0.2.3
+
- Date
- 14/02/2021
- Author
- German Martin
Definition in file ESPNtpClient.h.
diff --git a/docs/html/ESPNtpClient_8h_source.html b/docs/html/ESPNtpClient_8h_source.html
index c2202e9..019b453 100644
--- a/docs/html/ESPNtpClient_8h_source.html
+++ b/docs/html/ESPNtpClient_8h_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -362,113 +362,115 @@
543 tm* local_tm = localtime (&moment);
-
-
-
-
-
-
554 time_t currentTime = time (NULL);
-
555 return getDateStr (currentTime);
-
-
-
-
564 return getDateStr (moment.tv_sec);
-
-
-
-
573 tm* local_tm = localtime (&moment);
-
-
-
-
-
-
583 time_t currentTime = time (NULL);
-
584 return getTimeDateString (currentTime);
-
-
-
-
-
593 gettimeofday (¤tTime, NULL);
-
594 return getTimeDateString (currentTime);
-
-
-
-
603 tm* local_tm = localtime (&moment.tv_sec);
-
604 size_t index = strftime (
strBuffer,
sizeof (
strBuffer),
"%02d/%02m/%04Y %02H:%02M:%02S", local_tm);
-
605 index += snprintf (
strBuffer + index,
sizeof (
strBuffer) - index,
".%06ld", moment.tv_usec);
-
-
-
-
-
-
616 tm* local_tm = localtime (&moment);
-
-
-
-
-
-
-
-
-
+
+
+
+
+
553 time_t currentTime = time (NULL);
+
554 return getDateStr (currentTime);
+
+
+
+
563 return getDateStr (moment.tv_sec);
+
+
+
+
572 tm* local_tm = localtime (&moment);
+
+
+
+
+
+
582 time_t currentTime = time (NULL);
+
583 return getTimeDateString (currentTime);
+
+
+
+
+
592 gettimeofday (¤tTime, NULL);
+
593 return getTimeDateString (currentTime);
+
+
+
+
601 return getTimeDateString (time (NULL),
"%02m/%02d/%04Y %02H:%02M:%02S");
+
+
+
610 char*
getTimeDateString (timeval moment,
const char* format =
"%02d/%02m/%04Y %02H:%02M:%02S") {
+
611 tm* local_tm = localtime (&moment.tv_sec);
+
+
613 index += snprintf (
strBuffer + index,
sizeof (
strBuffer) - index,
".%06ld", moment.tv_usec);
+
+
+
+
+
+
625 tm* local_tm = localtime (&moment);
+
+
+
+
-
-
636 return lastSyncd.tv_sec;
+
+
-
643 char* getUptimeString ();
-
-
-
650 uptime = uptime + (::millis () - uptime);
-
651 return uptime / 1000;
-
+
+
+
645 return lastSyncd.tv_sec;
+
+
+
652 char* getUptimeString ();
-
-
-
-
-
-
667 return firstSync.tv_sec;
-
-
-
-
-
-
-
-
-
684 gettimeofday (¤tTime, NULL);
-
685 int64_t milliseconds = (int64_t)currentTime.tv_sec * 1000L + (int64_t)currentTime.tv_usec / 1000L;
-
-
-
-
-
-
-
696 gettimeofday (¤tTime, NULL);
-
697 int64_t microseconds = (int64_t)currentTime.tv_sec * 1000000L + (int64_t)currentTime.tv_usec;
-
-
-
-
-
-
-
-
-
-
-
-
714 #endif // _NtpClientLib_h
+
+
659 uptime = uptime + (::millis () - uptime);
+
660 return uptime / 1000;
+
+
+
+
+
+
+
+
676 return firstSync.tv_sec;
+
+
+
+
+
+
+
+
+
693 gettimeofday (¤tTime, NULL);
+
694 int64_t milliseconds = (int64_t)currentTime.tv_sec * 1000L + (int64_t)currentTime.tv_usec / 1000L;
+
+
+
+
+
+
+
705 gettimeofday (¤tTime, NULL);
+
706 int64_t microseconds = (int64_t)currentTime.tv_sec * 1000000L + (int64_t)currentTime.tv_usec;
+
+
+
+
+
+
+
+
+
+
+
+
723 #endif // _NtpClientLib_h
-time_t getLastNTPSync()
Gets last successful sync time in UNIX format.
+time_t getLastNTPSync()
Gets last successful sync time in UNIX format.
constexpr auto DEFAULT_NTP_SERVER
Default international NTP server. I recommend you to select a closer server to get better accuracy.
-time_t getFirstSync()
Gets first successful synchronization time after boot.
+time_t getFirstSync()
Gets first successful synchronization time after boot.
constexpr auto DEFAULT_MIN_SYNC_ACCURACY_US
Minimum sync accuracy in us.
Ticker loopTimer
Timer to trigger timesync.
constexpr auto SECS_PER_HOUR
-char * getTimeDateString(time_t moment)
Converts given time and date to a char string.
-char * getTimeDateString()
Converts current time and date to a char string.
+char * getTimeDateString()
Converts current time and date to a char string.
onSyncEvent_t onSyncEvent
Event handler callback.
timeval origin
Time at the client when the request departed for the server.
constexpr auto SECS_PER_DAY
@@ -480,7 +482,7 @@
static char strBuffer[35]
Temporary buffer for time and date strings.
char * getNtpServerName()
Gets NTP server name.
-char * getDateStr()
Converts current date to a char string.
+char * getDateStr()
Converts current date to a char string.
timeval receive
Time at the server when the request arrived from the client.
constexpr auto DEFAULT_NTP_TIMEOUT
Default NTP timeout ms.
NTPClient NTP
Singleton NTPClient instance.
@@ -491,11 +493,11 @@
int64_t offsetSum
Sum of offsets for average calculation.
constexpr auto DEFAULT_NUM_OFFSET_AVE_ROUNDS
Number of NTP request and response rounds to calculate offset average.
timeval reference
Time when the system clock was last set or corrected.
-NTPStatus_t syncStatus()
Returns sync status.
+NTPStatus_t syncStatus()
Returns sync status.
void setMaxNumSyncRetry(unsigned long maxRetry)
Sets max number of sync retrials if minimum accuracy has not been reached.
int li
2-bit integer warning of an impending leap second to be inserted or deleted in the last minute of the...
float dispersion
Total dispersion to the reference clock.
-int64_t millis()
Gets milliseconds since 1-Jan-1970 00:00 UTC.
+int64_t millis()
Gets milliseconds since 1-Jan-1970 00:00 UTC.
char * getTimeStr(time_t moment)
Converts a time in UNIX format to a char string representing time.
double offset
Temporary offset storage for event notify.
@@ -505,7 +507,7 @@
std::function< void(NTPEvent_t)> onSyncEvent_t
Event notifier callback.
constexpr auto SECS_PER_YEAR
constexpr auto SECS_PER_MIN
-timeval getLastNTPSyncUs()
Gets last successful sync time in UNIX format, with microseconds.
+timeval getLastNTPSyncUs()
Gets last successful sync time in UNIX format, with microseconds.
Ticker responseTimer
Timer to trigger response timeout.
char * getTimeStr()
Converts current time to a char string.
int mode
3-bit integer representing the mode, with values defined in this table
@@ -515,13 +517,15 @@
int getLongInterval()
Gets sync period.
constexpr auto DEFAULT_NTP_INTERVAL
Default sync interval 30 minutes.
enum NTPStatus NTPStatus_t
NTP client status code.
+char * getTimeDateString(time_t moment, const char *format="%02d/%02m/%04Y %02H:%02M:%02S")
Converts given time and date to a char string.
+char * getTimeDateString(timeval moment, const char *format="%02d/%02m/%04Y %02H:%02M:%02S")
Converts given time and date to a char string.
constexpr auto DEFAULT_NTP_PORT
Default local udp port. Select a different one if neccesary (usually not needed)
int vers
3-bit integer representing the NTP version number, currently 4
~NTPClient()
NTP client Class destructor.
pbuf * lastNtpResponsePacket
Last response packet to be processed by receiver task.
-char * getTimeDateStringUs()
Converts current time and date to a char string.
+char * getTimeDateStringUs()
Converts current time and date to a char string.
int64_t offsetAve
Average calculated value.
IPAddress ntpServerIPAddress
IP address of NTP server on Internet or LAN.
constexpr auto MIN_NTP_TIMEOUT
Minumum admisible ntp timeout in ms.
@@ -540,21 +544,21 @@
udp_pcb * udp
UDP connection object.
-char * getDateStr(timeval moment)
Converts a time in UNIX format to a char string representing its date.
+char * getDateStr(timeval moment)
Converts a time in UNIX format to a char string representing its date.
void setTimeZone(const char *TZ)
Sets time zone for getting local time.
timeval firstSync
Stored time of first successful sync after boot.
-timeval getFirstSyncUs()
Gets first successful synchronization time after boot.
+timeval getFirstSyncUs()
Gets first successful synchronization time after boot.
float clockPrecission
8-bit signed integer representing the precision of the system clock, in log2 seconds
constexpr auto SECS_YR_2000
The time at the start of y2k.
uint numSyncRetry
Current resync repetition.
-char * getTimeDateString(timeval moment)
Converts given time and date to a char string.
-char * getDateStr(time_t moment)
Converts a time in UNIX format to a char string representing its date.
+char * getDateStr(time_t moment)
Converts a time in UNIX format to a char string representing its date.
timeval lastSyncd
Stored time of last successful sync.
-time_t getUptime()
Gets uptime in UNIX format, time since MCU was last rebooted.
+time_t getUptime()
Gets uptime in UNIX format, time since MCU was last rebooted.
int getInterval()
Gets sync period.
void stop()
Cleans data and stops all tasks.
-int64_t micros()
Gets microseconds since 1-Jan-1970 00:00 UTC.
+char * getTimeDateStringForJS()
Converts current time and date to a char string.
+int64_t micros()
Gets microseconds since 1-Jan-1970 00:00 UTC.
uint8_t peerStratum
8-bit integer representing the stratum
constexpr auto MIN_NTP_INTERVAL
Minumum NTP request interval in seconds.
diff --git a/docs/html/LICENSE_8md.html b/docs/html/LICENSE_8md.html
index 14b7053..28a6fa1 100644
--- a/docs/html/LICENSE_8md.html
+++ b/docs/html/LICENSE_8md.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/NTPEventTypes_8h.html b/docs/html/NTPEventTypes_8h.html
index f447c93..fa34541 100644
--- a/docs/html/NTPEventTypes_8h.html
+++ b/docs/html/NTPEventTypes_8h.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/NTPEventTypes_8h_source.html b/docs/html/NTPEventTypes_8h_source.html
index ea8c52f..732fc43 100644
--- a/docs/html/NTPEventTypes_8h_source.html
+++ b/docs/html/NTPEventTypes_8h_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/TZdef_8h.html b/docs/html/TZdef_8h.html
index cde52f7..026cec8 100644
--- a/docs/html/TZdef_8h.html
+++ b/docs/html/TZdef_8h.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/TZdef_8h_source.html b/docs/html/TZdef_8h_source.html
index fa522d5..60dd62e 100644
--- a/docs/html/TZdef_8h_source.html
+++ b/docs/html/TZdef_8h_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/advancedExample_8ino.html b/docs/html/advancedExample_8ino.html
index eed0890..1299ddc 100644
--- a/docs/html/advancedExample_8ino.html
+++ b/docs/html/advancedExample_8ino.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/advancedExample_8ino_source.html b/docs/html/advancedExample_8ino_source.html
index 5896ed3..b37bf33 100644
--- a/docs/html/advancedExample_8ino_source.html
+++ b/docs/html/advancedExample_8ino_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -217,7 +217,7 @@
-char * getTimeDateString()
Converts current time and date to a char string.
+char * getTimeDateString()
Converts current time and date to a char string.
@@ -231,7 +231,7 @@
bool begin(const char *ntpServerName=DEFAULT_NTP_SERVER)
Starts time synchronization.
-char * getTimeDateStringUs()
Converts current time and date to a char string.
+char * getTimeDateStringUs()
Converts current time and date to a char string.
const PROGMEM char * ntpServer
@@ -240,7 +240,7 @@
void setTimeZone(const char *TZ)
Sets time zone for getting local time.
-timeval getFirstSyncUs()
Gets first successful synchronization time after boot.
+timeval getFirstSyncUs()
Gets first successful synchronization time after boot.
NTPClient NTP
Singleton NTPClient instance.
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32.
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
index f719ce1..6141749 100644
--- a/docs/html/annotated.html
+++ b/docs/html/annotated.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/basicExample_8ino.html b/docs/html/basicExample_8ino.html
index b760d16..1a3b376 100644
--- a/docs/html/basicExample_8ino.html
+++ b/docs/html/basicExample_8ino.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
diff --git a/docs/html/basicExample_8ino_source.html b/docs/html/basicExample_8ino_source.html
index 9b6419b..329f2dc 100644
--- a/docs/html/basicExample_8ino_source.html
+++ b/docs/html/basicExample_8ino_source.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -111,7 +111,7 @@
bool begin(const char *ntpServerName=DEFAULT_NTP_SERVER)
Starts time synchronization.
-char * getTimeDateStringUs()
Converts current time and date to a char string.
+char * getTimeDateStringUs()
Converts current time and date to a char string.
void setTimeZone(const char *TZ)
Sets time zone for getting local time.
diff --git a/docs/html/classNTPClient-members.html b/docs/html/classNTPClient-members.html
index b9809d8..f2dd9b9 100644
--- a/docs/html/classNTPClient-members.html
+++ b/docs/html/classNTPClient-members.html
@@ -23,7 +23,7 @@
|
ESPNtpClient
- 0.2.2
+ 0.2.3
Library to get system sync from a NTP server with microseconds accuracy in ESP8266 and ESP32
|
@@ -93,67 +93,68 @@
getShortInterval() | NTPClient | inline |
getTime() | NTPClient | |
getTimeDateString() | NTPClient | inline |
- getTimeDateString(timeval moment) | NTPClient | inline |
- getTimeDateString(time_t moment) | NTPClient | inline |
- getTimeDateStringUs() | NTPClient | inline |
- getTimeStr() | NTPClient | inline |
- getTimeStr(timeval moment) | NTPClient | inline |
- getTimeStr(time_t moment) | NTPClient | inline |
- getUptime() | NTPClient | inline |
- getUptimeString() | NTPClient | |
- isConnected | NTPClient | protected |
- lastNtpResponsePacket | NTPClient | protected |
- lastSyncd | NTPClient | protected |
- longInterval | NTPClient | protected |
- loopTimer | NTPClient | |
- maxDispersionErrors | NTPClient | protected |
- maxNumSyncRetry | NTPClient | protected |
- micros() | NTPClient | inline |
- millis() | NTPClient | inline |
- minSyncAccuracyUs | NTPClient | protected |
- ntpEvent2str(NTPEvent_t e) | NTPClient | |
- ntpRequested | NTPClient | protected |
- ntpServerIPAddress | NTPClient | protected |
- ntpServerName | NTPClient | protected |
- ntpTimeout | NTPClient | protected |
- numAveRounds | NTPClient | protected |
- numDispersionErrors | NTPClient | protected |
- numSyncRetry | NTPClient | protected |
- offset | NTPClient | protected |
- offsetAve | NTPClient | protected |
- offsetSum | NTPClient | protected |
- onNTPSyncEvent(onSyncEvent_t handler) | NTPClient | inline |
- onSyncEvent | NTPClient | protected |
- packetLastReceived | NTPClient | protected |
- processPacket(struct pbuf *p) | NTPClient | protected |
- processRequestTimeout() | NTPClient | protected |
- receiverTimer | NTPClient | |
- responsePacketValid | NTPClient | protected |
- responseTimer | NTPClient | protected |
- round | NTPClient | protected |
- s_getTimeloop(void *arg) | NTPClient | protectedstatic |
- s_processRequestTimeout(void *arg) | NTPClient | protectedstatic |
- s_receiverTask(void *arg) | NTPClient | protectedstatic |
- s_recvPacket(void *arg, struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *addr, u16_t port) | NTPClient | protectedstatic |
- sendNTPpacket() | NTPClient | protected |
- setInterval(int interval) | NTPClient | |
- setInterval(int shortInterval, int longInterval) | NTPClient | |
- setMaxNumSyncRetry(unsigned long maxRetry) | NTPClient | inline |
- setMinSyncAccuracy(long accuracy) | NTPClient | inline |
- setNtpServerName(const char *serverName) | NTPClient | |
- setNTPTimeout(uint16_t milliseconds) | NTPClient | |
- settimeSyncThreshold(long threshold) | NTPClient | inline |
- setTimeZone(const char *TZ) | NTPClient | inline |
- shortInterval | NTPClient | protected |
- status | NTPClient | protected |
- stop() | NTPClient | inline |
- syncStatus() | NTPClient | inline |
- timeSyncThreshold | NTPClient | protected |
- timeZone | NTPClient | protected |
- tzname | NTPClient | protected |
- udp | NTPClient | protected |
- uptime | NTPClient | protected |
- ~NTPClient() | NTPClient | inline |
+ getTimeDateString(timeval moment, const char *format="%02d/%02m/%04Y %02H:%02M:%02S") | NTPClient | inline |
+ getTimeDateString(time_t moment, const char *format="%02d/%02m/%04Y %02H:%02M:%02S") | NTPClient | inline |
+ getTimeDateStringForJS() | NTPClient | inline |
+ getTimeDateStringUs() | NTPClient | inline |
+ getTimeStr() | NTPClient | inline |
+ getTimeStr(timeval moment) | NTPClient | inline |
+ getTimeStr(time_t moment) | NTPClient | inline |
+ getUptime() | NTPClient | inline |
+ getUptimeString() | NTPClient | |
+ isConnected | NTPClient | protected |
+ lastNtpResponsePacket | NTPClient | protected |
+ lastSyncd | NTPClient | protected |
+ longInterval | NTPClient | protected |
+ loopTimer | NTPClient | |
+ maxDispersionErrors | NTPClient | protected |
+ maxNumSyncRetry | NTPClient | protected |
+ micros() | NTPClient | inline |
+ millis() | NTPClient | inline |
+ minSyncAccuracyUs | NTPClient | protected |
+ ntpEvent2str(NTPEvent_t e) | NTPClient | |
+ ntpRequested | NTPClient | protected |
+ ntpServerIPAddress | NTPClient | protected |
+ ntpServerName | NTPClient | protected |
+ ntpTimeout | NTPClient | protected |
+ numAveRounds | NTPClient | protected |
+ numDispersionErrors | NTPClient | protected |
+ numSyncRetry | NTPClient | protected |
+ offset | NTPClient | protected |
+ offsetAve | NTPClient | protected |
+ offsetSum | NTPClient | protected |
+ onNTPSyncEvent(onSyncEvent_t handler) | NTPClient | inline |
+ onSyncEvent | NTPClient | protected |
+ packetLastReceived | NTPClient | protected |
+ processPacket(struct pbuf *p) | NTPClient | protected |
+ processRequestTimeout() | NTPClient | protected |
+ receiverTimer | NTPClient | |
+ responsePacketValid | NTPClient | protected |
+ responseTimer | NTPClient | protected |
+ round | NTPClient | protected |
+ s_getTimeloop(void *arg) | NTPClient | protectedstatic |
+ s_processRequestTimeout(void *arg) | NTPClient | protectedstatic |
+ s_receiverTask(void *arg) | NTPClient | protectedstatic |
+ s_recvPacket(void *arg, struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *addr, u16_t port) | NTPClient | protectedstatic |
+ sendNTPpacket() | NTPClient | protected |
+ setInterval(int interval) | NTPClient | |
+ setInterval(int shortInterval, int longInterval) | NTPClient | |
+ setMaxNumSyncRetry(unsigned long maxRetry) | NTPClient | inline |
+ setMinSyncAccuracy(long accuracy) | NTPClient | inline |
+ setNtpServerName(const char *serverName) | NTPClient | |
+ setNTPTimeout(uint16_t milliseconds) | NTPClient | |
+ settimeSyncThreshold(long threshold) | NTPClient | inline |
+ setTimeZone(const char *TZ) | NTPClient | inline |
+ shortInterval | NTPClient | protected |
+ status | NTPClient | protected |
+ stop() | NTPClient | inline |
+ syncStatus() | NTPClient | inline |
+ timeSyncThreshold | NTPClient | protected |
+ timeZone | NTPClient | protected |
+ tzname | NTPClient | protected |
+ udp | NTPClient | protected |
+ uptime | NTPClient | protected |
+ ~NTPClient() | NTPClient | inline |