Skip to content

Command List

FeralAI edited this page Nov 1, 2022 · 2 revisions

Overview

tty2pico aims to be as compatible as needed/possible with the tty2oled v2 Command List, along with adding some custom commands.

tty2oled Commands

These commands are adapted from tty2oled and should be (mostly) compatible:

Command Function Example
CMDBYE Show Sorgelig's Cat Icon CMDBYE
CMDCLS Clear and Update the Display CMDCLS
CMDCOR Command to announce core change, will try to display in the following order:
[corename].loop.fast.gif
[corename].loop.gif
[corename].fast.gif
[corename].gif
[corename].png
CMDCOR,[corename]
[corename]
e.g.
SNES
CMDCOR,SNES
CMDCOR,19XX
CMDDOFF Turn off the display CMDDOFF
CMDDON Turn on the display.0 CMDDON
CMDENOTA Reboots tty2pico device into bootloader mode to receive a firmware update CMDENOTA
CMDROT Rotate screen relative to starting position (0=none, 1=180°, 2=90°, 3=270°) CMDROT,0 for no rotation
CMDROT,1 to flip screen
CMDSAVER Disable or Enable the ScreenSaver (currently only toggle) CMDSAVER
CMDSETTIME Set the time on the MCU RTC using a unix timestamp

Shell example:
timeoffset=$(date +%:::z)
localtime=$(date '-d now '${timeoffset}' hour' +%s)
echo "CMDSETTIME,${localtime}" > /dev/ttyACM0
CMDSETTIME,[timestamp]
CMDSETTIME,1665971593
CMDSHTEMP Alias to CMDSHSYSHW since that screen displays the CPU temp CMDSHTEMP
CMDSHSYSHW Show tty2pico system information CMDSHSYSHW
CMDSNAM Show actual loaded Corename CMDSNAM
CMDSORG Show Startup screen, also an alias to CMDSHSYSHW CMDSORG
CMDSWSAVER Switch screensaver on or off CMDSWSAVER,0 to disable
CMDSWSAVER,1 to enable
CMDTEST Show system info and some test graphics CMDTEST
CMDTXT Send text to the display CMDTXT,Can you see this?
Not currently compatible with tty2oled command

tty2pico Commands

These commands are specific to tty2pico:

Command Function Example
CMDGETSYS Retrieve a pipe-separated system identifier string composed from the build flags with the TTY2PICO_ prefix that can be used to remotely manage tty2pico options and updates, example output:

version=1.0.0|board=Raspberry Pi Pico|display=GC9A01
CMDGETSYS
CMDGETTIME Get the current real-time clock value in the specified format CMDGETTIME
CMDGETTIME,[format]

Formats are:
0 = Unix timestamp (default if missing)
1 = Human readable
CMDRLCONF Force a reload of the tty2pico.toml config file CMDRLCONF
CMDSHOW Show an image from the active storage device CMDSHOW,/logos/pattern.loop.gif

🏠 Home
⏱️ Quick Start
🛠️ Supported Hardware
🪛 Wiring Diagrams
⚙️ Configuration
🖼️ Image Files
🚩 Command List
😈 Development
🛣️ Roadmap

Clone this wiki locally