50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
[](https://badge.fury.io/py/streamdeckapi)
|
|
|
|
# streamdeckapi
|
|
Stream Deck API Library for Home Assistant Stream Deck Integration
|
|
|
|
Only compatible with separate [Stream Deck Plugin](https://github.com/Patrick762/streamdeckapi-plugin) or the bundled server.
|
|
|
|
## Server
|
|
This library also contains a server to use the streamdeck with Linux or without the official Stream Deck Software.
|
|
|
|
For this to work, the following software is required:
|
|
|
|
- LibUSB HIDAPI [Installation instructions](https://python-elgato-streamdeck.readthedocs.io/en/stable/pages/backend_libusb_hidapi.html) or [Installation instructions](https://github.com/jamesridgway/devdeck/wiki/Installation)
|
|
- cairo [Installation instructions for Windows](https://stackoverflow.com/a/73913080)
|
|
|
|
Cairo Installation for Windows:
|
|
```bash
|
|
pip install pipwin
|
|
|
|
pipwin install cairocffi
|
|
```
|
|
|
|
The event `doubleTap` is not working with this server software.
|
|
|
|
### Limitations
|
|
Discovery might not work.
|
|
|
|
### Installation on Linux / Raspberry Pi
|
|
|
|
Install requirements:
|
|
`sudo apt install -y libudev-dev libusb-1.0-0-dev libhidapi-libusb0 libjpeg-dev zlib1g-dev libopenjp2-7 libtiff5`
|
|
|
|
Allow all users non-root access to Stream Deck Devices:
|
|
```bash
|
|
sudo tee /etc/udev/rules.d/10-streamdeck.rules << EOF
|
|
SUBSYSTEMS=="usb", ATTRS{idVendor}=="0fd9", GROUP="users", TAG+="uaccess"
|
|
EOF
|
|
```
|
|
|
|
Reload access rules:
|
|
`sudo udevadm control --reload-rules`
|
|
|
|
Install the package:
|
|
`pip install streamdeckapi`
|
|
|
|
Reboot your system
|
|
|
|
Start the server:
|
|
`streamdeckapi-server`
|