Add comments to lotus-led-matrix.py

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

lotus-led-matrix.py

@@ -1,7 +1,17 @@
 #!/usr/bin/env python3
+# Script to generate the mapping of LEDs to the CS and SW registers of the
+# IS31FL3741A controller.
+#
+# The output looks like:
+# (0x00, 0), // x:1, y:1, sw:1, cs:1, id:1
+# (0x1e, 0), // x:2, y:1, sw:2, cs:1, id:2
+# [...]
 
 from dataclasses import dataclass
 
+WIDTH = 9
+HEIGHT = 34
+
 
 @dataclass
 class Led:
@@ -14,6 +24,7 @@ class Led:
     cs: int
 
     def led_register(self):
+        # See the IS31FL3741A for how the data pages are separated
         if self.cs <= 30 and self.sw >= 7:
             page = 1
             register = self.cs - 1 + (self.sw-7) * 30
@@ -22,63 +33,64 @@ def led_register(self):
             register = self.cs - 1 + (self.sw-1) * 30
         if self.cs >= 31:
             page = 1
-            register = 0x5a + self.cs - 31 + (self.sw-1) * 9
+            register = 0x5A + self.cs - 31 + (self.sw-1) * 9
         return (register, page)
 
 
 def get_leds():
     leds = []
 
+    # Generate LED mapping as how they are mapped in the Lotus LED Matrix Module
+
     # First down and then right
     # CS1 through CS4
     for cs in range(1, 5):
-        for sw in range(1, 10):
-            leds.append(Led(id=9 * (cs-1) + sw, x=sw, y=cs, sw=sw, cs=cs))
+        for sw in range(1, WIDTH+1):
+            leds.append(Led(id=WIDTH * (cs-1) + sw, x=sw, y=cs, sw=sw, cs=cs))
 
     # First right and then down
     # CS5 through CS7
     base_cs = 4
-    base_id = 9 * base_cs
+    base_id = WIDTH * base_cs
     for cs in range(1, 5):
-        for sw in range(1, 10):
+        for sw in range(1, WIDTH+1):
             leds.append(Led(id=base_id + 4 * (sw-1) + cs, x=sw,
                         y=cs+base_cs, sw=sw, cs=cs+base_cs))
 
     # First right and then down
     # CS9 through CS16
     base_cs = 8
-    base_id = 9 * base_cs
+    base_id = WIDTH * base_cs
     for cs in range(1, 9):
-        for sw in range(1, 10):
+        for sw in range(1, WIDTH+1):
             leds.append(Led(id=base_id + 8 * (sw-1) + cs, x=sw,
                         y=cs+base_cs, sw=sw, cs=cs+base_cs))
 
     # First right and then down
     # CS17 through CS32
     base_cs = 16
-    base_id = 9 * base_cs
+    base_id = WIDTH * base_cs
     for cs in range(1, 17):
-        for sw in range(1, 10):
+        for sw in range(1, WIDTH+1):
             leds.append(Led(id=base_id + 16 * (sw-1) + cs, x=sw,
                         y=cs+base_cs, sw=sw, cs=cs+base_cs))
 
     # First down and then right
     # CS33 through CS34
     base_cs = 32
-    base_id = 9 * base_cs
+    base_id = WIDTH * base_cs
     for cs in range(1, 3):
-        for sw in range(1, 10):
+        for sw in range(1, WIDTH+1):
             leds.append(Led(id=base_id + 9 * (cs-1) + sw, x=sw,
                         y=cs+base_cs, sw=sw, cs=cs+base_cs))
 
     return leds
 
 
 def main():
+    # Assumes that the index in the LEDs list is: index = x + y * 9
     leds = get_leds()
 
-    # Assume that the index in the leds list is: index = x + y * 9
-
     debug = False
 
     for led in leds:
@@ -88,19 +100,18 @@ def main():
         else:
             print("(0x{:02x}, {}), // x:{}, y:{}, sw:{}, cs:{}, id:{}".format(
                 register, page, led.x, led.y, led.sw, led.cs, led.id))
-
     # print_led(leds, 0, 30)
 
 # For debugging
 
 
 def get_led(leds, x, y):
-    return leds[x + y * 9]
+    return leds[x + y * WIDTH]
 
 
 # For debugging
 def print_led(leds, x, y):
-    led = get_led(leds, 0, 30)
+    led = get_led(leds, x, y)
     (register, page) = led.led_register()
     print(led, "(0x{:02x}, {})".format(register, page))