Skip to content

LucaDiLorenzo98/console_deck_pro

Repository files navigation

Console Deck PRO

A DIY macro deck built around an Arduino Nano — 9 programmable buttons, a rotary encoder, an OLED display, and an expandable module system (sliders, knobs, extra buttons). Each button can open a URL, launch an app, send a hotkey, control volume or screen brightness, and more. Configure everything from the desktop UI, no code editing required.

This is an open-source maker project. The full package (3D-printable enclosure files, electronics schematics, and BOM) is available as part of the crowdfunding campaign.


What's in this repo

Folder / File Description
console_deck_pro_arduino/ Arduino firmware (upload once to the board)
UI/ Flutter desktop app (Windows / macOS / Linux)
console_deck_pro.py Python backend source — bridges the Arduino with the OS
dist/console_deck_pro.exe Compiled backend executable (produced by CI via PyInstaller)
config.example.json Example configuration — copy to get started
requirements.txt Python dependencies (for manual / dev use)
BUILDING.md How to build the installer from source
PLATFORMS.md Platform-specific notes (Windows / macOS / Linux)

Getting started (Windows)

Step 1 — Download this repo

Click Code → Download ZIP on GitHub, then extract the folder anywhere on your PC.

Alternatively: git clone https://github.com/LucaDiLorenzo98/console_deck_pro.git


Step 2 — Flash the Arduino firmware

You only need to do this once.

  1. Download and install Arduino IDE
  2. Open Arduino IDE → Sketch → Include Library → Manage Libraries → search U8g2 → Install
  3. In the extracted folder, open console_deck_pro_arduino/console_deck_pro_arduino.ino
  4. Plug the Arduino Nano into your PC via USB
  5. Set Tools → Board → Arduino AVR Boards → Arduino Nano
  6. Set Tools → Processor → ATmega328P (try "Old Bootloader" if upload fails)
  7. Set Tools → Port → select the COM port that appeared when you plugged in the Nano
  8. Click Upload (the → arrow)

The OLED display should light up and show the boot screen. Done — you never need to touch Arduino IDE again.


Step 3 — Install the desktop software

  1. Go to the latest release on GitHub
  2. Download ConsoleDeckPro_Setup.exe
  3. Run the installer and follow the wizard

The installer includes everything: the UI app and the compiled backend — no Python installation required.


Step 4 — First launch

  1. In the installation folder (default: C:\Program Files\Console Deck PRO), double-click console_deck_pro.exe to start the backend. You can also add it to Windows startup via Task Scheduler or by placing a shortcut in shell:startup so it runs automatically at login.
  2. Open Console Deck PRO from the Start menu (or desktop shortcut) to launch the UI.
  3. Go to Settings and select the Arduino serial port (e.g. COM3).
  4. The OLED display will show the connected state and begin displaying PC stats.

Step 5 — Configure your buttons

  1. Go to the Modules tab in the app
  2. Click any button slot to assign an action
  3. Changes save automatically and take effect immediately

Button actions

Action What it does
open_url Opens a URL in the default browser
open_app Launches an executable by name
hotkey Sends a key combination (e.g. Ctrl+C, Win+PrintScreen)
type_text Types a text string
mute Toggles system mute
set_volume Maps slider/knob to system volume
set_brightness Maps slider/knob to screen brightness
home_assistant Triggers a Home Assistant service call

Expansion modules

Connect an expansion board to the side connector and select the module type from the on-device menu:

  • Sliders — 2 analog sliders (typically volume + brightness)
  • Knobs — 2 rotary knobs
  • Buttons — 6 additional momentary buttons

Installing Python and dependencies (advanced / dev use)

If you want to run the backend from source instead of using the compiled .exe:

Step 1 — Install Python

  1. Go to python.org/downloads and download the latest Python 3.10+ installer for Windows
  2. Run the installer — check "Add Python to PATH" before clicking Install
  3. Verify the installation by opening a terminal and running:
    python --version
    

Step 2 — Install dependencies

  1. Open a terminal in the project folder (where requirements.txt is located)
  2. Run:
    pip install -r requirements.txt
    

Step 3 — Start the backend

python console_deck_pro.py

Building from source

See BUILDING.md for instructions on building the Python backend, the Flutter app, and the Windows installer.


License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors