Skip to main content

Draw a traditional 12-hour analog clock face with hour and minute hands. Allows you to provide graphics to customize the clock.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Draw a traditional 12-hour analog clock face with hour and minute hands. Allows you to provide graphics to customize the clock.

Dependencies

This library depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

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-display-analogclock

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

sudo pip3 install adafruit-circuitpython-display-analogclock

To install in a virtual environment in your current project:

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

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_display_analogclock

Or the following command to update an existing version:

circup update

Usage Example

import board

from adafruit_display_analogclock import AnalogClock

display = board.DISPLAY

plain_clockface = AnalogClock(
    "green_hour_hand.bmp",
    "green_minute_hand.bmp",
    (120, 120),
    106,
    number_label_scale=2,
    number_label_color=0x00FF00,
)

display.root_group = plain_clockface

plain_clockface.set_time(3, 30)

while True:
    pass

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

Built Distribution

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

File details

Details for the file adafruit_circuitpython_display_analogclock-1.0.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_display_analogclock-1.0.4.tar.gz
Algorithm Hash digest
SHA256 137b689b7132c988cd14769ea4a0c6313e25736705ca0832733d5aba0a9a8a18
MD5 5ad24764ad330f44d0154994e6a79640
BLAKE2b-256 7ed9c40753c94b8191775268de01ceb1509f4bff5c0697e799629fb3118be471

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_display_analogclock-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_display_analogclock-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fce2b31222036014eb517f8758ce9cd8780e8e4d1d5135991c6343288fd4c532
MD5 e09138d018c2af6d46863371b2819673
BLAKE2b-256 567e8f052eb3a009978bd0f58a91751a7e91f78ef7dd3b4328b7a6c439262fe8

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