A small and simple framework for streamdeck applications
Project description
Streamdeck controls
This project is a simple and small framework which simplifies developing and running custom apps for streamdeck devices. It allows using streamdecks without the offical software so you can use it with any major OS.
Currently supported Streamdecks
- Streamdeck Mk.2
Installing
Prerequisites
Linux:
sudo apt install libhidapi-dev
MacOS:
brew install hidapi
Installing sd-controls
pip install sd-controls
Contributing
If you are interested in this project and have a streamdeck, please consider contributing to it. Adding support for other Streamdecks is greatly appreciated but feel free to propose any other changes too!
Using this software with Linux (Linux udev rules)
Create a /etc/udev/rules.d/50-elgato.rules
file with the following content:
SUBSYSTEM=="input", GROUP="input", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0080", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0080", MODE:="666", GROUP="plugdev"
Example app
from PIL import Image
from sd_controls.sdsystem import SDSystem, SDUserApp, Sprites
class HelloWorldApp(SDUserApp):
_KEY_GREET = 1
_KEY_ROTATE = 2
def __init__(self) -> None:
super().__init__("Settings")
self._icon = SDUserApp.generate_labeled_img(Sprites.CLEAR, "Hello World")
self._hello = SDUserApp.generate_labeled_img(Sprites.CLEAR, "Hello")
self._world = SDUserApp.generate_labeled_img(Sprites.CLEAR, "World")
self._rotate_key = Sprites.GOAT
def get_icon(self) -> Image:
return self._icon
def init(self) -> None:
self.set_key(self._KEY_GREET, self._hello)
self.set_key(self._KEY_ROTATE, self._rotate_key)
def keys_update(self, keys_before: list[bool], keys: list[bool]) -> None:
if not keys[self._KEY_GREET] and keys_before[self._KEY_GREET]:
self.set_key(self._KEY_GREET, self._world)
if not keys[self._KEY_ROTATE] and keys_before[self._KEY_ROTATE]:
self._rotate_key = self._rotate_key.rotate(90)
self.set_key(self._KEY_ROTATE, self._rotate_key)
system = SDSystem()
system.register_app(HelloWorldApp())
system.start()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sd_controls-0.0.15.tar.gz
(117.1 kB
view hashes)
Built Distribution
sd_controls-0.0.15-py3-none-any.whl
(116.3 kB
view hashes)
Close
Hashes for sd_controls-0.0.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f18eab04b5bf8c06985d9e9953db4966621063fff2d0a1daf317290431daed8d |
|
MD5 | d273fba31af5afb26d04697bf9a6f67a |
|
BLAKE2b-256 | 236a26594a4e7418ae44d84f2e26188c1bf6635bc7d6722afb4871ae53a26d35 |