Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-flipclock/badge/?version=latest
:target: https://docs.circuitpython.org/projects/displayio_flipclock/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
DisplayIO widgets for showing flip clock style animattions changing from one number to another.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `CedarGrove PaletteFader <https://github.com/CedarGroveStudios/CircuitPython_PaletteFader.git>`_
This command can be used to install the PaletteFader:
.. code-block:: shell
circup install cedargrove_palettefader
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase Feather ESP32-S2 TFT from the Adafruit shop <https://www.adafruit.com/product/5300/>`_
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-displayio-flipclock/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-displayio-flipclock
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-displayio-flipclock
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-displayio-flipclock
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_displayio_flipclock
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
from displayio import Group
import board
import adafruit_imageload
from adafruit_displayio_flipclock.flip_digit import FlipDigit
ANIMATION_DELAY = 0.02
ANIMATION_FRAME_COUNT = 10
TRANSPARENT_INDEXES = range(11)
BRIGHTER_LEVEL = 0.99
DARKER_LEVEL = 0.5
MEDIUM_LEVEL = 0.9
display = board.DISPLAY
main_group = Group()
static_spritesheet, static_palette = adafruit_imageload.load("static_sheet.bmp")
static_palette.make_transparent(0)
top_animation_spritesheet, top_animation_palette = adafruit_imageload.load(
"grey_top_animation_sheet.bmp"
)
bottom_animation_spritesheet, bottom_animation_palette = adafruit_imageload.load(
"grey_bottom_animation_sheet.bmp"
)
for i in TRANSPARENT_INDEXES:
top_animation_palette.make_transparent(i)
bottom_animation_palette.make_transparent(i)
SPRITE_WIDTH = static_spritesheet.width // 3
SPRITE_HEIGHT = (static_spritesheet.height // 4) // 2
flip_digit = FlipDigit(
static_spritesheet,
static_palette,
top_animation_spritesheet,
top_animation_palette,
bottom_animation_spritesheet,
bottom_animation_palette,
SPRITE_WIDTH,
SPRITE_HEIGHT,
anim_frame_count=ANIMATION_FRAME_COUNT,
anim_delay=ANIMATION_DELAY,
brighter_level=BRIGHTER_LEVEL,
darker_level=DARKER_LEVEL,
medium_level=MEDIUM_LEVEL,
)
flip_digit.anchor_point = (0.5, 0.5)
flip_digit.anchored_position = (display.width // 2, display.height // 2)
main_group.append(flip_digit)
display.root_group = main_group
while True:
for i in range(10):
flip_digit.value = i
time.sleep(0.75)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio_flipclock/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-displayio-flipclock",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,displayio_flipclock,displayio,clock,time,flipclock,display,lcd,widget,ui,number",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/95/bf/8853cc8fc573a05697fe6f237c0eab05789a0ef4a390c28f2c1d77a63c3d/adafruit-circuitpython-displayio-flipclock-1.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-flipclock/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/displayio_flipclock/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nDisplayIO widgets for showing flip clock style animattions changing from one number to another.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n* `CedarGrove PaletteFader <https://github.com/CedarGroveStudios/CircuitPython_PaletteFader.git>`_\n\nThis command can be used to install the PaletteFader:\n\n.. code-block:: shell\n\n circup install cedargrove_palettefader\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase Feather ESP32-S2 TFT from the Adafruit shop <https://www.adafruit.com/product/5300/>`_\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-displayio-flipclock/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-displayio-flipclock\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-displayio-flipclock\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install adafruit-circuitpython-displayio-flipclock\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_displayio_flipclock\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n from displayio import Group\n import board\n import adafruit_imageload\n from adafruit_displayio_flipclock.flip_digit import FlipDigit\n\n\n ANIMATION_DELAY = 0.02\n ANIMATION_FRAME_COUNT = 10\n TRANSPARENT_INDEXES = range(11)\n BRIGHTER_LEVEL = 0.99\n DARKER_LEVEL = 0.5\n MEDIUM_LEVEL = 0.9\n\n display = board.DISPLAY\n main_group = Group()\n\n static_spritesheet, static_palette = adafruit_imageload.load(\"static_sheet.bmp\")\n static_palette.make_transparent(0)\n\n top_animation_spritesheet, top_animation_palette = adafruit_imageload.load(\n \"grey_top_animation_sheet.bmp\"\n )\n bottom_animation_spritesheet, bottom_animation_palette = adafruit_imageload.load(\n \"grey_bottom_animation_sheet.bmp\"\n )\n\n for i in TRANSPARENT_INDEXES:\n top_animation_palette.make_transparent(i)\n bottom_animation_palette.make_transparent(i)\n\n SPRITE_WIDTH = static_spritesheet.width // 3\n SPRITE_HEIGHT = (static_spritesheet.height // 4) // 2\n\n flip_digit = FlipDigit(\n static_spritesheet,\n static_palette,\n top_animation_spritesheet,\n top_animation_palette,\n bottom_animation_spritesheet,\n bottom_animation_palette,\n SPRITE_WIDTH,\n SPRITE_HEIGHT,\n anim_frame_count=ANIMATION_FRAME_COUNT,\n anim_delay=ANIMATION_DELAY,\n brighter_level=BRIGHTER_LEVEL,\n darker_level=DARKER_LEVEL,\n medium_level=MEDIUM_LEVEL,\n )\n\n flip_digit.anchor_point = (0.5, 0.5)\n flip_digit.anchored_position = (display.width // 2, display.height // 2)\n\n main_group.append(flip_digit)\n\n display.root_group = main_group\n\n while True:\n for i in range(10):\n flip_digit.value = i\n time.sleep(0.75)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio_flipclock/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DisplayIO widgets for showing flip clock style animattions changing from one number to another.",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"displayio_flipclock",
"displayio",
"clock",
"time",
"flipclock",
"display",
"lcd",
"widget",
"ui",
"number"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "749bb8cb62659c58e613b9b9efa8266c1bda2586947bc28142a1807aaddbd81d",
"md5": "c7b72ea2bd4d71c34003dfc2d76dada8",
"sha256": "dfa75319a79d9d1f108b609f6d226710a187260fc59b3615e52b64e187cfc57d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_flipclock-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7b72ea2bd4d71c34003dfc2d76dada8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10760,
"upload_time": "2023-12-18T17:19:03",
"upload_time_iso_8601": "2023-12-18T17:19:03.736929Z",
"url": "https://files.pythonhosted.org/packages/74/9b/b8cb62659c58e613b9b9efa8266c1bda2586947bc28142a1807aaddbd81d/adafruit_circuitpython_displayio_flipclock-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95bf8853cc8fc573a05697fe6f237c0eab05789a0ef4a390c28f2c1d77a63c3d",
"md5": "93b9cc6c0cc429eac13ad34bc0426053",
"sha256": "78e34374097884f4c320af59449a0f70718575efea46b2c5a068dd88a7fb2f5e"
},
"downloads": -1,
"filename": "adafruit-circuitpython-displayio-flipclock-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "93b9cc6c0cc429eac13ad34bc0426053",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 168963,
"upload_time": "2023-12-18T17:19:05",
"upload_time_iso_8601": "2023-12-18T17:19:05.807460Z",
"url": "https://files.pythonhosted.org/packages/95/bf/8853cc8fc573a05697fe6f237c0eab05789a0ef4a390c28f2c1d77a63c3d/adafruit-circuitpython-displayio-flipclock-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 17:19:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DisplayIO_FlipClock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-displayio-flipclock"
}
JSON
