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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-ntp-3.0.5.tar.gz
Algorithm Hash digest
SHA256 e940693e3a84ca53658f39719b157a79dd1025860d19a5fe5f0964961a4114cf
MD5 f70b0ddda487dc4624029b48176875cb
BLAKE2b-256 29dcc49f13e17620e37d9da443ae4b9e262a2df84ebe8c2f61a2d50534a85ecd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c4c6e07d6354567840611c3ebe3b06607ead6ac2fcfbbf830450314ba5c186b0
MD5 4d697444f9cdaa7147accd4fda4f3b6a
BLAKE2b-256 c32f0ffbf75632d45de0e467ca9ccb56a2ca9042df99adb068caa844652c8d8e

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