About

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.

Index

Installation and Setup

• Library Installation
  • HID Backend Setup
    • Default LibUSB HIDAPI Backend
      • Windows
      • MacOS (Darwin)
      • Linux (Ubuntu/Debian)

Module Documentation

• 1. Modules: Device Discovery
  • 1.1. Device Manager
    • DeviceManager
      • DeviceManager.enumerate()
    • ProbeError
• 2. Modules: StreamDeck Devices
  • 2.1. StreamDeck (Abstract Base)
    • DialEventType
    • StreamDeck
      • StreamDeck.close()
      • StreamDeck.connected()
      • StreamDeck.deck_type()
      • StreamDeck.dial_count()
      • StreamDeck.dial_states()
      • StreamDeck.get_firmware_version()
      • StreamDeck.get_serial_number()
      • StreamDeck.id()
      • StreamDeck.is_open()
      • StreamDeck.is_touch()
      • StreamDeck.is_visual()
      • StreamDeck.key_count()
      • StreamDeck.key_image_format()
      • StreamDeck.key_layout()
      • StreamDeck.key_states()
      • StreamDeck.open()
      • StreamDeck.product_id()
      • StreamDeck.reset()
      • StreamDeck.set_brightness()
      • StreamDeck.set_dial_callback()
      • StreamDeck.set_dial_callback_async()
      • StreamDeck.set_key_callback()
      • StreamDeck.set_key_callback_async()
      • StreamDeck.set_key_image()
      • StreamDeck.set_poll_frequency()
      • StreamDeck.set_touchscreen_callback()
      • StreamDeck.set_touchscreen_callback_async()
      • StreamDeck.set_touchscreen_image()
      • StreamDeck.touchscreen_image_format()
      • StreamDeck.vendor_id()
    • TouchscreenEventType
  • 2.2. StreamDeck Original
    • StreamDeckOriginal
      • StreamDeckOriginal.get_firmware_version()
      • StreamDeckOriginal.get_serial_number()
      • StreamDeckOriginal.reset()
      • StreamDeckOriginal.set_brightness()
      • StreamDeckOriginal.set_key_image()
      • StreamDeckOriginal.set_touchscreen_image()
  • 2.3. StreamDeck Mini
    • StreamDeckMini
      • StreamDeckMini.get_firmware_version()
      • StreamDeckMini.get_serial_number()
      • StreamDeckMini.reset()
      • StreamDeckMini.set_brightness()
      • StreamDeckMini.set_key_image()
      • StreamDeckMini.set_touchscreen_image()
  • 2.4. StreamDeck XL
    • StreamDeckXL
      • StreamDeckXL.get_firmware_version()
      • StreamDeckXL.get_serial_number()
      • StreamDeckXL.reset()
      • StreamDeckXL.set_brightness()
      • StreamDeckXL.set_key_image()
      • StreamDeckXL.set_touchscreen_image()
  • 2.5. StreamDeck Pedal
    • StreamDeckPedal
      • StreamDeckPedal.get_firmware_version()
      • StreamDeckPedal.get_serial_number()
      • StreamDeckPedal.reset()
      • StreamDeckPedal.set_brightness()
      • StreamDeckPedal.set_key_image()
      • StreamDeckPedal.set_touchscreen_image()
  • 2.6. StreamDeck Plus
    • StreamDeckPlus
      • StreamDeckPlus.get_firmware_version()
      • StreamDeckPlus.get_serial_number()
      • StreamDeckPlus.reset()
      • StreamDeckPlus.set_brightness()
      • StreamDeckPlus.set_key_image()
      • StreamDeckPlus.set_touchscreen_image()
• 3. Modules: Communication Transports
  • 3.1. Transport (Abstract Base)
    • Transport
      • Transport.Device
        • Transport.Device.close()
        • Transport.Device.connected()
        • Transport.Device.is_open()
        • Transport.Device.open()
        • Transport.Device.path()
        • Transport.Device.product_id()
        • Transport.Device.read()
        • Transport.Device.read_feature()
        • Transport.Device.vendor_id()
        • Transport.Device.write()
        • Transport.Device.write_feature()
      • Transport.enumerate()
      • Transport.probe()
    • TransportError
  • 3.2. ‘LibUSB HIDAPI’ Library Transport
    • LibUSBHIDAPI
      • LibUSBHIDAPI.Device
        • LibUSBHIDAPI.Device.close()
        • LibUSBHIDAPI.Device.connected()
        • LibUSBHIDAPI.Device.is_open()
        • LibUSBHIDAPI.Device.open()
        • LibUSBHIDAPI.Device.path()
        • LibUSBHIDAPI.Device.product_id()
        • LibUSBHIDAPI.Device.read()
        • LibUSBHIDAPI.Device.read_feature()
        • LibUSBHIDAPI.Device.vendor_id()
        • LibUSBHIDAPI.Device.write()
        • LibUSBHIDAPI.Device.write_feature()
      • LibUSBHIDAPI.enumerate()
      • LibUSBHIDAPI.probe()
• 4. Modules: Image Helpers
  • 4.1. PIL Image Helper

Library Examples

• 1. Example Script: Device Information
• 2. Example Script: Basic Usage
• 3. Example Script: Pedal
• 4. Example Script: StreamDeck +
• 5. Example Script: Tiled Image
• 6. Example Script: Animated Images

About

• Source Code
• Changelog
• License

Indices and tables

• Index

• Module Index