locking to kmk version for more stability when in auto setup. resources for keycodes and kmk docs, switched oneshot to stickykeys

Author: JanLunge

src/main/kmkUpdater.ts

@@ -5,16 +5,11 @@ import decompress from 'decompress'
 import { mainWindow } from './index'
 
 // downloads kmk to app storage
-export const updateFirmware = () => {
-  console.log(appDir)
-  downloadFile(
-    'https://github.com/KMKfw/kmk_firmware/archive/refs/heads/main.zip',
-    appDir + 'kmk.zip'
-  )
-}
-
-// download kmk and copy it to the keyboard
-export const downloadFile = async (file_url, targetPath) => {
+export const updateFirmware = async () => {
+  const versionSha = 'f6346937d865f7e1f6baaae93ae5c9be935aae75'
+  console.log('updating kmk firmware', appDir, versionSha)
+  const file_url = `https://github.com/KMKfw/kmk_firmware/archive/${versionSha}.zip`
+  const targetPath = appDir + 'kmk.zip'
   if (!fs.existsSync(appDir)) {
     fs.mkdirSync(appDir)
   }
@@ -73,6 +68,8 @@ export const downloadFile = async (file_url, targetPath) => {
   // file copy needs to await the decompression
   try {
     console.log('moving kmk into keyboard')
+    // write a file to the keyboard with the version sha
+    fs.writeFileSync(`${currentKeyboard.path}/kmk/version`, versionSha)
     fs.cp(
       `${appDir}kmk/kmk_firmware-main/kmk`,
       `${currentKeyboard.path}/kmk`,

src/main/pythontemplates/customkeys.ts

@@ -3,25 +3,25 @@ export const customkeyspy = `# These are yous custom keycodes do any needed impo
 
 from kmk.keys import KC
 from kmk.modules.macros import Tap, Release, Press
+import microcontroller
 
-MyKey = KC.X
+# Here you can define your custom keys
+# MyKey = KC.X
 
+# Builtin macros for use in pog
 def next_boot_dfu(keyboard):
     print('setting next boot to dfu') #serial feedback
-    import microcontroller
     microcontroller.on_next_reset(microcontroller.RunMode.UF2)
 
 DFUMODE = KC.MACRO(next_boot_dfu)
 
 def next_boot_safe(keyboard):
     print('setting next boot to safe') #serial feedback
-    import microcontroller
     microcontroller.on_next_reset(microcontroller.RunMode.SAFE_MODE)
 SAFEMODE = KC.MACRO(next_boot_safe)
 
 def toggle_drive(keyboard):
     print('toggling usb drive') #serial feedback
-    import microcontroller
     if microcontroller.nvm[0] == 0:
         microcontroller.nvm[0] = 1
     else:

src/main/pythontemplates/kb.ts

@@ -1,4 +1,4 @@
-export const kbpy = `# kb.py KB base config - v0.9.8
+export const kbpy = `# kb.py KB base config - v1.0.0
 import board
 import pog
 import microcontroller
@@ -22,9 +22,12 @@ class POGKeyboard(KMKKeyboard):
             from pog_serial import pogSerial; self.modules.append(pogSerial())
 
         if "oneshot" in features:
-            from kmk.modules.oneshot import OneShot
-            self.oneshot = OneShot()
-            self.modules.append(self.oneshot)
+            from kmk.modules.sticky_keys import StickyKeys
+            sticky_keys = StickyKeys()
+            # optional: set a custom release timeout in ms (default: 1000ms)
+            # sticky_keys = StickyKeys(release_after=5000)
+            self.modules.append(sticky_keys)
+            
 
         if "tapdance" in features:
             from kmk.modules.tapdance import TapDance
@@ -42,10 +45,10 @@ class POGKeyboard(KMKKeyboard):
             self.combos = Combos()
             self.modules.append(self.combos)
 
-        if "macros" in features:
-            from kmk.modules.macros import Macros
-            self.macros = Macros()
-            self.modules.append(self.macros)
+        # if "macros" in features:
+        from kmk.modules.macros import Macros
+        self.macros = Macros()
+        self.modules.append(self.macros)
 
         # TODO: not tested yet
         if "capsword" in features:

src/renderer/src/components/KeyPicker.vue

@@ -163,6 +163,9 @@
         >App/Media/Mouse</a
       >
       <a class="tab" :class="{ 'tab-active': category === 'rgb' }" @click="category = 'rgb'">RGB</a>
+      <a class="tab" :class="{ 'tab-active': category === 'advanced' }" @click="category = 'advanced'"
+        >Advanced & Help</a
+      >
     </div>
     <div class="key-chooser">
       <div v-if="category === 'basic'" class="bonus">
@@ -282,6 +285,18 @@
         <div class="key" @click="setKey('KC.RGB_HUD')">RGB Hue decrease</div>
       </div>
     </div>
+    <div v-if="category === 'advanced'">
+      <p>you can build way more advanced things with custom keys here are some resources, for some you might need to edit the kb.py file or enable a keyboard feature. when testing these check the output of the REPL for errors
+      </p>
+      <ul>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/macros.md">Macros</a> KC.MACRO("send a string")</li>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/keycodes.md">Keycodes</a> List of all keys</li>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/layers.md">Layers</a> How layers work</li>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/combos.md">Combos</a> Multiple keys pressed at simultaneously output a different key</li>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/holdtap.md">Holdtap</a> Holding a key down for longer than a certain amount of time outputs a different key</li>
+        <li><a class="text-primary" href="https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/combo_layers.md">Combo Layers</a> pressing 2 layer keys at once opens a different layer</li>
+      </ul>
+    </div>
   </div>
 </template>