1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
import threading
from typing import Callable, Optional
from StreamDeck.Transport.Transport import TransportError
class Dimmer:
def __init__(self, timeout: int, brightness: int, brightness_dimmed: int, brightness_callback: Callable[[int], None]):
"""Constructs a new Dimmer instance
:param int timeout: The time in seconds before the dimmer starts.
:param int brightness: The normal brightness level.
:param int brightness_dimmed: The percentage of normal brightness when dimmed.
:param Callable[[int], None] brightness_callback: Callback that receives the current
brightness level.
"""
self.timeout = timeout
self.brightness = brightness
"The brightness when not dimmed"
self.brightness_dimmed = brightness_dimmed
"The percentage of normal brightness when dimmed"
self.brightness_callback = brightness_callback
self.__stopped = False
self.dimmed = True
"True if the Stream Deck is dimmed, False otherwise"
self.__timer: Optional[threading.Timer] = None
def dimmed_brightness(self) -> int:
"""Calculates the effective brightness when dimmed.
:return: The brightness value when applying the dim percentage to the normal brightness.
:rtype: int
"""
return int(self.brightness * (self.brightness_dimmed / 100))
def stop(self) -> None:
"""Stops the dimmer and sets the brightness back to normal. Call
reset to start normal dimming operation."""
if self.__timer:
self.__timer.cancel()
self.__timer = None
try:
self.brightness_callback(self.brightness)
except KeyError:
# During detach cleanup, this is likely to happen
pass
except TransportError:
pass
self.__stopped = True
def reset(self) -> bool:
"""Reset the dimmer and start counting down again. If it was busy dimming, it will
immediately stop dimming. Callback fires to set brightness back to normal."""
self.__stopped = False
if self.__timer:
self.__timer.cancel()
self.__timer = None
if self.timeout:
self.__timer = threading.Timer(self.timeout, self.dim)
self.__timer.start()
if self.dimmed:
self.brightness_callback(self.brightness)
self.dimmed = False
if self.dimmed_brightness() < 20:
# The screen was "too dark" so reset and let caller know
return True
return False
# Returning false means "I didn't have to reset it"
def dim(self, toggle: bool = False):
"""Manually initiate a dim event.
If the dimmer is stopped, this has no effect."""
if self.__stopped:
return
if toggle and self.dimmed:
# Don't dim
self.reset()
elif self.__timer:
# No need for the timer anymore, stop it
self.__timer.cancel()
self.__timer = None
self.brightness_callback(self.dimmed_brightness())
self.dimmed = True
|
