Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Latest commit f22112d Jul 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_ra8875 Linting Jul 2, 2019
docs Added Learn Guide link Mar 20, 2019
examples Fixed with CP4, added 480x80, shrunk Jul 2, 2019
.gitignore Linting Jul 2, 2019
.pylintrc Added hidden files Jan 19, 2019
.readthedocs.yml Added hidden files Jan 19, 2019
.travis.yml Made requested changes Feb 12, 2019
CODE_OF_CONDUCT.md Initial Commit Jan 15, 2019
LICENSE Initial Commit Jan 15, 2019
README.rst Fixed links Jan 26, 2019
requirements.txt Initial Commit Jan 15, 2019
setup.py Made requested changes Feb 12, 2019

README.rst

Introduction

Documentation Status Discord Build Status

This is a full featured CircuitPython Library for the RA8875 that included all of the hardware accelerated drawing functions as the original Arduino library. A lot of the functionality has been streamlined with a focus on ease of use that is still flexible enough to make full use of the hardware. For instace, Graphics and Text mode switching is now automatic and handled in the background.

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.

Usage Example

See examples/ra8875_simpletest.py and examples/ra8875_bmptest.py for examples of the module's usage. When running the bmptest, be sure to upload the blinka.bmp image to the root folder as well.

Contributing

Contributions are welcome! Please read our Code of Conduct 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 package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ra8875 --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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.

You can’t perform that action at this time.