Skip to main content

Network Time Protocol (NTP) helper for Python

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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_ntp
import socketpool
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.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)

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.0.11.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-ntp-3.0.11.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ntp-3.0.11.tar.gz
Algorithm Hash digest
SHA256 755dd106acf73a2ececb498cc70b8a3096eccffb5748ed058d5851b6f7f5ec50
MD5 7671ee4bb212426e8743b08d3500c8b4
BLAKE2b-256 e576b7b9b9049040626950b1e5447342effa25708155322c3ba93cc3c20b71fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e13a784b15c196ac6307367940eab54b3d6b332c7d0a47602d6b67518fe6ca
MD5 29c551c2400411b9592dc0982dfa81d9
BLAKE2b-256 d80480b385fb92d7566ec513b6b0a6d48ce85ee272d790f668195be2d3a682c8

See more details on using hashes here.

Supported by

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