format code according to conventions [skip ci]

A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename].

A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders.

If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.

docs/cli.md

@@ -95,6 +95,30 @@ qmk compile <configuratorExport.json>
 qmk compile -kb <keyboard_name> -km <keymap_name>
 ```
 
+## `qmk flash`
+
+This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default.
+To specify a different bootloader, use `-bl <bootloader>`. Visit <https://docs.qmk.fm/#/flashing>
+for more details of the available bootloaders.
+
+**Usage for Configurator Exports**:
+
+```
+qmk flash <configuratorExport.json> -bl <bootloader>
+```
+
+**Usage for Keymaps**:
+
+```
+qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
+```
+
+**Listing the Bootloaders**
+
+```
+qmk flash -b
+```
+
 ## `qmk config`
 
 This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md).

keyboards/crkbd/rev1/matrix.c

@@ -133,9 +133,8 @@ void rx_led_off(void)
 
 void matrix_init(void)
 {
-    debug_enable = true;
-    debug_matrix = true;
-    debug_mouse = true;
+    split_keyboard_setup();
+
     // initialize row and col
     unselect_rows();
     init_cols();

keyboards/crkbd/rev1/split_util.c

@@ -7,6 +7,11 @@
 #include "split_util.h"
 #include "matrix.h"
 #include "keyboard.h"
+#include "wait.h"
+
+#ifdef EE_HANDS
+#    include "eeconfig.h"
+#endif
 
 #ifdef USE_MATRIX_I2C
 #  include "i2c.h"
@@ -14,19 +19,59 @@
 #  include "split_scomm.h"
 #endif
 
+#ifndef SPLIT_USB_TIMEOUT
+#    define SPLIT_USB_TIMEOUT 2500
+#endif
+
 volatile bool isLeftHand = true;
 
-static void setup_handedness(void) {
-  #ifdef EE_HANDS
-    isLeftHand = eeprom_read_byte(EECONFIG_HANDEDNESS);
-  #else
-    // I2C_MASTER_RIGHT is deprecated, use MASTER_RIGHT instead, since this works for both serial and i2c
-    #if defined(I2C_MASTER_RIGHT) || defined(MASTER_RIGHT)
-      isLeftHand = !has_usb();
-    #else
-      isLeftHand = has_usb();
-    #endif
-  #endif
+bool waitForUsb(void) {
+    for (uint8_t i = 0; i < (SPLIT_USB_TIMEOUT / 100); i++) {
+        // This will return true of a USB connection has been established
+        if (UDADDR & _BV(ADDEN)) {
+            return true;
+        }
+        wait_ms(100);
+    }
+
+    // Avoid NO_USB_STARTUP_CHECK - Disable USB as the previous checks seem to enable it somehow
+    (USBCON &= ~(_BV(USBE) | _BV(OTGPADE)));
+
+    return false;
+}
+
+__attribute__((weak)) bool is_keyboard_left(void) {
+#if defined(SPLIT_HAND_PIN)
+    // Test pin SPLIT_HAND_PIN for High/Low, if low it's right hand
+    setPinInput(SPLIT_HAND_PIN);
+    return readPin(SPLIT_HAND_PIN);
+#elif defined(EE_HANDS)
+    return eeconfig_read_handedness();
+#elif defined(MASTER_RIGHT)
+    return !is_keyboard_master();
+#endif
+
+    return is_keyboard_master();
+}
+
+__attribute__((weak)) bool is_keyboard_master(void) {
+    static enum { UNKNOWN, MASTER, SLAVE } usbstate = UNKNOWN;
+
+    // only check once, as this is called often
+    if (usbstate == UNKNOWN) {
+#if defined(SPLIT_USB_DETECT)
+        usbstate = waitForUsb() ? MASTER : SLAVE;
+#elif defined(__AVR__)
+        USBCON |= (1 << OTGPADE);  // enables VBUS pad
+        wait_us(5);
+
+        usbstate = (USBSTA & (1 << VBUS)) ? MASTER : SLAVE;  // checks state of VBUS
+#else
+        usbstate = MASTER;
+#endif
+    }
+
+    return (usbstate == MASTER);
 }
 
 static void keyboard_master_setup(void) {
@@ -47,14 +92,9 @@ static void keyboard_slave_setup(void) {
 #endif
 }
 
-bool has_usb(void) {
-   USBCON |= (1 << OTGPADE); //enables VBUS pad
-   _delay_us(5);
-   return (USBSTA & (1<<VBUS));  //checks state of VBUS
-}
-
+// this code runs before the usb and keyboard is initialized
 void split_keyboard_setup(void) {
-   setup_handedness();
+    isLeftHand = is_keyboard_left();
 
    if (has_usb()) {
       keyboard_master_setup();
@@ -64,7 +104,7 @@ void split_keyboard_setup(void) {
    sei();
 }
 
-// this code runs before the usb and keyboard is initialized
-void matrix_setup(void) {
-    split_keyboard_setup();
+// backwards compat
+bool has_usb(void) {
+   return is_keyboard_master();
 }

layouts/community/ortho_4x12/jotix/keymap.c

@@ -32,9 +32,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 // ┌───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┐
     KC_GRV, KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,   _______,
 // ├───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤
-    _______,KC_VOLD,KC_MUTE,KC_VOLU,KC_MINS, KC_EQL,KC_LBRC,KC_RBRC,_______,_______,_______,_______,
+    _______,KC_VOLD,KC_MUTE,KC_VOLU,KC_MINS, KC_EQL,KC_MS_L,KC_MS_D,KC_MS_U,KC_MS_R,_______,_______,
 // ├───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤
-    _______,KC_MPRV,KC_MPLY,KC_MNXT,KC_UNDS,KC_PLUS,KC_LCBR,KC_RCBR,_______,_______,_______,_______,
+    _______,KC_MPRV,KC_MPLY,KC_MNXT,KC_UNDS,KC_PLUS,KC_BTN1,KC_BTN2,_______,_______,_______,_______,
 // ├───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤
     _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______
 // └───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┘

lib/python/qmk/cli/__init__.py

@@ -7,6 +7,7 @@ from . import compile
 from . import config
 from . import docs
 from . import doctor
+from . import flash
 from . import hello
 from . import json
 from . import list

lib/python/qmk/cli/compile.py

@@ -9,6 +9,9 @@ import subprocess
 from argparse import FileType
 
 from milc import cli
+from qmk.commands import create_make_command
+from qmk.commands import parse_configurator_json
+from qmk.commands import compile_configurator_json
 
 import qmk.keymap
 import qmk.path
@@ -30,20 +33,20 @@ def compile(cli):
     """
     if cli.args.filename:
         # Parse the configurator json
-        user_keymap = json.load(cli.args.filename)
+        user_keymap = parse_configurator_json(cli.args.filename)
 
         # Generate the keymap
         keymap_path = qmk.path.keymap(user_keymap['keyboard'])
         cli.log.info('Creating {fg_cyan}%s{style_reset_all} keymap in {fg_cyan}%s', user_keymap['keymap'], keymap_path)
-        qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers'])
-        cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
 
         # Compile the keymap
-        command = ['make', ':'.join((user_keymap['keyboard'], user_keymap['keymap']))]
+        command = compile_configurator_json(cli.args.filename)
+
+        cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
 
     elif cli.config.compile.keyboard and cli.config.compile.keymap:
         # Generate the make command for a specific keyboard/keymap.
-        command = ['make', ':'.join((cli.config.compile.keyboard, cli.config.compile.keymap))]
+        command = create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap)
 
     else:
         cli.log.error('You must supply a configurator export or both `--keyboard` and `--keymap`.')

lib/python/qmk/cli/flash.py

@@ -0,0 +1,88 @@
+"""Compile and flash QMK Firmware
+
+You can compile a keymap already in the repo or using a QMK Configurator export.
+A bootloader must be specified.
+"""
+import os
+import sys
+import subprocess
+from argparse import FileType
+
+from milc import cli
+from qmk.commands import create_make_command
+from qmk.commands import parse_configurator_json
+from qmk.commands import compile_configurator_json
+
+import qmk.path
+
+
+def print_bootloader_help():
+    """Prints the available bootloaders listed in docs.qmk.fm.
+    """
+    cli.log.info('Here are the available bootloaders:')
+    cli.echo('\tdfu')
+    cli.echo('\tdfu-ee')
+    cli.echo('\tdfu-split-left')
+    cli.echo('\tdfu-split-right')
+    cli.echo('\tavrdude')
+    cli.echo('\tBootloadHID')
+    cli.echo('\tdfu-util')
+    cli.echo('\tdfu-util-split-left')
+    cli.echo('\tdfu-util-split-right')
+    cli.echo('\tst-link-cli')
+    cli.echo('For more info, visit https://docs.qmk.fm/#/flashing')
+
+
+@cli.argument('-bl', '--bootloader', default='flash', help='The flash command, corresponding to qmk\'s make options of bootloaders.')
+@cli.argument('filename', nargs='?', arg_only=True, help='The configurator export JSON to compile. Use this if you dont want to specify a keymap and keyboard.')
+@cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Use this if you dont have a configurator file. Ignored when a configurator file is supplied.')
+@cli.argument('-kb', '--keyboard', help='The keyboard to build a firmware for. Use this if you dont have a configurator file. Ignored when a configurator file is supplied.')
+@cli.argument('-b', '--bootloaders', action='store_true', help='List the available bootloaders.')
+@cli.subcommand('QMK Flash.')
+def flash(cli):
+    """Compile and or flash QMK Firmware or keyboard/layout
+
+    If a Configurator JSON export is supplied this command will create a new keymap. Keymap and Keyboard arguments
+    will be ignored.
+
+    If no file is supplied, keymap and keyboard are expected.
+
+    If bootloader is omitted, the one according to the rules.mk will be used.
+
+    """
+    command = []
+    if cli.args.bootloaders:
+        # Provide usage and list bootloaders
+        cli.echo('usage: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename]')
+        print_bootloader_help()
+        return False
+
+    elif cli.args.keymap and not cli.args.keyboard:
+        # If only a keymap was given but no keyboard, suggest listing keyboards
+        cli.echo('usage: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename]')
+        cli.log.error('run \'qmk list_keyboards\' to find out the supported keyboards')
+        return False
+
+    elif cli.args.filename:
+        # Get keymap path to log info
+        user_keymap = parse_configurator_json(cli.args.filename)
+        keymap_path = qmk.path.keymap(user_keymap['keyboard'])
+
+        cli.log.info('Creating {fg_cyan}%s{style_reset_all} keymap in {fg_cyan}%s', user_keymap['keymap'], keymap_path)
+
+        # Convert the JSON into a C file and write it to disk.
+        command = compile_configurator_json(cli.args.filename, cli.args.bootloader)
+
+        cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
+
+    elif cli.args.keyboard and cli.args.keymap:
+        # Generate the make command for a specific keyboard/keymap.
+        command = create_make_command(cli.config.flash.keyboard, cli.config.flash.keymap, cli.args.bootloader)
+
+    else:
+        cli.echo('usage: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename]')
+        cli.log.error('You must supply a configurator export or both `--keyboard` and `--keymap`. You can also specify a bootloader with --bootloader. Use --bootloaders to list the available bootloaders.')
+        return False
+
+    cli.log.info('Flashing keymap with {fg_cyan}%s\n\n', ' '.join(command))
+    subprocess.run(command)

lib/python/qmk/commands.py

@@ -0,0 +1,59 @@
+"""Functions that build make commands
+"""
+import json
+import qmk.keymap
+
+
+def create_make_command(keyboard, keymap, target=None):
+    """Create a make compile command
+
+    Args:
+        keyboard
+            The path of the keyboard, for example 'plank'
+
+        keymap
+            The name of the keymap, for example 'algernon'
+
+        target
+            Usually a bootloader.
+
+    Returns:
+        A command that can be run to make the specified keyboard and keymap
+    """
+    if target is None:
+        return ['make', ':'.join((keyboard, keymap))]
+    return ['make', ':'.join((keyboard, keymap, target))]
+
+
+def parse_configurator_json(configurator_filename):
+    """Open and parse a configurator json export
+    """
+    file = open(configurator_filename)
+    user_keymap = json.load(file)
+    file.close()
+    return user_keymap
+
+
+def compile_configurator_json(configurator_filename, bootloader=None):
+    """Convert a configurator export JSON file into a C file
+
+    Args:
+        configurator_filename
+            The configurator JSON export file
+
+        bootloader
+            A bootloader to flash
+
+    Returns:
+        A command to run to compile and flash the C file.
+    """
+    # Parse the configurator json
+    user_keymap = parse_configurator_json(configurator_filename)
+
+    # Write the keymap C file
+    qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers'])
+
+    # 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)

lib/python/qmk/tests/test_cli_commands.py

@@ -14,6 +14,11 @@ def test_compile():
     assert check_subcommand('compile', '-kb', 'handwired/onekey/pytest', '-km', 'default').returncode == 0
 
 
+def test_flash():
+    assert check_subcommand('flash', '-b').returncode == 1
+    assert check_subcommand('flash').returncode == 1
+
+
 def test_config():
     result = check_subcommand('config')
     assert result.returncode == 0

quantum/encoder.c

@@ -38,14 +38,15 @@ static pin_t encoders_pad_b[] = ENCODERS_PAD_B;
 static int8_t encoder_LUT[] = {0, -1, 1, 0, 1, 0, 0, -1, -1, 0, 0, 1, 0, 1, -1, 0};
 
 static uint8_t encoder_state[NUMBER_OF_ENCODERS] = {0};
+static int8_t encoder_pulses[NUMBER_OF_ENCODERS] = {0};
 
 #ifdef SPLIT_KEYBOARD
 // right half encoders come over as second set of encoders
-static int8_t encoder_value[NUMBER_OF_ENCODERS * 2] = {0};
+static uint8_t encoder_value[NUMBER_OF_ENCODERS * 2] = {0};
 // row offsets for each hand
 static uint8_t thisHand, thatHand;
 #else
-static int8_t encoder_value[NUMBER_OF_ENCODERS] = {0};
+static uint8_t encoder_value[NUMBER_OF_ENCODERS] = {0};
 #endif
 
 __attribute__((weak)) void encoder_update_user(int8_t index, bool clockwise) {}
@@ -78,14 +79,16 @@ void encoder_init(void) {
 }
 
 static void encoder_update(int8_t index, uint8_t state) {
-    encoder_value[index] += encoder_LUT[state & 0xF];
-    if (encoder_value[index] >= ENCODER_RESOLUTION) {
-        encoder_update_kb(index, false);
-    }
-    if (encoder_value[index] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise
+    encoder_pulses[index] += encoder_LUT[state & 0xF];
+    if (encoder_pulses[index] >= ENCODER_RESOLUTION) {
+        encoder_value[index]++;
         encoder_update_kb(index, true);
     }
-    encoder_value[index] %= ENCODER_RESOLUTION;
+    if (encoder_pulses[index] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise
+        encoder_value[index]--;
+        encoder_update_kb(index, false);
+    }
+    encoder_pulses[index] %= ENCODER_RESOLUTION;
 }
 
 void encoder_read(void) {
@@ -101,11 +104,22 @@ void encoder_read(void) {
 }
 
 #ifdef SPLIT_KEYBOARD
-void encoder_state_raw(uint8_t* slave_state) { memcpy(slave_state, encoder_state, sizeof(encoder_state)); }
+void encoder_state_raw(uint8_t* slave_state) { memcpy(slave_state, &encoder_value[thisHand], sizeof(uint8_t) * NUMBER_OF_ENCODERS); }
 
 void encoder_update_raw(uint8_t* slave_state) {
     for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
-        encoder_update(i + thatHand, slave_state[i]);
+        uint8_t index = i + thatHand;
+        int8_t delta = slave_state[i] - encoder_value[index];
+        while (delta > 0) {
+            delta--;
+            encoder_value[index]++;
+            encoder_update_kb(index, true);
+        }
+        while (delta < 0) {
+            delta++;
+            encoder_value[index]--;
+            encoder_update_kb(index, false);
+        }
     }
 }
 #endif