Introduction¶
Dynamic progress bar widget for CircuitPython displays
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-progressbar
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-progressbar
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-progressbar
Usage Example¶
An for this library is within the examples directory.
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.
Table of Contents¶
- API Definition
adafruit_progressbar
ProgressBarBase
ProgressBarBase.bar_color
ProgressBarBase.border_color
ProgressBarBase.border_thickness
ProgressBarBase.fill
ProgressBarBase.fill_height()
ProgressBarBase.fill_width()
ProgressBarBase.get_value_ratio()
ProgressBarBase.margin_size
ProgressBarBase.maximum
ProgressBarBase.minimum
ProgressBarBase.progress
ProgressBarBase.range
ProgressBarBase.value
ProgressBarBase.widget_height
ProgressBarBase.widget_size
ProgressBarBase.widget_width
horizontalprogressbar
HorizontalFillDirection
HorizontalProgressBar
HorizontalProgressBar.bar_color
HorizontalProgressBar.border_color
HorizontalProgressBar.border_thickness
HorizontalProgressBar.fill
HorizontalProgressBar.fill_height()
HorizontalProgressBar.fill_width()
HorizontalProgressBar.get_value_ratio()
HorizontalProgressBar.margin_size
HorizontalProgressBar.maximum
HorizontalProgressBar.minimum
HorizontalProgressBar.progress
HorizontalProgressBar.range
HorizontalProgressBar.value
HorizontalProgressBar.widget_height
HorizontalProgressBar.widget_size
HorizontalProgressBar.widget_width
progressbar
ProgressBar
ProgressBar.bar_color
ProgressBar.border_color
ProgressBar.border_thickness
ProgressBar.fill
ProgressBar.fill_height()
ProgressBar.fill_width()
ProgressBar.get_value_ratio()
ProgressBar.margin_size
ProgressBar.maximum
ProgressBar.minimum
ProgressBar.progress
ProgressBar.range
ProgressBar.value
ProgressBar.widget_height
ProgressBar.widget_size
ProgressBar.widget_width
verticalprogressbar
VerticalFillDirection
VerticalProgressBar
VerticalProgressBar.bar_color
VerticalProgressBar.border_color
VerticalProgressBar.border_thickness
VerticalProgressBar.fill
VerticalProgressBar.fill_height()
VerticalProgressBar.fill_width()
VerticalProgressBar.get_value_ratio()
VerticalProgressBar.margin_size
VerticalProgressBar.maximum
VerticalProgressBar.minimum
VerticalProgressBar.progress
VerticalProgressBar.range
VerticalProgressBar.value
VerticalProgressBar.widget_height
VerticalProgressBar.widget_size
VerticalProgressBar.widget_width