1.1.0 added rgb and encoder fixes

Author: JanLunge

README.md

@@ -26,6 +26,8 @@ then just run it with dev to start
 
 
 # Tasks
+## bugs
+- [ ] maximum call stack error when closing the app
 ## urgent
 - [x] check if a keyboard is connected (usb drive) in the keyboard selector preview
 - [x] show serial output in the gui

package.json

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

src/main/index.ts

@@ -1,4 +1,4 @@
-import { app, shell, BrowserWindow, ipcMain, Menu } from 'electron'
+import { app, shell, BrowserWindow, ipcMain, Menu, SerialPort } from 'electron'
 import { join } from 'path'
 import { electronApp, optimizer, is } from '@electron-toolkit/utils'
 import icon from '../../resources/icon.png?asset'
@@ -14,6 +14,7 @@ export { mainWindow }
 
 const isMac = process.platform === 'darwin'
 
+let triedToQuit = false
 const template: unknown = [
   // { role: 'appMenu' }
   ...(isMac
@@ -181,9 +182,9 @@ app.on('window-all-closed', () => {
 })
 app.on('before-quit', (event) => {
   // Prevent the default behavior of this event
-  if (debugPort !== undefined) {
+  if (debugPort !== undefined && !triedToQuit) {
     event.preventDefault()
-
+    triedToQuit = true
     console.log('Preparing to quit...')
     debugPort.close(() => {
       console.log('Port closed')
@@ -233,19 +234,23 @@ const chunksize = 1200
 
 const getBoardInfo = (port) => {
   return new Promise((res, rej) => {
-    // connect to port and get the response
-    const sport = new serialPort.SerialPort(
-      { path: port.path, baudRate, autoOpen: true },
-      (e) => {}
-    )
+    // connect to port and get the response just once
+    const sport = new serialPort.SerialPort({ path: port.path, baudRate, autoOpen: true }, (e) => {
+      // if the connection fails reject the promise
+      if (e) return rej(e)
+    })
+
     const sparser = sport.pipe(new ReadlineParser({ delimiter: '\n' }))
     sparser.once('data', (data) => {
       sport.close()
-      res({ ...port, ...JSON.parse(data) })
+      return res({ ...port, ...JSON.parse(data) })
     })
+    // request the info
     sport.write('info_simple\n')
   })
 }
+
+// timer helper function
 const timeout = (prom, time) => {
   let timer
   return Promise.race([prom, new Promise((_r, rej) => (timer = setTimeout(rej, time)))]).finally(
@@ -261,14 +266,15 @@ const scanForKeyboards = async () => {
   if (connectedKeyboardPort && connectedKeyboardPort.isOpen) connectedKeyboardPort.close()
   const ports = await serialPort.SerialPort.list()
   console.log('found the following raw ports:', ports)
-  const circuitPythonPorts = ports.filter(port => {
+  const circuitPythonPorts = ports.filter((port) => {
     // TODO: make sure the port is used for a pog keyboard
     // we dont want to send serial data to a REPL that is not a keyboard with pog firmware
-    // maybe whitelist serialnumbers?
-    let manufacturer = port.manufacturer
-    manufacturer = manufacturer ? manufacturer.toLowerCase() : ''
-    return manufacturer.endsWith("-pog") || manufacturer.startsWith("pog-") || manufacturer === 'pog'
-  });
+    const manufacturer = port.manufacturer ? port.manufacturer.toLowerCase() : ''
+    // if the manufactuer is pog or has pog as suffix or prefix with the - we assume its a pog keyboard
+    return (
+      manufacturer.endsWith('-pog') || manufacturer.startsWith('pog-') || manufacturer === 'pog'
+    )
+  })
   const boards = (await Promise.allSettled(
     circuitPythonPorts.map(async (a) => await timeout(getBoardInfo(a), 2000))
   )) as {
@@ -290,7 +296,7 @@ const scanForKeyboards = async () => {
 
 let currentPackage = ''
 let addedChunks = 0
-function crossSum(s) {
+function crossSum(s: string) {
   // Compute the cross sum
   let total = 0
   for (let i = 0; i < s.length; i++) {

src/main/pythontemplates/kb.ts

@@ -61,8 +61,8 @@ class KMKKeyboard(_KMKKeyboard):
         if "rgb" in features:
             from kmk.extensions.RGB import RGB
             rgb = RGB(
-                pixel_pin=board.GP3,
-                num_pixels=16,
+                pixel_pin=eval(pog.rgbPin),
+                num_pixels=pog.rgbNumLeds,
                 rgb_order=(1, 0, 2),
                 val_limit=40, # Maximum brightness level. Only change if you know what you are doing!
                 hue_default=10,

src/main/pythontemplates/pog.ts

@@ -53,6 +53,9 @@ pins = ",".join(pinsArray)
 if len(pinsArray) == 1:
     pins = pins + ","
 
+rgbPin = config["rgbPin"]
+rgbNumLeds = config["rgbNumLeds"]
+
 matrixWiring = False
 directWiring = False
 

src/main/saveConfig.ts

@@ -94,15 +94,6 @@ export const handleKeymapSave = ({ pogConfig, serial }) => {
 
   // testing encoder enable
   if (pogConfig.encoders && pogConfig.encoders.length !== 0) {
-    // pythonImports +=
-    //   '\nfrom kmk.modules.layers import Layers\n' +
-    //   'from kmk.modules.encoder import EncoderHandler\n'
-    // kmkAddons +=
-    //   '\nlayers = Layers()\n' +
-    //   'encoder_handler = EncoderHandler()\n' +
-    //   'keyboard.modules = [layers, encoder_handler]\n'
-
-    // still keeping the option to save the encoder keymap as raw code instead of the lookup
     let encoderPins = ''
     pogConfig.encoders.forEach((encoder) => {
       encoderPins += `(board.GP${encoder.pad_a}, board.GP${encoder.pad_b}, None,),`
@@ -118,42 +109,6 @@ export const handleKeymapSave = ({ pogConfig, serial }) => {
       encoderKeymap += '),\n'
     })
   }
-
-  //   codeblock +=
-  //     '# Encoder\n' +
-  //     'encoder_handler.pins = (\n' +
-  //     encoderPins +
-  //     '\n' +
-  //     ')\n' +
-  //     'encoder_handler.map = [ \n' +
-  //     encoderKeymap + // layers
-  //     ']\n'
-  // }
-  //   const mainConfig = `# Main Keyboard Configuration
-  // print("Starting ${pogConfig.name || 'Keyboard'}")
-  //
-  // import board
-  // from kb import KMKKeyboard
-  // from kmk.modules.tapdance import TapDance
-  // ${pythonImports}
-  //
-  // keyboard = KMKKeyboard()
-  // ${kmkAddons}
-  //
-  // tapdance = TapDance()
-  // tapdance.tap_time = 200
-  // keyboard.modules.append(tapdance)
-  //
-  // # Keymap
-  // from keymap import keymap
-  // keyboard.keymap = keymap
-  //
-  // ${codeblock}
-  //
-  // if __name__ == '__main__':
-  //     keyboard.go()
-  // `
-
   // we are still writing the keymap file by hand
   const keymap = `# Keymap Autogenerated by Pog do not edit
 from kmk.keys import KC

src/main/selectKeyboard.ts

@@ -2,14 +2,13 @@ import * as fs from 'fs-extra'
 import { currentKeyboard } from './store'
 import { dialog } from 'electron'
 import { connectedKeyboardPort, connectSerialKeyboard, serialBoards } from './index'
-// select a keyboard
+
+// invoked from frontend to select a drive or folder load the conig from
 export const handleSelectDrive = async () => {
   const { canceled, filePaths } = await dialog.showOpenDialog({
     properties: ['openDirectory']
   })
-  if (canceled) {
-    return
-  }
+  if (canceled) return
   return await loadKeyboard(filePaths[0])
 }
 const loadKeyboard = async (path) => {
@@ -44,11 +43,11 @@ const loadKeyboard = async (path) => {
   }
 }
 export const selectKeyboard = async ({ path, id }: { path: string; id: string }) => {
-  console.log(path,id)
-  if(id){
+  console.log(path, id)
+  if (id) {
     // connect serial if available
     const port = serialBoards.value.find((a) => a.id === id)
-    if(!port) return { error:'not a serial keyboard' }
+    if (!port) return { error: 'not a serial keyboard' }
     console.log(serialBoards, id)
     await connectSerialKeyboard(port)
     connectedKeyboardPort.write('info\n')

src/main/store.ts

@@ -1,7 +1,7 @@
-import {app} from "electron";
+// Store for global variables
+import { app } from "electron";
 
 export const appDir = app.getPath("appData") + "/pog/";
-// export let win = undefined
 export const currentKeyboard = {
   path: ""
 }

src/renderer/src/components/KeyCap.vue

@@ -339,6 +339,8 @@ const isSimple = computed(() => {
 
 const keyElem = ref<VNodeRef | null>(null)
 const fixLabelWidth = () => {
+  // key is eventually hidden with a layout variant
+  if(!keyElem.value) return
   const label = keyElem.value.querySelector('.keylabel-main')
   const labels = keyElem.value.querySelector('.keylabels')
   if (label) {

src/renderer/src/components/KeyLayoutInfo.vue

@@ -293,10 +293,12 @@ const updateKey = () => {
     if (tmpKey.value.r !== '') props.layout[keyIndex].r = Number(tmpKey.value.r)
     if (tmpKey.value.rx !== '') props.layout[keyIndex].rx = Number(tmpKey.value.rx)
     if (tmpKey.value.ry !== '') props.layout[keyIndex].ry = Number(tmpKey.value.ry)
-    if (tmpKey.value.directPinIndex !== '')
+    if (tmpKey.value.directPinIndex !== '' && !isNaN(tmpKey.value.directPinIndex as any))
       props.layout[keyIndex].directPinIndex = Number(tmpKey.value.directPinIndex)
-    if (tmpKey.value.encoderIndex !== '')
+    else props.layout[keyIndex].directPinIndex = ""
+    if (tmpKey.value.encoderIndex !== '' && !isNaN(Number(tmpKey.value.encoderIndex)))
       props.layout[keyIndex].encoderIndex = Number(tmpKey.value.encoderIndex)
+    else props.layout[keyIndex].encoderIndex = undefined
     // if (
     //   (tmpKey.value.matrix &&
     //     tmpKey.value.matrix.length == 2 &&