-
Notifications
You must be signed in to change notification settings - Fork 4
Configuration
FeralAI edited this page Oct 31, 2022
·
1 revision
tty2pico uses a config file in TOML format named tty2pico.toml at the root of your storage device for some runtime options that can be adjusted. If the file does not exist on your storage device it will be automatically created. A sample tty2pico.toml file with all available options:
title = "tty2pico RoundyPi Configuration"
[tty2pico]
backgroundColor = 0
cpuBoost = true
missingCoreImage = "/logos/mister.png"
sdMode = 0
slideshowDelay = 2000
startupCommand = "CMDBYE"
startupDelay = 5000
startupImage = "/logos/psx.gif"
tftHeight = 240
tftWidth = 240
tftRotation = 2
uncapFramerate = false| Option | Valid Values | Default Value | Description |
|---|---|---|---|
| backgroundColor | 16-bit RGB565 color value in integer form | 0 (Black) | The default background color when using transparent images. You will need to find an RGB565 color value usually in hex format like the TFT_eSPI color definitions, then convert the hex value to an integer value using an online tool or the tools/hex-to-int.py Python script like python hex-to-int.py FFFF
|
| cpuBoost | true/false | true | Apply a slight boost to the standard overclock. For the RP2040 this takes it from 250MHz to 266MHz, and is enabled by default. This option is mostly meant for tuning SD reader compatibility with the sdMode option, since SPI rate is tied to CPU frequency. It can also be used if your board is unstable at the higher CPU speed. |
| missingCoreImage | string | "" | An image to be displayed when a requested core image is unavailable. |
| sdMode | 0 = Normal (25MHz-27MHz) 1 = Fast (32-33MHz) 2 = Max (41-44MHz) |
0 (Normal) | This option will configure the speed of your SPI SD reader. SPI rate ranges are given because this scales a bit with the cpuBoost setting.By default most SD readers should be able to handle the Normal setting, since that's about the top range of what would be defined as the standard speed.The RoundyPi and Sparkfun Thing Plus RP2040 have internal SD readers known to work at the Max speed, and the tty2pico builds for those devices default to this Max setting. The external SD readers from Adafruit and Sparkfun are also reported to work at Max (needs verification).Some other boards may work somewhere in between Normal and Max, which is where the Fast setting comes in. It will essentially apply a "mild" overclock to the SD reader with a rate in between the Normal and Max speeds.Be careful if testing higher ranges than are known or supported for the SD reader. The SD card may load initially, but become unstable during use possibly causing file system corruption. Make sure to backup your SD card prior to testing unsupported/unknown hardware with this option. |
| slideshowDelay | 0+ | 2000 | The delay in milliseconds between switching images during the slideshow/screensaver. |
| startupCommand | string | "" | The tty2pico command to run at startup. |
| startupDelay | 0+ | 5000 | The delay in milliseconds to show the startup screen |
| startupImage | string | "" | The image to display after the startupCommand runs. |
| tftHeight | 0-320 | Display specific | Override the predefined height of the display in pixels. If your screen is natively portrait (like the ST7789V) this value should be equal or larger than tftWidth. |
| tftWidth | 0-320 | Display specific | Override the predefined width of the display in pixels. If your screen is natively portrait (like the ST7789V) this value should be equal or smaller than tftHeight. |
| tftRotation | 0 = none 1 = 90° 2 = 180° 3 = 270° |
Display specific | Override the default startup rotation of the display. Uses rotation values from TFT_eSPI library, which are NOT the same rotation values as CMDROT. |
| uncapFramerate | true/false | false | Force animated GIFs to play without a framerate limit. |
🏠 Home
⏱️ Quick Start
🛠️ Supported Hardware
🪛 Wiring Diagrams
⚙️ Configuration
🖼️ Image Files
🚩 Command List
😈 Development
🛣️ Roadmap