aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2021-02-28 21:25:09 +0000
committerGitHub <noreply@github.com>2021-02-28 21:25:09 +0000
commitf8266a228cacbc31b0455161e0a8bd073feaa9db (patch)
tree877017e74a4369e7b3b07f35f7777af8fee5d84a /lib/python/qmk/cli
parent59c7deab0931207016315636ae1ef74c2c54dd18 (diff)
downloadqmk_firmware-f8266a228cacbc31b0455161e0a8bd073feaa9db.tar.gz
qmk_firmware-f8266a228cacbc31b0455161e0a8bd073feaa9db.zip
Migrate make_dfu_header to CLI (#12061)
* Migrate make_dfu_header to CLI * lint fixes * Update lib/python/qmk/cli/generate/dfu_header.py Co-authored-by: Ryan <fauxpark@gmail.com> * Rename object Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'lib/python/qmk/cli')
-rw-r--r--lib/python/qmk/cli/generate/__init__.py1
-rw-r--r--lib/python/qmk/cli/generate/dfu_header.py59
2 files changed, 60 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/generate/__init__.py b/lib/python/qmk/cli/generate/__init__.py
index bd75b044c..f064649ac 100644
--- a/lib/python/qmk/cli/generate/__init__.py
+++ b/lib/python/qmk/cli/generate/__init__.py
@@ -1,5 +1,6 @@
1from . import api 1from . import api
2from . import config_h 2from . import config_h
3from . import dfu_header
3from . import docs 4from . import docs
4from . import info_json 5from . import info_json
5from . import layouts 6from . import layouts
diff --git a/lib/python/qmk/cli/generate/dfu_header.py b/lib/python/qmk/cli/generate/dfu_header.py
new file mode 100644
index 000000000..6f958b3a3
--- /dev/null
+++ b/lib/python/qmk/cli/generate/dfu_header.py
@@ -0,0 +1,59 @@
1"""Used by the make system to generate LUFA Keyboard.h from info.json
2"""
3from dotty_dict import dotty
4from milc import cli
5
6from qmk.decorators import automagic_keyboard
7from qmk.info import info_json
8from qmk.path import is_keyboard, normpath
9
10
11@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
12@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
13@cli.argument('-kb', '--keyboard', help='Keyboard to generate LUFA Keyboard.h for.')
14@cli.subcommand('Used by the make system to generate LUFA Keyboard.h from info.json', hidden=True)
15@automagic_keyboard
16def generate_dfu_header(cli):
17 """Generates the Keyboard.h file.
18 """
19 # Determine our keyboard(s)
20 if not cli.config.generate_dfu_header.keyboard:
21 cli.log.error('Missing parameter: --keyboard')
22 cli.subcommands['info'].print_help()
23 return False
24
25 if not is_keyboard(cli.config.generate_dfu_header.keyboard):
26 cli.log.error('Invalid keyboard: "%s"', cli.config.generate_dfu_header.keyboard)
27 return False
28
29 # Build the Keyboard.h file.
30 kb_info_json = dotty(info_json(cli.config.generate_dfu_header.keyboard))
31
32 keyboard_h_lines = ['/* This file was generated by `qmk generate-dfu-header`. Do not edit or copy.' ' */', '', '#pragma once']
33 keyboard_h_lines.append(f'#define MANUFACTURER {kb_info_json["manufacturer"]}')
34 keyboard_h_lines.append(f'#define PRODUCT {cli.config.generate_dfu_header.keyboard} Bootloader')
35
36 # Optional
37 if 'qmk_lufa_bootloader.esc_output' in kb_info_json:
38 keyboard_h_lines.append(f'#define QMK_ESC_OUTPUT {kb_info_json["qmk_lufa_bootloader.esc_output"]}')
39 if 'qmk_lufa_bootloader.esc_input' in kb_info_json:
40 keyboard_h_lines.append(f'#define QMK_ESC_INPUT {kb_info_json["qmk_lufa_bootloader.esc_input"]}')
41 if 'qmk_lufa_bootloader.led' in kb_info_json:
42 keyboard_h_lines.append(f'#define QMK_LED {kb_info_json["qmk_lufa_bootloader.led"]}')
43 if 'qmk_lufa_bootloader.speaker' in kb_info_json:
44 keyboard_h_lines.append(f'#define QMK_SPEAKER {kb_info_json["qmk_lufa_bootloader.speaker"]}')
45
46 # Show the results
47 keyboard_h = '\n'.join(keyboard_h_lines)
48
49 if cli.args.output:
50 cli.args.output.parent.mkdir(parents=True, exist_ok=True)
51 if cli.args.output.exists():
52 cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
53 cli.args.output.write_text(keyboard_h)
54
55 if not cli.args.quiet:
56 cli.log.info('Wrote Keyboard.h to %s.', cli.args.output)
57
58 else:
59 print(keyboard_h)