Skip to content

Add displayio E-Paper drivers #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ build*
*zip
.env
bundles
.DS_Store
15 changes: 15 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -535,3 +535,18 @@
[submodule "libraries/helpers/bitmapsaver"]
path = libraries/helpers/bitmapsaver
url = https://github.com/adafruit/Adafruit_CircuitPython_BitmapSaver.git
[submodule "libraries/drivers/il91874"]
path = libraries/drivers/il91874
url = https://github.com/adafruit/Adafruit_CircuitPython_IL91874.git
[submodule "libraries/drivers/il0373"]
path = libraries/drivers/il0373
url = https://github.com/adafruit/Adafruit_CircuitPython_IL0373.git
[submodule "libraries/drivers/il0398"]
path = libraries/drivers/il0398
url = https://github.com/adafruit/Adafruit_CircuitPython_IL0398.git
[submodule "libraries/drivers/ssd1608"]
path = libraries/drivers/ssd1608
url = https://github.com/adafruit/Adafruit_CircuitPython_SSD1608.git
[submodule "libraries/drivers/ssd1675"]
path = libraries/drivers/ssd1675
url = https://github.com/adafruit/Adafruit_CircuitPython_SSD1675.git
69 changes: 57 additions & 12 deletions docs/drivers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ specific boards.

Adafruit CircuitPlayground Express <https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/>
Adafruit FeatherWings <https://circuitpython.readthedocs.io/projects/featherwing/en/latest/>
PyBadger (PyBadge and PyGamer) <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
Adafruit PyPortal <https://circuitpython.readthedocs.io/projects/pyportal/en/latest/>

Helper Libraries
-----------------
Expand Down Expand Up @@ -57,13 +59,14 @@ Helpers for building graphical interfaces using the displayio core module.
Display Button <https://circuitpython.readthedocs.io/projects/display_button/en/latest/>
Display Shapes <https://circuitpython.readthedocs.io/projects/display_shapes/en/latest/>
Display Text <https://circuitpython.readthedocs.io/projects/display-text/en/latest/>
PyBadger <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
PYOA <https://circuitpython.readthedocs.io/projects/pyoa/en/latest/>
Turtle Graphics <https://circuitpython.readthedocs.io/projects/turtle/en/latest/>
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
Framebuf Module <https://circuitpython.readthedocs.io/projects/framebuf/en/latest/>
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
Image Load <https://circuitpython.readthedocs.io/projects/imageload/en/latest/>
Bitmap Saver <https://circuitpython.readthedocs.io/projects/bitmapsaver/en/latest/>
GFX (framebuf) <https://circuitpython.readthedocs.io/projects/gfx/en/latest/>

Motor Helpers
^^^^^^^^^^^^^^
Expand Down Expand Up @@ -134,6 +137,7 @@ Music, noisemakers, and more.

.. toctree::

MIDI <https://circuitpython.readthedocs.io/projects/midi/en/latest/>
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>

Expand All @@ -150,6 +154,7 @@ Miscellaneous Helpers
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
Test Repo <https://circuitpython.readthedocs.io/projects/testrepo/en/latest/>


Blinky
Expand All @@ -170,25 +175,63 @@ Displays

Drivers used to display information. Either pixel or segment based.

Pixel based displays are implemented in two different ways. The original method called "framebuf"
uses a traditional frame buffer model where all pixels are stored in the microcontroller's ram. The
newer method called "displayio" generates the pixels on the fly and relies on the display's ram to
store the final pixels. "displayio" drivers will also work with CircuitPython to display error
messages and other output to the display when the user code is not using it.

The "displayio" drivers are recommended.

Color TFT-LCD
^^^^^^^^^^^^^^^

.. toctree::

HX8357 (displayio) <https://circuitpython.readthedocs.io/projects/hx8357/en/latest/>
ILI9341 and ILI9340 (displayio) <https://circuitpython.readthedocs.io/projects/ili9341/en/latest/>
ST7735 (displayio) <https://circuitpython.readthedocs.io/projects/st7735/en/latest/>
ST7735R (displayio) <https://circuitpython.readthedocs.io/projects/st7735r/en/latest/>
ST7789 (displayio) <https://circuitpython.readthedocs.io/projects/st7789/en/latest/>
RGB Displays (framebuf) <https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/>

OLED
^^^^^^^^^^^^^^^

.. toctree::

SSD1306 OLED (displayio) <https://circuitpython.readthedocs.io/projects/displayio_ssd1306/en/latest/>
SSD1306 OLED (framebuf) <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
SSD1322 OLED (displayio) <https://circuitpython.readthedocs.io/projects/ssd1322/en/latest/>
SSD1325 OLED (displayio) <https://circuitpython.readthedocs.io/projects/ssd1325/en/latest/>
SSD1327 OLED (displayio) <https://circuitpython.readthedocs.io/projects/ssd1327/en/latest/>
SSD1331 OLED (displayio) <https://circuitpython.readthedocs.io/projects/ssd1331/en/latest/>
SSD1351 OLED (displayio) <https://circuitpython.readthedocs.io/projects/ssd1351/en/latest/>

E-Paper / E-Ink
^^^^^^^^^^^^^^^

.. toctree::

E-Paper Display (framebuf) <https://circuitpython.readthedocs.io/projects/epd/en/latest/>
IL0373 (displayio) <https://circuitpython.readthedocs.io/projects/il0373/en/latest/>
IL0398 (displayio) <https://circuitpython.readthedocs.io/projects/il0398/en/latest/>
IL91874 (displayio) <https://circuitpython.readthedocs.io/projects/il91874/en/latest/>
SSD1608 (displayio) <https://circuitpython.readthedocs.io/projects/ssd1608/en/latest/>
SSD1675 (displayio) <https://circuitpython.readthedocs.io/projects/ssd1675/en/latest/>

Other
^^^^^^^^^^^^^^^

.. toctree::

Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/en/latest/>
E-Paper Display <https://circuitpython.readthedocs.io/projects/epd/en/latest/>
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/en/latest/>
HX8357 3.5-inch TFT Display Driver <https://circuitpython.readthedocs.io/projects/hx8357/en/latest/>
ILI9341 and ILI9340 TFT-LCD Display Driver <https://circuitpython.readthedocs.io/projects/ili9341/en/latest/>
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/en/latest/>
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/en/latest/>
Nokia PCD8544 Display <https://circuitpython.readthedocs.io/projects/pcd8544/en/latest/>
RA8875 40-Pin Display Driver <https://circuitpython.readthedocs.io/projects/ra8875/en/latest/>
RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/>
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
SSD1331 OLED Display Driver <https://circuitpython.readthedocs.io/projects/ssd1331/en/latest/>
SSD1351 OLED Display Driver <https://circuitpython.readthedocs.io/projects/ssd1351/en/latest/>
Sharp Memory Display <https://circuitpython.readthedocs.io/projects/sharpmemorydisplay/en/latest/>
ST7735 TFT-LCD displays <https://circuitpython.readthedocs.io/projects/st7735/en/latest/>
ST7735R TFT-LCD displays <https://circuitpython.readthedocs.io/projects/st7735r/en/latest/>
ST7789 TFT-LCD displays <https://circuitpython.readthedocs.io/projects/st7789/en/latest/>

Real-time clocks
-----------------
Expand Down Expand Up @@ -221,6 +264,7 @@ Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/en/latest/>
MLX90390 3 Axis Magnetometer <https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/>
MMA8451 3 Axis Accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/en/latest/>
MSA301 3 Axis Accelerometer <https://circuitpython.readthedocs.io/projects/msa301/en/latest/>
TLV493D 3 Axis Magnetometer <https://circuitpython.readthedocs.io/projects/tlv493d/en/latest/>

Environmental Sensors
Expand Down Expand Up @@ -286,6 +330,7 @@ These sensors measure the ``distance`` to another object and may also measure li

Garmin LIDARLite I2C <https://circuitpython.readthedocs.io/projects/lidarlite/en/latest/>
HC-SR04 Ultrasonic Range Sensors <https://circuitpython.readthedocs.io/projects/hcsr04/en/latest/>
Slamtech RPLidar <https://circuitpython.readthedocs.io/projects/rplidar/en/latest/>
TFmini IR Time of Flight ~30cm - 12m <https://circuitpython.readthedocs.io/projects/tfmini/en/latest/>
US-100 Ultrasonic Distance Sensor <https://circuitpython.readthedocs.io/projects/us100/en/latest/>
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/>
Expand Down Expand Up @@ -334,7 +379,6 @@ Miscellaneous
74HC595 Shift Register <https://circuitpython.readthedocs.io/projects/74hc595/en/latest/>
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/en/latest/>
BD3491FS Audio Processor <https://circuitpython.readthedocs.io/projects/bd3491fs/en/latest/>
Bitmap Saver <https://circuitpython.readthedocs.io/projects/bitmapsaver/en/latest/>
CAP1188 8-Key Capacitive Touch <https://circuitpython.readthedocs.io/projects/cap1188/en/latest/>
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/en/latest/>
DS3502 I2C Potentiometer <https://circuitpython.readthedocs.io/projects/ds3502/en/latest/>
Expand All @@ -346,6 +390,7 @@ Miscellaneous
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/en/latest/>
NeoTrellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/neotrellis/en/latest/>
NeoTrellis M4 4x8 Keypad <https://circuitpython.readthedocs.io/projects/trellism4/en/latest/>
PyPixelbuf <https://circuitpython.readthedocs.io/projects/pypixelbuf/en/latest/>
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/en/latest/>
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/en/latest/>
STMPE610 Resistive Touchscreen <https://circuitpython.readthedocs.io/projects/stmpe610/en/latest/>
Expand Down
1 change: 1 addition & 0 deletions libraries/drivers/il0373
Submodule il0373 added at 8fc5ca
1 change: 1 addition & 0 deletions libraries/drivers/il0398
Submodule il0398 added at deccff
1 change: 1 addition & 0 deletions libraries/drivers/il91874
Submodule il91874 added at 2ca7c2
1 change: 1 addition & 0 deletions libraries/drivers/ssd1608
Submodule ssd1608 added at 99adf0
1 change: 1 addition & 0 deletions libraries/drivers/ssd1675
Submodule ssd1675 added at 33b811
2 changes: 1 addition & 1 deletion update-submodules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# 'init' to make sure any new libraries are incorporated.
git submodule init
git submodule update
git submodule foreach git fetch
git submodule foreach git fetch --all

# Regular release tags are 'x.x.x'. Exclude tags that are alpha or beta releases
# They will contain a '-' in the tag, such as '3.0.0-beta.5'
Expand Down