Skip to main content

Network Time Protocol (NTP) helper for Python

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Network Time Protocol (NTP) helper for CircuitPython.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ntp

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ntp

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ntp

Usage Example

import adafruit_connection_manager
import adafruit_ntp
import os
import time
import wifi

wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
wifi.radio.connect(wifi_ssid, wifi_password)

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)
    time.sleep(1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ntp-3.3.4.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_ntp-3.3.4-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_ntp-3.3.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.3.4.tar.gz
Algorithm Hash digest
SHA256 cd820694055a60c786812f0101dc3d7027b53350580157421a07a9e4ee0e87b8
MD5 ccfaf0cd826239b2a86b3a1132651df0
BLAKE2b-256 43ddc1c5f932e7d1dc56b414228206823585fd646d22236880d21b3b6e12550a

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ntp-3.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e11e44acfd21988acbd0c4426077c1140a4f1565b1c18515e0133d6843e35e1a
MD5 425fc13f7b6f99a879850866c63d53a1
BLAKE2b-256 6bb06c2328e340e520d34253ddd475b4c79246d4275fcff82cda473b31315661

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page