Fruit Jam NTP module #14

mikeysklar · 2025-08-22T00:55:21Z

Helper module to get RTC time sync on Fruit Jam with minimal fuss. Includes example and settings.toml.

@b-blake had suggested this in the forums.

Asked for some guidance in circuitpython issue

@ladyada encouraged using the Adafruit_CircuitPython_NTP library and example code, but it was over 20 lines to get time sync and specific to the Fruit Jam.

With the NTP helper module it is two lines to set the RTC time on the Fruit Jam.

Adafruit CircuitPython 10.0.0-beta.2 on 2025-07-30; Adafruit Fruit Jam with rp2350b
>>> from adafruit_fruitjam.ntp import sync_time
>>> sync_time()
(struct_time(tm_year=2025, tm_mon=8, tm_mday=21, tm_hour=20, tm_min=46, tm_sec=36, tm_wday=3, tm_yday=233, tm_isdst=-1), 1755812796)
>>>

helper code to get time sync with minimal fuss on the Fruit Jam.

FoamyGuy

I think this should use adafruit_ntp instead of having a new npt.py module added with this functionality. And should make use of the existing networking functionality that is already in network.py if possible.

Here is an example script based on the ntp_simpletest.py that is adapted to use the networking from this library.

import time
import rtc
from adafruit_fruitjam import FruitJam
import adafruit_connection_manager
import adafruit_ntp

fruitjam = FruitJam()
fruitjam.network.connect()
pool = adafruit_connection_manager.get_radio_socketpool(fruitjam.network._wifi.esp)
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)

This code could be refactored into a function in the library for easier use.

Having it exposed as an easy to use sync_time() function would be nice. I think that should exist on the existing Network object that is inside of network.py. So with that helper put in place user code could look like:

from adafruit_fruitjam import FruitJam
fruitjam = FruitJam()
fruitjam.network.sync_time()
# or if desired we could add a convenience accessor for it on the main FruitJam object so that this would work:
# fruitjam.sync_time()

mikeysklar · 2025-08-22T12:51:17Z

Sounds good. I will refactor to make use of Fruit Jam network and adafruit_ntp.

FoamyGuy · 2025-08-22T12:55:32Z

The ability to specify ntp server, tz offset and interval (same as cache_time I think?) with environment vars from settings.toml as seen in the core issue would be nice to have still too. My code doesn't account for that but it would be great to have it.

@b-blake

Refactored and "works for me". I'll ask @b-blake to confirm functionality as well. • Added Network.sync_time() method in network.py • Uses adafruit_ntp + adafruit_connection_manager. • Reads optional NTP_* keys from settings.toml. • Sets rtc.RTC().datetime • Added example examples/fruitjam_time_sync.py (sync once, print localtime). • Added example examples/fruitjam_ntp_settings.toml

ntp and connection_manager libs

blank line missing.

mikeysklar · 2025-08-23T01:58:18Z

Refactored. I've asked @b-blake to confirm functionality as well.

•	add Network.sync_time() 
•	use adafruit_ntp + adafruit_connection_manager.
•	Read optional NTP_* keys from settings.toml.
•	sets rtc.RTC().datetime
•	add examples/fruitjam_time_sync.py (sync once, print localtime).
•	added example examples/fruitjam_ntp_settings.toml

FoamyGuy · 2025-08-25T13:49:41Z

adafruit_fruitjam/network.py

+        # Query NTP and set the system RTC.
+        ntp = adafruit_ntp.NTP(
+            pool,
+            server=server,
+            tz_offset=tz_offset,
+            socket_timeout=timeout,
+            cache_seconds=cache_seconds,
+        )
+
+        # Query NTP and set the system RTC.
+        ntp = adafruit_ntp.NTP(
+            pool,
+            server=server,
+            tz_offset=tz_offset,
+            socket_timeout=timeout,
+            cache_seconds=cache_seconds,
+        )


Does this ntp initialization need to be duplicated?

Also import rtc is in lines 34 and 316

mikeysklar · 2025-08-25T17:58:41Z

Thx. I'll do a review today and check for any other duplicate behavior like those two examples

ntp constructor removed. dup rtc import had already been removed. new NTP_RETRIES and NTP_DELAY_S user configurable settings. ``` NTP_RETRIES = 8 # number of NTP fetch attempts NTP_DELAY_S = 1.0 # delay between attempts (seconds) ``` updated settings.toml example updated docstring for sync_time with new NTP* configurables

mikeysklar · 2025-08-25T20:22:33Z

ntp constructor removed.

dup rtc import had already been removed.

new NTP_RETRIES and NTP_DELAY_S user configurable settings.

NTP_RETRIES   = 8     # number of NTP fetch attempts
NTP_DELAY_S   = 1.0   # delay between attempts (seconds)

updated settings.toml example

updated docstring for sync_time with new NTP* configurables

ruff was getting upset about too many branches

FoamyGuy · 2025-08-25T22:03:39Z

adafruit_fruitjam/network.py

+        if last_exc and "now" not in locals():
+            raise last_exc


I think that "now" not in locals() is getting confused here by scope or something. Or else perhaps I don't understand the intended behavior of the scope.

In any case it seems like this condition causes the current version not to work for me with default values for tuning and other arguments. In my case it seems to always time out on the first attempt, and then succeed on the second attempt. But when it gets to this check "now" not in locals() resolves to True which causes this to raise the OSError from the 1st attempt that timed out. Even though the second attempt succeeded.

I added this to confirm the value it resolves to and to verify that now is definitely definied and has a date object in it.

print(f"now locals: {'now' not in locals()}") print(now)

Here is the full output which shows these values just before the exception trace

code.py output: Connecting to AP AloeVera attempt: 0 caught OSError [Errno 116] ETIMEDOUT retrying attempt: 1 success now locals: True struct_time(tm_year=2025, tm_mon=8, tm_mday=25, tm_hour=21, tm_min=55, tm_sec=35, tm_wday=0, tm_yday=237, tm_isdst=-1) Traceback (most recent call last): File "code.py", line 114, in <module> File "/lib/adafruit_fruitjam/__init__.py", line 266, in sync_time File "/lib/adafruit_fruitjam/network.py", line 334, in sync_time File "/lib/adafruit_fruitjam/network.py", line 313, in sync_time File "adafruit_ntp.py", line 123, in datetime File "adafruit_ntp.py", line 91, in _update_time_sync File "/lib/adafruit_esp32spi/adafruit_esp32spi_socketpool.py", line 180, in recv_into OSError: [Errno 116] ETIMEDOUT

I was able to resolve this locally by adding

success = False

before the attempt for loop. And setting success = True before the break of a successful fetch. Then changing this condition to:

if last_exc and not success: raise last_exc

I think that makes the intent of the condition more clear, and it seems to be working now for me with this change.

It looks like the latest version is changed and likely doesn't have this issue based on only a quick glance at the code. I will re-test with latest version a bit later.

FoamyGuy · 2025-08-25T22:09:52Z

examples/fruitjam_ntp_settings.toml

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries


I also just noticed all the copyright notices are set to my name. You can set these to your name or handle if you want.

settings.toml example with double quotes for floating point values mikeysklar attribution drop duplicate last_exc

FoamyGuy

Looks good to me. Thanks for all of the work on this!

Tested successfully on Fruit Jam 10.0.0-beta.2

mikeysklar · 2025-08-26T00:04:04Z

Thx @FoamyGuy for all your guidance.

I think I can reduce the risk of transient TIMEOUT issues. I have some debug scripts running now. Should I start another PR for that. It will more parameter tuning than anything else.

b-blake · 2025-08-26T00:14:06Z

Mikey,

Looks great to me. This was harder than it looked at the onset.. Your persistence won the day.

An idea on the ETIMEOUT issue. How about time.sleep(NTP_DELAY_S( + 1))*.
That way the delay increases with each ETIMEOUT.

Bruce

mikeysklar · 2025-08-26T00:24:36Z

@b-blake It actually did quite well with my stress test. No failures or significantly delays.

+---------+-------------------+-----------+-----------+----------+
| Cycle # | Server            | Attempts  | Failures  | Delay(s) |
+---------+-------------------+-----------+-----------+----------+
|   1     | pool.ntp.org      |     1     |     0     |   0.20   |
|   2     | time.google.com   |     1     |     0     |   0.10   |
|   3     | time.cloudflare   |     1     |     0     |   0.10   |
|   4     | pool.ntp.org      |     1     |     0     |   0.26   |
|   5     | time.google.com   |     1     |     0     |   0.09   |
+---------+-------------------+-----------+-----------+----------+

b-blake · 2025-08-26T00:38:01Z

@mikeysklar,

I setup a twenty try loop for 30 seconds between tries. (10 minutes) Below is what I got. I had applied my patch were the delay between got larger with each ETIMEOUT. e.g. 1.5 sec, 3.0sec, 4.5 sec . . . 12 sec

For reasons I cannot understand you have more reliable access to NTP and I do.. smh

Bruce
code.py START

Init display
Init background
Init caption
Init text area
Connecting to AP TestNet
NTP Server: pool.ntp.org
struct_time(tm_year=2025, tm_mon=8, tm_mday=25, tm_hour=20, tm_min=17, tm_sec=3, tm_wday=0, tm_yday=237, tm_isdst=-1)

1.0 Hours between sync_time() attempts. 3600 Seconds.
000006 2025/08/25 20:17:08 Monday DoY: 237
Code stopped by auto-reload. Reloading soon.
soft reboot

Auto-reload is on. Simply save files over USB to run them or enter REPL to disable.
code.py output:
code.py START

Init display
Init background
Init caption
Init text area
Connecting to AP TestNet
NTP timeout, attempt 1/8
NTP timeout, attempt 2/8
NTP timeout, attempt 3/8
NTP timeout, attempt 4/8
NTP Server: pool.ntp.org
struct_time(tm_year=2025, tm_mon=8, tm_mday=25, tm_hour=20, tm_min=17, tm_sec=41, tm_wday=0, tm_yday=237, tm_isdst=-1)

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:18:10 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:18:40 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:19:10 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:19:40 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:20:11 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:20:41 Monday DoY: 237
NTP timeout, attempt 1/8
NTP timeout, attempt 2/8
NTP timeout, attempt 3/8
NTP timeout, attempt 4/8
NTP timeout, attempt 5/8
NTP timeout, attempt 6/8

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:21:49 Monday DoY: 237
NTP timeout, attempt 1/8

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:22:22 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:22:52 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:23:22 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:23:52 Monday DoY: 237
NTP timeout, attempt 1/8
NTP timeout, attempt 2/8
NTP timeout, attempt 3/8
NTP timeout, attempt 4/8

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:24:42 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:25:12 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:25:42 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:26:12 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:26:42 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:27:12 Monday DoY: 237
NTP timeout, attempt 1/8

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:27:45 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:28:15 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:28:45 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:29:16 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:29:46 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:30:16 Monday DoY: 237

0.00833333 Hours between sync_time() attempts. 30 Seconds.
000030 2025/08/25 20:30:46 Monday DoY: 237

Code done running.

Press any key to enter the REPL. Use CTRL-D to reload.

ladyada · 2025-08-26T20:14:11Z

use "0.adafruit.pool.ntp.org" please

b-blake · 2025-08-26T22:35:35Z

@ladyada,

I implemented the new NTP pool and monitored the results.
The system clock was reset every 30 seconds for 20 minutes.
They were better than the official NTP pool by about 50%
These are the results:
Took 1 retry: 4
Took 2 retries 4
Took 3 retries 3
Took 4 retries 1
Took 8 retries 2

Bruce

Updating https://github.com/adafruit/Adafruit_CircuitPython_DotStar to 2.2.18 from 2.2.17: > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#71 from dhalbert/spi-lock-managment Updating https://github.com/adafruit/Adafruit_CircuitPython_EPD to 2.15.0 from 2.14.0: > Merge pull request adafruit/Adafruit_CircuitPython_EPD#94 from adafruit/UC8197 > Merge pull request adafruit/Adafruit_CircuitPython_EPD#95 from adafruit/ssd1883 > Merge pull request adafruit/Adafruit_CircuitPython_EPD#93 from adafruit/ssd1680_fix > Merge pull request adafruit/Adafruit_CircuitPython_EPD#90 from AJMansfield/patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_JD79661 to 1.0.1 from 1.0.0: > Merge pull request adafruit/Adafruit_CircuitPython_JD79661#1 from adafruit/cleanup Updating https://github.com/adafruit/Adafruit_CircuitPython_TLV320 to 1.2.1 from 1.1.0: > Merge pull request adafruit/Adafruit_CircuitPython_TLV320#11 from samblenny/fix-example-link > Merge pull request adafruit/Adafruit_CircuitPython_TLV320#10 from samblenny/volume-fixes Updating https://github.com/adafruit/Adafruit_CircuitPython_FruitJam to 1.2.0 from 0.5.0: > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#13 from FoamyGuy/volume_api > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#14 from mikeysklar/ntp-helper > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#12 from mikeysklar/headphone-speaker > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#11 from adafruit/TheKitty-patch-1 > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#9 from relic-se/request_display_config-default > Merge pull request adafruit/Adafruit_CircuitPython_FruitJam#8 from relic-se/any_button_pressed-fix Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Added the following libraries: Adafruit_CircuitPython_UC8253

ntp module

544adaa

helper code to get time sync with minimal fuss on the Fruit Jam.

mikeysklar changed the title ~~Fruit Jam ntp module~~ Fruit Jam NTP module Aug 22, 2025

ladyada requested a review from FoamyGuy August 22, 2025 01:59

FoamyGuy requested changes Aug 22, 2025

View reviewed changes

mikeysklar added 4 commits August 22, 2025 18:30

mock imports / requirements

fc388c5

ntp and connection_manager libs

rtc lib mock add

6b86bc9

Update __init__.py

75e5fb7

blank line missing.

retry logic for ETIMEOUT

96e4575

FoamyGuy reviewed Aug 25, 2025

View reviewed changes

mikeysklar mentioned this pull request Aug 25, 2025

NTP time sync helper for Airlift boards adafruit/circuitpython#10572

Closed

helpers for sync_time

d2ae05e

ruff was getting upset about too many branches

FoamyGuy reviewed Aug 25, 2025

View reviewed changes

settings.toml float quote, attribution, duplicate last_exc setting

cb5d1db

settings.toml example with double quotes for floating point values mikeysklar attribution drop duplicate last_exc

FoamyGuy approved these changes Aug 25, 2025

View reviewed changes

FoamyGuy merged commit 9259a09 into adafruit:main Aug 25, 2025
1 check passed

		@@ -0,0 +1,33 @@
		# SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries

Fruit Jam NTP module #14

Fruit Jam NTP module #14

Uh oh!

Conversation

mikeysklar commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FoamyGuy left a comment

Choose a reason for hiding this comment

Uh oh!

mikeysklar commented Aug 22, 2025

Uh oh!

FoamyGuy commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mikeysklar commented Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FoamyGuy Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

b-blake Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

mikeysklar commented Aug 25, 2025

Uh oh!

mikeysklar commented Aug 25, 2025

Uh oh!

FoamyGuy Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FoamyGuy Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

FoamyGuy Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

FoamyGuy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mikeysklar commented Aug 26, 2025

Uh oh!

b-blake commented Aug 26, 2025

Uh oh!

mikeysklar commented Aug 26, 2025

Uh oh!

b-blake commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ladyada commented Aug 26, 2025

Uh oh!

b-blake commented Aug 26, 2025

Uh oh!

Uh oh!

mikeysklar commented Aug 22, 2025 •

edited

Loading

FoamyGuy commented Aug 22, 2025 •

edited

Loading

mikeysklar commented Aug 23, 2025 •

edited

Loading

FoamyGuy Aug 25, 2025 •

edited

Loading

b-blake commented Aug 26, 2025 •

edited

Loading