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.3.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_display_analogclock-1.0.3.tar.gz
Algorithm Hash digest
SHA256 ab51d18bdc7f26e3104db5acf6aa150fa2ce4a5d8bc858ec609dffceed50846c
MD5 7b47375a5718d8e348bd7e0b2f4c3ca7
BLAKE2b-256 eeb8699bda4dc75e1af34ce21344fbe342678ff14c15e311711305af3790b5b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_display_analogclock-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9d498f560d81611d3722dedf8985239d9a37fb80d44af5597c2daef959d6e800
MD5 ae0ba2bd29b3fe227c27b190e8abcd62
BLAKE2b-256 f91b166d46924dc7c9c058b1fdd9bf09e7b8165d0d8d375dcee61c30fee2e156

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