This commit introduces a complete integration for Mirabox StreamDock devices with Home Assistant, allowing users to control entities and monitor states directly from the hardware. Key features included: - Support for multiple Mirabox models: N1, N3, N4, N4Pro, XL, M3, M18, K1Pro, and various 293 variants. - Home Assistant WebSocket integration for real-time entity updates and service execution. - Dynamic LCD key rendering with support for custom icons, labels, and entity-state aware colors. - Input handling for physical buttons and rotary encoders (knobs). - Multi-page navigation support with configurable cycle keys and knobs. - Cross-platform transport layer using a custom HID library. - Configuration system using YAML with page-based layouts. - Linux udev rules for non-root USB access.
180 lines
5.4 KiB
Python
180 lines
5.4 KiB
Python
from StreamDock.FeatrueOption import device_type
|
|
from .StreamDock import StreamDock
|
|
from ..InputTypes import InputEvent, ButtonKey, EventType
|
|
from PIL import Image
|
|
import ctypes
|
|
import ctypes.util
|
|
import os, io
|
|
from ..ImageHelpers.PILHelper import *
|
|
import random
|
|
|
|
|
|
class StreamDockM18(StreamDock):
|
|
"""StreamDockM18 device class - supports 15 keys"""
|
|
|
|
KEY_COUNT = 15
|
|
KEY_MAP = False
|
|
|
|
# Image key mapping: logical key -> hardware key (for setting images)
|
|
_IMAGE_KEY_MAP = {
|
|
ButtonKey.KEY_1: 11,
|
|
ButtonKey.KEY_2: 12,
|
|
ButtonKey.KEY_3: 13,
|
|
ButtonKey.KEY_4: 14,
|
|
ButtonKey.KEY_5: 15,
|
|
ButtonKey.KEY_6: 6,
|
|
ButtonKey.KEY_7: 7,
|
|
ButtonKey.KEY_8: 8,
|
|
ButtonKey.KEY_9: 9,
|
|
ButtonKey.KEY_10: 10,
|
|
ButtonKey.KEY_11: 1,
|
|
ButtonKey.KEY_12: 2,
|
|
ButtonKey.KEY_13: 3,
|
|
ButtonKey.KEY_14: 4,
|
|
ButtonKey.KEY_15: 5,
|
|
ButtonKey.KEY_16: 0x25,
|
|
ButtonKey.KEY_17: 0x30,
|
|
ButtonKey.KEY_18: 0x31,
|
|
}
|
|
|
|
# Reverse mapping: hardware key -> logical key (for event decoding)
|
|
_HW_TO_LOGICAL_KEY = {v: k for k, v in _IMAGE_KEY_MAP.items()}
|
|
|
|
def __init__(self, transport1, devInfo):
|
|
super().__init__(transport1, devInfo)
|
|
|
|
def get_image_key(self, logical_key: ButtonKey) -> int:
|
|
"""
|
|
Convert logical key value to hardware key value (for setting images)
|
|
|
|
Args:
|
|
logical_key: Logical key enum
|
|
|
|
Returns:
|
|
int: Hardware key value
|
|
"""
|
|
if logical_key in self._IMAGE_KEY_MAP:
|
|
return self._IMAGE_KEY_MAP[logical_key]
|
|
raise ValueError(f"StreamDockM18: Unsupported key {logical_key}")
|
|
|
|
def decode_input_event(self, hardware_code: int, state: int) -> InputEvent:
|
|
"""
|
|
Decode hardware event codes into a unified InputEvent
|
|
|
|
M18 supports only regular buttons; hardware code range 1-15
|
|
"""
|
|
# Handle state value: 0x02=release, 0x01=press
|
|
normalized_state = 1 if state == 0x01 else 0
|
|
|
|
# Regular button events (1-15)
|
|
if hardware_code in self._HW_TO_LOGICAL_KEY:
|
|
return InputEvent(
|
|
event_type=EventType.BUTTON,
|
|
key=self._HW_TO_LOGICAL_KEY[hardware_code],
|
|
state=normalized_state
|
|
)
|
|
|
|
# Unknown event
|
|
return InputEvent(event_type=EventType.UNKNOWN)
|
|
|
|
# Set device screen brightness
|
|
def set_brightness(self, percent):
|
|
return self.transport.setBrightness(percent)
|
|
|
|
# Set device background image 480 * 272
|
|
def set_touchscreen_image(self, path):
|
|
try:
|
|
if not os.path.exists(path):
|
|
print(f"Error: The image file '{path}' does not exist.")
|
|
return -1
|
|
|
|
# open formatter
|
|
image = Image.open(path)
|
|
image = to_native_touchscreen_format(self, image)
|
|
temp_image_path = (
|
|
"rotated_touchscreen_image_"
|
|
+ str(random.randint(9999, 999999))
|
|
+ ".jpg"
|
|
)
|
|
image.save(temp_image_path)
|
|
|
|
# encode send
|
|
path_bytes = temp_image_path.encode("utf-8")
|
|
c_path = ctypes.c_char_p(path_bytes)
|
|
res = self.transport.setBackgroundImgDualDevice(c_path)
|
|
os.remove(temp_image_path)
|
|
return res
|
|
|
|
except Exception as e:
|
|
print(f"Error: {e}")
|
|
return -1
|
|
|
|
# Set device key icon image 64 * 64
|
|
def set_key_image(self, key, path):
|
|
try:
|
|
if isinstance(key, int):
|
|
if key not in range(1, 16):
|
|
print(f"key '{key}' out of range. you should set (1 ~ 15)")
|
|
return -1
|
|
logical_key = ButtonKey(key)
|
|
else:
|
|
logical_key = key
|
|
|
|
if not os.path.exists(path):
|
|
print(f"Error: The image file '{path}' does not exist.")
|
|
return -1
|
|
|
|
# Get hardware key value
|
|
hardware_key = self.get_image_key(logical_key)
|
|
|
|
# open formatter
|
|
image = Image.open(path)
|
|
image = to_native_key_format(self, image)
|
|
temp_image_path = (
|
|
"rotated_key_image_" + str(random.randint(9999, 999999)) + ".jpg"
|
|
)
|
|
image.save(temp_image_path)
|
|
|
|
# encode send
|
|
path_bytes = temp_image_path.encode("utf-8")
|
|
c_path = ctypes.c_char_p(path_bytes)
|
|
res = self.transport.setKeyImgDualDevice(c_path, hardware_key)
|
|
os.remove(temp_image_path)
|
|
return res
|
|
|
|
except Exception as e:
|
|
print(f"Error: {e}")
|
|
return -1
|
|
|
|
# TODO
|
|
def set_key_imageData(self, key, path):
|
|
pass
|
|
|
|
# Get device firmware version
|
|
def get_serial_number(self):
|
|
return self.serial_number
|
|
|
|
def key_image_format(self):
|
|
return {
|
|
"size": (64, 64),
|
|
"format": "JPEG",
|
|
"rotation": 0,
|
|
"flip": (False, False),
|
|
}
|
|
|
|
def touchscreen_image_format(self):
|
|
return {
|
|
"size": (480, 272),
|
|
"format": "JPEG",
|
|
"rotation": 0,
|
|
"flip": (False, False),
|
|
}
|
|
|
|
# Set device parameters
|
|
def set_device(self):
|
|
self.transport.set_report_size(513, 1025, 0)
|
|
self.feature_option.hasRGBLed = True
|
|
self.feature_option.ledCounts = 24
|
|
self.feature_option.deviceType = device_type.dock_m18
|
|
pass
|