- Generated by
1.18.0
|
deki-lovyangfx-integration 1.3.0
Deki package reference
|
LovyanGFX display and touch panel integration
Repository: github.com/dekiengine/deki-lovyangfx-integration · Latest release: 1.2.0 · Needs engine 1.2.0+ · Requires: deki-i2c
Install: DekiEditor --packages-add deki-lovyangfx-integration <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.
Shown in the editor as LovyanGFX Integration.
| Component | Category | Description |
|---|---|---|
| LGFXDisplayPanel | LovyanGFX | Drives an SPI display panel (ILI9341, ST7789, GC9A01, ...) through LovyanGFX. |
| LGFXTouchPanel | LovyanGFX | Reads a touch controller (FT5x06, GT911, CST816S, XPT2046) through LovyanGFX. |
Compile-time features the package exposes (package.json):
| Feature | Define | Default |
|---|---|---|
| Display Panel | DEKI_FEATURE_LGFX_DISPLAY_PANEL | on |
| Touch Panel | DEKI_FEATURE_LGFX_TOUCH_PANEL | on |
Drives an SPI display panel (ILI9341, ST7789, GC9A01, ...) through LovyanGFX.
Inspector name: LGFX Display Panel · Category: LovyanGFX · Type GUID: a7e1d3f0-8b4c-4e2a-9f61-3c8d2b5a7e90
| Property | Type | Default | Constraints | Description |
|---|---|---|---|---|
| panelType | enum | ILI9341 | ILI9341, ST7789, ST7735, GC9A01, SSD1351, ST7789P3 | Display panel driver IC |
| panelWidth | int32 | 320 | 1 to 1024 | Display width in pixels |
| panelHeight | int32 | 240 | 1 to 1024 | Display height in pixels |
| rotation | enum | Landscape | Portrait, Landscape, Portrait_180, Landscape_270, Portrait_Mirror, Landscape_Mirror, Portrait_180_Mirror, Landscape_270_Mirror | Display rotation |
| offsetX | int32 | 0 | Pixel offset X (for panels with non-zero origin) | |
| offsetY | int32 | 0 | Pixel offset Y (for panels with non-zero origin) | |
| invertColor | bool | false | Invert display colors | |
| rgbOrder | bool | false | Swap R and B color channels (RGB vs BGR) | |
| busType | enum | Parallel8bit | SPI, Parallel8bit, Parallel16bit | Display bus type |
| spiMosi | int32 | -1 | -1 to 48; shown when busType allows | SPI MOSI pin |
| spiMiso | int32 | -1 | -1 to 48; shown when busType allows | SPI MISO pin (-1 = not used) |
| spiClk | int32 | -1 | -1 to 48; shown when busType allows | SPI clock pin |
| spiDc | int32 | -1 | -1 to 48; shown when busType allows | SPI data/command pin |
| spiHost | int32 | 0 | 0 to 1; shown when busType allows | SPI host (0=VSPI, 1=HSPI) |
| spiFreqWrite | int32 | 40000000 | shown when busType allows | SPI write frequency in Hz |
| parFreqWrite | int32 | 40000000 | shown when busType allows | Parallel bus write frequency in Hz |
| rsPin | int32 | -1 | -1 to 48; shown when busType allows | Register select / data-command pin (RS/DC) |
| wrPin | int32 | -1 | -1 to 48; shown when busType allows | Parallel bus write strobe pin |
| rdPin | int32 | -1 | -1 to 48; shown when busType allows | Parallel bus read strobe pin (-1 = not used) |
| d0Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D0 |
| d1Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D1 |
| d2Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D2 |
| d3Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D3 |
| d4Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D4 |
| d5Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D5 |
| d6Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D6 |
| d7Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D7 |
| d8Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D8 |
| d9Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D9 |
| d10Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D10 |
| d11Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D11 |
| d12Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D12 |
| d13Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D13 |
| d14Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D14 |
| d15Pin | int32 | -1 | -1 to 48; shown when busType allows | Parallel data pin D15 |
| pinCs | int32 | -1 | -1 to 48 | Chip select pin (-1 = not used) |
| pinRst | int32 | -1 | -1 to 48 | Reset pin (-1 = not connected) |
| blPin | int32 | -1 | -1 to 48 | Backlight pin (-1 = none) |
| blPwmChannel | int32 | 0 | 0 to 15 | PWM channel for backlight |
| blInvert | bool | false | Invert backlight signal (active low) | |
| swapBytes | bool | false | Swap RGB565 byte order for display transfer | |
| memoryWidth | int32 | 320 | 1 to 1024 | Panel memory width (may differ from visible width) |
| memoryHeight | int32 | 240 | 1 to 1024 | Panel memory height (may differ from visible height) |
| usePsram | bool | false | Allocate display buffers in PSRAM instead of internal RAM | |
| doubleBuffer | bool | false | Use double buffering for async DMA (overlaps render and display transfer) |
Reads a touch controller (FT5x06, GT911, CST816S, XPT2046) through LovyanGFX.
Inspector name: LGFX Touch Panel · Category: LovyanGFX · Type GUID: 9c79bf8d-6ba3-48b8-80da-1e775d818ad3
| Property | Type | Default | Constraints | Description |
|---|---|---|---|---|
| driverType | enum | FT5x06 | FT5x06, GT911, CST816S, XPT2046 | Touch controller IC |
| i2cPort | int32 | 0 | 0 to 3; shown when driverType allows | I2C bus port (must match an I2CBusComponent in the boot scene) |
| spiCs | int32 | -1 | -1 to 48; shown when driverType allows | SPI chip select pin (-1 = not used) |
| spiMosi | int32 | -1 | -1 to 48; shown when driverType allows | SPI MOSI pin (-1 = not used) |
| spiMiso | int32 | -1 | -1 to 48; shown when driverType allows | SPI MISO pin (-1 = not used) |
| spiClk | int32 | -1 | -1 to 48; shown when driverType allows | SPI clock pin (-1 = not used) |
| m_PinInt | int32 | -1 | -1 to 48 | Interrupt pin for touch events (-1 = polling mode) |
| pinRst | int32 | -1 | -1 to 48 | Reset pin for touch controller (-1 = not connected) |
| xMin | int32 | 0 | Minimum raw X value from touch controller | |
| xMax | int32 | 239 | Maximum raw X value from touch controller | |
| yMin | int32 | 0 | Minimum raw Y value from touch controller | |
| yMax | int32 | 319 | Maximum raw Y value from touch controller | |
| offsetRotation | enum | None | None, CW_90, CW_180, CW_270, Mirror, Mirror_CW_90, Mirror_CW_180, Mirror_CW_270 | Touch coordinate rotation, must match display rotation |
| busShared | bool | false | Enable if touch shares the SPI bus with the display |
Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.
1.18.0