Merge pull request #74 from theld21/fix/keymap-crash-optimization

fix keymap: improve stability and defaults, add loading overlay

Author: JanLunge

src/main/saveConfig.ts

@@ -8,41 +8,75 @@ import { codepy } from './pythontemplates/code'
 import { bootpy } from './pythontemplates/boot'
 import { pog_serialpy } from './pythontemplates/pog_serial'
 import { keymappy } from './pythontemplates/keymap'
-import { writePogConfViaSerial } from './index'
+import { writePogConfViaSerial, mainWindow } from './index'
 
-export const saveConfiguration = (data: string) => {
+export const saveConfiguration = async (data: string) => {
   const { pogConfig, serial, writeFirmware } = JSON.parse(data)
   if (serial) {
     // write by serial to current keyboard
     console.log('writing firmware via usb serial')
     writePogConfViaSerial(JSON.stringify(pogConfig, null, 0))
-  } else {
-    // write pog.json
-    console.log('writing firmware via usb files', 'overwriting Firmware:', writeFirmware)
-    fs.writeFile(currentKeyboard.path + '/pog.json', JSON.stringify(pogConfig, null, 4), (e) => {
-      if (e) {
-        console.log('error writing pog.json', e)
-      } else {
-        console.log('pog.json written successfully')
-      }
-    })
-
-    const files = [
-      { name: 'pog.py', contents: pogpy },
-      { name: 'code.py', contents: codepy },
-      { name: 'coordmaphelper.py', contents: coordmaphelperpy },
-      { name: 'customkeys.py', contents: customkeyspy },
-      { name: 'boot.py', contents: bootpy },
-      { name: 'pog_serial.py', contents: pog_serialpy },
-      { name: 'keymap.py', contents: keymappy },
-      { name: 'kb.py', contents: kbpy }
-    ]
-    for (const file of files) {
-      if (!fs.existsSync(currentKeyboard.path + '/' + file.name) || writeFirmware) {
-        fs.writeFile(currentKeyboard.path + '/' + file.name, file.contents, () => {
-          console.log(file.name + 'File written successfully')
-        })
-      }
+    return
+  }
+
+  // write via mounted USB drive
+  console.log('writing firmware via usb files', 'overwriting Firmware:', writeFirmware)
+
+  type WriteTask = { name: string; path: string; contents: string }
+  const tasks: WriteTask[] = []
+
+  // Always write pog.json
+  tasks.push({
+    name: 'pog.json',
+    path: currentKeyboard.path + '/pog.json',
+    contents: JSON.stringify(pogConfig, null, 4)
+  })
+
+  const files = [
+    { name: 'pog.py', contents: pogpy },
+    { name: 'code.py', contents: codepy },
+    { name: 'coordmaphelper.py', contents: coordmaphelperpy },
+    { name: 'customkeys.py', contents: customkeyspy },
+    { name: 'boot.py', contents: bootpy },
+    { name: 'pog_serial.py', contents: pog_serialpy },
+    { name: 'keymap.py', contents: keymappy },
+    { name: 'kb.py', contents: kbpy }
+  ]
+
+  for (const file of files) {
+    const targetPath = currentKeyboard.path + '/' + file.name
+    if (!fs.existsSync(targetPath) || writeFirmware) {
+      tasks.push({ name: file.name, path: targetPath, contents: file.contents })
     }
   }
+
+  const total = tasks.length
+  let completed = 0
+
+  for (const task of tasks) {
+    try {
+      await fs.promises.writeFile(task.path, task.contents)
+      completed += 1
+      mainWindow?.webContents.send('save-configuration-progress', {
+        state: 'writing',
+        filename: task.name,
+        completed,
+        total
+      })
+    } catch (e) {
+      console.error(`error writing ${task.name}`, e)
+      mainWindow?.webContents.send('save-configuration-progress', {
+        state: 'error',
+        filename: task.name,
+        completed,
+        total
+      })
+    }
+  }
+
+  mainWindow?.webContents.send('save-configuration-progress', {
+    state: 'done',
+    completed,
+    total
+  })
 }

src/preload/index.d.ts

@@ -43,6 +43,7 @@ export interface IElectronAPI {
   serialConnect: (port: string) => Promise<void>
   serialDisconnect: () => Promise<void>
   serialData: (callback: (event: any, data: { message: string }) => void) => void
+  offSerialData: (callback: (event: any, data: { message: string }) => void) => void
   serialConnectionStatus: (
     callback: (event: any, data: { connected: boolean; error?: string }) => void
   ) => void
@@ -60,6 +61,12 @@ export interface IElectronAPI {
   onDetectionUpdate: (callback: (data: any, event: any) => void) => void
   removeDetectionListeners: () => void
   onUpdateFirmwareInstallProgress: (callback: (data: any, event: any) => void) => void
+  onSaveConfigurationProgress: (
+    callback: (event: any, data: { state: 'writing' | 'done' | 'error'; filename?: string; completed: number; total: number }) => void
+  ) => void
+  offSaveConfigurationProgress: (
+    callback: (event: any, data: { state: 'writing' | 'done' | 'error'; filename?: string; completed: number; total: number }) => void
+  ) => void
 
   // Legacy API (to be migrated)
   selectKeyboard: (data: any) => Promise<any>

src/preload/index.ts

@@ -9,6 +9,10 @@ const api = {
   selectKeyboard: (data) => ipcRenderer.invoke('selectKeyboard', data),
   onUpdateFirmwareInstallProgress: (callback) =>
     ipcRenderer.on('onUpdateFirmwareInstallProgress', callback),
+  onSaveConfigurationProgress: (callback) =>
+    ipcRenderer.on('save-configuration-progress', callback),
+  offSaveConfigurationProgress: (callback) =>
+    ipcRenderer.removeListener('save-configuration-progress', callback),
   keyboardScan: (callback) => {
     ipcRenderer.on('keyboardScan', callback)
   },
@@ -19,6 +23,7 @@ const api = {
   checkForUSBKeyboards: (data) => ipcRenderer.invoke('checkForUSBKeyboards', data),
   deselectKeyboard: () => ipcRenderer.invoke('deselectKeyboard'),
   serialData: (callback) => ipcRenderer.on('serialData', callback),
+  offSerialData: (callback) => ipcRenderer.removeListener('serialData', callback),
   serialConnectionStatus: (callback) => ipcRenderer.on('serialConnectionStatus', callback),
   serialPorts: () => ipcRenderer.invoke('serial-ports'),
   serialSend: (data) => ipcRenderer.send('serialSend', data),

src/renderer/src/App.vue

@@ -1,6 +1,7 @@
 <script setup lang="ts">
-import { computed } from 'vue'
+import { computed, onMounted, onUnmounted } from 'vue'
 import { addToHistory, keyboardStore, notifications, serialKeyboards } from './store'
+import { addSerialLine } from './store/serial'
 import { useRouter } from 'vue-router'
 const router = useRouter()
 const store = computed(() => {
@@ -29,7 +30,17 @@ window.api.serialKeyboardPogConfig((_event: Event, value: { pogconfig }) => {
   if (keyboardStore.pogConfigured) {
     addToHistory(keyboardStore)
   }
-  router.push('/configurator')
+  router.push('/configurator/keymap')
+})
+
+let serialHandler: ((event: any, data: { message: string }) => void) | null = null
+onMounted(() => {
+  serialHandler = (_event, data) => addSerialLine(data.message)
+  window.api.serialData(serialHandler)
+})
+onUnmounted(() => {
+  if (serialHandler) window.api.offSerialData(serialHandler)
+  serialHandler = null
 })
 </script>
 

src/renderer/src/components/EncoderLayer.vue

@@ -8,11 +8,13 @@
       v-model="keyboardStore.encoderKeymap[lindex][eindex][0]"
       type="text"
       class="input input-bordered input-sm"
+      @blur="handleBlur(0)"
     />
     <input
       v-model="keyboardStore.encoderKeymap[lindex][eindex][1]"
       type="text"
       class="input input-bordered input-sm"
+      @blur="handleBlur(1)"
     />
   </div>
 </template>
@@ -27,6 +29,13 @@ if (!keyboardStore.encoderKeymap[props.lindex]) {
 if (!keyboardStore.encoderKeymap[props.lindex][props.eindex]) {
   keyboardStore.encoderKeymap[props.lindex][props.eindex] = ['KC.TRNS', 'KC.TRNS']
 }
+
+const handleBlur = (index: number) => {
+  const value = keyboardStore.encoderKeymap[props.lindex][props.eindex][index]
+  if (!value || value === '▽') {
+    keyboardStore.encoderKeymap[props.lindex][props.eindex][index] = 'KC.TRNS'
+  }
+}
 </script>
 
 <style lang="scss" scoped></style>

src/renderer/src/components/KeymapEditor.vue

@@ -143,10 +143,13 @@ const currentKeyCode = computed({
   },
   set(newVal) {
     if (newVal === '▽') return
-    if (selectedKeys.value.size === 0) return
+    let setNewVal = newVal
+    if (!newVal || selectedKeys.value.size === 0) {
+      setNewVal = 'KC.TRNS'
+    }
     const keys = keyboardStore.keys.filter((_k, index) => selectedKeys.value.has(index))
     keys.forEach((key) => {
-      key.setOnKeymap(newVal)
+      key.setOnKeymap(setNewVal)
     })
   }
 })
@@ -155,9 +158,9 @@ const switchedKeyCodeType = () => {
   const keys = keyboardStore.keys.filter((_k, index) => selectedKeys.value.has(index))
   keys.forEach((key) => {
     if (keycodeModeForSelection.value === 'macro') {
-      key.setOnKeymap('KC.MACRO((KC.A, KC.B))')
+      key.setOnKeymap('KC.MACRO(Press(KC.LCTL),Tap(KC.A),Release(KC.LCTL))')
     } else if (keycodeModeForSelection.value === 'string') {
-      key.setOnKeymap('send_string("")')
+      key.setOnKeymap('KC.MACRO("Sample string")')
     } else if (keycodeModeForSelection.value === 'tapdance') {
       key.setOnKeymap('KC.TD(KC.A,KC.B)')
     } else if (keycodeModeForSelection.value === 'custom') {