145 lines
4.1 KiB
ReStructuredText
145 lines
4.1 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display_shapes/badge/?version=latest
|
|
:target: https://circuitpython.readthedocs.io/projects/display_shapes/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
.. image:: https://img.shields.io/discord/327254708534116352.svg
|
|
:target: https://discord.gg/nBQh6qu
|
|
:alt: Discord
|
|
|
|
.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Display_Shapes.svg?branch=master
|
|
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Display_Shapes
|
|
:alt: Build Status
|
|
|
|
Various common shapes for use with displayio
|
|
|
|
|
|
Dependencies
|
|
=============
|
|
This driver depends on:
|
|
|
|
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
|
|
|
|
Please ensure all dependencies are available on the CircuitPython filesystem.
|
|
This is easily achieved by downloading
|
|
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
|
|
|
|
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-display_shapes/>`_. To install for current user:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install adafruit-circuitpython-display_shapes
|
|
|
|
To install system-wide (this may be required in some cases):
|
|
|
|
.. code-block:: shell
|
|
|
|
sudo pip3 install adafruit-circuitpython-display_shapes
|
|
|
|
To install in a virtual environment in your current project:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir project-name && cd project-name
|
|
python3 -m venv .env
|
|
source .env/bin/activate
|
|
pip3 install adafruit-circuitpython-display_shapes
|
|
|
|
Usage Example
|
|
=============
|
|
|
|
..code-block:: python
|
|
|
|
import board
|
|
import displayio
|
|
from adafruit_display_shapes.rect import Rect
|
|
from adafruit_display_shapes.circle import Circle
|
|
from adafruit_display_shapes.roundrect import RoundRect
|
|
|
|
splash = displayio.Group(max_size=10)
|
|
board.DISPLAY.show(splash)
|
|
|
|
color_bitmap = displayio.Bitmap(320, 240, 1)
|
|
color_palette = displayio.Palette(1)
|
|
color_palette[0] = 0xFFFFFF
|
|
bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, position=(0, 0))
|
|
print(bg_sprite.position)
|
|
splash.append(bg_sprite)
|
|
|
|
rect = Rect(80, 20, 41, 41, fill=0x0)
|
|
splash.append(rect)
|
|
|
|
circle = Circle(100, 100, 20, fill=0x00FF00, outline=0xFF00FF)
|
|
splash.append(circle)
|
|
|
|
rect2 = Rect(50, 100, 61, 81, outline=0x0, stroke=3)
|
|
splash.append(rect2)
|
|
|
|
roundrect = RoundRect(10, 10, 61, 81, 10, fill=0x0, outline=0xFF00FF, stroke=6)
|
|
splash.append(roundrect)
|
|
|
|
while True:
|
|
pass
|
|
|
|
|
|
Contributing
|
|
============
|
|
|
|
Contributions are welcome! Please read our `Code of Conduct
|
|
<https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes/blob/master/CODE_OF_CONDUCT.md>`_
|
|
before contributing to help this project stay welcoming.
|
|
|
|
Building locally
|
|
================
|
|
|
|
Zip release files
|
|
-----------------
|
|
|
|
To build this library locally you'll need to install the
|
|
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
|
|
|
|
.. code-block:: shell
|
|
|
|
python3 -m venv .env
|
|
source .env/bin/activate
|
|
pip install circuitpython-build-tools
|
|
|
|
Once installed, make sure you are in the virtual environment:
|
|
|
|
.. code-block:: shell
|
|
|
|
source .env/bin/activate
|
|
|
|
Then run the build:
|
|
|
|
.. code-block:: shell
|
|
|
|
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-display_shapes --library_location .
|
|
|
|
Sphinx documentation
|
|
-----------------------
|
|
|
|
Sphinx is used to build the documentation based on rST files and comments in the code. First,
|
|
install dependencies (feel free to reuse the virtual environment from above):
|
|
|
|
.. code-block:: shell
|
|
|
|
python3 -m venv .env
|
|
source .env/bin/activate
|
|
pip install Sphinx sphinx-rtd-theme
|
|
|
|
Now, once you have the virtual environment activated:
|
|
|
|
.. code-block:: shell
|
|
|
|
cd docs
|
|
sphinx-build -E -W -b html . _build/html
|
|
|
|
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
|
|
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
|
|
locally verify it will pass.
|