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.3.tar.gz (24.0 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.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.3.3.tar.gz
Algorithm Hash digest
SHA256 3fa2a315e651cd9e407779aaeeacfe55ba0d5efb21b47e9f9043519771ffa9f4
MD5 ec8d1d96449cce8483d87df798a32b68
BLAKE2b-256 03009bfbcc4d8331ee783aeff04d648b3b48139ace2df373ee0a83023da7b58d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ntp-3.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e3dbc8e10197e69497a6fcd154e3bc4a0069dce009450694b48d3d42be09adba
MD5 fe51298b64eab33780de6ef689f883ad
BLAKE2b-256 c4f55bad6eae25f989e4cd95dbaff7710b1684163ca1c359277373e51d6c11b6

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