# SPDX-License-Identifier: GPL-2.0-or-later """ Class to manage syncing of effects """ import inspect import logging class EffectSync(object): """ Class which deals with receiving effect events from other devices """ def __init__(self, parent, device_number): self._logger = logging.getLogger('razer.device{0}.effect_sync'.format(device_number)) self._parent = parent self._parent.register_observer(self) def __del__(self): self.close() def close(self): self._parent.remove_observer(self) def notify(self, msg): """ Receive notificatons from the device (we only care about effects) :param msg: Notification :type msg: tuple """ if not isinstance(msg, tuple): self._logger.warning("Got msg that was not a tuple") elif msg[0] == 'effect': # We have a message directed at us # MSG format # 0 1 2 3 # ('effect', Device, 'effectName', 'effectparams'...) # Device is the device the msg originated from (could be parent device) if msg[1] is not self._parent: # Msg from another device self.run_effect(msg[2], *msg[3:]) def run_effect(self, effect_name, *args): """ Run the specified effect with the given arguments :param effect_name: Name of the effect :type effect_name: str :param args: Arguments for the specified effect :type args: list """ # Disable notifications self._parent.disable_notify = True try: # Does parent have method effect_func = getattr(self._parent, effect_name, None) if effect_func is not None: # We have method, does it have the correct num arguments actual_args = self.get_num_arguments(effect_func) if actual_args == len(args): # method should be same effect_func(*args) else: # Method same but wrong args, try alternatives if effect_name == 'setStatic': # Could be static from chroma to non chroma if actual_args == 0: # Chroma -> BW effect_func() else: # BW -> Chroma effect_func(0x0, 0xFF, 0x00) # Green else: # setNone sets active to false and needs to be re-enabled for effects to show - maybe a bit inefficient if not effect_name == 'setNone': effect_func = getattr(self._parent, 'setScrollActive', None) if effect_func is not None: effect_func(True) effect_func = getattr(self._parent, 'setLogoActive', None) if effect_func is not None: effect_func(True) effect_func = getattr(self._parent, 'setLeftActive', None) if effect_func is not None: effect_func(True) effect_func = getattr(self._parent, 'setRightActive', None) if effect_func is not None: effect_func(True) effect_func = getattr(self._parent, 'setBacklightActive', None) if effect_func is not None: effect_func(True) else: effect_func = getattr(self._parent, 'setScrollNone', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setLogoNone', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setLeftNone', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setRightNone', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setBacklightNone', None) if effect_func is not None: effect_func() # The target device doesn't have these methods, use similar ones if effect_name == 'setPulsate': # setPulsate doesn't provide a color but we need one, take green. pargs = (0x00, 0xFF, 0x00) # Green effect_func = getattr(self._parent, 'setBreathSingle', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setScrollBreathSingle', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setLogoBreathSingle', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setLeftBreathSingle', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setRightBreathSingle', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setScrollPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setLogoPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setBacklightPulsate', None) if effect_func is not None: effect_func(*pargs) elif effect_name == 'setSpectrum': effect_func = getattr(self._parent, 'setScrollSpectrum', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setLogoSpectrum', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setLeftSpectrum', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setRightSpectrum', None) if effect_func is not None: effect_func() effect_func = getattr(self._parent, 'setBacklightSpectrum', None) if effect_func is not None: effect_func() elif effect_name == 'setStatic': effect_func = getattr(self._parent, 'setScrollStatic', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoStatic', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftStatic', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightStatic', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightStatic', None) if effect_func is not None: effect_func(*args) elif effect_name == 'setWave': effect_func = getattr(self._parent, 'setScrollWave', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoWave', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftWave', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightWave', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightWave', None) if effect_func is not None: effect_func(*args) elif effect_name == 'setReactive': effect_func = getattr(self._parent, 'setScrollReactive', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoReactive', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftReactive', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightReactive', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightReactive', None) if effect_func is not None: effect_func(*args) elif effect_name in ('setBreathRandom', 'setBreathSingle', 'setBreathDual', 'setBreathTriple'): if effect_name in ('setBreathRandom', 'setBreathSingle'): pargs = (0x00, 0xFF, 0x00) # Green else: pargs = args[0:3] # limit args to first 3, as setBreathDual gives 6 args and setBreathTriple gives 9 args if effect_name == 'setBreathRandom': effect_func = getattr(self._parent, 'setPulsate', None) if effect_func is not None: # setPulsate doesn't take any argument effect_func() effect_func = getattr(self._parent, 'setScrollPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setLogoPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setBacklightPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setScrollBreathRandom', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoBreathRandom', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftBreathRandom', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightBreathRandom', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightBreathRandom', None) if effect_func is not None: effect_func(*args) if effect_name == 'setBreathSingle': if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setScrollPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setLogoPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setBacklightPulsate', None) if effect_func is not None: effect_func(*pargs) effect_func = getattr(self._parent, 'setScrollBreathSingle', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoBreathSingle', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftBreathSingle', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightBreathSingle', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightBreathSingle', None) if effect_func is not None: effect_func(*args) if effect_name == 'setBreathDual': effect_func = getattr(self._parent, 'setScrollBreathDual', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoBreathDual', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftBreathDual', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightBreathDual', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightBreathDual', None) if effect_func is not None: effect_func(*args) elif effect_name == 'setBrightness': effect_func = getattr(self._parent, 'setScrollBrightness', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLogoBrightness', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setLeftBrightness', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setRightBrightness', None) if effect_func is not None: effect_func(*args) effect_func = getattr(self._parent, 'setBacklightBrightness', None) if effect_func is not None: effect_func(*args) except Exception as err: self._logger.exception("Caught exception trying to sync effects.", exc_info=err) # Re-enable notifications self._parent.disable_notify = False @staticmethod def get_num_arguments(func): """ Get number of arguments in a function :param func: Function :type func: callable :return: Number of arguments :rtype: int """ func_sig = inspect.signature(func) return len(func_sig.parameters)