Skip to main content

Library to control Elgato StreamDeck devices.

Project description

Python Elgato Stream Deck Library

Example Deck

This is an open source Python 3 library to control an Elgato Stream Deck directly, without the official software. This can allow you to create your own custom front-ends, such as a custom control front-end for home automation software.


PyPi Project Entry - Online Documentation - Source Code

Project Status:

Working - you can enumerate devices, set the brightness of the panel(s), set the images shown on each button, and read the current button states.

Currently the following StreamDeck products are supported in multiple hardware variants:

  • StreamDeck Mini
  • StreamDeck Neo
  • StreamDeck Original
  • StreamDeck Pedal
  • StreamDeck Plus
  • StreamDeck XL

Package Installation:

Install the library via pip:

pip install streamdeck

Alternatively, manually clone the project repository:

git clone https://github.com/abcminiuser/python-elgato-streamdeck.git

For detailed installation instructions, refer to the prebuilt online documentation, or build the documentation yourself locally by running make html from the docs directory.

Credits:

I've used the reverse engineering notes from this GitHub repository to implement this library. Thanks Alex Van Camp!

Thank you to the following contributors, large and small, for helping with the development and maintenance of this library:

If you've contributed in some manner, but I've accidentally missed you in the list above, please let me know.

License:

Released under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

streamdeck-0.9.6.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

streamdeck-0.9.6-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file streamdeck-0.9.6.tar.gz.

File metadata

  • Download URL: streamdeck-0.9.6.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for streamdeck-0.9.6.tar.gz
Algorithm Hash digest
SHA256 ec42d9b711b352ea274ad305a6eb48ece1eed3a5bffe70b928e082dce0f788f0
MD5 5df74415fbcf811cb177d74657dfb81d
BLAKE2b-256 f92d70bb4ba717745afdf9e7012655ceadf885dbb0e81465423e60bd003dfb88

See more details on using hashes here.

File details

Details for the file streamdeck-0.9.6-py3-none-any.whl.

File metadata

  • Download URL: streamdeck-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 32.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for streamdeck-0.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e5fdcce06d399e249cfee7f0363eb12343b90a8ed2bfc1cd8408ced021ab184b
MD5 4900ba22b1e371f8df32eeed67bf3d16
BLAKE2b-256 975a99dfdd3d8d8a2c7699ebb2e9a97a2d34ae8f2cd6bc1eee1febb8166d8317

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page