Skip to content

Latest commit

 

History

History
267 lines (203 loc) · 6.29 KB

CLI_COMMANDS.md

File metadata and controls

267 lines (203 loc) · 6.29 KB

LoupixDeck CLI Commands

Usage

Control your Razer Stream Controller from the terminal while the app is running.

Start the Application First

dotnet run
# Or if you built it:
./bin/Debug/net9.0/LoupixDeck

Available Commands

1. Device OFF (Load OFF Config)

./loupixdeck-cli off
# or
./bin/Debug/net9.0/LoupixDeck off

Effect: Loads config_razer_off.json - turns off display, all LEDs black, screen clears

2. Device ON (Reload Config)

./loupixdeck-cli on
# or
./bin/Debug/net9.0/LoupixDeck on

Effect: Reloads config_razer.json - restores brightness, buttons, everything

3. Device ON/OFF Toggle

./loupixdeck-cli on-off

Effect: Toggles device state - if OFF turns ON, if ON turns OFF

4. Device Wakeup (Reconnect)

./loupixdeck-cli wakeup

Effect: Reconnects the device (useful after system suspend/resume) and turns it ON

5. Toggle Window Visibility

./loupixdeck-cli toggle
# or
./loupixdeck-cli show
# or
./loupixdeck-cli hide

Effect: Shows window if hidden, hides if shown

6. Update Button Properties

Update text, colors, and images on touch buttons:

# Update button text
./loupixdeck-cli updateButton 0 text=Hello

# Text with spaces (underscores become spaces)
./loupixdeck-cli updateButton 0 text=Hello_World

# Update text and text color
./loupixdeck-cli updateButton 0 text=Status textColor=Red

# Update background color
./loupixdeck-cli updateButton 0 backColor=Blue

# Update with image (use full path)
./loupixdeck-cli updateButton 0 image=/path/to/image.png

# Update multiple properties at once
./loupixdeck-cli updateButton 0 text=Status textColor=White backColor=#00FF00

# Clear the image
./loupixdeck-cli updateButton 0 image=clear

Supported properties:

  • text=... - Button text (use underscores for spaces: text=Hello_World)
  • textColor=... - Text color (named colors like Red, Blue, or hex like #FF0000)
  • backColor=... - Background color (named colors or hex)
  • image=... - Path to image file, or "clear" to remove image

Notes:

  • Button index is 0-based (0, 1, 2, etc.)
  • For text with spaces, use underscores: text=Hello_World
  • Separate multiple properties with spaces

7. Page Navigation

Go to Specific Touch Page:

./loupixdeck-cli page1    # Go to touch page 1
./loupixdeck-cli page2    # Go to touch page 2
./loupixdeck-cli page3    # Go to touch page 3
# etc...

Go to Specific Rotary Page:

./loupixdeck-cli rotaryPage1    # Go to rotary page 1
./loupixdeck-cli rotaryPage2    # Go to rotary page 2
# etc...

Navigate Pages:

./loupixdeck-cli nextPage           # Next touch page
./loupixdeck-cli previousPage       # Previous touch page
./loupixdeck-cli nextRotaryPage     # Next rotary page
./loupixdeck-cli previousRotaryPage # Previous rotary page

8. Quit Application

./loupixdeck-cli quit

Effect: Applies OFF config, then exits (device goes dark)

Example Use Cases

Automatic Device Control with Scripts

Turn off device when locking screen:

# Add to ~/.config/systemd/user/loupixdeck-lock.service
./loupixdeck-cli off

Turn on device when unlocking:

./loupixdeck-cli on

Reconnect device after system suspend/resume:

# Add to wakeup script or systemd resume service
./loupixdeck-cli wakeup

Keyboard Shortcuts

Bind to keyboard shortcuts in your DE:

  • Super+L → ./loupixdeck-cli off (turn off device)
  • Super+O → ./loupixdeck-cli on (turn on device)
  • Super+D → ./loupixdeck-cli toggle (show/hide GUI)

Systemd Integration

Auto-start on boot:

# Create ~/.config/systemd/user/loupixdeck.service
[Unit]
Description=LoupixDeck Razer Stream Controller

[Service]
ExecStart=/home/ovehbe/Code/LoupixDeck-master/bin/Debug/net9.0/LoupixDeck
Restart=always

[Install]
WantedBy=default.target

Then:

systemctl --user enable loupixdeck
systemctl --user start loupixdeck

Control from terminal anytime:

./loupixdeck-cli off  # Turn device off
./loupixdeck-cli on   # Turn device on

Response Messages

All commands return a response:

  • OK: System.GotoPage(1) executed - Command successful
  • ERROR: ... - Command failed
  • Unknown command. Available: on, off, on-off, wakeup, page<N>, rotaryPage<N>, nextPage, previousPage, nextRotaryPage, previousRotaryPage, toggle, show, hide, quit - Invalid command

Installation for System-Wide Access

Option 1: Symlink to ~/bin

mkdir -p ~/bin
ln -s /home/ovehbe/Code/LoupixDeck-master/loupixdeck-cli ~/bin/loupixdeck
# Add ~/bin to PATH if not already
export PATH="$HOME/bin:$PATH"

Then use anywhere:

loupixdeck off
loupixdeck on
loupixdeck toggle

Option 2: Alias in ~/.bashrc

echo 'alias loupixdeck="/home/ovehbe/Code/LoupixDeck-master/loupixdeck-cli"' >> ~/.bashrc
source ~/.bashrc

Then:

loupixdeck off
loupixdeck on

Troubleshooting

"LoupixDeck is not running"

  • Start the app first: dotnet run or ./bin/Debug/net9.0/LoupixDeck

"Connection refused"

  • App crashed or exited
  • Check if socket exists: ls -la /tmp/loupixdeck_app.sock

Commands don't work

  • Make sure CLI wrapper is executable: chmod +x loupixdeck-cli
  • Try direct binary: ./bin/Debug/net9.0/LoupixDeck off

Summary

While app is running, control it from terminal:

Device Control:

  • ./loupixdeck-cli on - Turn device ON
  • ./loupixdeck-cli off - Turn device OFF
  • ./loupixdeck-cli on-off - Toggle device ON/OFF
  • ./loupixdeck-cli wakeup - Reconnect device and turn ON (for suspend/resume)

Button Control:

  • ./loupixdeck-cli updateButton <index> text=... textColor=... backColor=... image=... - Update button display

Page Navigation:

  • ./loupixdeck-cli page1, page2, etc. - Go to specific touch page
  • ./loupixdeck-cli rotaryPage1, rotaryPage2, etc. - Go to specific rotary page
  • ./loupixdeck-cli nextPage - Next touch page
  • ./loupixdeck-cli previousPage - Previous touch page
  • ./loupixdeck-cli nextRotaryPage - Next rotary page
  • ./loupixdeck-cli previousRotaryPage - Previous rotary page

Window & App:

  • ./loupixdeck-cli toggle - Show/Hide window
  • ./loupixdeck-cli quit - Exit app (with device clear)

Perfect for automation, scripts, and keyboard shortcuts! 🚀