https://github.com/jposada202020/circuitpython_uplot
Small framework to create graphics in CircuitPython
https://github.com/jposada202020/circuitpython_uplot
bar cartesian circuitpython displayio graphical logging pie-chart plot polar scientific svg
Last synced: 3 months ago
JSON representation
Small framework to create graphics in CircuitPython
- Host: GitHub
- URL: https://github.com/jposada202020/circuitpython_uplot
- Owner: jposada202020
- License: mit
- Created: 2023-02-10T00:10:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-08T13:09:27.000Z (7 months ago)
- Last Synced: 2025-06-28T18:06:58.699Z (3 months ago)
- Topics: bar, cartesian, circuitpython, displayio, graphical, logging, pie-chart, plot, polar, scientific, svg
- Language: Python
- Homepage:
- Size: 4.7 MB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://github.com/jposada202020/CircuitPython_uplot/workflows/Build%20CI/badge.svg
:target: https://github.com/jposada202020/CircuitPython_uplot/actions
:alt: Build Status
.. image:: https://img.shields.io/pypi/v/circuitpython-uplot.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/circuitpython-uplot
.. image:: https://static.pepy.tech/personalized-badge/circuitpython-uplot?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
:alt: Total PyPI downloads
:target: https://pepy.tech/project/circuitpython-uplot
Framework to display different graphical plots in displayio.
Take a look in the `examples `_ section in RTD to see the gallery
For detailed view of the library please refer to the `Quick start guide `_
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/readme.png
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/readme2.png
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/readme3.png
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/readme4.png
Below a picture of a real live application. for more information visit the project `page `_. Thanks to @Casainho
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/logging.png
Dependencies
=============
This library depends on:
* `Adafruit CircuitPython `_
This library is resource consuming, may or may not with some CircuitPython supported devices.
Tinker it as you wish in order to work.
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:
.. code-block:: shell
pip3 install circuitpython-uplot
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-uplot
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 circuitpython-uplot
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 circuitpython_uplot
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
To learn how to use the library please refer to the examples folder or the
`Quick start guide `_
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
Contributing
============
Contributions are welcome!