Encoder Support in CLI qmk compile

keyboards/handwired/onekey/encodertest/encoder.json

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

keyboards/handwired/onekey/encodertest/no_encoder.json

@@ -0,0 +1,12 @@
+{
+  "keyboard": "handwired/onekey",
+  "keymap": "no_encoder",
+  "layout": "LAYOUT",
+  "layers": [
+    [
+      "KC_ENTER"
+    ]
+  ],
+  "author": "",
+  "notes": ""
+}

lib/python/qmk/cli/compile.py

@@ -29,10 +29,15 @@ def compile(cli):
     command = None
 
     if cli.args.filename:
+
         # 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'])
+
+        # Compile the keymap
         command = compile_configurator_json(user_keymap)
 
         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

@@ -51,12 +51,12 @@ def compile_configurator_json(user_keymap, bootloader=None):
         A command to run to compile and flash the C file.
     """
     # 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.get('keyboard'), user_keymap.get('keymap'), user_keymap.get('layout'), user_keymap.get('layers'), user_keymap.get('encoders'))
 
     # Return a command that can be run to make the keymap and flash if given
     if bootloader is None:
-        return create_make_command(user_keymap['keyboard'], user_keymap['keymap'])
-    return create_make_command(user_keymap['keyboard'], user_keymap['keymap'], bootloader)
+        return create_make_command(user_keymap.get('keyboard'), user_keymap.get('keymap'))
+    return create_make_command(user_keymap.get('keyboard'), user_keymap.get('keymap'), bootloader)
 
 
 def parse_configurator_json(configurator_file):

lib/python/qmk/keymap.py

@@ -18,6 +18,19 @@
 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_code16(_CLOCKWISE_);
+\t\t} else {
+\t\t\ttap_code16(_COUNTER_);
+\t\t}
+\t}
 """
 
 
@@ -48,7 +61,7 @@ def _strip_any(keycode):
     return keycode
 
 
-def generate(keyboard, layout, layers):
+def generate(keyboard, layout, layers, encoders=None):
     """Returns a keymap.c for the specified keyboard, layout, and layers.
 
     Args:
@@ -60,6 +73,9 @@ 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
+            An array of encoders on the keyboard, if any. Each item includes the index and the counter- and clockwise key codes.
     """
     layer_txt = []
 
@@ -74,10 +90,40 @@ def generate(keyboard, layout, layers):
     keymap = '\n'.join(layer_txt)
     keymap_c = template(keyboard)
 
-    return keymap_c.replace('__KEYMAP_GOES_HERE__', keymap)
+    keymap_c = keymap_c.replace('__KEYMAP_GOES_HERE__', keymap)
+
+    encoder_func = ''
+    if encoders:
+        encoders_txt = []
+        for encoder_set in encoders:
+            curr_encoder = ENCODER_IF.replace('_ELIF_', 'if' if encoder_set.get('index') == 0 else 'else if')
+            curr_encoder = curr_encoder.replace('_INDEX_', str(encoder_set.get('index')))
+
+            clockwise = parse_basic_code(encoder_set.get('clockwise'))
+            counter = parse_basic_code(encoder_set.get('counter'))
+
+            curr_encoder = curr_encoder.replace('_CLOCKWISE_', clockwise)
+            curr_encoder = curr_encoder.replace('_COUNTER_', counter)
+
+            encoders_txt.append(curr_encoder)
 
+        encoder_func = '\n'.join(encoders_txt)[:-1]
 
-def write(keyboard, keymap, layout, layers):
+    keymap_c = keymap_c.replace('__ENCODERS_GO_HERE__', encoder_func)
+    return keymap_c
+
+
+def parse_basic_code(keycode):
+    """Performs a simplistic check for a 'basic' keycode. Otherwise it returns 'KC_NO'
+
+    Args:
+        keycode
+            The keycode the user is trying to apply
+    """
+    return keycode if keycode[:2].lower() == 'kc' else 'KC_NO'
+
+
+def write(keyboard, keymap, layout, layers, encoders=None):
     """Generate the `keymap.c` and write it to disk.
 
     Returns the filename written to.
@@ -94,8 +140,11 @@ 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
+            An array of encoders on the keyboard. Each item includes the index and the counter- and clockwise key codes.
     """
-    keymap_c = generate(keyboard, layout, layers)
+    keymap_c = generate(keyboard, layout, layers, encoders)
     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

@@ -13,8 +13,14 @@ def test_cformat():
 
 
 def test_compile():
+    # keyboard compile
     assert check_subcommand('compile', '-kb', 'handwired/onekey/pytest', '-km', 'default').returncode == 0
 
+    # json compile
+    test_json = ['encoder', 'no_encoder']
+    for j in test_json:
+        assert check_subcommand('compile', f'keyboards/handwired/onekey/encodertest/{j}.json').returncode == 0  # with encoder
+
 
 def test_flash():
     assert check_subcommand('flash', '-b').returncode == 1