linting and extra comments

Author: BillyTPilgrim

examples/tiny_fx/examples/director/effectpackage.py

@@ -2,19 +2,22 @@
 from picofx.mono import StaticFX, BlinkFX, FlashFX, FlickerFX, PulseFX, RandomFX, NoneFX
 from picofx.colour import StaticRGBFX, BlinkRGBFX, FlashRGBFX, FlickerRGBFX, PulseRGBFX, RandomRGBFX
 
+
 class EffectPackage:
     # The EffectPackage class mainly keeps all the methods all together which adjust the effect.
     # It holds a list of EffectSettings objects, one for each channel, and this should
     # initialise to have one member for each output on the device.
-    def __init__(self, board, colour, num_outputs):
+
+    def __init__(self, colour, num_outputs):
         # First we load in everything from the settings file.
         self.colour = colour
         loaded_settings = self.load_settings()
+
         # Then we create a new entry for each output on the board,
         # using the imported settings if they're there and making a
         # fresh new EffectSettings with default values if not.
         self.channel_settings = []
-        
+
         for i in range(num_outputs):
             if len(loaded_settings) > 0:
                 new_effect = loaded_settings.pop(0)
@@ -24,6 +27,7 @@ def __init__(self, board, colour, num_outputs):
 
     def load_settings(self):
         new_settings = []
+
         # To load the settings we first open the file...
         with open("settings.txt", "r") as settingsfile:
             # ...then loop through reading each line in turn.
@@ -38,7 +42,7 @@ def load_settings(self):
                 # If the line begins with "Mono" or "RGB" as specified in the colour
                 # parameter, then we start a new internal loop to
                 # populate values into a new instance of EffectSettings.
-                
+
                 if line.split(" ")[0] == self.colour:
                     type = EffectSettings.default_values["type"]
                     brightness = EffectSettings.default_values["brightness"]
@@ -278,12 +282,14 @@ def cycle_fx(self, channel, player):
         # To change effect within a provided channel, we just
         # pull the right EffectSettings from the list, get its current type
         # and add one, looping around to zero if necessary.
-        # Then write that new effect type to the EffectSettings.
+        # The while loop will skip over any that aren't marked as
+        # valid effects for the channel type.
+        # Then we write that new effect type to the EffectSettings.
         if self.colour == "Mono":
             valid_effects = (0, 1, 2, 3, 4, 5, 6)
         elif self.colour == "RGB":
             valid_effects = (0, 7, 8, 9, 10, 11, 12)
-        
+
         effect = self.channel_settings[channel - 1]
         old_effect_type = effect.type
         new_effect_type = (old_effect_type + 1) % 13
@@ -485,17 +491,24 @@ def alter_chaos(self, channel, amount):
         effect.bright_max_time = new_bmax
         effect.dim_min_time = new_dmin
         effect.dim_max_time = new_dmax
-        
+
     def alter_hue(self, channel, amount):
+        # Changing hue is basically a little state machine. To go round the colour
+        # wheel starting with red for example, we need to keep red at 100%
+        # and slowly increase green. When it hits 100% we've got yellow, and then green
+        # stays at 100% as red decreases. Once red is at zero we've got just green, then
+        # we start increasing blue and so on and so on.
+
         effect = self.channel_settings[channel - 1]
 
         if effect.type in (0, 1, 2, 3, 4, 5, 6):
             return
-        
+
         red = effect.red
         green = effect.green
         blue = effect.blue
-        
+
+        # These checks are what determine which colour value we should be increasing or decreasing.
         if red == 255 and not green == 255 and blue == 0:
             green += amount
         elif not red == 0 and green == 255 and blue == 0:
@@ -508,19 +521,23 @@ def alter_hue(self, channel, amount):
             red += amount
         elif red == 255 and green == 0 and not blue == 0:
             blue -= amount
-            
+
         effect.red = self.clamp(red, 0, 255)
         effect.green = self.clamp(green, 0, 255)
         effect.blue = self.clamp(blue, 0, 255)
-        
+
         print(effect.red, effect.green, effect.blue)
-        
+
     def alter_hue2(self, channel, amount):
+        # This is just for the dimmer hue on the FlickerRGB effect.
+        # It works just the same as the hue above. If there's no second colour set,
+        # it defaults to starting at the hue of the main colour.
+
         effect = self.channel_settings[channel - 1]
 
         if effect.type in (0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12):
             return
-        
+
         if None in (effect.red2, effect.green2, effect.blue2):
             red = effect.red
             green = effect.green
@@ -529,7 +546,7 @@ def alter_hue2(self, channel, amount):
             red = effect.red2
             green = effect.green2
             blue = effect.blue2
-        
+
         if red == 255 and not green == 255 and blue == 0:
             green += amount
         elif not red == 0 and green == 255 and blue == 0:
@@ -542,9 +559,9 @@ def alter_hue2(self, channel, amount):
             red += amount
         elif red == 255 and green == 0 and not blue == 0:
             blue -= amount
-            
+
         effect.red2 = self.clamp(red, 0, 255)
         effect.green2 = self.clamp(green, 0, 255)
         effect.blue2 = self.clamp(blue, 0, 255)
-        
-        print(effect.red2, effect.green2, effect.blue2)
+
+        print(effect.red2, effect.green2, effect.blue2)

examples/tiny_fx/examples/director/main.py

@@ -11,11 +11,11 @@
 """
 
 # Variables
-tiny = TinyFX()                               # Create a new TinyFX object to interact with the board
-monoplayer = MonoPlayer(tiny.outputs)         # Create a new effect player to control TinyFX's mono outputs
-rgbplayer = ColourPlayer(tiny.rgb)            # Create a new effect player to control TinyFX's RGB output
-mono_effects = EffectPackage(tiny, "Mono", 6) # Create a new EffectPackage to take care of all the different effect settings for each mono channel.
-rgb_effects = EffectPackage(tiny, "RGB", 1)   # Create a new EffectPackage to take care of all the different effect settings for the RGB channel.
+tiny = TinyFX()                          # Create a new TinyFX object to interact with the board
+monoplayer = MonoPlayer(tiny.outputs)    # Create a new effect player to control TinyFX's mono outputs
+rgbplayer = ColourPlayer(tiny.rgb)       # Create a new effect player to control TinyFX's RGB output
+mono_effects = EffectPackage("Mono", 6)  # Create a new EffectPackage to take care of all the different effect settings for each mono channel.
+rgb_effects = EffectPackage("RGB", 1)    # Create a new EffectPackage to take care of all the different effect settings for the RGB channel.
 mono_channel = 1
 run_mode = 0
 
@@ -26,17 +26,19 @@ class Mode:
     RGB = 2
 
 
-def select_channel(dir, repeat):
-    # Selecting a channel just involves incrementing or decrementing the selected_channel variable,
-    # looping it round if it goes above the total number of channels or below zero.
-
+def rotate(dir, repeat):
+    # If the TinyFX is just running this button doesn't do anything.
     if run_mode == Mode.Running:
         return
-    
+
+    # However, if we're in RGB editing mode then we're altering the hue.
     if run_mode == Mode.RGB:
         rgb_effects.alter_hue(0, dir * 5)
         rgb_effects.update_effects_list(rgbplayer)
-        
+
+    # And if we're in mono editing mode this selects the channel.
+    # Selecting a channel just involves incrementing or decrementing the selected_channel variable,
+    # looping it round if it goes above the total number of channels or below zero.
     elif run_mode == Mode.Mono and not repeat:
         global mono_channel
 
@@ -46,7 +48,7 @@ def select_channel(dir, repeat):
         if mono_channel < 1:
             mono_channel = len(mono_effects.channel_settings)
 
-        # Otherwise we just loop through each channel and undim it if it's the selected
+        # Then we just loop through each channel and undim it if it's the selected
         # channel or dim it if it's not.
         for i in range(len(mono_effects.channel_settings)):
             effect = mono_effects.channel_settings[i]
@@ -55,7 +57,7 @@ def select_channel(dir, repeat):
             else:
                 effect.dim()
 
-        # This is important when any changes are made. It takes the settings data from the
+        # Calling this is important when any changes are made. It takes the settings data from the
         # channel settings and actually applies them to the player class.
         mono_effects.update_effects_list(monoplayer)
 
@@ -64,11 +66,11 @@ def toggle_mono(channel=0):
     # This controls the quick mute for each channel. It goes straight into the
     # player and sets the brightness to zero, or to whatever's in the
     # settings for that channel if it's already at zero.
-    
+
     if channel > 0:
         effect = monoplayer.effects[channel - 1]
         old_brightness = mono_effects.channel_settings[channel - 1].brightness
-        
+
     else:
         effect = rgbplayer.effects[0]
         old_brightness = rgb_effects.channel_settings[channel - 1].brightness
@@ -82,22 +84,31 @@ def toggle_mono(channel=0):
         brightness = old_brightness
         effect.brightness = brightness
 
+
 def saving_handler():
     # Saving is simpler than loading, first we put in a bit of text directing the user to the instructions:
     text = "# SETTINGS FILE\n#\n# For instructions, check readme.txt\n#\n"
 
+    # Then add in each channel's settings.
     text += mono_effects.save_settings()
     text += rgb_effects.save_settings()
+
     # Finally save the file.
     with open("settings.txt", "w") as settingsfile:
         settingsfile.write(text)
-    
+
+
 def mode_handler():
+    # Here we're just switching between the running mode, mono editing mode and
+    # RGB editing mode.
     global run_mode
 
     run_mode += 1
     if run_mode > 2:
         run_mode = 0
+
+    # That's the actual switch done, the rest just dims or brightens LEDs
+    # appropriately for the current mode.
     if run_mode == Mode.Running:
         for i in range(len(mono_effects.channel_settings)):
             mono_effects.channel_settings[i].undim()
@@ -118,6 +129,7 @@ def mode_handler():
     mono_effects.update_effects_list(monoplayer)
     rgb_effects.update_effects_list(rgbplayer)
 
+
 def common_handler(button):
     # This handles presses on the buttons common to all effect types.
     # It gets passed which button was pressed and depending on which it was,
@@ -130,12 +142,12 @@ def common_handler(button):
 
     if run_mode == Mode.Running:
         return
-    
+
     if run_mode == Mode.Mono:
         player = monoplayer
         effects = mono_effects
         selected_channel = mono_channel
-        
+
     if run_mode == Mode.RGB:
         player = rgbplayer
         effects = rgb_effects
@@ -172,7 +184,7 @@ def number_handler(number_button, repeat):
         selected_channel = mono_channel
         effects = mono_effects
         effect = effects.channel_settings[selected_channel - 1]
-        
+
     elif run_mode == Mode.RGB:
         player = rgbplayer
         selected_channel = 0
@@ -225,7 +237,7 @@ def number_handler(number_button, repeat):
     elif number_button == 9:
         if effect.type in (3, 9) and not repeat:
             effects.alter_flashes(selected_channel, 1)
-            
+
     elif number_button == 0:
         if effect.type == 10:
             effects.alter_hue2(0, 5)
@@ -243,8 +255,8 @@ def number_handler(number_button, repeat):
 # This binds functions to each of the Pimoroni remote's buttons for what happens when they're pressed, and when they're held.
 # For the most part they're set to pass to a handler for the reasons mentioned above.
 remote = PimoroniRemote()
-remote.bind("CLOCKWISE", (select_channel, 1,False), on_repeat=(select_channel, 1,True))
-remote.bind("ANTICLOCK", (select_channel, -1, False), on_repeat=(select_channel, -1,True))
+remote.bind("CLOCKWISE", (rotate, 1, False), on_repeat=(rotate, 1, True))
+remote.bind("ANTICLOCK", (rotate, -1, False), on_repeat=(rotate, -1, True))
 remote.bind("MENU/ACTION", (mode_handler), on_repeat=None)
 remote.bind("1/RED", (number_handler, 1, False), on_repeat=(number_handler, 1, True))
 remote.bind("2/GREEN", (number_handler, 2, False), on_repeat=(number_handler, 2, True))

picofx/colour/blinkRGB.py

@@ -4,6 +4,7 @@
 
 from picofx import Cycling
 
+
 class BlinkRGBFX(Cycling):
     def __init__(self, speed=1, phase=0.0, duty=0.5, brightness=1.0, r=255, g=0, b=0):
         super().__init__(speed)
@@ -20,12 +21,9 @@ def __call__(self):
             r = self.red * self.brightness
             g = self.green * self.brightness
             b = self.blue * self.brightness
-        
+
             return max(min(r, 255), 0), \
                 max(min(g, 255), 0), \
                 max(min(b, 255), 0)
         else:
             return 0, 0, 0
-
-
-

picofx/colour/flashRGB.py

@@ -36,10 +36,10 @@ def __call__(self):
                 r = self.red * self.brightness
                 g = self.green * self.brightness
                 b = self.blue * self.brightness
-        
+
                 return max(min(r, 255), 0), \
                     max(min(g, 255), 0), \
                     max(min(b, 255), 0)
             else:
                 return 0, 0, 0
-        return 0, 0, 0
+        return 0, 0, 0

picofx/colour/flickerRGB.py

@@ -42,7 +42,7 @@ def __call__(self):
             r = self.red1 * self.brightness
             g = self.green1 * self.brightness
             b = self.blue1 * self.brightness
-        
+
         return max(min(r, 255), 0), \
             max(min(g, 255), 0), \
             max(min(b, 255), 0)

picofx/colour/pulseRGB.py

@@ -21,7 +21,7 @@ def __call__(self):
         r = self.red * self.brightness * ((math.sin(angle) + 1) / 2.0)
         g = self.green * self.brightness * ((math.sin(angle) + 1) / 2.0)
         b = self.blue * self.brightness * ((math.sin(angle) + 1) / 2.0)
-        
+
         return max(min(r, 255), 0), \
             max(min(g, 255), 0), \
             max(min(b, 255), 0)

picofx/colour/randRGB.py

@@ -21,7 +21,7 @@ def __call__(self):
         r = self.red * self.__brightness
         g = self.green * self.__brightness
         b = self.blue * self.__brightness
-        
+
         return max(min(r, 255), 0), \
             max(min(g, 255), 0), \
             max(min(b, 255), 0)

picofx/colour/staticRGB.py

@@ -13,7 +13,7 @@ def __call__(self):
         r = self.red * self.brightness
         g = self.green * self.brightness
         b = self.blue * self.brightness
-        
+
         return max(min(r, 255), 0), \
             max(min(g, 255), 0), \
             max(min(b, 255), 0)

picofx/mono/blink.py

@@ -6,7 +6,7 @@
 
 
 class BlinkFX(Cycling):
-    def __init__(self, speed=1, phase=0.0, duty=0.5, brightness = 1.0):
+    def __init__(self, speed=1, phase=0.0, duty=0.5, brightness=1.0):
         super().__init__(speed)
         self.phase = phase
         self.duty = duty

picofx/mono/none.py

@@ -4,4 +4,4 @@
 
 class NoneFX:
     def __call__(self):
-        return 0.0
+        return 0.0