Data streamdeck

Open Screen Deck

Six Waveshare ScreenKey modules (128×128 IPS + switch in each cap) on an ESP32-S3 carrier you have fabricated, in a case you print. This repo is the KiCad, Gerbers, OpenSCAD, STLs, firmware, and an optional desktop companion.

Build notes · Latest release (macOS/Windows app + firmware .bin) · Discord

Build one

1. Order — 6× Waveshare 34168 (about $66, longest lead time). Upload hardware/pcb/data_streamdeck_gerbers.zip to JLCPCB (about $15 for five boards). Full list: hardware/bom_assembly.csv
2. Print while those ship — four STLs in hardware/enclosure/stl/, PETG or PLA+, no supports: deck_bottom_v14.stl, deck_top_v14.stl, corner_spacers_x4_v14.stl, optional deck_stand_v14.stl
3. Assemble — guide, about 45 minutes
4. Flash over USB-C — companion (Settings → Firmware) or Arduino / esptool. Same release has firmware-0.14.5.bin plus bootloader and partitions.

Parts land around $100. The six modules are most of that. v14 STLs match the Rev E board (59.5 × 108.5 mm); don’t mix with older v13 prints.

Pinout lives in hardware/pinout.py. Generators refuse to run if firmware/config.h disagrees.

Firmware

Sources in firmware/. Out of the box it types F13–F24. Pages, labels, icons, microSD animations, auto-dim, glow LEDs, and haptics are configured over USB serial (protocol).

Prebuilt images are on Releases (firmware-0.14.5.bin, .bootloader.bin, .partitions.bin). The companion bundles the same files. To compile locally:

./scripts/build_firmware.sh          # also copies bins into the app
./scripts/build_firmware.sh --flash  # then upload to a connected deck

Arduino: ESP32S3 Dev Module, USB CDC On Boot enabled, USB-OTG, OPI PSRAM, 16 MB flash (app3M_fat9M_16MB). Libraries: Adafruit GFX, ST7735, NeoPixel.

Companion app

Optional. The deck is a USB keyboard without it. Use the app to draw key faces, bind host actions, flash firmware, and (on Rev E) drive auto-dim / glow / self-test.

• Download: Releases — macOS .dmg (unsigned: right-click → Open), Windows .msi
• From source: cd app && npm install && npx tauri dev
• Plugins: folders in plugins/; directory · plugins/registry.json

A push to main updates this repo and the docs site. A GitHub Release (installers + firmware bins) is created only when a tag app-v* is pushed, e.g. app-v0.2.0.

Repo map

hardware/
  pinout.py          Canonical GPIO + Rev E geometry
  pcb/               KiCad, Gerbers, board BOM
  enclosure/         OpenSCAD v14 + printable STLs
  3d/                Fastener / assembly STEP
firmware/            ESP32-S3 Arduino (0.14.5)
app/                 Tauri companion (Rust + React)
plugins/             Bundled plugins + registry.json
profiles/            Shared layouts (.osdprofile.json)
docs/                MkDocs site
scripts/             PCB / schematic / firmware helpers

Contributing

• Plugins — folder in plugins/ + a registry line (how)
• Profiles — export from the app, PR into profiles/
• Hardware — OpenSCAD is parametric; keep the mechanical contract if the PCB should still fit
• App / firmware — cd app && npm test && npm run test:e2e

Related projects

Same neighbourhood: FreeTouchDeck (one touchscreen), open-deck (one TFT behind keys), MacroPad (per-key OLED). This one is six discrete ScreenKey modules on a carrier you can order.

License

• Firmware, app, scripts, docs: MIT
• Hardware (PCB + enclosure): CERN-OHL-P v2

ScreenKey modules are a Waveshare product; this project is not affiliated with or endorsed by Waveshare or Elgato.