keyboard stuff
auri.ee
1"""This script automates the copying of the default keymap into your own keymap.
2"""
3import re
4import json
5import shutil
6from pathlib import Path
7
8from milc import cli
9from milc.questions import question, choice
10
11from qmk.constants import HAS_QMK_USERSPACE, QMK_USERSPACE
12from qmk.errors import NoSuchKeyboardError
13from qmk.path import is_keyboard, keymaps, keymap
14from qmk.git import git_get_username
15from qmk.decorators import automagic_keyboard, automagic_keymap
16from qmk.keyboard import keyboard_completer, keyboard_folder
17from qmk.userspace import UserspaceDefs
18from qmk.json_schema import json_load
19from qmk.json_encoders import KeymapJSONEncoder
20from qmk.info import info_json
21
22
23def _list_available_converters(kb_name):
24 """Search for converters that can be applied to a given keyboard
25 """
26 if not is_keyboard(kb_name):
27 return None
28
29 info = info_json(kb_name)
30 pin_compatible = info.get('pin_compatible')
31 if not pin_compatible:
32 return None
33
34 return sorted(folder.name.split('_to_')[-1] for folder in Path('platforms').glob(f'*/converters/{pin_compatible}_to_*'))
35
36
37def _set_converter(file, converter):
38 """add/overwrite any existing converter specified in keymap.json
39 """
40 json_data = json_load(file) if file.exists() else {}
41
42 json_data['converter'] = converter
43
44 output = json.dumps(json_data, cls=KeymapJSONEncoder, sort_keys=True)
45 file.write_text(output + '\n', encoding='utf-8')
46
47
48def validate_keymap_name(name):
49 """Returns True if the given keymap name contains only a-z, 0-9 and underscore characters.
50 """
51 regex = re.compile(r'^[a-zA-Z0-9][a-zA-Z0-9_]+$')
52 return bool(regex.match(name))
53
54
55def prompt_keyboard():
56 prompt = """{fg_yellow}Select Keyboard{style_reset_all}
57If you're unsure you can view a full list of supported keyboards with {fg_yellow}qmk list-keyboards{style_reset_all}.
58
59Keyboard Name? """
60 return question(prompt)
61
62
63def prompt_user():
64 prompt = """
65{fg_yellow}Name Your Keymap{style_reset_all}
66
67Keymap name? """
68 return question(prompt, default=git_get_username())
69
70
71def prompt_converter(kb_name):
72 prompt = """
73{fg_yellow}Configure Development Board{style_reset_all}
74For more information, see:
75https://docs.qmk.fm/feature_converters
76
77Use converter? """
78
79 converters = _list_available_converters(kb_name)
80 if not converters:
81 return None
82
83 choices = ['No (default)', *converters]
84
85 answer = choice(prompt, options=choices, default=0)
86 return None if choices.index(answer) == 0 else answer
87
88
89@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='Specify keyboard name. Example: 1upkeyboards/1up60hse')
90@cli.argument('-km', '--keymap', help='Specify the name for the new keymap directory')
91@cli.argument('--converter', help='Specify the name of a converter to configure')
92@cli.argument('--skip-converter', arg_only=True, action='store_true', help='Skip converter')
93@cli.subcommand('Creates a new keymap for the keyboard of your choosing')
94@automagic_keyboard
95@automagic_keymap
96def new_keymap(cli):
97 """Creates a new keymap for the keyboard of your choosing.
98 """
99 cli.log.info('{style_bright}Generating a new keymap{style_normal}')
100 cli.echo('')
101
102 # ask for user input if keyboard or keymap was not provided in the command line
103 kb_name = cli.config.new_keymap.keyboard if cli.config.new_keymap.keyboard else prompt_keyboard()
104 user_name = cli.config.new_keymap.keymap if cli.config.new_keymap.keymap else prompt_user()
105 converter = cli.config.new_keymap.converter if cli.args.skip_converter or cli.config.new_keymap.converter else prompt_converter(kb_name)
106
107 # check directories
108 try:
109 kb_name = keyboard_folder(kb_name)
110 except ValueError:
111 cli.log.error(f'Keyboard {{fg_cyan}}{kb_name}{{fg_reset}} does not exist! Please choose a valid name.')
112 return False
113
114 # validate before any keymap ops
115 try:
116 keymaps_dirs = keymaps(kb_name)
117 keymap_path_new = keymaps_dirs[0] / user_name
118 except NoSuchKeyboardError:
119 cli.log.error(f'Keymap folder for {{fg_cyan}}{kb_name}{{fg_reset}} does not exist!')
120 return False
121
122 keymap_path_default = keymap(kb_name, 'default')
123
124 if not keymap_path_default:
125 cli.log.error(f'Default keymap for {{fg_cyan}}{kb_name}{{fg_reset}} does not exist!')
126 return False
127
128 if not validate_keymap_name(user_name):
129 cli.log.error('Keymap names must contain only {fg_cyan}a-z{fg_reset}, {fg_cyan}0-9{fg_reset} and {fg_cyan}_{fg_reset}! Please choose a different name.')
130 return False
131
132 if keymap_path_new.exists():
133 cli.log.error(f'Keymap {{fg_cyan}}{user_name}{{fg_reset}} already exists! Please choose a different name.')
134 return False
135
136 # create user directory with default keymap files
137 shutil.copytree(keymap_path_default, keymap_path_new, symlinks=True)
138
139 if converter:
140 _set_converter(keymap_path_new / 'keymap.json', converter)
141
142 # end message to user
143 cli.log.info(f'{{fg_green}}Created a new keymap called {{fg_cyan}}{user_name}{{fg_green}} in: {{fg_cyan}}{keymap_path_new}{{fg_reset}}.')
144 cli.log.info(f"Compile a firmware with your new keymap by typing: {{fg_yellow}}qmk compile -kb {kb_name} -km {user_name}{{fg_reset}}.")
145
146 # Add to userspace compile if we have userspace available
147 if HAS_QMK_USERSPACE:
148 userspace = UserspaceDefs(QMK_USERSPACE / 'qmk.json')
149 userspace.add_target(keyboard=kb_name, keymap=user_name, do_print=False)
150 return userspace.save()