st7789py_mpy Asset Conversion Utilities

The driver supports two font types: Bitmap Fonts (fixed-size, extracted from PC VGA/BIOS images) and TrueType Fonts (variable width, converted from .ttf files).

All fonts are stored as Python modules and should be imported using standard Python import statements. To save memory, pre-compile these modules to .mpy files or convert them to frozen bytecode in the MicroPython firmware.

To use the M5STACK AtomS3 (128x128 resolution with a GC9107 driver), use the configuration defined in tft_configs/atom_s3/tft_config.py. This file contains the necessary hardware parameters for the display driver and initialization.

# Refer to tft_configs/atom_s3/tft_config.py for the specific configuration implementation

Use text_font_converter.py to convert binary font files (from sources like spacerace's romfont repo) into Python font modules. These modules are designed for use with the text() method in the library. You can specify an input directory containing .bin files and an output directory for the resulting Python modules. You can also limit the character range included in the conversion using -f (first character) and -l (last character).

text_font_converter.py [-h] [-f FIRST_CHAR] [-l LAST_CHAR] input output

Use sprites_converter.py to convert a sprite sheet image into a Python module for use with the indexed bitmap method.

Requirements for the sprite sheet:

• The sheet width and height must be multiples of the specified sprite_width and sprite_height.
• There must be no extra pixels between sprites.
• All sprites in the sheet must share the same palette.

sprites_converter [-h] image_file sprite_width sprite_height bits_per_pixel

The text_font_converter.py utility converts binary font files (such as those from the spacerace/romfont repository) into Python modules.

Input/Output Rules:

• If the input is a directory, the output must be a directory.
• If the input is a single file, the output can be either a file or a directory.

Arguments:

• input: The file or directory containing the binary font file(s).
• output: The file or directory where the resulting Python font module(s) will be saved.
• -f FIRST_CHAR (optional): The first character code to include in the conversion (defaults to 0x20).
• -l LAST_CHAR (optional): The last character code to include in the conversion (defaults to 0x7F).

# convert the IBM_VGA_8x8.bin font to a python module with 8x8 characters
text_font_converter.py romfont/font-bin/IBM_VGA_8x8.bin vga_8x8.py -f 32 -l 127

To use the LilyGo T-DISPLAY (1.14 inch LCD ESP32 control board) with this library, use the configuration provided in tft_configs/ttgo_tdisplay/tft_config.py. This file contains the necessary hardware parameters for the ST7789 driver to work correctly with this specific board's pinout and display dimensions.

# Reference the configuration from tft_configs/ttgo_tdisplay/tft_config.py

The M5STACK AtomS3 has specific button configurations. Use the definitions provided in tft_configs/atom_s3/tft_buttons.py to handle button inputs for this device.

# Refer to tft_configs/atom_s3/tft_buttons.py for button definitions

Use write_font_converter.py (located in the utils directory) to convert TrueType (.ttf) fonts into bitmap font modules. TrueType fonts can be converted to any size as long as the widest character is 256 pixels or less.

Requirements:

• The freetype Python module must be installed.

Usage Examples:

• Convert a font with a specific character string: ./write_font_converter.py NotoSans-Regular.ttf 32 -s "0123456789ABCEDF"
• Convert a font using a hex range: ./write_font_converter.py Chango-Regular.ttf 16 -c 0x20-0x7f

Use image_converter.py to convert a standard image file into a Python module. The resulting module is used with the bitmap() method. You must specify the number of bits per pixel (ranging from 1 to 8).

image_converter.py [-h] image_file bits_per_pixel

Use write_font_converter.py to convert characters from a TrueType (.ttf) font into a Python bitmap module. These modules can be used with the .write() method in the st7789 and ili9342 drivers. The output is typically redirected to a .py file.

# Convert Chango-Regular.ttf to a python bitmap module with ~32 pixel high characters
./write_font_converter.py Chango-Regular.ttf 32 -c 0x20-0x7f > chango_32.py

Use text_font_converter.py (located in the utils directory) to convert PC BIOS bitmap fonts from the romfont repository into Python font modules.

Options:

• -i, --input-directory: The directory containing the .bin files to convert.
• -o, --output-directory: The directory where the resulting Python font files will be written.
• -f, --first-char: The first character code to include in the output.
• -l, --last-char: The last character code to include in the output.

text_font_converter.py -i font-bin -o fonts -f 32 -l 127

The Waveshare 1.3" TFT display includes buttons. Pin assignments and button logic for this specific hardware module are defined in tft_configs/waveshare_13/tft_buttons.py.

# Reference the button definitions from tft_configs/waveshare_13/tft_buttons.py