https://github.com/n-ziermann/pi-deck
A stream deck alternative
https://github.com/n-ziermann/pi-deck
iot macros raspberry-pi raspberry-pi-3 streaming touch
Last synced: about 1 month ago
JSON representation
A stream deck alternative
- Host: GitHub
- URL: https://github.com/n-ziermann/pi-deck
- Owner: N-Ziermann
- License: gpl-3.0
- Created: 2019-05-17T15:00:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T15:02:13.000Z (about 2 years ago)
- Last Synced: 2025-03-14T08:43:23.242Z (over 1 year ago)
- Topics: iot, macros, raspberry-pi, raspberry-pi-3, streaming, touch
- Language: JavaScript
- Homepage: https://n-ziermann.github.io/projects/pi-deck.html
- Size: 739 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pi-deck
A stream deck alternative based on electron and react.
## Installation
Choose one of the builds from the release section that best fits your system and install it on the device you want to control.
You will also need to have python as well as the pynput module installed.
It is highly advised to add the pideck software to your autostart programms to allow your macros to work right when the computer starts.
## Configuration
When you open the pideck desktop app you will see an icon appear in your Tray/Taskbar.
Clicking it will allow you to open the configuration interface in which you can add macros to each of the buttons the pideck provides.
## Known Issues
- Keyboard shortcuts on MacOS will only work, if the programm is ran from the commandline, because of issues with OSX's accessibility API
## Using the pideck
When you're done configuring your pideck you can use your phone to head to the url displayed on the bottom right of the configuration panel.
Here you'll be able to execute the configured commands by pressing the any of your assigned buttons.
## Key Mappings
Defining key combinations requires you to know the shorthands for each non-letter-key you want to use. So here's a mapping of all relevant keys you might want to create macros for:
| Key | Shorthand |
| ------------------------ | ----------------- |
| Alt | alt |
| Alt (Gr) | alt_gr |
| Alt (Left) | alt_l |
| Alt (Right) | alt_r |
| Backspace | backspace |
| CapsLock | caps_lock |
| Command (Windows / Meta) | cmd |
| Command (Left) | cmd_l |
| Command (Right) | cmd_r |
| Control | ctrl |
| Control (Left) | ctrl_l |
| Control (Right) | ctrl_r |
| Delete | delete |
| Down | down |
| End | end |
| Enter | enter |
| Escape | esc |
| F-Keys | f1, f2, ... |
| Home (Pos-1) | home |
| Insert | insert |
| Left | left |
| Media Next | media_next |
| Media Play/Pause | media_play_pause |
| Media Previous | media_previous |
| Media Volume Down | media_volume_down |
| Media Volume Mute | media_volume_mute |
| Media Volume Up | media_volume_up |
| Menu / Application | menu |
| NumLock | num_lock |
| Page Down | page_down |
| Page Up | page_up |
| Pause | pause |
| Print Screen | print_screen |
| Right | right |
| ScrollLock | scroll_lock |
| Shift | shift |
| Shift (Left) | shift_l |
| Shift (Right) | shift_r |
| Space | space |
| Tab | tab |
| Up | up |
Note: These are the bindings from the pynput python module. If any of them dont work properly then it's most likely because of this library