.. image:: https://readthedocs.org/projects/ili9163/badge/?version=latest :target: https://ili9163.readthedocs.io/en/latest/ :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg :target: https://discord.gg/nBQh6qu :alt: Discord

.. image:: https://api.travis-ci.org/electronut/Electronutlabs_CircuitPython_ILI9163.svg?branch=master :target: https://travis-ci.org/electronut/Electronutlabs_CircuitPython_ILI9163/ :alt: Build Status

displayio driver for ILI9163 TFT-LCD displays.

Dependencies

This driver depends on:

• Adafruit CircuitPython <https://github.com/adafruit/circuitpython>_
• Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>_

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>_.

Usage Example

.. code-block:: python

import board
import displayio
import electronutlabs_ili9163

spi = board.SPI()
tft_cs = board.D4
tft_dc = board.D33

displayio.release_displays()
display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs)

display = electronutlabs_ili9163.ILI9163(display_bus, width=160, height=128)

# Make the display context
splash = displayio.Group(max_size=10)
display.show(splash)

color_bitmap = displayio.Bitmap(160, 128, 1)
color_palette = displayio.Palette(1)
color_palette[0] = 0xFF0000

bg_sprite = displayio.TileGrid(color_bitmap,
                            pixel_shader=color_palette,
                            x=0, y=0)
splash.append(bg_sprite)

while True:
    pass

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/electronut/Electronutlabs_CircuitPython_ILI9163/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 electronutlabs-circuitpython-ili9163 --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.