Merge pull request #26 from JanLunge/coordmap-split-boards

supply coordmap for the coordmap helper, better naming of custom keyb…

Author: JanLunge

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pog",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "license": "MIT",
   "description": "A KMK firmware configurator",
   "main": "./out/main/index.js",

src/main/pythontemplates/code.ts

@@ -1,33 +1,31 @@
-export const codepy = `# Main Keyboard Configuration - v0.9.5
+export const codepy = `# Main Keyboard Configuration - v1.0.0
 import board
 import pog
-
 # check if we just want to run the coord_mappping Assistant
 if pog.coordMappingAssistant:
-    from coordmaphelper import KMKKeyboard
+    from coordmaphelper import CoordMapKeyboard
     if __name__ == '__main__':
-        KMKKeyboard().go()
-        exit()
+        CoordMapKeyboard().go()
+    print("Exiting Coord Mapping Assistant Because of an error")
 else:
-    from kb import KMKKeyboard
-
-# set the required features for you keyboard and keymap
-# add custom ones in the kb.py
+    from kb import POGKeyboard
+    # set the required features for you keyboard and keymap
+    # add custom ones in the kb.py
 
-keyboard = KMKKeyboard(features=pog.kbFeatures)
+    keyboard = POGKeyboard(features=pog.kbFeatures)
 
-# manage settings for our modules and extensions here
-keyboard.tapdance.tap_time = 200
+    # manage settings for our modules and extensions here
+    keyboard.tapdance.tap_time = 200
 
-# Keymap
-import keymap
-keyboard.keymap = keymap.keymap
+    # Keymap
+    import keymap
+    keyboard.keymap = keymap.keymap
 
-# Encoder Keymap if available
-if pog.hasEncoders:
-    keyboard.encoder_handler.map = keymap.encoderKeymap
+    # Encoder Keymap if available
+    if pog.hasEncoders:
+        keyboard.encoder_handler.map = keymap.encoderKeymap
 
-# Execute the keyboard loop
-if __name__ == '__main__':
-    keyboard.go()
+    # Execute the keyboard loop
+    if __name__ == '__main__':
+        keyboard.go()
 `

src/main/pythontemplates/coordmaphelper.ts

@@ -1,31 +1,46 @@
-export const coordmaphelperpy = `# coordmaphelper.py helper script to get your coord map - v1.0.0
+export const coordmaphelperpy = `# coordmaphelper.py v1.0.1
+import board
+import pog
+from kb import POGKeyboard
 from kmk.keys import KC
-from kb import KMKKeyboard as _KMKKeyboard
 from kmk.modules.macros import Press, Release, Tap, Macros
-import pog
-class KMKKeyboard(_KMKKeyboard):
+
+class CoordMapKeyboard(POGKeyboard):
     def __init__(self):
-        super().__init__()
-        macros = Macros()
-        self.modules.append(macros)
-        print("running coord_mapping assistant")
-        print("press each key to get its coord_mapping value")
-        # *2 for split keyboards, which will typically manage twice the number of keys
-        # of one side. Having this N too large will have no impact (maybe slower boot..)
+        super().__init__(features=['basic', 'macros'])
+        print("Running coord_mapping assistant")
+        print("Press each key to get its coord_mapping value")
+
+        if not hasattr(pog, 'keyCount') or pog.keyCount == 0:
+            raise ValueError("pog.keyCount is not set or is zero")
+
         N = pog.keyCount * 2
         coord_mapping = list(range(N))
-
         layer = []
+        print(f"coord_mapping = {coord_mapping}")
+        print(f"Total keys: {N}")
 
         for i in range(N):
             c, r = divmod(i, 100)
             d, u = divmod(r, 10)
-            layer.append(
-                KC.MACRO(
-                        Tap(getattr(KC, "N" + str(c))),
-                        Tap(getattr(KC, "N" + str(d))),
-                        Tap(getattr(KC, "N" + str(u))),
+            print(f"Adding key {i} ({c}{d}{u})")
+            try:
+                layer.append(
+                    KC.MACRO(
+                        Tap(getattr(KC, f"N{c}")),
+                        Tap(getattr(KC, f"N{d}")),
+                        Tap(getattr(KC, f"N{u}")),
                         Tap(KC.SPC),
+                    )
                 )
-            )
-        self.keymap = [layer]`
+            except AttributeError as e:
+                print(f"Error creating macro for key {i}: {e}")
+
+        if not layer:
+            raise ValueError("No keys were added to the layer")
+
+        print(f"Layer created with {len(layer)} keys")
+        self.keymap = [layer]
+        self.coord_mapping = coord_mapping
+        print(f"Keymap initialized with {len(self.keymap[0])} keys")
+`

src/main/pythontemplates/kb.ts

@@ -2,11 +2,11 @@ export const kbpy = `# kb.py KB base config - v0.9.5
 import board
 import pog
 
-from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.kmk_keyboard import KMKKeyboard
 from kmk.scanners import DiodeOrientation
 from kmk.scanners.keypad import KeysScanner
 
-class KMKKeyboard(_KMKKeyboard):
+class POGKeyboard(KMKKeyboard):
     def __init__(self, features=['basic']):
         if "basic" in features:
             from kmk.modules.layers import Layers;

src/main/pythontemplates/keymap.py

@@ -1,6 +1,6 @@
 # Keymap Autogenerated by Pog do not edit
 from kmk.keys import KC
-from kmk.modules.macros import Macros, Press, Release, Tap
+from kmk.modules.macros import Macros, Press, Release, Tap, Delay
 import pog
 import customkey
 from kmk.modules.combos import Chord, Sequence

src/main/saveConfig.ts

@@ -112,7 +112,7 @@ export const handleKeymapSave = ({ pogConfig, serial }) => {
   // we are still writing the keymap file by hand
   const keymap = `# Keymap Autogenerated by Pog do not edit
 from kmk.keys import KC
-from kmk.modules.macros import Macros, Press, Release, Tap
+from kmk.modules.macros import Macros, Press, Release, Tap, Delay
 from kmk.modules.combos import Chord, Sequence
 
 import pog