adafruit-circuitpython-ntp 3.0.13__tar.gz → 3.3.2__tar.gz

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/.readthedocs.yaml

@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-ntp
-Version: 3.0.13
+Version: 3.3.2
 Summary: Network Time Protocol (NTP) helper for Python
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -78,22 +78,18 @@ Usage Example
 
 .. code-block:: python
 
+    import adafruit_connection_manager
     import adafruit_ntp
-    import socketpool
+    import os
     import time
     import wifi
 
-    # Get wifi details and more from a secrets.py file
-    try:
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in secrets.py, please add them there!")
-        raise
+    wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
+    wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
+    wifi.radio.connect(wifi_ssid, wifi_password)
 
-    wifi.radio.connect(secrets["ssid"], secrets["password"])
-
-    pool = socketpool.SocketPool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/README.rst

@@ -59,22 +59,18 @@ Usage Example
 
 .. code-block:: python
 
+    import adafruit_connection_manager
     import adafruit_ntp
-    import socketpool
+    import os
     import time
     import wifi
 
-    # Get wifi details and more from a secrets.py file
-    try:
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in secrets.py, please add them there!")
-        raise
+    wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
+    wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
+    wifi.radio.connect(wifi_ssid, wifi_password)
 
-    wifi.radio.connect(secrets["ssid"], secrets["password"])
-
-    pool = socketpool.SocketPool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/adafruit_circuitpython_ntp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: adafruit-circuitpython-ntp
-Version: 3.0.13
+Version: 3.3.2
 Summary: Network Time Protocol (NTP) helper for Python
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -78,22 +78,18 @@ Usage Example
 
 .. code-block:: python
 
+    import adafruit_connection_manager
     import adafruit_ntp
-    import socketpool
+    import os
     import time
     import wifi
 
-    # Get wifi details and more from a secrets.py file
-    try:
-        from secrets import secrets
-    except ImportError:
-        print("WiFi secrets are kept in secrets.py, please add them there!")
-        raise
+    wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
+    wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
+    wifi.radio.connect(wifi_ssid, wifi_password)
 
-    wifi.radio.connect(secrets["ssid"], secrets["password"])
-
-    pool = socketpool.SocketPool(wifi.radio)
-    ntp = adafruit_ntp.NTP(pool, tz_offset=0)
+    pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
+    ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
 
     while True:
         print(ntp.datetime)

adafruit_circuitpython_ntp-3.3.2/adafruit_ntp.py

@@ -0,0 +1,145 @@
+# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+`adafruit_ntp`
+================================================================================
+
+Network Time Protocol (NTP) helper for CircuitPython
+
+ * Author(s): Scott Shawcroft
+
+Implementation Notes
+--------------------
+**Hardware:**
+**Software and Dependencies:**
+
+ * Adafruit CircuitPython firmware for the supported boards:
+   https://github.com/adafruit/circuitpython/releases
+
+"""
+import struct
+import time
+
+from micropython import const
+
+
+__version__ = "3.3.2"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NTP.git"
+
+NTP_TO_UNIX_EPOCH = 2208988800  # 1970-01-01 00:00:00
+PACKET_SIZE = const(48)
+
+
+class NTP:  # pylint:disable=too-many-instance-attributes
+    """Network Time Protocol (NTP) helper module for CircuitPython.
+    This module does not handle daylight savings or local time. It simply requests
+    UTC from a NTP server.
+    """
+
+    def __init__(  # pylint:disable=too-many-arguments
+        self,
+        socketpool,
+        *,
+        server: str = "0.adafruit.pool.ntp.org",
+        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.
+        :param str server: The domain of the ntp server to query.
+        :param int port: The port of the ntp server to query.
+        :param float tz_offset: Timezone offset in hours from UTC. Only useful for timezone ignorant
+            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
+        self._port = port
+        self._socket_address = None
+        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.
+        self._monotonic_start_ns = 0
+
+        self.next_sync = 0
+
+    def _update_time_sync(self) -> None:
+        """Update the time sync value. Raises OSError exception if no response
+        is received within socket_timeout seconds, ArithmeticError for substantially incorrect
+        NTP results."""
+        if self._socket_address is None:
+            self._socket_address = self._pool.getaddrinfo(self._server, self._port)[0][
+                4
+            ]
+
+        self._packet[0] = 0b00100011  # Not leap second, NTP version 4, Client mode
+        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:
+            sock.settimeout(self._socket_timeout)
+            local_send_ns = time.monotonic_ns()  # expanded
+            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.
+            local_recv_ns = time.monotonic_ns()  # was destination
+
+        poll = struct.unpack_from("!B", self._packet, offset=2)[0]
+
+        cache_offset_s = max(2**poll, self._cache_seconds)
+        self.next_sync = local_recv_ns + cache_offset_s * 1_000_000_000
+
+        srv_recv_s, srv_recv_f = struct.unpack_from("!II", self._packet, offset=32)
+        srv_send_s, srv_send_f = struct.unpack_from("!II", self._packet, offset=40)
+
+        # Convert the server times from NTP to UTC for local use
+        srv_recv_ns = (srv_recv_s - NTP_TO_UNIX_EPOCH) * 1_000_000_000 + (
+            srv_recv_f * 1_000_000_000 // 2**32
+        )
+        srv_send_ns = (srv_send_s - NTP_TO_UNIX_EPOCH) * 1_000_000_000 + (
+            srv_send_f * 1_000_000_000 // 2**32
+        )
+
+        # _round_trip_delay = (local_recv_ns - local_send_ns) - (srv_send_ns - srv_recv_ns)
+        # Calculate (best estimate) offset between server UTC and board monotonic_ns time
+        clock_offset = (
+            (srv_recv_ns - local_send_ns) + (srv_send_ns - local_recv_ns)
+        ) // 2
+
+        self._monotonic_start_ns = clock_offset + self._tz_offset * 1_000_000_000
+
+    @property
+    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."""
+        if time.monotonic_ns() > self.next_sync:
+            self._update_time_sync()
+
+        # Calculate the current time based on the current and start monotonic times
+        current_time_s = (
+            time.monotonic_ns() + self._monotonic_start_ns
+        ) // 1_000_000_000
+
+        return time.localtime(current_time_s)
+
+    @property
+    def utc_ns(self) -> int:
+        """UTC (unix epoch) time in nanoseconds. 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, ArithmeticError for substantially
+        incorrect NTP results."""
+        if time.monotonic_ns() > self.next_sync:
+            self._update_time_sync()
+
+        return time.monotonic_ns() + self._monotonic_start_ns

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/docs/conf.py

@@ -103,7 +103,6 @@ napoleon_numpy_docstring = False
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/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.0.13 → adafruit_circuitpython_ntp-3.3.2}/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.3.2/examples/ntp_set_rtc.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+"""Example demonstrating how to set the realtime clock (RTC) based on NTP time."""
+
+import os
+import time
+
+import rtc
+import socketpool
+import wifi
+
+import adafruit_ntp
+
+# Get wifi AP credentials from a settings.toml file
+wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
+wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
+if wifi_ssid is None:
+    print("WiFi credentials are kept in settings.toml, please add them there!")
+    raise ValueError("SSID not found in environment variables")
+
+try:
+    wifi.radio.connect(wifi_ssid, wifi_password)
+except ConnectionError:
+    print("Failed to connect to WiFi with provided credentials")
+    raise
+
+pool = socketpool.SocketPool(wifi.radio)
+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.
+rtc.RTC().datetime = ntp.datetime
+
+while True:
+    print(time.localtime())
+    time.sleep(1)

adafruit_circuitpython_ntp-3.3.2/examples/ntp_simpletest.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+"""Print out time based on NTP."""
+
+import os
+import time
+
+import socketpool
+import wifi
+
+import adafruit_ntp
+
+# Get wifi AP credentials from a settings.toml file
+wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
+wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
+if wifi_ssid is None:
+    print("WiFi credentials are kept in settings.toml, please add them there!")
+    raise ValueError("SSID not found in environment variables")
+
+try:
+    wifi.radio.connect(wifi_ssid, wifi_password)
+except ConnectionError:
+    print("Failed to connect to WiFi with provided credentials")
+    raise
+
+pool = socketpool.SocketPool(wifi.radio)
+ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
+
+while True:
+    print(ntp.datetime)
+    time.sleep(1)

{adafruit-circuitpython-ntp-3.0.13 → adafruit_circuitpython_ntp-3.3.2}/pyproject.toml

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

adafruit-circuitpython-ntp-3.0.13/adafruit_ntp.py

@@ -1,98 +0,0 @@
-# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
-#
-# SPDX-License-Identifier: MIT
-
-"""
-`adafruit_ntp`
-================================================================================
-
-Network Time Protocol (NTP) helper for CircuitPython
-
- * Author(s): Scott Shawcroft
-
-Implementation Notes
---------------------
-**Hardware:**
-**Software and Dependencies:**
-
- * Adafruit CircuitPython firmware for the supported boards:
-   https://github.com/adafruit/circuitpython/releases
-
-"""
-import struct
-import time
-
-__version__ = "3.0.13"
-__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NTP.git"
-
-NTP_TO_UNIX_EPOCH = 2208988800  # 1970-01-01 00:00:00
-
-
-class NTP:
-    """Network Time Protocol (NTP) helper module for CircuitPython.
-    This module does not handle daylight savings or local time. It simply requests
-    UTC from a NTP server.
-    """
-
-    def __init__(
-        self,
-        socketpool,
-        *,
-        server: str = "0.adafruit.pool.ntp.org",
-        port: int = 123,
-        tz_offset: float = 0,
-        socket_timeout: int = 10,
-    ) -> None:
-        """
-        :param object socketpool: A socket provider such as CPython's `socket` module.
-        :param str server: The domain of the ntp server to query.
-        :param int port: The port of the ntp server to query.
-        :param float tz_offset: Timezone offset in hours from UTC. Only useful for timezone ignorant
-            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.
-        """
-        self._pool = socketpool
-        self._server = server
-        self._port = port
-        self._packet = bytearray(48)
-        self._tz_offset = int(tz_offset * 60 * 60)
-        self._socket_timeout = socket_timeout
-
-        # This is our estimated start time for the monotonic clock. We adjust it based on the ntp
-        # responses.
-        self._monotonic_start = 0
-
-        self.next_sync = 0
-
-    @property
-    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"""
-        if time.monotonic_ns() > self.next_sync:
-            self._packet[0] = 0b00100011  # Not leap second, NTP version 4, Client mode
-            for i in range(1, len(self._packet)):
-                self._packet[i] = 0
-            with self._pool.socket(self._pool.AF_INET, self._pool.SOCK_DGRAM) as sock:
-                sock.settimeout(self._socket_timeout)
-                sock.sendto(self._packet, (self._server, self._port))
-                sock.recvfrom_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
-            seconds = struct.unpack_from(
-                "!I", self._packet, offset=len(self._packet) - 8
-            )[0]
-            self._monotonic_start = (
-                seconds
-                + self._tz_offset
-                - NTP_TO_UNIX_EPOCH
-                - (destination // 1_000_000_000)
-            )
-
-        return time.localtime(
-            time.monotonic_ns() // 1_000_000_000 + self._monotonic_start
-        )

adafruit-circuitpython-ntp-3.0.13/examples/ntp_set_rtc.py

@@ -1,32 +0,0 @@
-# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
-# SPDX-License-Identifier: MIT
-
-"""Example demonstrating how to set the realtime clock (RTC) based on NTP time."""
-
-import time
-
-import rtc
-import socketpool
-import wifi
-
-import adafruit_ntp
-
-# Get wifi details and more from a secrets.py file
-try:
-    from secrets import secrets
-except ImportError:
-    print("WiFi secrets are kept in secrets.py, please add them there!")
-    raise
-
-wifi.radio.connect(secrets["ssid"], secrets["password"])
-
-pool = socketpool.SocketPool(wifi.radio)
-ntp = adafruit_ntp.NTP(pool, tz_offset=0)
-
-# NOTE: This changes the system time so make sure you aren't assuming that time
-# doesn't jump.
-rtc.RTC().datetime = ntp.datetime
-
-while True:
-    print(time.localtime())
-    time.sleep(1)

adafruit-circuitpython-ntp-3.0.13/examples/ntp_simpletest.py

@@ -1,27 +0,0 @@
-# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries
-# SPDX-License-Identifier: MIT
-
-"""Print out time based on NTP."""
-
-import time
-
-import socketpool
-import wifi
-
-import adafruit_ntp
-
-# Get wifi details and more from a secrets.py file
-try:
-    from secrets import secrets
-except ImportError:
-    print("WiFi secrets are kept in secrets.py, please add them there!")
-    raise
-
-wifi.radio.connect(secrets["ssid"], secrets["password"])
-
-pool = socketpool.SocketPool(wifi.radio)
-ntp = adafruit_ntp.NTP(pool, tz_offset=0)
-
-while True:
-    print(ntp.datetime)
-    time.sleep(1)