mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-11 14:40:06 +00:00
897888db41
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.
57 lines
1.7 KiB
Python
57 lines
1.7 KiB
Python
"""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)
|
|
|