diff options
Diffstat (limited to 'lib/python')
| -rw-r--r-- | lib/python/qmk/cli/__init__.py | 1 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/compile.py | 14 | ||||
| -rw-r--r-- | lib/python/qmk/cli/flash.py | 87 | ||||
| -rw-r--r-- | lib/python/qmk/commands.py | 57 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_cli_commands.py | 3 | 
5 files changed, 157 insertions, 5 deletions
| diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py index 1b83e78c70..72ee38f562 100644 --- a/lib/python/qmk/cli/__init__.py +++ b/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 diff --git a/lib/python/qmk/cli/compile.py b/lib/python/qmk/cli/compile.py index 6646891b30..c7093d4215 100755 --- a/lib/python/qmk/cli/compile.py +++ b/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,21 @@ 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']) +         +        # Compile the 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']) -        # Compile the keymap -        command = ['make', ':'.join((user_keymap['keyboard'], 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`.') diff --git a/lib/python/qmk/cli/flash.py b/lib/python/qmk/cli/flash.py new file mode 100644 index 0000000000..8f7bb55a22 --- /dev/null +++ b/lib/python/qmk/cli/flash.py @@ -0,0 +1,87 @@ +"""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') + [email protected]('-bl', '--bootloader', default='flash', help='The flash command, corresponding to qmk\'s make options of bootloaders.') [email protected]('filename', nargs='?', arg_only=True, help='The configurator export JSON to compile. Use this if you dont want to specify a keymap and keyboard.') [email protected]('-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.') [email protected]('-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.') [email protected]('-b', '--bootloaders', action='store_true', help='List the available bootloaders.') [email protected]('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)
\ No newline at end of file diff --git a/lib/python/qmk/commands.py b/lib/python/qmk/commands.py new file mode 100644 index 0000000000..9fbf00f165 --- /dev/null +++ b/lib/python/qmk/commands.py @@ -0,0 +1,57 @@ +"""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) + diff --git a/lib/python/qmk/tests/test_cli_commands.py b/lib/python/qmk/tests/test_cli_commands.py index 85d4d91af1..dcab8bdae4 100644 --- a/lib/python/qmk/tests/test_cli_commands.py +++ b/lib/python/qmk/tests/test_cli_commands.py @@ -13,6 +13,9 @@ def test_cformat():  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') | 
