adafruit-circuitpython-ntp 3.1.0__tar.gz → 3.2.0__tar.gz

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: adafruit-circuitpython-ntp
-Version: 3.1.0
+Version: 3.2.0
 Summary: Network Time Protocol (NTP) helper for Python
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -89,7 +89,7 @@ Usage Example
     wifi.radio.connect(wifi_ssid, wifi_password)
 
     pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/README.rst

@@ -70,7 +70,7 @@ Usage Example
     wifi.radio.connect(wifi_ssid, wifi_password)
 
     pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/adafruit_circuitpython_ntp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: adafruit-circuitpython-ntp
-Version: 3.1.0
+Version: 3.2.0
 Summary: Network Time Protocol (NTP) helper for Python
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -89,7 +89,7 @@ Usage Example
     wifi.radio.connect(wifi_ssid, wifi_password)
 
     pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/adafruit_ntp.py

@@ -25,7 +25,7 @@ import time
 from micropython import const
 
 
-__version__ = "3.1.0"
+__version__ = "3.2.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NTP.git"
 
 NTP_TO_UNIX_EPOCH = 2208988800  # 1970-01-01 00:00:00
@@ -46,6 +46,7 @@ class NTP:
         port: int = 123,
         tz_offset: float = 0,
         socket_timeout: int = 10,
+        cache_seconds: int = 0,
     ) -> None:
         """
         :param object socketpool: A socket provider such as CPython's `socket` module.
@@ -55,6 +56,8 @@ class NTP:
             CircuitPython. CPython will determine timezone automatically and adjust (so don't use
             this.) For example, Pacific daylight savings time is -7.
         :param int socket_timeout: UDP socket timeout, in seconds.
+        :param int cache_seconds: how many seconds to use a cached result from NTP server
+            (default 0, which respects NTP server's minimum).
         """
         self._pool = socketpool
         self._server = server
@@ -63,6 +66,7 @@ class NTP:
         self._packet = bytearray(PACKET_SIZE)
         self._tz_offset = int(tz_offset * 60 * 60)
         self._socket_timeout = socket_timeout
+        self._cache_seconds = cache_seconds
 
         # This is our estimated start time for the monotonic clock. We adjust it based on the ntp
         # responses.
@@ -74,7 +78,8 @@ class NTP:
     def datetime(self) -> time.struct_time:
         """Current time from NTP server. Accessing this property causes the NTP time request,
         unless there has already been a recent request. Raises OSError exception if no response
-        is received within socket_timeout seconds"""
+        is received within socket_timeout seconds, ArithmeticError for substantially incorrect
+        NTP results."""
         if time.monotonic_ns() > self.next_sync:
             if self._socket_address is None:
                 self._socket_address = self._pool.getaddrinfo(self._server, self._port)[
@@ -85,18 +90,18 @@ class NTP:
             for i in range(1, PACKET_SIZE):
                 self._packet[i] = 0
             with self._pool.socket(self._pool.AF_INET, self._pool.SOCK_DGRAM) as sock:
-                # Since the ESP32SPI doesn't support sendto, we are using
-                # connect + send to standardize code
                 sock.settimeout(self._socket_timeout)
-                sock.connect(self._socket_address)
-                sock.send(self._packet)
+                sock.sendto(self._packet, self._socket_address)
                 sock.recv_into(self._packet)
                 # Get the time in the context to minimize the difference between it and receiving
                 # the packet.
                 destination = time.monotonic_ns()
             poll = struct.unpack_from("!B", self._packet, offset=2)[0]
-            self.next_sync = destination + (2**poll) * 1_000_000_000
+
+            cache_offset = max(2**poll, self._cache_seconds)
+            self.next_sync = destination + cache_offset * 1_000_000_000
             seconds = struct.unpack_from("!I", self._packet, offset=PACKET_SIZE - 8)[0]
+
             self._monotonic_start = (
                 seconds
                 + self._tz_offset

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/examples/ntp_connection_manager.py

@@ -33,7 +33,7 @@ except ImportError:
 # get the socket pool from connection manager
 socket = adafruit_connection_manager.get_radio_socketpool(radio)
 
-# adjust tz_offset for locale...
-ntp = adafruit_ntp.NTP(socket, tz_offset=-5)
+# adjust tz_offset for locale, only ping NTP server every hour
+ntp = adafruit_ntp.NTP(socket, tz_offset=-5, cache_seconds=3600)
 
 print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/examples/ntp_cpython.py

@@ -9,7 +9,7 @@ import time
 import adafruit_ntp
 
 # Don't use tz_offset kwarg with CPython because it will adjust automatically.
-ntp = adafruit_ntp.NTP(socket)
+ntp = adafruit_ntp.NTP(socket, cache_seconds=3600)
 
 while True:
     print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/examples/ntp_set_rtc.py

@@ -21,7 +21,7 @@ except ImportError:
 wifi.radio.connect(secrets["ssid"], secrets["password"])
 
 pool = socketpool.SocketPool(wifi.radio)
-ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
 # NOTE: This changes the system time so make sure you aren't assuming that time
 # doesn't jump.

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/examples/ntp_simpletest.py

@@ -20,7 +20,7 @@ except ImportError:
 wifi.radio.connect(secrets["ssid"], secrets["password"])
 
 pool = socketpool.SocketPool(wifi.radio)
-ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
 while True:
     print(ntp.datetime)

{adafruit_circuitpython_ntp-3.1.0 → adafruit_circuitpython_ntp-3.2.0}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-ntp"
 description = "Network Time Protocol (NTP) helper for Python"
-version = "3.1.0"
+version = "3.2.0"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}