| 1 |
# SPDX-License-Identifier: GPL-2.0-or-later |
| 2 |
|
| 3 |
""" |
| 4 |
Class to manage syncing of effects |
| 5 |
""" |
| 6 |
import inspect |
| 7 |
import logging |
| 8 |
|
| 9 |
|
| 10 |
class EffectSync(object): |
| 11 |
""" |
| 12 |
Class which deals with receiving effect events from other devices |
| 13 |
""" |
| 14 |
|
| 15 |
def __init__(self, parent, device_number): |
| 16 |
self._logger = logging.getLogger('razer.device{0}.effect_sync'.format(device_number)) |
| 17 |
self._parent = parent |
| 18 |
self._parent.register_observer(self) |
| 19 |
|
| 20 |
def __del__(self): |
| 21 |
self.close() |
| 22 |
|
| 23 |
def close(self): |
| 24 |
self._parent.remove_observer(self) |
| 25 |
|
| 26 |
def notify(self, msg): |
| 27 |
""" |
| 28 |
Receive notificatons from the device (we only care about effects) |
| 29 |
|
| 30 |
:param msg: Notification |
| 31 |
:type msg: tuple |
| 32 |
""" |
| 33 |
if not isinstance(msg, tuple): |
| 34 |
self._logger.warning("Got msg that was not a tuple") |
| 35 |
elif msg[0] == 'effect': |
| 36 |
# We have a message directed at us |
| 37 |
# MSG format |
| 38 |
# 0 1 2 3 |
| 39 |
# ('effect', Device, 'effectName', 'effectparams'...) |
| 40 |
# Device is the device the msg originated from (could be parent device) |
| 41 |
if msg[1] is not self._parent: |
| 42 |
# Msg from another device |
| 43 |
self.run_effect(msg[2], *msg[3:]) |
| 44 |
|
| 45 |
def run_effect(self, effect_name, *args): |
| 46 |
""" |
| 47 |
Run the specified effect with the given arguments |
| 48 |
|
| 49 |
:param effect_name: Name of the effect |
| 50 |
:type effect_name: str |
| 51 |
|
| 52 |
:param args: Arguments for the specified effect |
| 53 |
:type args: list |
| 54 |
""" |
| 55 |
# Disable notifications |
| 56 |
self._parent.disable_notify = True |
| 57 |
|
| 58 |
try: |
| 59 |
# Does parent have method |
| 60 |
effect_func = getattr(self._parent, effect_name, None) |
| 61 |
if effect_func is not None: |
| 62 |
# We have method, does it have the correct num arguments |
| 63 |
actual_args = self.get_num_arguments(effect_func) |
| 64 |
if actual_args == len(args): |
| 65 |
# method should be same |
| 66 |
effect_func(*args) |
| 67 |
else: |
| 68 |
# Method same but wrong args, try alternatives |
| 69 |
if effect_name == 'setStatic': |
| 70 |
# Could be static from chroma to non chroma |
| 71 |
if actual_args == 0: |
| 72 |
# Chroma -> BW |
| 73 |
effect_func() |
| 74 |
else: |
| 75 |
# BW -> Chroma |
| 76 |
effect_func(0x0, 0xFF, 0x00) # Green |
| 77 |
|
| 78 |
else: |
| 79 |
# setNone sets active to false and needs to be re-enabled for effects to show - maybe a bit inefficient |
| 80 |
if not effect_name == 'setNone': |
| 81 |
effect_func = getattr(self._parent, 'setScrollActive', None) |
| 82 |
if effect_func is not None: |
| 83 |
effect_func(True) |
| 84 |
effect_func = getattr(self._parent, 'setLogoActive', None) |
| 85 |
if effect_func is not None: |
| 86 |
effect_func(True) |
| 87 |
effect_func = getattr(self._parent, 'setLeftActive', None) |
| 88 |
if effect_func is not None: |
| 89 |
effect_func(True) |
| 90 |
effect_func = getattr(self._parent, 'setRightActive', None) |
| 91 |
if effect_func is not None: |
| 92 |
effect_func(True) |
| 93 |
effect_func = getattr(self._parent, 'setBacklightActive', None) |
| 94 |
if effect_func is not None: |
| 95 |
effect_func(True) |
| 96 |
else: |
| 97 |
effect_func = getattr(self._parent, 'setScrollNone', None) |
| 98 |
if effect_func is not None: |
| 99 |
effect_func() |
| 100 |
effect_func = getattr(self._parent, 'setLogoNone', None) |
| 101 |
if effect_func is not None: |
| 102 |
effect_func() |
| 103 |
effect_func = getattr(self._parent, 'setLeftNone', None) |
| 104 |
if effect_func is not None: |
| 105 |
effect_func() |
| 106 |
effect_func = getattr(self._parent, 'setRightNone', None) |
| 107 |
if effect_func is not None: |
| 108 |
effect_func() |
| 109 |
effect_func = getattr(self._parent, 'setBacklightNone', None) |
| 110 |
if effect_func is not None: |
| 111 |
effect_func() |
| 112 |
|
| 113 |
# The target device doesn't have these methods, use similar ones |
| 114 |
|
| 115 |
if effect_name == 'setPulsate': |
| 116 |
# setPulsate doesn't provide a color but we need one, take green. |
| 117 |
pargs = (0x00, 0xFF, 0x00) # Green |
| 118 |
effect_func = getattr(self._parent, 'setBreathSingle', None) |
| 119 |
if effect_func is not None: |
| 120 |
effect_func(*pargs) |
| 121 |
effect_func = getattr(self._parent, 'setScrollBreathSingle', None) |
| 122 |
if effect_func is not None: |
| 123 |
effect_func(*pargs) |
| 124 |
effect_func = getattr(self._parent, 'setLogoBreathSingle', None) |
| 125 |
if effect_func is not None: |
| 126 |
effect_func(*pargs) |
| 127 |
effect_func = getattr(self._parent, 'setLeftBreathSingle', None) |
| 128 |
if effect_func is not None: |
| 129 |
effect_func(*pargs) |
| 130 |
effect_func = getattr(self._parent, 'setRightBreathSingle', None) |
| 131 |
if effect_func is not None: |
| 132 |
effect_func(*pargs) |
| 133 |
effect_func = getattr(self._parent, 'setScrollPulsate', None) |
| 134 |
if effect_func is not None: |
| 135 |
effect_func(*pargs) |
| 136 |
effect_func = getattr(self._parent, 'setLogoPulsate', None) |
| 137 |
if effect_func is not None: |
| 138 |
effect_func(*pargs) |
| 139 |
effect_func = getattr(self._parent, 'setBacklightPulsate', None) |
| 140 |
if effect_func is not None: |
| 141 |
effect_func(*pargs) |
| 142 |
|
| 143 |
elif effect_name == 'setSpectrum': |
| 144 |
effect_func = getattr(self._parent, 'setScrollSpectrum', None) |
| 145 |
if effect_func is not None: |
| 146 |
effect_func() |
| 147 |
effect_func = getattr(self._parent, 'setLogoSpectrum', None) |
| 148 |
if effect_func is not None: |
| 149 |
effect_func() |
| 150 |
effect_func = getattr(self._parent, 'setLeftSpectrum', None) |
| 151 |
if effect_func is not None: |
| 152 |
effect_func() |
| 153 |
effect_func = getattr(self._parent, 'setRightSpectrum', None) |
| 154 |
if effect_func is not None: |
| 155 |
effect_func() |
| 156 |
effect_func = getattr(self._parent, 'setBacklightSpectrum', None) |
| 157 |
if effect_func is not None: |
| 158 |
effect_func() |
| 159 |
|
| 160 |
elif effect_name == 'setStatic': |
| 161 |
effect_func = getattr(self._parent, 'setScrollStatic', None) |
| 162 |
if effect_func is not None: |
| 163 |
effect_func(*args) |
| 164 |
effect_func = getattr(self._parent, 'setLogoStatic', None) |
| 165 |
if effect_func is not None: |
| 166 |
effect_func(*args) |
| 167 |
effect_func = getattr(self._parent, 'setLeftStatic', None) |
| 168 |
if effect_func is not None: |
| 169 |
effect_func(*args) |
| 170 |
effect_func = getattr(self._parent, 'setRightStatic', None) |
| 171 |
if effect_func is not None: |
| 172 |
effect_func(*args) |
| 173 |
effect_func = getattr(self._parent, 'setBacklightStatic', None) |
| 174 |
if effect_func is not None: |
| 175 |
effect_func(*args) |
| 176 |
|
| 177 |
elif effect_name == 'setWave': |
| 178 |
effect_func = getattr(self._parent, 'setScrollWave', None) |
| 179 |
if effect_func is not None: |
| 180 |
effect_func(*args) |
| 181 |
effect_func = getattr(self._parent, 'setLogoWave', None) |
| 182 |
if effect_func is not None: |
| 183 |
effect_func(*args) |
| 184 |
effect_func = getattr(self._parent, 'setLeftWave', None) |
| 185 |
if effect_func is not None: |
| 186 |
effect_func(*args) |
| 187 |
effect_func = getattr(self._parent, 'setRightWave', None) |
| 188 |
if effect_func is not None: |
| 189 |
effect_func(*args) |
| 190 |
effect_func = getattr(self._parent, 'setBacklightWave', None) |
| 191 |
if effect_func is not None: |
| 192 |
effect_func(*args) |
| 193 |
|
| 194 |
elif effect_name == 'setReactive': |
| 195 |
effect_func = getattr(self._parent, 'setScrollReactive', None) |
| 196 |
if effect_func is not None: |
| 197 |
effect_func(*args) |
| 198 |
effect_func = getattr(self._parent, 'setLogoReactive', None) |
| 199 |
if effect_func is not None: |
| 200 |
effect_func(*args) |
| 201 |
effect_func = getattr(self._parent, 'setLeftReactive', None) |
| 202 |
if effect_func is not None: |
| 203 |
effect_func(*args) |
| 204 |
effect_func = getattr(self._parent, 'setRightReactive', None) |
| 205 |
if effect_func is not None: |
| 206 |
effect_func(*args) |
| 207 |
effect_func = getattr(self._parent, 'setBacklightReactive', None) |
| 208 |
if effect_func is not None: |
| 209 |
effect_func(*args) |
| 210 |
|
| 211 |
elif effect_name in ('setBreathRandom', 'setBreathSingle', 'setBreathDual', 'setBreathTriple'): |
| 212 |
if effect_name in ('setBreathRandom', 'setBreathSingle'): |
| 213 |
pargs = (0x00, 0xFF, 0x00) # Green |
| 214 |
else: |
| 215 |
pargs = args[0:3] # limit args to first 3, as setBreathDual gives 6 args and setBreathTriple gives 9 args |
| 216 |
|
| 217 |
if effect_name == 'setBreathRandom': |
| 218 |
effect_func = getattr(self._parent, 'setPulsate', None) |
| 219 |
if effect_func is not None: |
| 220 |
# setPulsate doesn't take any argument |
| 221 |
effect_func() |
| 222 |
effect_func = getattr(self._parent, 'setScrollPulsate', None) |
| 223 |
if effect_func is not None: |
| 224 |
effect_func(*pargs) |
| 225 |
effect_func = getattr(self._parent, 'setLogoPulsate', None) |
| 226 |
if effect_func is not None: |
| 227 |
effect_func(*pargs) |
| 228 |
effect_func = getattr(self._parent, 'setBacklightPulsate', None) |
| 229 |
if effect_func is not None: |
| 230 |
effect_func(*pargs) |
| 231 |
|
| 232 |
effect_func = getattr(self._parent, 'setScrollBreathRandom', None) |
| 233 |
if effect_func is not None: |
| 234 |
effect_func(*args) |
| 235 |
effect_func = getattr(self._parent, 'setLogoBreathRandom', None) |
| 236 |
if effect_func is not None: |
| 237 |
effect_func(*args) |
| 238 |
effect_func = getattr(self._parent, 'setLeftBreathRandom', None) |
| 239 |
if effect_func is not None: |
| 240 |
effect_func(*args) |
| 241 |
effect_func = getattr(self._parent, 'setRightBreathRandom', None) |
| 242 |
if effect_func is not None: |
| 243 |
effect_func(*args) |
| 244 |
effect_func = getattr(self._parent, 'setBacklightBreathRandom', None) |
| 245 |
if effect_func is not None: |
| 246 |
effect_func(*args) |
| 247 |
|
| 248 |
if effect_name == 'setBreathSingle': |
| 249 |
if effect_func is not None: |
| 250 |
effect_func(*pargs) |
| 251 |
effect_func = getattr(self._parent, 'setScrollPulsate', None) |
| 252 |
if effect_func is not None: |
| 253 |
effect_func(*pargs) |
| 254 |
effect_func = getattr(self._parent, 'setLogoPulsate', None) |
| 255 |
if effect_func is not None: |
| 256 |
effect_func(*pargs) |
| 257 |
effect_func = getattr(self._parent, 'setBacklightPulsate', None) |
| 258 |
if effect_func is not None: |
| 259 |
effect_func(*pargs) |
| 260 |
|
| 261 |
effect_func = getattr(self._parent, 'setScrollBreathSingle', None) |
| 262 |
if effect_func is not None: |
| 263 |
effect_func(*args) |
| 264 |
effect_func = getattr(self._parent, 'setLogoBreathSingle', None) |
| 265 |
if effect_func is not None: |
| 266 |
effect_func(*args) |
| 267 |
effect_func = getattr(self._parent, 'setLeftBreathSingle', None) |
| 268 |
if effect_func is not None: |
| 269 |
effect_func(*args) |
| 270 |
effect_func = getattr(self._parent, 'setRightBreathSingle', None) |
| 271 |
if effect_func is not None: |
| 272 |
effect_func(*args) |
| 273 |
effect_func = getattr(self._parent, 'setBacklightBreathSingle', None) |
| 274 |
if effect_func is not None: |
| 275 |
effect_func(*args) |
| 276 |
|
| 277 |
if effect_name == 'setBreathDual': |
| 278 |
effect_func = getattr(self._parent, 'setScrollBreathDual', None) |
| 279 |
if effect_func is not None: |
| 280 |
effect_func(*args) |
| 281 |
effect_func = getattr(self._parent, 'setLogoBreathDual', None) |
| 282 |
if effect_func is not None: |
| 283 |
effect_func(*args) |
| 284 |
effect_func = getattr(self._parent, 'setLeftBreathDual', None) |
| 285 |
if effect_func is not None: |
| 286 |
effect_func(*args) |
| 287 |
effect_func = getattr(self._parent, 'setRightBreathDual', None) |
| 288 |
if effect_func is not None: |
| 289 |
effect_func(*args) |
| 290 |
effect_func = getattr(self._parent, 'setBacklightBreathDual', None) |
| 291 |
if effect_func is not None: |
| 292 |
effect_func(*args) |
| 293 |
|
| 294 |
elif effect_name == 'setBrightness': |
| 295 |
effect_func = getattr(self._parent, 'setScrollBrightness', None) |
| 296 |
if effect_func is not None: |
| 297 |
effect_func(*args) |
| 298 |
effect_func = getattr(self._parent, 'setLogoBrightness', None) |
| 299 |
if effect_func is not None: |
| 300 |
effect_func(*args) |
| 301 |
effect_func = getattr(self._parent, 'setLeftBrightness', None) |
| 302 |
if effect_func is not None: |
| 303 |
effect_func(*args) |
| 304 |
effect_func = getattr(self._parent, 'setRightBrightness', None) |
| 305 |
if effect_func is not None: |
| 306 |
effect_func(*args) |
| 307 |
effect_func = getattr(self._parent, 'setBacklightBrightness', None) |
| 308 |
if effect_func is not None: |
| 309 |
effect_func(*args) |
| 310 |
|
| 311 |
except Exception as err: |
| 312 |
self._logger.exception("Caught exception trying to sync effects.", exc_info=err) |
| 313 |
|
| 314 |
# Re-enable notifications |
| 315 |
self._parent.disable_notify = False |
| 316 |
|
| 317 |
@staticmethod |
| 318 |
def get_num_arguments(func): |
| 319 |
""" |
| 320 |
Get number of arguments in a function |
| 321 |
|
| 322 |
:param func: Function |
| 323 |
:type func: callable |
| 324 |
|
| 325 |
:return: Number of arguments |
| 326 |
:rtype: int |
| 327 |
""" |
| 328 |
func_sig = inspect.signature(func) |
| 329 |
return len(func_sig.parameters) |