Something went wrong. Try again.
keyboard stuff
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160"""Generate a keymap.c from a configurator export."""import jsonimport re
from milc import cli
import qmk.keyboardimport qmk.pathfrom qmk.info import info_jsonfrom qmk.json_encoders import KeymapJSONEncoderfrom qmk.commands import dump_linesfrom qmk.keymap import generate_json
def _find_via_layout_macro(keyboard_data): """Assume layout macro when only 1 is available """ layouts = list(keyboard_data['layouts'].keys()) return layouts[0] if len(layouts) == 1 else None
def _convert_macros(via_macros): via_macros = list(filter(lambda f: bool(f), via_macros)) if len(via_macros) == 0: return list() split_regex = re.compile(r'(}\,)|(\,{)') macro_group_regex = re.compile(r'({.+?})') macros = list() for via_macro in via_macros: # Split VIA macro to its elements macro = split_regex.split(via_macro) # Remove junk elements (None, '},' and ',{') macro = list(filter(lambda f: False if f in (None, '},', ',{') else True, macro)) macro_data = list() for m in macro: if '{' in m or '}' in m: # Split macro groups macro_groups = macro_group_regex.findall(m) for macro_group in macro_groups: # Remove whitespaces and curly braces from around group macro_group = macro_group.strip(' {}')
macro_action = 'tap' macro_keycodes = []
if macro_group[0] == '+': macro_action = 'down' macro_keycodes.append(macro_group[1:]) elif macro_group[0] == '-': macro_action = 'up' macro_keycodes.append(macro_group[1:]) else: macro_keycodes.extend(macro_group.split(',') if ',' in macro_group else [macro_group])
# Remove the KC prefixes macro_keycodes = list(map(lambda s: s.replace('KC_', ''), macro_keycodes))
macro_data.append({"action": macro_action, "keycodes": macro_keycodes}) else: # Found text macro_data.append(m) macros.append(macro_data)
return macros
def _fix_macro_keys(keymap_data): macro_no = re.compile(r'MACRO0?\(([0-9]{1,2})\)') for i in range(0, len(keymap_data)): for j in range(0, len(keymap_data[i])): kc = keymap_data[i][j] m = macro_no.match(kc) if m: keymap_data[i][j] = f'MC_{m.group(1)}' return keymap_data
def _via_to_keymap(via_backup, keyboard_data, keymap_layout): # Check if passed LAYOUT is correct layout_data = keyboard_data['layouts'].get(keymap_layout) if not layout_data: cli.log.error(f'LAYOUT macro {keymap_layout} is not a valid one for keyboard {cli.args.keyboard}!') return None
layout_data = layout_data['layout'] sorting_hat = list() for index, data in enumerate(layout_data): sorting_hat.append([index, data['matrix']])
sorting_hat.sort(key=lambda k: (k[1][0], k[1][1]))
pos = 0 for row_num in range(0, keyboard_data['matrix_size']['rows']): for col_num in range(0, keyboard_data['matrix_size']['cols']): if pos >= len(sorting_hat) or sorting_hat[pos][1][0] != row_num or sorting_hat[pos][1][1] != col_num: sorting_hat.insert(pos, [None, [row_num, col_num]]) else: sorting_hat.append([None, [row_num, col_num]]) pos += 1
keymap_data = list() for layer in via_backup['layers']: pos = 0 layer_data = list() for key in layer: if sorting_hat[pos][0] is not None: layer_data.append([sorting_hat[pos][0], key]) pos += 1 layer_data.sort() layer_data = [kc[1] for kc in layer_data] keymap_data.append(layer_data)
return keymap_data
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")@cli.argument('filename', type=qmk.path.FileType('r'), arg_only=True, help='VIA Backup JSON file')@cli.argument('-kb', '--keyboard', type=qmk.keyboard.keyboard_folder, completer=qmk.keyboard.keyboard_completer, arg_only=True, required=True, help='The keyboard\'s name')@cli.argument('-km', '--keymap', arg_only=True, default='via2json', help='The keymap\'s name')@cli.argument('-l', '--layout', arg_only=True, help='The keymap\'s layout')@cli.subcommand('Convert a VIA backup json to keymap.json format.')def via2json(cli): """Convert a VIA backup json to keymap.json format.
This command uses the `qmk.keymap` module to generate a keymap.json from a VIA backup json. The generated keymap is written to stdout, or to a file if -o is provided. """ # Load the VIA backup json with cli.args.filename.open('r') as fd: via_backup = json.load(fd)
keyboard_data = info_json(cli.args.keyboard)
# Find appropriate layout macro keymap_layout = cli.args.layout if cli.args.layout else _find_via_layout_macro(keyboard_data) if not keymap_layout: cli.log.error(f"Couldn't find LAYOUT macro for keyboard {cli.args.keyboard}. Please specify it with the '-l' argument.") return False
# Get keycode array keymap_data = _via_to_keymap(via_backup, keyboard_data, keymap_layout) if not keymap_data: cli.log.error(f'Could not extract valid keycode data from VIA backup matching keyboard {cli.args.keyboard}!') return False
# Convert macros macro_data = list() if via_backup.get('macros'): macro_data = _convert_macros(via_backup['macros'])
# Replace VIA macro keys with JSON keymap ones keymap_data = _fix_macro_keys(keymap_data)
# Generate the keymap.json keymap_json = generate_json(cli.args.keymap, cli.args.keyboard, keymap_layout, keymap_data, macro_data)
keymap_lines = [json.dumps(keymap_json, cls=KeymapJSONEncoder, sort_keys=True)] dump_lines(cli.args.output, keymap_lines, cli.args.quiet)