versioning for py files

set split keyboard pins

Author: JanLunge

README.md

@@ -22,23 +22,25 @@ then just run it with dev to start
 
 # Tasks
 ## urgent
-- [ ] boot.py generation
+- [ ] guides etc for setup + split workflow
 - [ ] share pog.json files
-- [ ] use injection points from the pog.json for codeblocks
-- [ ] direct pin wiring support
+- [ ] check if the controller you use even has the pin you specified (controller lookup and serial to get pins )
 - [ ] bluetooth workflow
 - [ ] generate layout based on matrix + clear layout button / delete multiple
-- [ ] save a backup of the json in electron
 
 ## features
-- [x] dragging keys on the layout editor
 - [ ] language switcher for german and other layouts changing the labels on the keymap
 - [ ] modtap/tapdance/macros/sequences
 - [ ] encoder support direct pin click
 - [ ] way to handle differences between pog.json to kmk code
 - [ ] wiring preview
 
 ## done
+- [x] boot.py generation
+- [x] versioning for python files
+- [x] direct pin wiring support
+- [x] save a backup of the json in electron
+- [x] dragging keys on the layout editor
 - [x] Layout editor to replace KLE
 - [x] save pog.json (use as main storage for everything)
 - [x] adjust keymap when matrix changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pog",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "A KMK firmware configurator",
   "main": "./out/main/index.js",
   "author": "Jan Lunge",

src/main/index.ts

@@ -233,25 +233,32 @@ const timeout = (prom, time) => {
 }
 
 export const serialBoards: { value: any[] } = { value: [] }
+// TODO: resolve callbacks properly
+// https://stackoverflow.com/questions/69608234/get-promise-resolve-from-separate-callback
 const scanForKeyboards = async () => {
   console.log('checking for connected keyboards')
   if (connectedKeyboardPort && connectedKeyboardPort.isOpen) connectedKeyboardPort.close()
   const ports = await serialPort.SerialPort.list()
   const circuitPythonPorts = ports //.filter(port => {
   //     return port.manufacturer && ['0xCB'].includes(port.manufacturer)
   // });
-  let boards = await Promise.allSettled(
+  const boards = (await Promise.allSettled(
     circuitPythonPorts.map(async (a) => await timeout(getBoardInfo(a), 2000))
-  )
-  boards = boards.filter((a) => a.value !== undefined).map((a) => a.value)
+  )) as {
+    status: 'fulfilled' | 'rejected'
+    value:  { name: string; id: string; path: string }
+  }[]
+  const filteredBoards: { name: string; id: string; path: string }[] = boards
+    .filter((a) => a.value !== undefined)
+    .map((a) => a.value)
 
   console.log('boards ready')
-  boards.map((a) => console.log(`${a.name} - ${a.id} | ${a.path}`))
+  filteredBoards.map((a) => console.log(`${a.name} - ${a.id} | ${a.path}`))
   mainWindow?.webContents.send('keyboardScan', {
-    keyboards: boards
+    keyboards: filteredBoards
   })
-  serialBoards.value = boards
-  return boards
+  serialBoards.value = filteredBoards
+  return filteredBoards
 }
 
 let currentPackage = ''

src/main/pythontemplates/boot.ts

@@ -1,4 +1,4 @@
-export const bootpy = `# boot.py
+export const bootpy = `# boot.py - v0.9.5
 import usb_cdc
 import supervisor
 import storage

src/main/pythontemplates/code.ts

@@ -1,4 +1,4 @@
-export const codepy = `# Main Keyboard Configuration
+export const codepy = `# Main Keyboard Configuration - v0.9.5
 import board
 import pog
 

src/main/pythontemplates/coordmaphelper.ts

@@ -1,4 +1,4 @@
-export const coordmaphelperpy = `# coordmaphelper.py helper script to get your coord map
+export const coordmaphelperpy = `# coordmaphelper.py helper script to get your coord map - v0.9.5
 from kmk.handlers.sequences import simple_key_sequence
 from kmk.keys import KC
 from kb import KMKKeyboard as _KMKKeyboard

src/main/pythontemplates/customkeys.ts

@@ -1,4 +1,4 @@
-export const customkeyspy = `# These are yous custom keycodes do any needed imports at the top
+export const customkeyspy = `# These are yous custom keycodes do any needed imports at the top - v0.9.5
 # then you can reference them in your keymap with for example customkeys.MyKey
 
 from kmk.keys import KC

src/main/pythontemplates/kb.ts

@@ -1,4 +1,4 @@
-export const kbpy = `# kb.py KB base config
+export const kbpy = `# kb.py KB base config - v0.9.5
 import board
 import pog
 
@@ -36,6 +36,15 @@ class KMKKeyboard(_KMKKeyboard):
             self.combos = Combos()
             self.modules.append(self.combos)
 
+        if pog.config['split']:
+          from kmk.modules.split import Split, SplitSide, SplitType
+          side = SplitSide.RIGHT if str(getmount('/').label)[-1] == 'R' else SplitSide.LEFT
+          if pog.splitPinB:
+              self.split = Split(split_side=side, data_pin=pog.splitPinA, data_pin2=pog.splitPinB, use_pio=True)
+            else:
+              self.split = Split(split_side=side, data_pin=pog.splitPinA, use_pio=True)
+          self.modules.append(self.split)
+
         # Add your own modules and extensions here
         # or sort them into the correct spot to have the correct import order
 

src/main/pythontemplates/pog.ts

@@ -1,4 +1,4 @@
-export const pogpy =`# pog.py Import the pog config
+export const pogpy =`# pog.py Import the pog config - v0.9.5
 import json
 import board
 from kmk.keys import KC
@@ -97,4 +97,11 @@ directPinScanner = (
         max_events=64
     )"""
 )
+
+splitPinA = None
+splitPinB = None
+if config.get('splitPinA'):
+    splitPinA = eval(renderPin(config['splitPinA']))
+if config.get('splitPinB'):
+    splitPinB = eval(renderPin(config['splitPinB']))
 `

src/main/pythontemplates/pog_serial.ts

@@ -1,6 +1,5 @@
-export const pog_serialpy = `# pog_serial module
+export const pog_serialpy = `# pog_serial module - v0.9.5
 from usb_cdc import data
-
 from kmk.modules import Module
 from kmk.utils import Debug
 import pog
@@ -11,6 +10,7 @@ import microcontroller
 import os
 import supervisor
 import math
+import board
 
 debug = Debug(__name__)
 
@@ -158,7 +158,7 @@ class pogSerial(Module):
                 if split[0] == 'info_simple':
                     # print basic keyboard info
                     print('getting basic keyboard info')
-                    data.write((json.dumps({"driveMounted": microcontroller.nvm[0]!=0 ,"name": pog.config['name'], "manufacturer": pog.config['manufacturer'], "id": pog.config['id']})+"\\n").encode())
+                    data.write((json.dumps({"driveMounted": microcontroller.nvm[0]!=0 ,"name": pog.config['name'], "manufacturer": pog.config['manufacturer'], "id": pog.config['id'], "board": dir(board) })+"\\n").encode())
                 if split[0] == 'save':
                     # read chunks
                     file_to_delete = open("received_file.json",'w')