Encoder Support in CLI qmk compile

keyboards/handwired/onekey/pytest/keymap.json

@@ -0,0 +1,19 @@
+{
+  "keyboard": "handwired/onekey/pytest",
+  "keymap": "pytest",
+  "layout": "LAYOUT",
+  "layers": [
+    [
+      "KC_ENTER"
+    ]
+  ],
+  "author": "",
+  "notes": "",
+  "encoders": [
+    {
+      "index": 0,
+      "clockwise": "KC_UP",
+      "counter": "KC_DOWN"
+    }
+  ]
+}

lib/python/qmk/cli/compile.py

@@ -12,9 +12,10 @@
 from qmk.commands import compile_configurator_json, create_make_command, parse_configurator_json
 
 
-@cli.argument('filename', nargs='?', arg_only=True, type=FileType('r'), help='The configurator export to compile')
+@cli.argument('filename', nargs='?', type=FileType('r'), help='The configurator export to compile')
 @cli.argument('-kb', '--keyboard', help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
 @cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.argument('-x', '--experimental', action='store_true', help='True enables encoder support for configurator export files. Only enabled when a configurator export is supplied.')
 @cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually build, just show the make command to be run.")
 @cli.subcommand('Compile a QMK Firmware.')
 @automagic_keyboard
@@ -29,11 +30,20 @@ def compile(cli):
     command = None
 
     if cli.args.filename:
+
+        # Warn the user if they are using experimental mode
+        if cli.args.experimental:
+            cli.log.info("{fg_yellow}Compiling in experimental mode! I hope you know what you're doing...")
+
         # If a configurator JSON was provided generate a keymap and compile it
         # FIXME(skullydazed): add code to check and warn if the keymap already exists when compiling a json keymap.
+
+        # Parse the configurator json
         user_keymap = parse_configurator_json(cli.args.filename)
         keymap_path = qmk.path.keymap(user_keymap['keyboard'])
-        command = compile_configurator_json(user_keymap)
+
+        # Compile the keymap
+        command = compile_configurator_json(user_keymap, experimental=cli.args.experimental)
 
         cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
 

lib/python/qmk/cli/flash.py

@@ -61,7 +61,9 @@ def flash(cli):
         # Handle compiling a configurator JSON
         user_keymap = parse_configurator_json(cli.args.filename)
         keymap_path = qmk.path.keymap(user_keymap['keyboard'])
-        command = compile_configurator_json(user_keymap, cli.args.bootloader)
+
+        # Convert the JSON into a C file and write it to disk.
+        command = compile_configurator_json(user_keymap, bootloader=cli.args.bootloader)
 
         cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
 

lib/python/qmk/commands.py

@@ -31,7 +31,7 @@ def create_make_command(keyboard, keymap, target=None):
     return ['make', ':'.join(make_args)]
 
 
-def compile_configurator_json(user_keymap, bootloader=None):
+def compile_configurator_json(user_keymap, bootloader=None, experimental=False):
     """Convert a configurator export JSON file into a C file
 
     Args:
@@ -42,12 +42,18 @@ def compile_configurator_json(user_keymap, bootloader=None):
         bootloader
             A bootloader to flash
 
+        experimental
+            True if the user wants to attempt compilation with encoder support.
+
     Returns:
 
         A command to run to compile and flash the C file.
     """
+    # Find the encoders, if any
+    encoders = None if 'encoders' not in user_keymap.keys() else user_keymap['encoders']
+
     # Write the keymap C file
-    qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers'])
+    qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers'], encoders, experimental)
 
     # Return a command that can be run to make the keymap and flash if given
     if bootloader is None:

lib/python/qmk/keymap.py

@@ -20,8 +20,34 @@
 };
 """
 
+DEFAULT_KEYMAP_ENCODERS_C = """#include QMK_KEYBOARD_H
 
-def template(keyboard):
+/* THIS FILE WAS GENERATED AND IS EXPERIMENTAL!
+ *
+ * This file was generated by qmk-compile-json. You may or may not want to
+ * edit it directly.
+ */
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+__KEYMAP_GOES_HERE__
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+__ENCODERS_GO_HERE__
+};
+"""
+
+ENCODER_IF = """\t_ELIF_ (index == _INDEX_) {
+\t\tif (clockwise) {
+\t\t\ttap_code(_CLOCKWISE_);
+\t\t} else {
+\t\t\ttap_code(_COUNTER_);
+\t\t}
+\t}
+"""
+
+
+def template(keyboard, experimental=False):
     """Returns the `keymap.c` template for a keyboard.
 
     If a template exists in `keyboards/<keyboard>/templates/keymap.c` that
@@ -30,16 +56,21 @@ def template(keyboard):
     Args:
         keyboard
             The keyboard to return a template for.
+
+        experimental
+            True if the user wants to attempt compilation with encoder support
     """
     template_file = Path('keyboards/%s/templates/keymap.c' % keyboard)
 
     if template_file.exists():
         return template_file.read_text()
 
+    if experimental:
+        return DEFAULT_KEYMAP_ENCODERS_C
     return DEFAULT_KEYMAP_C
 
 
-def generate(keyboard, layout, layers):
+def generate(keyboard, layout, layers, encoders=None, experimental=False):
     """Returns a keymap.c for the specified keyboard, layout, and layers.
 
     Args:
@@ -51,6 +82,13 @@ def generate(keyboard, layout, layers):
 
         layers
             An array of arrays describing the keymap. Each item in the inner array should be a string that is a valid QMK keycode.
+
+        encoders
+            EXPERIMENTAL
+            An array of encoders on the keyboard. Each item includes the index and the counter- and clockwise key codes.
+
+        experimental
+            True if the user wants to attempt compilation with encoder support
     """
     layer_txt = []
     for layer_num, layer in enumerate(layers):
@@ -60,12 +98,32 @@ def generate(keyboard, layout, layers):
         layer_txt.append('\t[%s] = %s(%s)' % (layer_num, layout, layer_keys))
 
     keymap = '\n'.join(layer_txt)
-    keymap_c = template(keyboard)
+    keymap_c = template(keyboard, experimental)
 
-    return keymap_c.replace('__KEYMAP_GOES_HERE__', keymap)
+    keymap_c = keymap_c.replace('__KEYMAP_GOES_HERE__', keymap)
 
+    if experimental:
+        encoder_function = ''
+        if encoders is not None:
+            encoders_txt = []
+            for encoder_set in encoders:
+                elif_str = "else if"
+                if encoder_set['index'] == 0:
+                    elif_str = "if"
 
-def write(keyboard, keymap, layout, layers):
+                curr_encoder = ENCODER_IF.replace('_ELIF_', elif_str)
+                curr_encoder = curr_encoder.replace('_INDEX_', str(encoder_set['index']))
+                curr_encoder = curr_encoder.replace('_CLOCKWISE_', encoder_set['clockwise'])
+                curr_encoder = curr_encoder.replace('_COUNTER_', encoder_set['counter'])
+                encoders_txt.append(curr_encoder)
+            encoder_function = '\n'.join(encoders_txt)
+
+        keymap_c = keymap_c.replace('__ENCODERS_GO_HERE__', encoder_function)
+
+    return keymap_c
+
+
+def write(keyboard, keymap, layout, layers, encoders=None, experimental=False):
     """Generate the `keymap.c` and write it to disk.
 
     Returns the filename written to.
@@ -82,8 +140,15 @@ def write(keyboard, keymap, layout, layers):
 
         layers
             An array of arrays describing the keymap. Each item in the inner array should be a string that is a valid QMK keycode.
+
+        encoders
+            EXPERIMENTAL
+            An array of encoders on the keyboard. Each item includes the index and the counter- and clockwise key codes.
+
+        experimental
+            True if the user wants to attempt compilation with encoder support
     """
-    keymap_c = generate(keyboard, layout, layers)
+    keymap_c = generate(keyboard, layout, layers, encoders, experimental)
     keymap_file = qmk.path.keymap(keyboard) / keymap / 'keymap.c'
 
     keymap_file.parent.mkdir(parents=True, exist_ok=True)

lib/python/qmk/tests/test_cli_commands.py

@@ -1,4 +1,5 @@
 import subprocess
+import os
 
 
 def check_subcommand(command, *args):
@@ -13,6 +14,13 @@ def test_cformat():
 
 def test_compile():
     assert check_subcommand('compile', '-kb', 'handwired/onekey/pytest', '-km', 'default').returncode == 0
+    assert check_subcommand('compile', 'keyboards/handwired/onekey/pytest/keymap.json').returncode == 0
+    assert check_subcommand('compile', 'keyboards/handwired/onekey/pytest/keymap.json', '-x').returncode == 0
+
+    # Cleanup
+    test_output = 'keyboards/handwired/onekey/keymaps/pytest/keymap.c'
+    if os.path.exists(test_output):
+        os.remove(test_output)
 
 
 def test_flash():