qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

dfu_header.py (2398B)


      1 """Used by the make system to generate LUFA Keyboard.h from info.json
      2 """
      3 from dotty_dict import dotty
      4 from milc import cli
      5 
      6 from qmk.decorators import automagic_keyboard
      7 from qmk.info import info_json
      8 from qmk.path import is_keyboard, normpath
      9 from qmk.keyboard import keyboard_completer
     10 from qmk.commands import dump_lines
     11 from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
     12 
     13 
     14 @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
     15 @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
     16 @cli.argument('-kb', '--keyboard', completer=keyboard_completer, help='Keyboard to generate LUFA Keyboard.h for.')
     17 @cli.subcommand('Used by the make system to generate LUFA Keyboard.h from info.json', hidden=True)
     18 @automagic_keyboard
     19 def generate_dfu_header(cli):
     20     """Generates the Keyboard.h file.
     21     """
     22     # Determine our keyboard(s)
     23     if not cli.config.generate_dfu_header.keyboard:
     24         cli.log.error('Missing parameter: --keyboard')
     25         cli.subcommands['info'].print_help()
     26         return False
     27 
     28     if not is_keyboard(cli.config.generate_dfu_header.keyboard):
     29         cli.log.error('Invalid keyboard: "%s"', cli.config.generate_dfu_header.keyboard)
     30         return False
     31 
     32     # Build the Keyboard.h file.
     33     kb_info_json = dotty(info_json(cli.config.generate_dfu_header.keyboard))
     34 
     35     keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
     36     keyboard_h_lines.append(f'#define MANUFACTURER "{kb_info_json["manufacturer"]}"')
     37     keyboard_h_lines.append(f'#define PRODUCT "{kb_info_json["keyboard_name"]} Bootloader"')
     38 
     39     # Optional
     40     if 'qmk_lufa_bootloader.esc_output' in kb_info_json:
     41         keyboard_h_lines.append(f'#define QMK_ESC_OUTPUT {kb_info_json["qmk_lufa_bootloader.esc_output"]}')
     42     if 'qmk_lufa_bootloader.esc_input' in kb_info_json:
     43         keyboard_h_lines.append(f'#define QMK_ESC_INPUT {kb_info_json["qmk_lufa_bootloader.esc_input"]}')
     44     if 'qmk_lufa_bootloader.led' in kb_info_json:
     45         keyboard_h_lines.append(f'#define QMK_LED {kb_info_json["qmk_lufa_bootloader.led"]}')
     46     if 'qmk_lufa_bootloader.speaker' in kb_info_json:
     47         keyboard_h_lines.append(f'#define QMK_SPEAKER {kb_info_json["qmk_lufa_bootloader.speaker"]}')
     48 
     49     # Show the results
     50     dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)