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.7.tar.gz (28.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.0.7-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-ntp-3.0.7.tar.gz
Algorithm Hash digest
SHA256 e6d79879570f691d3f483560544daa98b68005c74f0ebfe459ce58183ae2df29
MD5 78e212637dd409b974342a7cd241dcff
BLAKE2b-256 52ec5926c9cc91d1cc522ecfb9bb6f4785cda5dfeb41d4bfa2d75d05fd3e4cc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ccb2cc78368000cbca774d0145450bb5e861aa9e14870412ef78505cb1c5e23b
MD5 eec81458388f9ad8acbfb9de03d5f474
BLAKE2b-256 a352289898de1f61038b84fe75079aceb6531847bcb0f2ae0c4ebf2919392425

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