mlg556 / circuitpython_hx1230 Goto Github PK

CircuitPython framebuf driver for HX1230 96x68 monochrome LCD displays using SPI. Adapted from mcauser/micropython-hx1230, check out their repo for more information on the hardware.

This driver depends on:

• Adafruit CircuitPython
• Bus Device

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.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-hx1230

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-hx1230

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-hx1230

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install hx1230

Or the following command to update an existing version:

circup update

# simple example printing hello world
# to be able to print text, download the font file "font5x8.bin" from
# https://github.com/adafruit/Adafruit_CircuitPython_framebuf/blob/main/examples/font5x8.bin
# and put it in the same directory as your code

# import required CircuitPython libraries
import board
import busio
import digitalio

# import the HX1230 module
import hx1230

# create the SPI interface, this part depends on your specific board
# for Raspberry Pico W using SPI0:
spi = busio.SPI(clock=board.GP18, MOSI=board.GP19)
# choose a CS (chip select) pin
cs = digitalio.DigitalInOut(board.GP17)  # Chip select
# choose a reset pin, this part is optional since HX1230 has sofware reset
reset = digitalio.DigitalInOut(board.GP20)
# create the HX1230 class
display = hx1230.HX1230(spi=spi, cs=cs, reset=reset)

# clear the display
display.clear()
# print hello world
display.text("hello world", 0, 0, 1)
# don't forget to call show!
display.show()

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.