Update (KinesisCorporation#3)

* Add additional pedal keys Adds pedal2 keys on left and right back into matrix * Fix json files * Remove unnecessary keys from GUI * Provide flashing instructions, point at GUI editor, and format support links. * Refine wording of steps in firmware flashing. * fix: positions and timing --------- Co-authored-by: ReFil <31960031+ReFil@users.noreply.github.com> Co-authored-by: Tom Plunket <tom@mightysprite.com>
duqcyxwd · Apr 24, 2023 · 12b19c4 · 12b19c4
1 parent f0e6ddd
commit 12b19c4
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
 # ADV360-PRO-ZMK
 
-## To build Firmware in GitHub Actions
+## Modifying the keymap
+
+There is a GUI for editing the keymap. It is available at https://kinesiscorporation.github.io/Adv360-Pro-GUI
+
+## Building the Firmware with GitHub Actions
 
 ### Setup
 
@@ -12,19 +16,20 @@
 1. Push a commit to trigger the build.
 2. Download the artifact.
 
-## Local building in a container
+## Building the Firmware in a local container
 
 ### Setup
 
 #### Software
 
-Either Podman or Docker is required, Podman is preferred if both are present.\
-Make is also required
+* Either Podman or Docker is required, Podman is preferred if both are present.
+* Make is also required
 
 #### Windows specific
-If compiling on Windows use WSL2 and Docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).\
-Install make using `sudo apt-get install make`.\
-The repository can be cloned directly into the WSL2 instance or accessed through the C: mount point WSL provides by default (`/mnt/c/path-to-repo`).
+
+* If compiling on Windows use WSL2 and Docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).
+* Install make using `sudo apt-get install make`.
+* The repository can be cloned directly into the WSL2 instance or accessed through the C: mount point WSL provides by default (`/mnt/c/path-to-repo`).
 
 ### Build firmware
 
@@ -39,8 +44,25 @@ The built docker container and compiled firmware files can be deleted with `make
 
 Follow the programming instruction on page 8 of the [Quick Start Guide](https://kinesis-ergo.com/wp-content/uploads/Advantage360-Professional-QSG-v8-25-22.pdf) to flash the firmware.
 
+### briefly
+
+1. Extract the firmwares from the downloaded archive.
+1. Connect the left side keyboard to USB.
+1. Press Mod+macro1 to put the left side into bootloader mode; it should attach to your computer as a USB drive.
+1. Copy `left.uf2` to the USB drive and it will disconnect.
+1. Power off both keyboards (by unplugging them and making sure the switches are off).
+1. Turn on the left side keyboard with the switch.
+1. Connect the right side keyboard to USB to power it on.
+1. Press Mod+macro3 to put the right side into bootloader mode to attach it as a USB drive.
+1. Copy `right.uf2` to the mounted drive.
+1. Unplug the right side keyboard and turn it back on.
+1. Enjoy!
+
+> Note: There are also physical reset buttons on both keyboards which can be used to enter and exit the bootloader mode. Their location is described in section 2.7 on page 9 in the [User Manual](https://kinesis-ergo.com/wp-content/uploads/Advantage360-ZMK-KB360-PRO-Users-Manual-v3-10-23.pdf) and use is described in section 5.9 on page 14. 
+
 ## Other support
 
-Further support resources can be found on Kinesis.com
-https://kinesis-ergo.com/support/kb360pro/#firmware-updates
-https://kinesis-ergo.com/support/kb360pro/#manuals
+Further support resources can be found on Kinesis.com:
+
+* https://kinesis-ergo.com/support/kb360pro/#firmware-updates
+* https://kinesis-ergo.com/support/kb360pro/#manuals
diff --git a/config/adv360.keymap b/config/adv360.keymap
@@ -8,63 +8,63 @@
     combos {
       compatible = "zmk,combos";
       lctrl {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <29 30>;
           bindings = <&kp LCTRL>;
       };
       lalt {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <30 31>;
           bindings = <&kp LALT>;
       };
       lcmd {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <31 32>;
           bindings = <&kp LEFT_COMMAND>;
       };
       laltcmd {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <30 31 32>;
           bindings = <&kp LA(LEFT_COMMAND)>;
       };
       lctrlcmd {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <29 31 32>;
           bindings = <&kp LC(LEFT_COMMAND)>;
       };
       rctrl {
-          timeout-ms = <40>;
-          key-positions = <44 43>;
+          timeout-ms = <60>;
+          key-positions = <46 45>;
           bindings = <&kp RCTRL>;
       };
       ralt {
-          timeout-ms = <40>;
-          key-positions = <43 42>;
+          timeout-ms = <60>;
+          key-positions = <45 44>;
           bindings = <&kp RALT>;
       };
       rcmd {
-          timeout-ms = <40>;
-          key-positions = <42 41>;
+          timeout-ms = <60>;
+          key-positions = <44 43>;
           bindings = <&kp RIGHT_COMMAND>;
       };
       creturn {
-          timeout-ms = <40>;
-          key-positions = <41 43>;
+          timeout-ms = <60>;
+          key-positions = <43 45>;
           bindings = <&kp RETURN>;
       };
       ctab {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <30 32>;
           bindings = <&kp TAB>;
       };
       escr {
-          timeout-ms = <40>;
+          timeout-ms = <60>;
           key-positions = <29 32>;
           bindings = <&kp ESC>;
       };
       eq {
-          timeout-ms = <40>;
-          key-positions = <44 41>;
+          timeout-ms = <60>;
+          key-positions = <46 43>;
           bindings = <&kp EQUAL>;
       };
     };
@@ -82,6 +82,7 @@
       };
     };
 
+
     keymap {
         compatible = "zmk,keymap";
 
@@ -90,7 +91,7 @@
             bindings = <
  &kp EQUAL     &kp N1    &kp N2    &kp N3     &kp N4     &kp N5                    &tog 1      &mo 3      &kp N6           &kp N7         &kp N8     &kp N9     &kp N0  &kp MINUS
  &kp TAB      &kp Q     &kp W     &kp E      &kp R      &kp T                     &none      &none       &kp Y            &kp U          &kp I      &kp O      &kp P   &kp BSLH
- &none      &kp A     &kp S     &kp D      &kp F      &kp G                    &trans  &kp LCTRL    &kp LALT                                   &kp LGUI  &kp RCTRL      &none     &kp H    &kp J        &kp K    &kp L  &kp SEMI    &kp SQT
+ &none      &kp A     &kp S     &kp D      &kp F      &kp G                    &trans  &kp LCTRL    &kp LALT              &none          &none           &kp LGUI  &kp RCTRL      &none     &kp H    &kp J        &kp K    &kp L  &kp SEMI    &kp SQT
  &none      &kp Z     &kp X     &lt 5 C    &lt 1 V      &kp B                     &none      &none    &kp HOME            &none          &none  &kp PG_UP      &none      &none     &kp N  &lt 2 M  &lt 4 COMMA  &kp DOT  &kp FSLH  &none
  &none          &none     &none     &none  &none        &kp SPACE            &kp LEFT_SHIFT    &kp END  &kp RETURN  &kp RIGHT_SHIFT  &kp BACKSPACE     &none   &none   &none  &none    &none
 
@@ -101,7 +102,7 @@
             bindings = <
  &kp EQUAL     &kp N1        &kp N2            &kp N3     &kp N4    &kp N5             &trans      &mo 3     &kp N6  &kp KP_NUM  &kp KP_EQUAL  &kp KP_DIVIDE  &kp KP_MULTIPLY   &kp MINUS
    &kp TAB      &kp Q         &kp W             &kp E      &kp R     &kp T              &none      &none      &kp Y   &kp N7     &kp N8      &kp N9     &kp N0    &kp BSLH
-   &kp ESC      &kp A         &kp S             &kp D      &kp F     &kp G              &none  &kp LCTRL   &kp LALT                                 &kp LGUI        &kp RCTRL       &none     &kp H  &kp N4  &kp N5  &kp N6   &kp KP_PLUS    &kp SQT
+   &kp ESC      &kp A         &kp S             &kp D      &kp F     &kp G              &none  &kp LCTRL   &kp LALT       &none         &none                 &kp LGUI        &kp RCTRL       &none     &kp H  &kp N4  &kp N5  &kp N6   &kp KP_PLUS    &kp SQT
  &kp LSHFT  &kp LCTRL  &kp LEFT_ALT  &kp LEFT_COMMAND      &kp V     &kp B              &none      &none   &kp HOME       &none         &none      &kp PG_UP            &none       &none     &kp N  &kp N1  &kp N2  &kp N3  &kp KP_ENTER  &kp RSHFT
      &mo 2  &kp GRAVE      &kp CAPS          &kp LEFT  &kp RIGHT  &kp SPACE            &kp DEL    &kp END  &kp PG_DN   &kp ENTER     &kp KP_N0         &kp UP         &kp DOWN  &kp KP_DOT  &kp RBKT      &mo 2
             >;
@@ -111,7 +112,7 @@
             bindings = <
  &kp F1          &kp F2             &kp F3                &kp F4                 &kp F5         &kp F6            &tog 1   &mo 3  &kp F7  &kp F8  &kp F9  &kp F10  &kp F11  &kp F12
  &trans  &kp UNDERSCORE  &kp DOUBLE_QUOTES        &kp LEFT_BRACE        &kp RIGHT_BRACE       &kp PIPE             &none   &none  &trans  &trans  &trans   &trans   &trans   &trans
- &trans       &kp MINUS   &kp SINGLE_QUOTE  &kp LEFT_PARENTHESIS  &kp RIGHT_PARENTHESIS  &kp BACKSLASH             &none  &trans  &trans                   &trans   &trans    &none  &trans  &trans  &trans  &trans  &trans  &trans
+ &trans       &kp MINUS   &kp SINGLE_QUOTE  &kp LEFT_PARENTHESIS  &kp RIGHT_PARENTHESIS  &kp BACKSLASH             &none  &trans  &trans   &none   &none             &trans   &trans    &none  &trans  &trans  &trans  &trans  &trans  &trans
  &trans       &kp TILDE          &kp GRAVE      &kp LEFT_BRACKET      &kp RIGHT_BRACKET       &kp PLUS             &none   &none  &trans   &none   &none   &trans    &none    &none  &trans  &trans  &kp LEFT_COMMAND  &kp LALT  &kp LCTRL  &kp LSHFT
  &trans          &trans             &trans                &trans                 &trans         &trans            &trans  &trans  &trans  &trans  &trans   &trans   &trans   &trans  &trans  &trans
             >;
@@ -121,7 +122,7 @@
             bindings = <
   &none  &bt BT_SEL 0  &bt BT_SEL 1  &bt BT_SEL 2  &bt BT_SEL 3     &bt BT_SEL 4                             &none       &trans  &bt BT_SEL 0  &bt BT_SEL 1     &bt BT_SEL 2  &bt BT_SEL 3  &bt BT_SEL 4                   &none
   &none         &none         &none         &none         &none            &none                       &bootloader  &bootloader         &none         &none            &none         &none         &none                   &none
-  &none         &none         &none         &none         &none            &none            &rgb_ug RGB_MEFS_CMD 5   &bt BT_CLR         &none                                   &bt BT_CLR    &bt BT_CLR  &rgb_ug RGB_MEFS_CMD 5   &none   &none   &none   &none   &none   &none
+  &none         &none         &none         &none         &none            &none            &rgb_ug RGB_MEFS_CMD 5   &bt BT_CLR         &none         &none            &none              &bt BT_CLR    &bt BT_CLR  &rgb_ug RGB_MEFS_CMD 5   &none   &none   &none   &none   &none   &none
   &none         &none         &none         &none         &none            &none                             &none        &none         &none         &none            &none         &none         &none                   &none   &none   &none   &none   &none   &none   &none
   &none         &none         &none    &bl BL_INC    &bl BL_DEC  &rgb_ug RGB_TOG                        &bl BL_TOG        &none         &none    &bl BL_TOG  &rgb_ug RGB_TOG    &bl BL_INC    &bl BL_DEC                   &none   &none   &none
             >;
@@ -131,7 +132,7 @@
             bindings = <
  &trans  &trans           &trans       &trans     &trans  &trans            &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
  &trans  &trans    &kp AMPERSAND     &kp STAR      &none  &trans            &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
- &trans  &trans       &kp DOLLAR  &kp PERCENT  &kp CARET  &trans            &trans  &trans  &trans                  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
+ &trans  &trans       &kp DOLLAR  &kp PERCENT  &kp CARET  &trans            &trans  &trans  &trans  &trans  &trans              &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
  &trans  &trans  &kp EXCLAMATION  &kp AT_SIGN   &kp HASH  &trans            &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
  &trans  &trans           &trans       &trans     &trans  &trans            &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans  &trans
             >;
@@ -141,7 +142,7 @@
             bindings = <
         &kp F1 &kp F2 &kp F3 &kp F4 &kp F5 &kp F6  &trans                                                     &trans &kp F7 &kp F8 &kp F9 &kp F10 &kp F11 &kp F12
         &trans &trans &trans &trans &trans &trans  &none                                                       &none &trans &trans &trans &trans  &trans  &trans
-        &trans &trans &trans &trans &trans &trans  &none        &trans &trans             &trans &trans        &none &trans &kp EQUAL &kp GT &kp COLON  &trans  &trans
+        &trans &trans &trans &trans &trans &trans  &none        &trans &trans &none &none          &trans &trans        &none &trans &kp EQUAL &kp GT &kp COLON  &trans  &trans
         &trans &trans &trans &trans &trans &trans        &none  &none  &trans &none &none &trans &none  &none        &trans &kp LT    &kp GT &kp SLASH  &trans  &trans
         &trans &trans &trans &trans &trans               &trans &trans &trans             &trans &trans &trans              &trans &trans &trans  &trans  &trans
             >;

diff --git a/config/boards/arm/adv360/adv360.dtsi b/config/boards/arm/adv360/adv360.dtsi
@@ -36,7 +36,7 @@
 					map = <
 			RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5)  RC(4,6) 																																						RC(4,15) RC(4,16) RC(4,17) RC(4,18) RC(4,19) RC(4,20) RC(4,21)
 			RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5)  RC(3,6) 																																						RC(3,15) RC(3,16) RC(3,17) RC(3,18) RC(3,19) RC(3,20) RC(3,21)
-			RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)  RC(2,6)           RC(2,8)	RC(2,9)  										 RC(2,12) RC(2,13)      	  RC(2,15) RC(2,16) RC(2,17) RC(2,18) RC(2,19) RC(2,20) RC(2,21)
+			RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)  RC(2,6)           RC(2,8)	RC(2,9)  			RC(2,10) RC(2,11)							 RC(2,12) RC(2,13)      	  RC(2,15) RC(2,16) RC(2,17) RC(2,18) RC(2,19) RC(2,20) RC(2,21)
 			RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)  				  RC(1,7)  RC(1,8)	RC(1,9)  RC(1,10)		RC(1,11) RC(1,12) RC(1,13) RC(1,14)					 RC(1,16) RC(1,17) RC(1,18) RC(1,19) RC(1,20) RC(1,21)
 			RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) 								  RC(0,7)  RC(0,8)  RC(0,9)										   RC(0,12) RC(0,13) RC(0,14)								 	  RC(0,17) RC(0,18) RC(0,19) RC(0,20) RC(0,21)
 

diff --git a/config/info.json b/config/info.json
@@ -42,6 +42,8 @@
         { "label": "mod5", "row": 2, "col": 6, "x": 6.25, "y": 2},
         { "label": "LCtrl", "row": 2, "col": 7, "x": 6.75, "y": 4, "r":15, "rx":5.25 ,"ry":4},
         { "label": "LAlt", "row": 2, "col": 8, "x": 7.75, "y": 4, "r":15, "rx":5.25 ,"ry":4},
+        { "label": "Ped1", "row": 2, "col": 9, "x": 6.75, "y": 5, "r":15, "rx":5.25 ,"ry":4, "h":0},
+        { "label": "Ped2", "row": 2, "col": 10, "x": 10.25, "y": 5, "r":-15, "rx":12.75 ,"ry":4, "h":0},
         { "label": "LGui", "row": 2, "col": 11, "x": 9.25, "y": 4, "r":-15, "rx":12.75 ,"ry":4},
         { "label": "RCtrl", "row": 2, "col": 12, "x": 10.25, "y": 4, "r":-15, "rx":12.75 ,"ry":4},
         { "label": "mod6", "row": 2, "col": 13, "x": 10.75, "y": 2},
@@ -61,8 +63,8 @@
         { "label": "1U1", "row": 3, "col": 6, "x": 5.75, "y": 5, "r":15, "rx":5.25 ,"ry":4, "h":0},
         { "label": "1U2", "row": 3, "col": 7, "x": 6.75, "y": 5, "r":15, "rx":5.25 ,"ry":4, "h":0},
         { "label": "Home", "row": 3, "col": 8, "x": 7.75, "y": 5, "r":15, "rx":5.25 ,"ry":4},
-        { "label": "Ped3", "row": 3, "col": 9, "x": 20, "y": 5},
-        { "label": "Ped4", "row": 3, "col": 10, "x": 21, "y": 5},
+        { "label": "Ped3", "row": 3, "col": 9, "x": 6.75, "y": 5, "r":15, "rx":5.25 ,"ry":4, "h":0},
+        { "label": "Ped4", "row": 3, "col": 10, "x": 10.25, "y": 5, "r":-15, "rx":12.75 ,"ry":4, "h":0},
         { "label": "PgUp", "row": 3, "col": 11, "x": 9.25, "y": 5, "r":-15, "rx":12.75 ,"ry":4},
         { "label": "1U3", "row": 3, "col": 12, "x": 10.25, "y": 5, "r":-15, "rx":12.75 ,"ry":4, "h":0},
         { "label": "1U4", "row": 3, "col": 13, "x": 11.25, "y": 5, "r":-15, "rx":12.75 ,"ry":4, "h":0},