st7789py

https://russhughes.github.io/st7789py_mpy/
Admin
st7789py is a MicroPython driver for ST7789 TFT displays that supports multiple resolutions, display...
Tokens:104,716
Snippets:619
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Programs and Configurations

Source: https://russhughes.github.io/st7789py_mpy/fonts.html

Information on example programs and configuration files for various hardware setups.

```APIDOC
## Example Programs

The `st7789py` driver includes various example programs demonstrating its capabilities.

### Configuration Modules

Pre-configured settings for different display modules and development boards are available in the `tft_configs` directory.

*   **M5STACK AtomS3 128x128 (GC9107)**
    *   `tft_configs/atom_s3/tft_config.py`
    *   `tft_configs/atom_s3/tft_buttons.py`
*   **Generic ESP32 320x240**
    *   `tft_configs/esp32_320x240/tft_config.py`
    *   `tft_configs/esp32_320x240/tft_buttons.py`
*   **M5STACK CORE 320x240 (ILI9342)**
    *   `tft_configs/m5stack_core/tft_config.py`
    *   `tft_configs/m5stack_core/tft_buttons.py`
*   **M5STACK CORE2 320x240 (ILI9342)**
    *   `tft_configs/m5stack_core2/tft_config.py`
    *   `tft_configs/m5stack_core2/tft_buttons.py`
*   **M5STACK CoreS3 320x240 (ILI9342)**
    *   `tft_configs/m5stack_core3/tft_config.py`
    *   `tft_configs/m5stack_core3/tft_buttons.py`
*   **RP2040-Touch-LCD-1.28 240x240 (GC9A01)**
    *   `tft_configs/rp2040_touch_lcd_128/tft_config.py`
    *   `tft_configs/rp2040_touch_lcd_128/tft_buttons.py`
*   **LilyGo T-Dongle-S3 80x160 (ST7735)**
    *   `tft_configs/t-dongle-s3/tft_config.py`
    *   `tft_configs/t-dongle-s3/tft_buttons.py`
*   **LilyGo T-embed 170x320**
    *   `tft_configs/t-embed/tft_config.py`
    *   `tft_configs/t-embed/tft_buttons.py`
*   **LilyGo T-QT Pro 128x128 (GC9107)**
    *   `tft_configs/t_qt_pro/tft_config.py`
    *   `tft_configs/t_qt_pro/tft_buttons.py`
*   **LilyGo T-DISPLAY 135x240**
    *   `tft_configs/ttgo_tdisplay/tft_config.py`
    *   `tft_configs/ttgo_tdisplay/tft_buttons.py`
*   **LilyGo T-DISPLAY RP2040 135x240**
    *   `tft_configs/ttgo_tdisplay_rp2040/tft_config.py`
    *   `tft_configs/ttgo_tdisplay_rp2040/tft_buttons.py`
*   **Waveshare Pico LCD 1.14 135x240**
    *   `tft_configs/waveshare_114/tft_config.py`
    *   `tft_configs/waveshare_114/tft_buttons.py`
*   **Waveshare Pico LCD 1.3 240x240**
    *   `tft_configs/waveshare_13/tft_config.py`
    *   `tft_configs/waveshare_13/tft_buttons.py`
*   **Waveshare Pico LCD 2 240x320**
    *   `tft_configs/waveshare_2/tft_config.py`
    *   `tft_configs/waveshare_2/tft_buttons.py`

### Example Scripts

*   `alien.py`
*   `boxlines.py`
*   `chango.py`
*   `color_test.py`
*   `colorbars.py`
*   `feathers.py`
*   `fonts.py`
*   `hello.py`
*   `noto_fonts.py`
*   `proverbs.py`
*   `roids.py`
*   `rotations.py`
*   `scroll.py`
*   `tiny_hello.py`
*   `tiny_toasters.py`
```

--------------------------------

### Configuration Example: M5STACK CoreS3 320x240 (ILI9342)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the M5STACK CoreS3 with a 320x240 ILI9342 display. Includes display setup and button handling.

```python
# tft_configs/m5stack_core3/tft_config.py
import machine

_WIDTH = 320
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "ILI9342"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/m5stack_core3/tft_buttons.py
import st7789

_WIDTH = 320
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: M5STACK CORE 320x240 (ILI9342)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the M5STACK CORE with a 320x240 ILI9342 display. Includes display setup and button handling.

```python
# tft_configs/m5stack_core/tft_config.py
import machine

_WIDTH = 320
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "ILI9342"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/m5stack_core/tft_buttons.py
import st7789

_WIDTH = 320
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: M5STACK CORE2 320x240 (ILI9342)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the M5STACK CORE2 with a 320x240 ILI9342 display. Includes display setup and button handling.

```python
# tft_configs/m5stack_core2/tft_config.py
import machine

_WIDTH = 320
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "ILI9342"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/m5stack_core2/tft_buttons.py
import st7789

_WIDTH = 320
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: M5STACK AtomS3

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the M5STACK AtomS3 with a 128x128 GC9107 display. Includes display setup and button handling.

```python
# tft_configs/atom_s3/tft_config.py
import machine

_WIDTH = 128
_HEIGHT = 128

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "GC9107"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/atom_s3/tft_buttons.py
import st7789

_WIDTH = 128
_HEIGHT = 128

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: Generic ESP32 320x240

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for a generic ESP32 with a 320x240 display. Includes display setup and button handling.

```python
# tft_configs/esp32_320x240/tft_config.py
import machine

_WIDTH = 320
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "ILI9342"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/esp32_320x240/tft_buttons.py
import st7789

_WIDTH = 320
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example Program: rotations.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

This example program demonstrates different display rotation settings.

```python
# rotations.py
# (Code content not provided in the source text)

```

--------------------------------

### Example Programs and Configurations

Source: https://russhughes.github.io/st7789py_mpy/examples/rotations.html

This section provides examples of how to use the st7789py driver with various hardware configurations and demonstrates example programs.

```APIDOC
## Example Programs and Configurations

This section provides examples of how to use the st7789py driver with various hardware configurations and demonstrates example programs.

### Configuration Modules

These modules provide specific configurations for different development boards and displays.

- **M5STACK AtomS3 128x128 (GC9107)**
  - `tft_configs/atom_s3/tft_config.py`
  - `tft_configs/atom_s3/tft_buttons.py`
- **Generic ESP32 320x240**
  - `tft_configs/esp32_320x240/tft_config.py`
  - `tft_configs/esp32_320x240/tft_buttons.py`
- **M5STACK CORE 320x240 (ILI9342)**
  - `tft_configs/m5stack_core/tft_config.py`
  - `tft_configs/m5stack_core/tft_buttons.py`
- **M5STACK CORE2 320x240 (ILI9342)**
  - `tft_configs/m5stack_core2/tft_config.py`
  - `tft_configs/m5stack_core2/tft_buttons.py`
- **M5STACK CoreS3 320x240 (ILI9342)**
  - `tft_configs/m5stack_core3/tft_config.py`
  - `tft_configs/m5stack_core3/tft_buttons.py`
- **RP2040-Touch-LCD-1.28 240x240 (GC9A01)**
  - `tft_configs/rp2040_touch_lcd_128/tft_config.py`
  - `tft_configs/rp2040_touch_lcd_128/tft_buttons.py`
- **LilyGo T-Dongle-S3 80x160 (ST7735)**
  - `tft_configs/t-dongle-s3/tft_config.py`
  - `tft_configs/t-dongle-s3/tft_buttons.py`
- **LilyGo T-embed 170x320**
  - `tft_configs/t-embed/tft_config.py`
  - `tft_configs/t-embed/tft_buttons.py`
- **LilyGo T-QT Pro 128x128 (GC9107)**
  - `tft_configs/t_qt_pro/tft_config.py`
  - `tft_configs/t_qt_pro/tft_buttons.py`
- **LilyGo T-DISPLAY 135x240**
  - `tft_configs/ttgo_tdisplay/tft_config.py`
  - `tft_configs/ttgo_tdisplay/tft_buttons.py`
- **LilyGo T-DISPLAY RP2040 135x240**
  - `tft_configs/ttgo_tdisplay_rp2040/tft_config.py`
  - `tft_configs/ttgo_tdisplay_rp2040/tft_buttons.py`
- **Waveshare Pico LCD 1.14 135x240**
  - `tft_configs/waveshare_114/tft_config.py`
  - `tft_configs/waveshare_114/tft_buttons.py`
- **Waveshare Pico LCD 1.3 240x240**
  - `tft_configs/waveshare_13/tft_config.py`
  - `tft_configs/waveshare_13/tft_buttons.py`
- **Waveshare Pico LCD 2 240x320**
  - `tft_configs/waveshare_2/tft_config.py`
  - `tft_configs/waveshare_2/tft_buttons.py`

### Example Programs

Demonstrates various graphical effects and functionalities.

- `alien.py`
- `boxlines.py`
- `chango.py`
- `color_test.py`
- `colorbars.py`
- `feathers.py`
- `fonts.py`
- `hello.py`
- `noto_fonts.py`
- `proverbs.py`
- `roids.py`
- `rotations.py`
- `scroll.py`
- `tiny_hello.py`
- `tiny_toasters.py`
```

--------------------------------

### Example: hello.py

Source: https://russhughes.github.io/st7789py_mpy/index.html

A simple 'Hello, World!' example program to verify basic display functionality and text rendering.

```python
import machine
import time
import st7789py as st7789

# Configuration for a specific display (e.g., M5STACK AtomS3 128x128)
TFT_MOSI = 35
TFT_SCLK = 36
TFT_CS = 37
TFT_DC = 38
TFT_RST = 34
TFT_WIDTH = 128
TFT_HEIGHT = 128
TFT_OFFSET_X = 0
TFT_OFFSET_Y = 0

spi = machine.SPI(0, baudrate=80000000, polarity=0, phase=0, sck=TFT_SCLK, mosi=TFT_MOSI, miso=machine.Pin(12))

display = st7789.ST7789(spi, 
                    width=TFT_WIDTH, 
                    height=TFT_HEIGHT, 
                    reset=TFT_RST, 
                    dc=TFT_DC, 
                    cs=TFT_CS, 
                    rotation=0, 
                    options=st7789.ST7789_OPTIONS.COLOR_ORDER_BGR)

time.sleep_ms(100)

def color565(r, g, b):
    return (r & 0xF8) << 8 | (g & 0xFC) << 3 | b >> 3

display.fill(st7789.color565(0, 0, 0))
display.text(10, 50, "Hello, World!", color565(255, 255, 255), color565(0, 0, 0))

print("Hello, World! displayed")

```

--------------------------------

### Example: Configuration Modules

Source: https://russhughes.github.io/st7789py_mpy/examples/scroll.html

Provides example configuration files for various boards and display resolutions, used to initialize the st7789py driver.

```python
# Example configuration file: tft_config.py
# This file contains pin definitions and display settings for a specific board.

import machine
import st7789

# Board: M5STACK AtomS3 128x128 (GC9107)
# SCK = 36
# MOSI = 35
# MISO = 37
# CS = 34
# DC = 38
# RST = -1

# Board: Generic ESP32 320x240
# SCK = 18
# MOSI = 23
# MISO = -1
# CS = 5
# DC = 4
# RST = 15

# Board: M5STACK CORE 320x240 (ILI9342)
# SCK = 18
# MOSI = 23
# MISO = -1
# CS = 5
# DC = 4
# RST = 15

# Board: RP2040-Touch-LCD-1.28 240x240 (GC9A01)
# SCK = 2
# MOSI = 3
# MISO = 0
# CS = 1
# DC = 0
# RST = -1

# SPI bus
# spi = machine.SPI(1, baudrate=30000000, polarity=0, phase=0, sck=machine.Pin(SCK), mosi=machine.Pin(MOSI), miso=machine.Pin(MISO))

# Display
# tft = st7789.ST7789(spi, dc=machine.Pin(DC), cs=machine.Pin(CS), rst=machine.Pin(RST))

# Rotation (example)
# tft.rotation(st7789.LANDSCAPE)

```

--------------------------------

### Configuration Example: RP2040-Touch-LCD-1.28 (GC9A01)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the RP2040-Touch-LCD-1.28 with a 240x240 GC9A01 display. Includes display setup and button handling.

```python
# tft_configs/rp2040_touch_lcd_128/tft_config.py
import machine

_WIDTH = 240
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(17)
_PIN_NUM_DC = machine.Pin(15)
_PIN_NUM_RST = machine.Pin(16)
_PIN_NUM_BL = machine.Pin(14)

_SPI_BUS = 0
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(12)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(10)

_ROTATION = 0

_MODEL = "GC9A01"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/rp2040_touch_lcd_128/tft_buttons.py
import st7789

_WIDTH = 240
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example Program: tiny_hello.py

Source: https://russhughes.github.io/st7789py_mpy/examples/roids.html

A minimal "Hello, World!" example, likely optimized for size or speed.

```python
# tiny_hello.py
import machine
import st7789py
import ttgo_tdisplay

# Pin definitions for TTGO T-Display
spi = machine.SPI(1, baudrate=40000000, polarity=0, phase=0, sck=18, mosi=23, miso=0)
tft = st7789py.ST7789(spi, dc=17, rst=16, width=135, height=240, rotation=0)

tft.text(0, 0, "Hello", st7789py.color565(255, 0, 0))

```

--------------------------------

### Configuration Example: LilyGo T-DISPLAY RP2040 135x240

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the LilyGo T-DISPLAY RP2040 with a 135x240 display. Includes display setup and button handling.

```python
# tft_configs/ttgo_tdisplay_rp2040/tft_config.py
import machine

_WIDTH = 135
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(17)
_PIN_NUM_DC = machine.Pin(15)
_PIN_NUM_RST = machine.Pin(16)
_PIN_NUM_BL = machine.Pin(14)

_SPI_BUS = 0
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(12)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(10)

_ROTATION = 0

_MODEL = "ST7789"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/ttgo_tdisplay_rp2040/tft_buttons.py
import st7789

_WIDTH = 135
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example: Tiny Hello World

Source: https://russhughes.github.io/st7789py_mpy/examples/scroll.html

A minimal "Hello World" example, suitable for quick testing.

```python
# Example program: tiny_hello.py
# A very minimal "Hello World" example.

import machine
import st7789

# Pin definitions for the display (example for Pico)
SCK = 2
MOSI = 3
MISO = 0 # Not used
CS = 1
DC = 0
RST = -1 # Not used

# SPI bus
spi = machine.SPI(0, baudrate=30000000, polarity=0, phase=0, sck=machine.Pin(SCK), mosi=machine.Pin(MOSI), miso=machine.Pin(MISO))

# Display
tft = st7789.ST7789(spi, dc=machine.Pin(DC), cs=machine.Pin(CS), rst=machine.Pin(RST))

tft.text(0, 0, "Hello", st7789.WHITE)

```

--------------------------------

### Example Program: hello.py

Source: https://russhughes.github.io/st7789py_mpy/examples/roids.html

A simple "Hello, World!" example that displays text on the screen using the default font.

```python
# hello.py
import machine
import st7789py
import ttgo_tdisplay

# Pin definitions for TTGO T-Display
spi = machine.SPI(1, baudrate=40000000, polarity=0, phase=0, sck=18, mosi=23, miso=0)
tft = st7789py.ST7789(spi, dc=17, rst=16, width=135, height=240, rotation=0)

tft.fill(st7789py.color565(0, 0, 0)) # Clear screen
tft.text(10, 10, "Hello, World!", st7789py.color565(255, 255, 0)) # Yellow text

```

--------------------------------

### Example: Hello World

Source: https://russhughes.github.io/st7789py_mpy/utilities.html

A basic example program demonstrating how to display "Hello" on the ST7789 display.

```python
import machine
import st7789

scl=machine.Pin(36)
sda=machine.Pin(35)
te=machine.Pin(4)
res=machine.Pin(2)
dc=machine.Pin(5)
bbacklight=machine.Pin(15, machine.Pin.OUT)

bbacklight.on()

tft = st7789.ST7789(scl, sda, te, res, dc, width=128, height=128, rotation=0, offsetx=0, offsety=0)

tft.text(x=10, y=10, text="Hello", color=st7789.color565(255, 255, 255), bgcolor=st7789.color565(0, 0, 0))
```

--------------------------------

### Configuration Example: LilyGo T-DISPLAY 135x240

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the LilyGo T-DISPLAY with a 135x240 display. Includes display setup and button handling.

```python
# tft_configs/ttgo_tdisplay/tft_config.py
import machine

_WIDTH = 135
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "ST7789"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/ttgo_tdisplay/tft_buttons.py
import st7789

_WIDTH = 135
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example: Hello World

Source: https://russhughes.github.io/st7789py_mpy/examples/scroll.html

A simple "Hello World" example to verify display functionality and basic text output.

```python
# Example program: hello.py
# A basic "Hello World" example.

import machine
import st7789
import time

# Pin definitions for the display (example for Pico)
SCK = 2
MOSI = 3
MISO = 0 # Not used
CS = 1
DC = 0
RST = -1 # Not used

# SPI bus
spi = machine.SPI(0, baudrate=30000000, polarity=0, phase=0, sck=machine.Pin(SCK), mosi=machine.Pin(MOSI), miso=machine.Pin(MISO))

# Display
tft = st7789.ST7789(spi, dc=machine.Pin(DC), cs=machine.Pin(CS), rst=machine.Pin(RST))

tft.rotation(st7789.LANDSCAPE)

tft.fill(st7789.BLACK)
tft.text(10, 50, "Hello World!", st7789.WHITE)

time.sleep(5)

```

--------------------------------

### Configuration Example: LilyGo T-QT Pro 128x128 (GC9107)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the LilyGo T-QT Pro with a 128x128 GC9107 display. Includes display setup and button handling.

```python
# tft_configs/t_qt_pro/tft_config.py
import machine

_WIDTH = 128
_HEIGHT = 128

_PIN_NUM_CS = machine.Pin(5)
_PIN_NUM_DC = machine.Pin(4)
_PIN_NUM_RST = machine.Pin(15)
_PIN_NUM_BL = machine.Pin(16)

_SPI_BUS = 2
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(13)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(12)

_ROTATION = 0

_MODEL = "GC9107"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/t_qt_pro/tft_buttons.py
import st7789

_WIDTH = 128
_HEIGHT = 128

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: Waveshare Pico LCD 1.3 (240x240)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the Waveshare Pico LCD 1.3 with a 240x240 display. Includes display setup and button handling.

```python
# tft_configs/waveshare_13/tft_config.py
import machine

_WIDTH = 240
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(17)
_PIN_NUM_DC = machine.Pin(15)
_PIN_NUM_RST = machine.Pin(16)
_PIN_NUM_BL = machine.Pin(14)

_SPI_BUS = 0
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(12)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(10)

_ROTATION = 0

_MODEL = "GC9A01"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/waveshare_13/tft_buttons.py
import st7789

_WIDTH = 240
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example Program: tiny_hello.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

A minimal example program, likely displaying a very short 'Hello' message.

```python
# tiny_hello.py
# (Code content not provided in the source text)

```

--------------------------------

### Example Program: hello.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

A basic example program that likely displays a 'Hello, World!' message on the screen.

```python
# hello.py
# (Code content not provided in the source text)

```

--------------------------------

### Configuration Example: Waveshare Pico LCD 2 (240x320)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the Waveshare Pico LCD 2 with a 240x320 display. Includes display setup and button handling.

```python
# tft_configs/waveshare_2/tft_config.py
import machine

_WIDTH = 240
_HEIGHT = 320

_PIN_NUM_CS = machine.Pin(17)
_PIN_NUM_DC = machine.Pin(15)
_PIN_NUM_RST = machine.Pin(16)
_PIN_NUM_BL = machine.Pin(14)

_SPI_BUS = 0
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(12)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(10)

_ROTATION = 0

_MODEL = "ST7789"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/waveshare_2/tft_buttons.py
import st7789

_WIDTH = 240
_HEIGHT = 320

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example Programs

Source: https://russhughes.github.io/st7789py_mpy/_modules/index.html

Demonstrates various example programs showcasing the capabilities of the st7789py driver.

```APIDOC
## Example Programs

This directory contains example programs that utilize the `st7789py` driver for various applications and demonstrations.

### Configuration Modules

Pre-configured settings for different development boards and display combinations.

- M5STACK AtomS3 128x128 (GC9107)
- Generic ESP32 320x240
- M5STACK CORE 320x240 (ILI9342)
- M5STACK CORE2 320x240 (ILI9342)
- M5STACK CoreS3 320x240 (ILI9342)
- RP2040-Touch-LCD-1.28 240x240 (GC9A01)
- LilyGo T-Dongle-S3 80x160 (ST7735)
- LilyGo T-embed 170x320
- LilyGo T-QT Pro 128x128 (GC9107)
- LilyGo T-DISPLAY 135x240
- LilyGo T-DISPLAY RP2040 135x240
- Waveshare Pico LCD 1.14 135x240
- Waveshare Pico LCD 1.3 240x240
- Waveshare Pico LCD 2 240x320

### Examples

Standalone example scripts demonstrating specific functionalities.

- alien.py
- boxlines.py
- chango.py
- color_test.py
- colorbars.py
- feathers.py
- fonts.py
- hello.py
- noto_fonts.py
- proverbs.py
- roids.py
- rotations.py
- scroll.py
- tiny_hello.py
- tiny_toasters.py
```

--------------------------------

### Configuration Example: LilyGo T-embed 170x320

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the LilyGo T-embed with a 170x320 display. Includes display setup and button handling.

```python
# tft_configs/t-embed/tft_config.py
import machine

_WIDTH = 170
_HEIGHT = 320

_PIN_NUM_CS = machine.Pin(10)
_PIN_NUM_DC = machine.Pin(8)
_PIN_NUM_RST = machine.Pin(12)
_PIN_NUM_BL = machine.Pin(9)

_SPI_BUS = 1
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(16)
_SPI_MOSI = machine.Pin(18)
_SPI_SCK = machine.Pin(17)

_ROTATION = 0

_MODEL = "ST7735"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/t-embed/tft_buttons.py
import st7789

_WIDTH = 170
_HEIGHT = 320

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: LilyGo T-Dongle-S3 (ST7735)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the LilyGo T-Dongle-S3 with an 80x160 ST7735 display. Includes display setup and button handling.

```python
# tft_configs/t-dongle-s3/tft_config.py
import machine

_WIDTH = 80
_HEIGHT = 160

_PIN_NUM_CS = machine.Pin(10)
_PIN_NUM_DC = machine.Pin(8)
_PIN_NUM_RST = machine.Pin(12)
_PIN_NUM_BL = machine.Pin(9)

_SPI_BUS = 1
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(16)
_SPI_MOSI = machine.Pin(18)
_SPI_SCK = machine.Pin(17)

_ROTATION = 0

_MODEL = "ST7735"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/t-dongle-s3/tft_buttons.py
import st7789

_WIDTH = 80
_HEIGHT = 160

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Configuration Example: Waveshare Pico LCD 1.14 (135x240)

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

Configuration files for the Waveshare Pico LCD 1.14 with a 135x240 display. Includes display setup and button handling.

```python
# tft_configs/waveshare_114/tft_config.py
import machine

_WIDTH = 135
_HEIGHT = 240

_PIN_NUM_CS = machine.Pin(17)
_PIN_NUM_DC = machine.Pin(15)
_PIN_NUM_RST = machine.Pin(16)
_PIN_NUM_BL = machine.Pin(14)

_SPI_BUS = 0
_SPI_FREQ = 10000000
_SPI_MISO = machine.Pin(12)
_SPI_MOSI = machine.Pin(11)
_SPI_SCK = machine.Pin(10)

_ROTATION = 0

_MODEL = "ST7789"

_ দিকের = {
    0: (_WIDTH, _HEIGHT),
    1: (_HEIGHT, _WIDTH),
    2: (_WIDTH, _HEIGHT),
    3: (_HEIGHT, _WIDTH),
}

def get_config():
    return (
        _SPI_BUS,
        _PIN_NUM_CS,
        _PIN_NUM_DC,
        _PIN_NUM_RST,
        _PIN_NUM_BL,
        _SPI_FREQ,
        _SPI_MISO,
        _SPI_MOSI,
        _SPI_SCK,
        _ROTATION,
        _MODEL,
        _WIDTH,
        _HEIGHT,
    )

```

```python
# tft_configs/waveshare_114/tft_buttons.py
import st7789

_WIDTH = 135
_HEIGHT = 240

def get_buttons(tft):
    return [
        (tft.width - 40, tft.height - 40, 40, 40, "A", 0xFFFFFF, 0x000000),
        (40, tft.height - 40, 40, 40, "B", 0xFFFFFF, 0x000000),
    ]

```

--------------------------------

### Example Program: fonts.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

This example program demonstrates the usage of different fonts for displaying text on the screen.

```python
# fonts.py
# (Code content not provided in the source text)

```

--------------------------------

### Example Program: proverbs.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

This example program likely displays various proverbs or quotes on the screen.

```python
# proverbs.py
# (Code content not provided in the source text)

```

--------------------------------

### Example Program: colorbars.py

Source: https://russhughes.github.io/st7789py_mpy/configs/m5stack_core.html

This example program likely generates and displays color bars on the screen.

```python
# colorbars.py
# (Code content not provided in the source text)

```
Tokens:
Raw