streamdeck 0.9.6__tar.gz → 0.9.7__tar.gz

{streamdeck-0.9.6 → streamdeck-0.9.7}/CHANGELOG

@@ -1,3 +1,9 @@
+Version 0.9.7:
+	- Added type hints to public APIs.
+	- Fixed leading whitespace in StreamDeck Plus serial number strings.
+	- Added support for new PID variant of the StreamDeck MK2.
+	- Added support for new StreamDeck 16-key, 32-key and scissor modules.
+
 Version 0.9.6:
 	- Fixed StreamDeck+ returning 10 key states instead of the expected 8.
 	- Fixed StreamDeck+ dial push event not being detected correctly.

{streamdeck-0.9.6 → streamdeck-0.9.7}/PKG-INFO

@@ -1,14 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: streamdeck
-Version: 0.9.6
+Version: 0.9.7
 Summary: Library to control Elgato StreamDeck devices.
 Home-page: https://github.com/abcminiuser/python-elgato-streamdeck
 Author: Dean Camera
 Author-email: dean@fourwalledcubicle.com
 License: MIT
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
 
 # Python Elgato Stream Deck Library
 
@@ -32,6 +41,7 @@ the images shown on each button, and read the current button states.
 Currently the following StreamDeck products are supported in multiple hardware
 variants:
 
+* StreamDeck 16 Key, 32 Key and Scissor Modules
 * StreamDeck Mini
 * StreamDeck Neo
 * StreamDeck Original
@@ -79,16 +89,20 @@ development and maintenance of this library:
 - [dubstech](https://github.com/dubstech)
 - [Giraut](https://github.com/Giraut)
 - [impala454](https://github.com/impala454)
+- [iPhoneAddict](https://github.com/iPhoneAddict)
 - [itsusony](https://github.com/itsusony)
 - [jakobbuis](https://github.com/jakobbuis)
 - [jmudge14](https://github.com/jmudge14)
+- [jonbloom](https://github.com/jonbloom)
 - [Kalle-Wirsch](https://github.com/Kalle-Wirsch)
 - [karstlok](https://github.com/karstlok)
 - [Lewiscowles1986](https://github.com/Lewiscowles1986)
 - [m-weigand](https://github.com/m-weigand)
+- [mathben](https://github.com/mathben)
 - [matrixinius](https://github.com/matrixinius)
 - [phillco](https://github.com/phillco)
 - [pointshader](https://github.com/pointshader)
+- [pylogger-html](https://github.com/pylogger-html)
 - [shanna](https://github.com/shanna)
 - [spidererrol](https://github.com/Spidererrol)
 - [spyoungtech](https://github.com/spyoungtech)

{streamdeck-0.9.6 → streamdeck-0.9.7}/README.md

@@ -20,6 +20,7 @@ the images shown on each button, and read the current button states.
 Currently the following StreamDeck products are supported in multiple hardware
 variants:
 
+* StreamDeck 16 Key, 32 Key and Scissor Modules
 * StreamDeck Mini
 * StreamDeck Neo
 * StreamDeck Original
@@ -67,16 +68,20 @@ development and maintenance of this library:
 - [dubstech](https://github.com/dubstech)
 - [Giraut](https://github.com/Giraut)
 - [impala454](https://github.com/impala454)
+- [iPhoneAddict](https://github.com/iPhoneAddict)
 - [itsusony](https://github.com/itsusony)
 - [jakobbuis](https://github.com/jakobbuis)
 - [jmudge14](https://github.com/jmudge14)
+- [jonbloom](https://github.com/jonbloom)
 - [Kalle-Wirsch](https://github.com/Kalle-Wirsch)
 - [karstlok](https://github.com/karstlok)
 - [Lewiscowles1986](https://github.com/Lewiscowles1986)
 - [m-weigand](https://github.com/m-weigand)
+- [mathben](https://github.com/mathben)
 - [matrixinius](https://github.com/matrixinius)
 - [phillco](https://github.com/phillco)
 - [pointshader](https://github.com/pointshader)
+- [pylogger-html](https://github.com/pylogger-html)
 - [shanna](https://github.com/shanna)
 - [spidererrol](https://github.com/Spidererrol)
 - [spyoungtech](https://github.com/spyoungtech)

streamdeck-0.9.7/VERSION

@@ -0,0 +1 @@
+0.9.7

{streamdeck-0.9.6 → streamdeck-0.9.7}/setup.py

@@ -20,5 +20,5 @@ setuptools.setup(
    long_description=long_description,
    long_description_content_type="text/markdown",
    include_package_data=True,
-   python_requires='>=3.8',
+   python_requires='>=3.9',
 )

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/DeviceManager.py

@@ -5,6 +5,7 @@
 #         www.fourwalledcubicle.com
 #
 
+from .Devices.StreamDeck import StreamDeck
 from .Devices.StreamDeckMini import StreamDeckMini
 from .Devices.StreamDeckNeo import StreamDeckNeo
 from .Devices.StreamDeckOriginal import StreamDeckOriginal
@@ -12,6 +13,7 @@ from .Devices.StreamDeckOriginalV2 import StreamDeckOriginalV2
 from .Devices.StreamDeckXL import StreamDeckXL
 from .Devices.StreamDeckPedal import StreamDeckPedal
 from .Devices.StreamDeckPlus import StreamDeckPlus
+from .Transport import Transport
 from .Transport.Dummy import Dummy
 from .Transport.LibUSBHIDAPI import LibUSBHIDAPI
 from .ProductIDs import USBVendorIDs, USBProductIDs
@@ -33,18 +35,8 @@ class DeviceManager:
     StreamDeck devices.
     """
 
-    USB_VID_ELGATO = 0x0fd9
-    USB_PID_STREAMDECK_ORIGINAL = 0x0060
-    USB_PID_STREAMDECK_ORIGINAL_V2 = 0x006d
-    USB_PID_STREAMDECK_MINI = 0x0063
-    USB_PID_STREAMDECK_NEO = 0x009a
-    USB_PID_STREAMDECK_XL = 0x006c
-    USB_PID_STREAMDECK_MK2 = 0x0080
-    USB_PID_STREAMDECK_PEDAL = 0x0086
-    USB_PID_STREAMDECK_PLUS = 0x0084
-
     @staticmethod
-    def _get_transport(transport):
+    def _get_transport(transport: str | None):
         """
         Creates a new HID transport instance from the given transport back-end
         name. If no specific transport is supplied, an attempt to find an
@@ -87,15 +79,15 @@ class DeviceManager:
 
             raise ProbeError("Probe failed to find any functional HID backend.", probe_errors)
 
-    def __init__(self, transport=None):
+    def __init__(self, transport: str | None = None):
         """
         Creates a new StreamDeck DeviceManager, used to detect attached StreamDeck devices.
 
         :param str transport: name of the the specific HID transport back-end to use, None to auto-probe.
         """
-        self.transport = self._get_transport(transport)
+        self.transport: Transport.Transport = self._get_transport(transport)
 
-    def enumerate(self):
+    def enumerate(self) -> list[StreamDeck]:
         """
         Detect attached StreamDeck devices.
 
@@ -106,13 +98,18 @@ class DeviceManager:
         products = [
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_ORIGINAL, StreamDeckOriginal),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_ORIGINAL_V2, StreamDeckOriginalV2),
+            (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MK2_SCISSOR, StreamDeckOriginalV2),
+            (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MK2_MODULE, StreamDeckOriginalV2),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MINI, StreamDeckMini),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_NEO, StreamDeckNeo),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_XL, StreamDeckXL),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MK2, StreamDeckOriginalV2),
+            (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MK2_V2, StreamDeckOriginalV2),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_PEDAL, StreamDeckPedal),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MINI_MK2, StreamDeckMini),
+            (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_MINI_MK2_MODULE, StreamDeckMini),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_XL_V2, StreamDeckXL),
+            (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_XL_V2_MODULE, StreamDeckXL),
             (USBVendorIDs.USB_VID_ELGATO, USBProductIDs.USB_PID_STREAMDECK_PLUS, StreamDeckPlus),
         ]
 

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/Devices/StreamDeck.py

@@ -8,9 +8,11 @@
 import threading
 import time
 from abc import ABC, abstractmethod
+from collections.abc import Callable
 from enum import Enum
+from typing import Any, Iterable, TypeVar
 
-from ..Transport.Transport import TransportError
+from ..Transport.Transport import Transport, TransportError
 
 
 class TouchscreenEventType(Enum):
@@ -78,19 +80,24 @@ class StreamDeck(ABC):
     DECK_VISUAL = False
     DECK_TOUCH = False
 
-    def __init__(self, device):
-        self.device = device
-        self.last_key_states = [False] * (self.KEY_COUNT + self.TOUCH_KEY_COUNT)
-        self.last_dial_states = [False] * self.DIAL_COUNT
-        self.read_thread = None
-        self.run_read_thread = False
-        self.read_poll_hz = 20
+    _Self = TypeVar('_Self', bound='StreamDeck')
+    KeyCallback = Callable[[_Self, int, bool], None] | None
+    DialCallback = Callable[[_Self, int, DialEventType, bool], None] | None
+    TouchScreenCallback = Callable[[_Self, TouchscreenEventType, Any], None] | None
 
-        self.key_callback = None
-        self.dial_callback = None
-        self.touchscreen_callback = None
+    def __init__(self, device: Transport.Device):
+        self.device: Transport.Device = device
+        self.last_key_states: list[bool] = [False] * (self.KEY_COUNT + self.TOUCH_KEY_COUNT)
+        self.last_dial_states: list[bool] = [False] * self.DIAL_COUNT
+        self.read_thread: threading.Thread | None = None
+        self.run_read_thread: bool = False
+        self.read_poll_hz: int = 20
 
-        self.update_lock = threading.RLock()
+        self.key_callback: StreamDeck.KeyCallback = None
+        self.dial_callback: StreamDeck.DialCallback = None
+        self.touchscreen_callback: StreamDeck.TouchScreenCallback = None
+
+        self.update_lock: threading.RLock = threading.RLock()
 
     def __del__(self):
         """
@@ -124,7 +131,7 @@ class StreamDeck(ABC):
         self.update_lock.release()
 
     @abstractmethod
-    def _read_control_states(self):
+    def _read_control_states(self) -> None:
         """
         Reads the raw key states from an attached StreamDeck.
 
@@ -133,7 +140,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def _reset_key_stream(self):
+    def _reset_key_stream(self) -> None:
         """
         Sends a blank key report to the StreamDeck, resetting the key image
         streamer in the device. This prevents previously started partial key
@@ -142,15 +149,16 @@ class StreamDeck(ABC):
         """
         pass
 
-    def _extract_string(self, data):
+    def _extract_string(self, data: Iterable[int]) -> str:
         """
         Extracts out a human-readable string from a collection of raw bytes,
-        removing any trailing whitespace or data after the first NUL byte.
+        removing any trailing whitespace or data after and before the first NUL
+        byte.
         """
 
-        return str(bytes(data), 'ascii', 'replace').partition('\0')[0].rstrip()
+        return str(bytes(data), 'ascii', 'replace').partition('\0')[0].strip()
 
-    def _read(self):
+    def _read(self) -> None:
         """
         Read handler for the underlying transport, listening for control state
         changes on the underlying device, caching the new states and firing off
@@ -200,7 +208,7 @@ class StreamDeck(ABC):
                 self.run_read_thread = False
                 self.close()
 
-    def _setup_reader(self, callback):
+    def _setup_reader(self, callback: Callable) -> None:
         """
         Sets up the internal transport reader thread with the given callback,
         for asynchronous processing of HID events from the device. If the thread
@@ -223,7 +231,7 @@ class StreamDeck(ABC):
             self.read_thread.daemon = True
             self.read_thread.start()
 
-    def open(self):
+    def open(self) -> None:
         """
         Opens the device for input/output. This must be called prior to setting
         or retrieving any device state.
@@ -235,7 +243,7 @@ class StreamDeck(ABC):
         self._reset_key_stream()
         self._setup_reader(self._read)
 
-    def close(self):
+    def close(self) -> None:
         """
         Closes the device for input/output.
 
@@ -243,7 +251,7 @@ class StreamDeck(ABC):
         """
         self.device.close()
 
-    def is_open(self):
+    def is_open(self) -> bool:
         """
         Indicates if the StreamDeck device is currently open and ready for use.
 
@@ -252,7 +260,7 @@ class StreamDeck(ABC):
         """
         return self.device.is_open()
 
-    def connected(self):
+    def connected(self) -> bool:
         """
         Indicates if the physical StreamDeck device this instance is attached to
         is still connected to the host.
@@ -262,7 +270,7 @@ class StreamDeck(ABC):
         """
         return self.device.connected()
 
-    def vendor_id(self):
+    def vendor_id(self) -> int:
         """
         Retrieves the vendor ID attached StreamDeck. This can be used
         to determine the exact type of attached StreamDeck.
@@ -272,7 +280,7 @@ class StreamDeck(ABC):
         """
         return self.device.vendor_id()
 
-    def product_id(self):
+    def product_id(self) -> int:
         """
         Retrieves the product ID attached StreamDeck. This can be used
         to determine the exact type of attached StreamDeck.
@@ -282,7 +290,7 @@ class StreamDeck(ABC):
         """
         return self.device.product_id()
 
-    def id(self):
+    def id(self) -> str:
         """
         Retrieves the physical ID of the attached StreamDeck. This can be used
         to differentiate one StreamDeck from another.
@@ -292,7 +300,7 @@ class StreamDeck(ABC):
         """
         return self.device.path()
 
-    def key_count(self):
+    def key_count(self) -> int:
         """
         Retrieves number of physical buttons on the attached StreamDeck device.
 
@@ -301,7 +309,7 @@ class StreamDeck(ABC):
         """
         return self.KEY_COUNT
 
-    def touch_key_count(self):
+    def touch_key_count(self) -> int:
         """
         Retrieves number of touch buttons on the attached StreamDeck device.
 
@@ -310,7 +318,7 @@ class StreamDeck(ABC):
         """
         return self.TOUCH_KEY_COUNT
 
-    def dial_count(self):
+    def dial_count(self) -> int:
         """
         Retrieves number of physical dials on the attached StreamDeck device.
 
@@ -319,7 +327,7 @@ class StreamDeck(ABC):
         """
         return self.DIAL_COUNT
 
-    def deck_type(self):
+    def deck_type(self) -> str:
         """
         Retrieves the model of Stream Deck.
 
@@ -328,7 +336,7 @@ class StreamDeck(ABC):
         """
         return self.DECK_TYPE
 
-    def is_visual(self):
+    def is_visual(self) -> bool:
         """
         Returns whether the Stream Deck has a visual display output.
 
@@ -337,7 +345,7 @@ class StreamDeck(ABC):
         """
         return self.DECK_VISUAL
 
-    def is_touch(self):
+    def is_touch(self) -> bool:
         """
         Returns whether the Stream Deck can receive touch events
 
@@ -346,7 +354,7 @@ class StreamDeck(ABC):
         """
         return self.DECK_TOUCH
 
-    def key_layout(self):
+    def key_layout(self) -> tuple[int, int]:
         """
         Retrieves the physical button layout on the attached StreamDeck device.
 
@@ -414,7 +422,7 @@ class StreamDeck(ABC):
             'rotation': self.SCREEN_ROTATION,
         }
 
-    def set_poll_frequency(self, hz):
+    def set_poll_frequency(self, hz: int) -> None:
         """
         Sets the frequency of the button polling reader thread, determining how
         often the StreamDeck will be polled for button changes.
@@ -426,7 +434,7 @@ class StreamDeck(ABC):
         """
         self.read_poll_hz = min(max(hz, 1), 1000)
 
-    def set_key_callback(self, callback):
+    def set_key_callback(self, callback: KeyCallback) -> None:
         """
         Sets the callback function called each time a button on the StreamDeck
         changes state (either pressed, or released).
@@ -445,7 +453,7 @@ class StreamDeck(ABC):
         """
         self.key_callback = callback
 
-    def set_key_callback_async(self, async_callback, loop=None):
+    def set_key_callback_async(self, async_callback: KeyCallback, loop=None):
         """
         Sets the asynchronous callback function called each time a button on the
         StreamDeck changes state (either pressed, or released). The given
@@ -470,7 +478,7 @@ class StreamDeck(ABC):
 
         self.set_key_callback(callback)
 
-    def set_dial_callback(self, callback):
+    def set_dial_callback(self, callback: DialCallback) -> None:
         """
         Sets the callback function called each time there is an interaction
         with a dial on the StreamDeck.
@@ -489,7 +497,7 @@ class StreamDeck(ABC):
         """
         self.dial_callback = callback
 
-    def set_dial_callback_async(self, async_callback, loop=None):
+    def set_dial_callback_async(self, async_callback: DialCallback, loop=None) -> None:
         """
         Sets the asynchronous callback function called each time there is an
         interaction with a dial on the StreamDeck. The given callback should
@@ -514,7 +522,7 @@ class StreamDeck(ABC):
 
         self.set_dial_callback(callback)
 
-    def set_touchscreen_callback(self, callback):
+    def set_touchscreen_callback(self, callback: TouchScreenCallback) -> None:
         """
         Sets the callback function called each time there is an interaction
         with a touchscreen on the StreamDeck.
@@ -533,7 +541,7 @@ class StreamDeck(ABC):
         """
         self.touchscreen_callback = callback
 
-    def set_touchscreen_callback_async(self, async_callback, loop=None):
+    def set_touchscreen_callback_async(self, async_callback: TouchScreenCallback, loop=None) -> None:
         """
         Sets the asynchronous callback function called each time there is an
         interaction with the touchscreen on the StreamDeck. The given callback
@@ -558,7 +566,7 @@ class StreamDeck(ABC):
 
         self.set_touchscreen_callback(callback)
 
-    def key_states(self):
+    def key_states(self) -> list[bool]:
         """
         Retrieves the current states of the buttons on the StreamDeck.
 
@@ -569,7 +577,7 @@ class StreamDeck(ABC):
         """
         return self.last_key_states
 
-    def dial_states(self):
+    def dial_states(self) -> list[bool]:
         """
         Retrieves the current states of the dials (pressed or not) on the
         Stream Deck
@@ -582,7 +590,7 @@ class StreamDeck(ABC):
         return self.last_dial_states
 
     @abstractmethod
-    def reset(self):
+    def reset(self) -> None:
         """
         Resets the StreamDeck, clearing all button images and showing the
         standby image.
@@ -590,7 +598,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def set_brightness(self, percent):
+    def set_brightness(self, percent: int | float) -> None:
         """
         Sets the global screen brightness of the StreamDeck, across all the
         physical buttons.
@@ -601,7 +609,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def get_serial_number(self):
+    def get_serial_number(self) -> str:
         """
         Gets the serial number of the attached StreamDeck.
 
@@ -611,7 +619,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def get_firmware_version(self):
+    def get_firmware_version(self) -> str:
         """
         Gets the firmware version of the attached StreamDeck.
 
@@ -621,7 +629,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def set_key_image(self, key, image):
+    def set_key_image(self, key: int, image: bytes) -> None:
         """
         Sets the image of a button on the StreamDeck to the given image. The
         image being set should be in the correct format for the device, as an
@@ -638,7 +646,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def set_touchscreen_image(self, image, x_pos=0, y_pos=0, width=0, height=0):
+    def set_touchscreen_image(self, image: bytes, x_pos: int = 0, y_pos: int = 0, width: int = 0, height: int = 0):
         """
         Draws an image on the touchscreen in a certain position. The image
         should be in the correct format for the devices, as an enumerable
@@ -658,7 +666,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def set_key_color(self, key, r, g, b):
+    def set_key_color(self, key: int, r: int, g: int, b: int) -> None:
         """
         Sets the color of the touch buttons. These buttons are indexed
         in order after the standard keys.
@@ -672,7 +680,7 @@ class StreamDeck(ABC):
         pass
 
     @abstractmethod
-    def set_screen_image(self, image):
+    def set_screen_image(self, image: bytes) -> None:
         """
         Draws an image on the touchless screen of the StreamDeck.
 

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/ImageHelpers/PILHelper.py

@@ -8,12 +8,14 @@
 import io
 from PIL import Image
 
+from ..Devices.StreamDeck import StreamDeck
+
 
 def _create_image(image_format, background):
     return Image.new("RGB", image_format['size'], background)
 
 
-def _scale_image(image, image_format, margins=[0, 0, 0, 0], background='black'):
+def _scale_image(image, image_format, margins=(0, 0, 0, 0), background='black'):
     if len(margins) != 4:
         raise ValueError("Margins should be given as an array of four integers.")
 
@@ -47,12 +49,12 @@ def _to_native_format(image, image_format):
         image = image.transpose(Image.FLIP_TOP_BOTTOM)
 
     # We want a compressed image in a given codec, convert.
-    compressed_image = io.BytesIO()
-    image.save(compressed_image, image_format['format'], quality=100)
-    return compressed_image.getbuffer()
+    with io.BytesIO() as compressed_image:
+        image.save(compressed_image, image_format['format'], quality=100)
+        return compressed_image.getvalue()
 
 
-def create_image(deck, background='black'):
+def create_image(deck: StreamDeck, background: str = 'black') -> Image.Image:
     """
     .. deprecated:: 0.9.5
         Use :func:`~PILHelper.create_key_image` method instead.
@@ -60,7 +62,7 @@ def create_image(deck, background='black'):
     return create_key_image(deck, background)
 
 
-def create_key_image(deck, background='black'):
+def create_key_image(deck: StreamDeck, background: str = 'black') -> Image.Image:
     """
     Creates a new PIL Image with the correct image dimensions for the given
     StreamDeck device's keys.
@@ -78,7 +80,7 @@ def create_key_image(deck, background='black'):
     return _create_image(deck.key_image_format(), background)
 
 
-def create_touchscreen_image(deck, background='black'):
+def create_touchscreen_image(deck: StreamDeck, background: str = 'black') -> Image.Image:
     """
     Creates a new PIL Image with the correct image dimensions for the given
     StreamDeck device's touchscreen.
@@ -96,10 +98,10 @@ def create_touchscreen_image(deck, background='black'):
     return _create_image(deck.touchscreen_image_format(), background)
 
 
-def create_screen_image(deck, background='black'):
+def create_screen_image(deck: StreamDeck, background: str = 'black') -> Image.Image:
     """
     Creates a new PIL Image with the correct image dimensions for the given
-    StreamDeck device's creen.
+    StreamDeck device's screen.
 
     .. seealso:: See :func:`~PILHelper.to_native_screen_format` method for converting a
                  PIL image instance to the native screen image format of a given
@@ -114,7 +116,7 @@ def create_screen_image(deck, background='black'):
     return _create_image(deck.screen_image_format(), background)
 
 
-def create_scaled_image(deck, image, margins=[0, 0, 0, 0], background='black'):
+def create_scaled_image(deck: StreamDeck, image: Image.Image, margins: tuple[int, int, int, int] = (0, 0, 0, 0), background: str = 'black') -> Image.Image:
     """
     .. deprecated:: 0.9.5
         Use :func:`~PILHelper.create_scaled_key_image` method instead.
@@ -122,7 +124,7 @@ def create_scaled_image(deck, image, margins=[0, 0, 0, 0], background='black'):
     return create_scaled_key_image(deck, image, margins, background)
 
 
-def create_scaled_key_image(deck, image, margins=[0, 0, 0, 0], background='black'):
+def create_scaled_key_image(deck: StreamDeck, image: Image.Image, margins: tuple[int, int, int, int] = (0, 0, 0, 0), background: str = 'black') -> Image.Image:
     """
     Creates a new key image that contains a scaled version of a given image,
     resized to best fit the given StreamDeck device's keys with the given
@@ -146,7 +148,7 @@ def create_scaled_key_image(deck, image, margins=[0, 0, 0, 0], background='black
     return _scale_image(image, deck.key_image_format(), margins, background)
 
 
-def create_scaled_touchscreen_image(deck, image, margins=[0, 0, 0, 0], background='black'):
+def create_scaled_touchscreen_image(deck: StreamDeck, image: Image.Image, margins: tuple[int, int, int, int] = (0, 0, 0, 0), background: str = 'black') -> Image.Image:
     """
     Creates a new touchscreen image that contains a scaled version of a given image,
     resized to best fit the given StreamDeck device's touchscreen with the given
@@ -170,7 +172,7 @@ def create_scaled_touchscreen_image(deck, image, margins=[0, 0, 0, 0], backgroun
     return _scale_image(image, deck.touchscreen_image_format(), margins, background)
 
 
-def create_scaled_screen_image(deck, image, margins=[0, 0, 0, 0], background='black'):
+def create_scaled_screen_image(deck: StreamDeck, image: Image.Image, margins: tuple[int, int, int, int] = (0, 0, 0, 0), background: str = 'black') -> Image.Image:
     """
     Creates a new screen image that contains a scaled version of a given image,
     resized to best fit the given StreamDeck device's screen with the given
@@ -194,7 +196,7 @@ def create_scaled_screen_image(deck, image, margins=[0, 0, 0, 0], background='bl
     return _scale_image(image, deck.screen_image_format(), margins, background)
 
 
-def to_native_format(deck, image):
+def to_native_format(deck: StreamDeck, image: Image.Image) -> bytes:
     """
     .. deprecated:: 0.9.5
         Use :func:`~PILHelper.to_native_key_format` method instead.
@@ -202,7 +204,7 @@ def to_native_format(deck, image):
     return to_native_key_format(deck, image)
 
 
-def to_native_key_format(deck, image):
+def to_native_key_format(deck: StreamDeck, image: Image.Image) -> bytes:
     """
     Converts a given PIL image to the native key image format for a StreamDeck,
     suitable for passing to :func:`~StreamDeck.set_key_image`.
@@ -219,7 +221,7 @@ def to_native_key_format(deck, image):
     return _to_native_format(image, deck.key_image_format())
 
 
-def to_native_touchscreen_format(deck, image):
+def to_native_touchscreen_format(deck: StreamDeck, image: Image.Image) -> bytes:
     """
     Converts a given PIL image to the native touchscreen image format for a StreamDeck,
     suitable for passing to :func:`~StreamDeck.set_touchscreen_image`.
@@ -236,7 +238,7 @@ def to_native_touchscreen_format(deck, image):
     return _to_native_format(image, deck.touchscreen_image_format())
 
 
-def to_native_screen_format(deck, image):
+def to_native_screen_format(deck: StreamDeck, image: Image.Image) -> bytes:
     """
     Converts a given PIL image to the native screen image format for a StreamDeck,
     suitable for passing to :func:`~StreamDeck.set_screen_image`.

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/ProductIDs.py

@@ -19,13 +19,18 @@ class USBProductIDs:
     USB Product IDs for known StreamDeck devices.
     """
 
-    USB_PID_STREAMDECK_ORIGINAL = 0x0060
-    USB_PID_STREAMDECK_ORIGINAL_V2 = 0x006d
     USB_PID_STREAMDECK_MINI = 0x0063
-    USB_PID_STREAMDECK_NEO = 0x009a
-    USB_PID_STREAMDECK_XL = 0x006c
-    USB_PID_STREAMDECK_XL_V2 = 0x008f
+    USB_PID_STREAMDECK_MINI_MK2 = 0x0090
+    USB_PID_STREAMDECK_MINI_MK2_MODULE = 0x00b8
     USB_PID_STREAMDECK_MK2 = 0x0080
+    USB_PID_STREAMDECK_MK2_MODULE = 0x00b9
+    USB_PID_STREAMDECK_MK2_SCISSOR = 0x00a5
+    USB_PID_STREAMDECK_MK2_V2 = 0x00B9
+    USB_PID_STREAMDECK_NEO = 0x009a
+    USB_PID_STREAMDECK_ORIGINAL = 0x0060
+    USB_PID_STREAMDECK_ORIGINAL_V2 = 0x006d
     USB_PID_STREAMDECK_PEDAL = 0x0086
-    USB_PID_STREAMDECK_MINI_MK2 = 0x0090
     USB_PID_STREAMDECK_PLUS = 0x0084
+    USB_PID_STREAMDECK_XL = 0x006c
+    USB_PID_STREAMDECK_XL_V2 = 0x008f
+    USB_PID_STREAMDECK_XL_V2_MODULE = 0x00ba

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/Transport/LibUSBHIDAPI.py

@@ -213,7 +213,6 @@ class LibUSBHIDAPI(Transport):
             :rtype: Handle
             :return: Device handle if opened successfully, None if open failed.
             """
-
             with self.mutex:
                 if type(path) is not bytes:
                     path = bytes(path, 'utf-8')
@@ -250,10 +249,10 @@ class LibUSBHIDAPI(Transport):
             :rtype: int
             :return: Number of bytes successfully sent to the device.
             """
-            with self.mutex:
-                if not handle:
-                    raise TransportError("No HID device.")
+            if not handle:
+                raise TransportError("No HID device.")
 
+            with self.mutex:
                 result = self.hidapi.hid_send_feature_report(handle, bytes(data), len(data))
 
             if result < 0:
@@ -274,6 +273,8 @@ class LibUSBHIDAPI(Transport):
                      first byte of the report will be the Report ID of the
                      report that was read.
             """
+            if not handle:
+                raise TransportError("No HID device.")
 
             # We may need to oversize our read due a bug in some versions of
             # HIDAPI. Only applied on Mac systems, as this will cause other
@@ -284,9 +285,6 @@ class LibUSBHIDAPI(Transport):
             data[0] = report_id
 
             with self.mutex:
-                if not handle:
-                    raise TransportError("No HID device.")
-
                 result = self.hidapi.hid_get_feature_report(handle, data, len(data))
 
             if result < 0:
@@ -313,10 +311,10 @@ class LibUSBHIDAPI(Transport):
             :rtype: int
             :return: Number of bytes successfully sent to the device.
             """
-            with self.mutex:
-                if not handle:
-                    raise TransportError("No HID device.")
+            if not handle:
+                raise TransportError("No HID device.")
 
+            with self.mutex:
                 result = self.hidapi.hid_write(handle, bytes(data), len(data))
 
             if result < 0:
@@ -336,13 +334,12 @@ class LibUSBHIDAPI(Transport):
                      first byte of the report will be the Report ID of the
                      report that was read.
             """
+            if not handle:
+                raise TransportError("No HID device.")
 
             data = ctypes.create_string_buffer(length)
 
             with self.mutex:
-                if not handle:
-                    raise TransportError("No HID device.")
-
                 result = self.hidapi.hid_read(handle, data, len(data))
 
             if result < 0:

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/StreamDeck/Transport/Transport.py

@@ -31,7 +31,7 @@ class Transport(ABC):
         """
 
         @abstractmethod
-        def open(self):
+        def open(self) -> None:
             """
             Opens the device for input/output. This must be called prior to
             sending or receiving any reports.
@@ -42,7 +42,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def close(self):
+        def close(self) -> None:
             """
             Closes the device for input/output.
 
@@ -52,7 +52,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def is_open(self):
+        def is_open(self) -> bool:
             """
             Indicates if the physical device object this instance is attached
             to has been opened by the host.
@@ -63,7 +63,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def connected(self):
+        def connected(self) -> bool:
             """
             Indicates if the physical device object this instance is attached
             to is still connected to the host.
@@ -74,7 +74,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def path(self):
+        def path(self) -> str:
             """
             Retrieves the logical path of the attached device within the
             current system. This can be used to uniquely differentiate one
@@ -86,7 +86,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def vendor_id(self):
+        def vendor_id(self) -> int:
             """
             Retrieves the vendor ID value of the attached device.
 
@@ -96,7 +96,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def product_id(self):
+        def product_id(self) -> int:
             """
             Retrieves the product ID value of the attached device.
 
@@ -106,7 +106,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def write_feature(self, payload):
+        def write_feature(self, payload: bytes) -> int:
             """
             Sends a HID Feature report to the open HID device.
 
@@ -121,7 +121,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def read_feature(self, report_id, length):
+        def read_feature(self, report_id: int, length: int) -> bytes:
             """
             Reads a HID Feature report from the open HID device.
 
@@ -136,7 +136,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def write(self, payload):
+        def write(self, payload: bytes) -> int:
             """
             Sends a HID Out report to the open HID device.
 
@@ -151,7 +151,7 @@ class Transport(ABC):
             pass
 
         @abstractmethod
-        def read(self, length):
+        def read(self, length: int) -> bytes:
             """
             Performs a blocking read of a HID In report from the open HID device.
 
@@ -166,7 +166,7 @@ class Transport(ABC):
 
     @staticmethod
     @abstractmethod
-    def probe():
+    def probe() -> None:
         """
         Attempts to determine if the back-end is installed and usable. It is
         expected that probe failures throw exceptions detailing their exact
@@ -175,7 +175,7 @@ class Transport(ABC):
         pass
 
     @abstractmethod
-    def enumerate(self, vid, pid):
+    def enumerate(self, vid: int, pid: int) -> list[Device]:
         """
         Enumerates all available devices on the system using the current
         transport back-end.

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_animated.py

@@ -168,5 +168,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_basic.py

@@ -16,6 +16,7 @@ import threading
 from PIL import Image, ImageDraw, ImageFont
 from StreamDeck.DeviceManager import DeviceManager
 from StreamDeck.ImageHelpers import PILHelper
+from StreamDeck.Transport.Transport import TransportError
 
 # Folder location of image assets used by this example.
 ASSETS_PATH = os.path.join(os.path.dirname(__file__), "Assets")
@@ -140,5 +141,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_neo.py

@@ -17,6 +17,7 @@ import random
 from PIL import Image, ImageDraw, ImageFont
 from StreamDeck.DeviceManager import DeviceManager
 from StreamDeck.ImageHelpers import PILHelper
+from StreamDeck.Transport.Transport import TransportError
 
 # Folder location of image assets used by this example.
 ASSETS_PATH = os.path.join(os.path.dirname(__file__), "Assets")
@@ -166,5 +167,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_pedal.py

@@ -14,6 +14,7 @@
 import threading
 
 from StreamDeck.DeviceManager import DeviceManager
+from StreamDeck.Transport.Transport import TransportError
 
 
 def key_change_callback(deck, key, state):
@@ -40,5 +41,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_plus.py

@@ -14,6 +14,7 @@ import io
 from PIL import Image
 from StreamDeck.DeviceManager import DeviceManager
 from StreamDeck.Devices.StreamDeck import DialEventType, TouchscreenEventType
+from StreamDeck.Transport.Transport import TransportError
 
 # Folder location of image assets used by this example.
 ASSETS_PATH = os.path.join(os.path.dirname(__file__), "Assets")
@@ -131,5 +132,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/example_tileimage.py

@@ -17,6 +17,7 @@ import threading
 from PIL import Image, ImageOps
 from StreamDeck.DeviceManager import DeviceManager
 from StreamDeck.ImageHelpers import PILHelper
+from StreamDeck.Transport.Transport import TransportError
 
 # Folder location of image assets used by this example.
 ASSETS_PATH = os.path.join(os.path.dirname(__file__), "Assets")
@@ -144,5 +145,5 @@ if __name__ == "__main__":
         for t in threading.enumerate():
             try:
                 t.join()
-            except RuntimeError:
+            except (TransportError, RuntimeError):
                 pass

{streamdeck-0.9.6 → streamdeck-0.9.7}/src/streamdeck.egg-info/PKG-INFO

@@ -1,14 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: streamdeck
-Version: 0.9.6
+Version: 0.9.7
 Summary: Library to control Elgato StreamDeck devices.
 Home-page: https://github.com/abcminiuser/python-elgato-streamdeck
 Author: Dean Camera
 Author-email: dean@fourwalledcubicle.com
 License: MIT
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
 
 # Python Elgato Stream Deck Library
 
@@ -32,6 +41,7 @@ the images shown on each button, and read the current button states.
 Currently the following StreamDeck products are supported in multiple hardware
 variants:
 
+* StreamDeck 16 Key, 32 Key and Scissor Modules
 * StreamDeck Mini
 * StreamDeck Neo
 * StreamDeck Original
@@ -79,16 +89,20 @@ development and maintenance of this library:
 - [dubstech](https://github.com/dubstech)
 - [Giraut](https://github.com/Giraut)
 - [impala454](https://github.com/impala454)
+- [iPhoneAddict](https://github.com/iPhoneAddict)
 - [itsusony](https://github.com/itsusony)
 - [jakobbuis](https://github.com/jakobbuis)
 - [jmudge14](https://github.com/jmudge14)
+- [jonbloom](https://github.com/jonbloom)
 - [Kalle-Wirsch](https://github.com/Kalle-Wirsch)
 - [karstlok](https://github.com/karstlok)
 - [Lewiscowles1986](https://github.com/Lewiscowles1986)
 - [m-weigand](https://github.com/m-weigand)
+- [mathben](https://github.com/mathben)
 - [matrixinius](https://github.com/matrixinius)
 - [phillco](https://github.com/phillco)
 - [pointshader](https://github.com/pointshader)
+- [pylogger-html](https://github.com/pylogger-html)
 - [shanna](https://github.com/shanna)
 - [spidererrol](https://github.com/Spidererrol)
 - [spyoungtech](https://github.com/spyoungtech)

streamdeck-0.9.6/VERSION

@@ -1 +0,0 @@
-0.9.6