Skip to content

TinyDesk 0.1.3

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 01 Oct 15:54
· 30 commits to main since this release

TinyDesk developer preview

A mouse-operated desktop running on an ESP32, displayed in your terminal.
Drag and resize windows, browse files, edit and save text, and use the
embedded shell. MQTT and Modbus apps connect the desktop to real projects.

This release is a developer preview: expect rough edges, and please report
what breaks.

New in 0.1.3

  • Official updates: Software Update has Check for official updates
    (it fills in the newest release's image and shows its version, date and
    size; Install installs it) and Check daily and notify me, which tells
    you once when a newer version is out. Shell: ota official. From this
    release on, each release carries what the ESP32-C6 and ESP32 (PSRAM)
    boards need for it; the 4 MB ESP32 cannot update over the air.

Fixes for problems reported on an ESP32-2432S028R (4 MB, no PSRAM):

  • No more restart with many windows open. Opening the Log Viewer (or
    another app) with several windows open could restart a board without
    PSRAM. Now an app that does not fit says Too many windows are open.
    Close one, then try again.
    , and more fits: 16 windows, 96 widgets on
    boards without PSRAM (was 40), 128 with it. With every app opened one
    after another: all 13 fit on the ESP32 with PSRAM, 12 on the 4 MB ESP32,
    11 on the ESP32-C6.
  • Task Manager lists the tasks with many windows open (it could stay
    empty); the Task Manager, MQTT and Modbus say Not enough memory instead
    of not opening.
  • nano in the Terminal window shows its status line and help (Ctrl+C:
    the cursor position); it assumed an 80x24 screen.
  • The factory password is named: passwd says the old password is
    TinyDesk (capital T and D) while root still has it, and the Network app
    and ssh start say so when they keep remote access off.
  • Software Update on the 4 MB ESP32 explains that it cannot update over
    the air and how to update instead.

Also since 0.1.0: the SD card at /sd and in Files (0.1.2), ping -c,
MQTT over TLS in the PC programs, and tdsh.exe for Windows.

Install

  • ESP boards, from the browser: https://schikani.github.io/tinydesk-docs/install/
    (Chrome or Edge on a computer). Pick the edition and your exact board.
  • Open the board in the browser: https://schikani.github.io/tinydesk-docs/console/
    (a real terminal with mouse support; the installer's own Logs & Console
    cannot show the desktop).
  • Without the browser: each *-factory.bin below is flashed at offset 0
    with esptool; see the installer page for the commands.
  • PC programs: tinydesk-desktop-windows-x64.zip and
    tinydesk-shell-windows-x64.zip (Windows 10 or later, run them in Windows
    Terminal), tinydesk-desktop-linux-x86_64.tar.gz and
    tinydesk-shell-linux-x86_64.tar.gz (x86_64, built on Ubuntu 22.04).

Check the files against SHA256SUMS.txt. The firmware is not signed.
Factory flashing can erase user data: back up an existing board first.

Before connecting

Use a UTF-8 terminal with ANSI/VT cursor control and xterm mouse reporting,
or the web terminal above. ESP32-C6 uses its built-in USB port (any speed);
the classic ESP32 Desktop edition uses 921600 baud, the Shell edition
115200. On the local console, run passwd as root (initial password:
TinyDesk). Remote access is blocked until that password changes. Telnet
starts disabled; enable it explicitly in Network only on a trusted network.
It is unencrypted and root-only because it takes over the existing desktop.
SSH provides a separate encrypted shell, not the windowed desktop (the 4 MB
ESP32 Desktop build has no SSH server).

Physical password recovery is unavailable after a Telnet takeover until the
board reboots. Remote takeover is refused while physical recovery is active.

Choose the exact board

Desktop target Required hardware Screen Limits
ESP32-C6 8 MB flash, built-in USB Serial/JTAG up to 80×25
ESP32 with PSRAM 16 MB flash plus PSRAM (e.g. WROVER-IE N16R8) up to 256×96
ESP32 4 MB 4 MB flash, no PSRAM needed (e.g. WROOM-32) up to 80×25 no SSH server, no over-the-air updates
Windows, Linux x86_64 PC up to 400×150 no Wi-Fi, OTA or users (the PC's network is used)

Measured on our boards with this firmware (About → Free RAM, idle desktop,
Wi-Fi connected):

Board Firmware size (app slot) Free RAM
ESP32-C6 1.80 MB (2.5 MB slot, 28 % free) about 179 KB
ESP32 with PSRAM 1.71 MB (3 MB slot, 43 % free) about 155 KB internal + 3.2 MB PSRAM
ESP32 4 MB 1.64 MB (2.5 MB slot, 35 % free) about 71 KB

What is in this preview

  • Desktop: overlapping windows (move, resize, minimise, maximise, full
    screen), taskbar, start menu, desktop icons, drag and drop, copy and paste
    with the PC; Dark theme by default; the screen follows the terminal's size.
  • Apps: Terminal (TinyDesk Shell), Files, Editor, Network, MQTT (TLS),
    Modbus TCP/RTU with a TCP server, System Monitor, Task Manager, Log Viewer,
    Settings, Software Update (OTA with rollback), About.
  • Shell scripts (.tdsh): variables, if/while/for, functions, pipes
    and redirection; right-click → Run on the desktop.
  • Two editions: TinyDesk Desktop, and TinyDesk Shell on its own.
  • Security: physical recovery uses a transport trust policy, not just shell
    task identity; Telnet is opt-in; Telnet, SSH and FTP reject the factory
    password.
  • PC programs: the Windows desktop follows Windows Terminal when it is
    resized or maximised, and its shell has ifconfig, ping, date, cal
    and tz.
  • Board pins come from a configuration file (board command), not from
    the code.
  • Tests gate release builds; every release starts as a draft pre-release.