Skip to content

About

A circular gauge that can be filled to a certain value. The origin is set using ``x`` and ``y`` coordinates relative to the center of the gauge.

Resources

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Black

Displayio widget that creates circular gauges that can have their fill value set dynamically.

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 or individual libraries can be installed using circup.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

.. todo:: Remove the above note if PyPI version is/will be available at time of release.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-displayio-gauge

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

sudo pip3 install circuitpython-displayio-gauge

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-displayio-gauge

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 displayio_gauge

Or the following command to update an existing version:

circup update

Usage Example

.. todo:: Add a quick, simple example. It and other examples should live in the

examples folder and be included in docs/examples.rst.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.

About

A circular gauge that can be filled to a certain value. The origin is set using ``x`` and ``y`` coordinates relative to the center of the gauge.

Resources

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages