summaryrefslogtreecommitdiffstats
path: root/lib/python/qmk/cli/generate
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/generate')
-rw-r--r--lib/python/qmk/cli/generate/__init__.py4
-rwxr-xr-xlib/python/qmk/cli/generate/api.py14
-rwxr-xr-xlib/python/qmk/cli/generate/config_h.py277
-rwxr-xr-xlib/python/qmk/cli/generate/info_json.py65
-rwxr-xr-xlib/python/qmk/cli/generate/layouts.py98
-rwxr-xr-xlib/python/qmk/cli/generate/rules_mk.py78
6 files changed, 530 insertions, 6 deletions
diff --git a/lib/python/qmk/cli/generate/__init__.py b/lib/python/qmk/cli/generate/__init__.py
index f9585bfb5c..bd75b044c5 100644
--- a/lib/python/qmk/cli/generate/__init__.py
+++ b/lib/python/qmk/cli/generate/__init__.py
@@ -1,3 +1,7 @@
from . import api
+from . import config_h
from . import docs
+from . import info_json
+from . import layouts
from . import rgb_breathe_table
+from . import rules_mk
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index 66db37cb52..6d111f244c 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -8,6 +8,7 @@ from milc import cli
from qmk.datetime import current_datetime
from qmk.info import info_json
+from qmk.info_json_encoder import InfoJSONEncoder
from qmk.keyboard import list_keyboards
@@ -44,15 +45,16 @@ def generate_api(cli):
if 'usb' in kb_all['keyboards'][keyboard_name]:
usb = kb_all['keyboards'][keyboard_name]['usb']
- if usb['vid'] not in usb_list['devices']:
+ if 'vid' in usb and usb['vid'] not in usb_list['devices']:
usb_list['devices'][usb['vid']] = {}
- if usb['pid'] not in usb_list['devices'][usb['vid']]:
+ if 'pid' in usb and usb['pid'] not in usb_list['devices'][usb['vid']]:
usb_list['devices'][usb['vid']][usb['pid']] = {}
- usb_list['devices'][usb['vid']][usb['pid']][keyboard_name] = usb
+ if 'vid' in usb and 'pid' in usb:
+ usb_list['devices'][usb['vid']][usb['pid']][keyboard_name] = usb
# Write the global JSON files
- keyboard_list.write_text(json.dumps({'last_updated': current_datetime(), 'keyboards': sorted(kb_all['keyboards'])}))
- keyboard_all.write_text(json.dumps(kb_all))
- usb_file.write_text(json.dumps(usb_list))
+ keyboard_list.write_text(json.dumps({'last_updated': current_datetime(), 'keyboards': sorted(kb_all['keyboards'])}, cls=InfoJSONEncoder))
+ keyboard_all.write_text(json.dumps(kb_all, cls=InfoJSONEncoder))
+ usb_file.write_text(json.dumps(usb_list, cls=InfoJSONEncoder))
diff --git a/lib/python/qmk/cli/generate/config_h.py b/lib/python/qmk/cli/generate/config_h.py
new file mode 100755
index 0000000000..1de84de7a9
--- /dev/null
+++ b/lib/python/qmk/cli/generate/config_h.py
@@ -0,0 +1,277 @@
+"""Used by the make system to generate info_config.h from info.json.
+"""
+from milc import cli
+
+from qmk.constants import LED_INDICATORS
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.info import info_json, rgblight_animations, rgblight_properties, rgblight_toggles
+from qmk.path import is_keyboard, normpath
+
+usb_prop_map = {
+ 'vid': 'VENDOR_ID',
+ 'pid': 'PRODUCT_ID',
+ 'device_ver': 'DEVICE_VER',
+}
+
+
+def debounce(debounce):
+ """Return the config.h lines that set debounce
+ """
+ return """
+#ifndef DEBOUNCE
+# define DEBOUNCE %s
+#endif // DEBOUNCE
+""" % debounce
+
+
+def diode_direction(diode_direction):
+ """Return the config.h lines that set diode direction
+ """
+ return """
+#ifndef DIODE_DIRECTION
+# define DIODE_DIRECTION %s
+#endif // DIODE_DIRECTION
+""" % diode_direction
+
+
+def keyboard_name(keyboard_name):
+ """Return the config.h lines that set the keyboard's name.
+ """
+ return """
+#ifndef DESCRIPTION
+# define DESCRIPTION %s
+#endif // DESCRIPTION
+
+#ifndef PRODUCT
+# define PRODUCT %s
+#endif // PRODUCT
+""" % (keyboard_name.replace("'", ""), keyboard_name.replace("'", ""))
+
+
+def manufacturer(manufacturer):
+ """Return the config.h lines that set the manufacturer.
+ """
+ return """
+#ifndef MANUFACTURER
+# define MANUFACTURER %s
+#endif // MANUFACTURER
+""" % (manufacturer.replace("'", ""))
+
+
+def direct_pins(direct_pins):
+ """Return the config.h lines that set the direct pins.
+ """
+ rows = []
+
+ for row in direct_pins:
+ cols = ','.join(map(str, [col or 'NO_PIN' for col in row]))
+ rows.append('{' + cols + '}')
+
+ col_count = len(direct_pins[0])
+ row_count = len(direct_pins)
+
+ return """
+#ifndef MATRIX_COLS
+# define MATRIX_COLS %s
+#endif // MATRIX_COLS
+
+#ifndef MATRIX_ROWS
+# define MATRIX_ROWS %s
+#endif // MATRIX_ROWS
+
+#ifndef DIRECT_PINS
+# define DIRECT_PINS {%s}
+#endif // DIRECT_PINS
+""" % (col_count, row_count, ','.join(rows))
+
+
+def col_pins(col_pins):
+ """Return the config.h lines that set the column pins.
+ """
+ cols = ','.join(map(str, [pin or 'NO_PIN' for pin in col_pins]))
+ col_num = len(col_pins)
+
+ return """
+#ifndef MATRIX_COLS
+# define MATRIX_COLS %s
+#endif // MATRIX_COLS
+
+#ifndef MATRIX_COL_PINS
+# define MATRIX_COL_PINS {%s}
+#endif // MATRIX_COL_PINS
+""" % (col_num, cols)
+
+
+def row_pins(row_pins):
+ """Return the config.h lines that set the row pins.
+ """
+ rows = ','.join(map(str, [pin or 'NO_PIN' for pin in row_pins]))
+ row_num = len(row_pins)
+
+ return """
+#ifndef MATRIX_ROWS
+# define MATRIX_ROWS %s
+#endif // MATRIX_ROWS
+
+#ifndef MATRIX_ROW_PINS
+# define MATRIX_ROW_PINS {%s}
+#endif // MATRIX_ROW_PINS
+""" % (row_num, rows)
+
+
+def indicators(config):
+ """Return the config.h lines that setup LED indicators.
+ """
+ defines = []
+
+ for led, define in LED_INDICATORS.items():
+ if led in config:
+ defines.append('')
+ defines.append('#ifndef %s' % (define,))
+ defines.append('# define %s %s' % (define, config[led]))
+ defines.append('#endif // %s' % (define,))
+
+ return '\n'.join(defines)
+
+
+def layout_aliases(layout_aliases):
+ """Return the config.h lines that setup layout aliases.
+ """
+ defines = []
+
+ for alias, layout in layout_aliases.items():
+ defines.append('')
+ defines.append('#ifndef %s' % (alias,))
+ defines.append('# define %s %s' % (alias, layout))
+ defines.append('#endif // %s' % (alias,))
+
+ return '\n'.join(defines)
+
+
+def matrix_pins(matrix_pins):
+ """Add the matrix config to the config.h.
+ """
+ pins = []
+
+ if 'direct' in matrix_pins:
+ pins.append(direct_pins(matrix_pins['direct']))
+
+ if 'cols' in matrix_pins:
+ pins.append(col_pins(matrix_pins['cols']))
+
+ if 'rows' in matrix_pins:
+ pins.append(row_pins(matrix_pins['rows']))
+
+ return '\n'.join(pins)
+
+
+def rgblight(config):
+ """Return the config.h lines that setup rgblight.
+ """
+ rgblight_config = []
+
+ for json_key, config_key in rgblight_properties.items():
+ if json_key in config:
+ rgblight_config.append('')
+ rgblight_config.append('#ifndef %s' % (config_key[0],))
+ rgblight_config.append('# define %s %s' % (config_key[0], config[json_key]))
+ rgblight_config.append('#endif // %s' % (config_key[0],))
+
+ for json_key, config_key in rgblight_toggles.items():
+ if config.get(json_key):
+ rgblight_config.append('')
+ rgblight_config.append('#ifndef %s' % (config_key,))
+ rgblight_config.append('# define %s' % (config_key,))
+ rgblight_config.append('#endif // %s' % (config_key,))
+
+ for json_key, config_key in rgblight_animations.items():
+ if 'animations' in config and config['animations'].get(json_key):
+ rgblight_config.append('')
+ rgblight_config.append('#ifndef %s' % (config_key,))
+ rgblight_config.append('# define %s' % (config_key,))
+ rgblight_config.append('#endif // %s' % (config_key,))
+
+ return '\n'.join(rgblight_config)
+
+
+def usb_properties(usb_props):
+ """Return the config.h lines that setup USB params.
+ """
+ usb_lines = []
+
+ for info_name, config_name in usb_prop_map.items():
+ if info_name in usb_props:
+ usb_lines.append('')
+ usb_lines.append('#ifndef ' + config_name)
+ usb_lines.append('# define %s %s' % (config_name, usb_props[info_name]))
+ usb_lines.append('#endif // ' + config_name)
+
+ return '\n'.join(usb_lines)
+
+
+@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', help='Keyboard to generate config.h for.')
+@cli.subcommand('Used by the make system to generate info_config.h from info.json', hidden=True)
+@automagic_keyboard
+@automagic_keymap
+def generate_config_h(cli):
+ """Generates the info_config.h file.
+ """
+ # Determine our keyboard(s)
+ if not cli.config.generate_config_h.keyboard:
+ cli.log.error('Missing paramater: --keyboard')
+ cli.subcommands['info'].print_help()
+ return False
+
+ if not is_keyboard(cli.config.generate_config_h.keyboard):
+ cli.log.error('Invalid keyboard: "%s"', cli.config.generate_config_h.keyboard)
+ return False
+
+ # Build the info.json file
+ kb_info_json = info_json(cli.config.generate_config_h.keyboard)
+
+ # Build the info_config.h file.
+ config_h_lines = ['/* This file was generated by `qmk generate-config-h`. Do not edit or copy.' ' */', '', '#pragma once']
+
+ if 'debounce' in kb_info_json:
+ config_h_lines.append(debounce(kb_info_json['debounce']))
+
+ if 'diode_direction' in kb_info_json:
+ config_h_lines.append(diode_direction(kb_info_json['diode_direction']))
+
+ if 'indicators' in kb_info_json:
+ config_h_lines.append(indicators(kb_info_json['indicators']))
+
+ if 'keyboard_name' in kb_info_json:
+ config_h_lines.append(keyboard_name(kb_info_json['keyboard_name']))
+
+ if 'layout_aliases' in kb_info_json:
+ config_h_lines.append(layout_aliases(kb_info_json['layout_aliases']))
+
+ if 'manufacturer' in kb_info_json:
+ config_h_lines.append(manufacturer(kb_info_json['manufacturer']))
+
+ if 'rgblight' in kb_info_json:
+ config_h_lines.append(rgblight(kb_info_json['rgblight']))
+
+ if 'matrix_pins' in kb_info_json:
+ config_h_lines.append(matrix_pins(kb_info_json['matrix_pins']))
+
+ if 'usb' in kb_info_json:
+ config_h_lines.append(usb_properties(kb_info_json['usb']))
+
+ # Show the results
+ config_h = '\n'.join(config_h_lines)
+
+ if cli.args.output:
+ cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+ if cli.args.output.exists():
+ cli.args.output.replace(cli.args.output.name + '.bak')
+ cli.args.output.write_text(config_h)
+
+ if not cli.args.quiet:
+ cli.log.info('Wrote info_config.h to %s.', cli.args.output)
+
+ else:
+ print(config_h)
diff --git a/lib/python/qmk/cli/generate/info_json.py b/lib/python/qmk/cli/generate/info_json.py
new file mode 100755
index 0000000000..f3fc54ddcf
--- /dev/null
+++ b/lib/python/qmk/cli/generate/info_json.py
@@ -0,0 +1,65 @@
+"""Keyboard information script.
+
+Compile an info.json for a particular keyboard and pretty-print it.
+"""
+import json
+
+from jsonschema import Draft7Validator, validators
+from milc import cli
+
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.info import info_json, _jsonschema
+from qmk.info_json_encoder import InfoJSONEncoder
+from qmk.path import is_keyboard
+
+
+def pruning_validator(validator_class):
+ """Extends Draft7Validator to remove properties that aren't specified in the schema.
+ """
+ validate_properties = validator_class.VALIDATORS["properties"]
+
+ def remove_additional_properties(validator, properties, instance, schema):
+ for prop in list(instance.keys()):
+ if prop not in properties:
+ del instance[prop]
+
+ for error in validate_properties(validator, properties, instance, schema):
+ yield error
+
+ return validators.extend(validator_class, {"properties": remove_additional_properties})
+
+
+def strip_info_json(kb_info_json):
+ """Remove the API-only properties from the info.json.
+ """
+ pruning_draft_7_validator = pruning_validator(Draft7Validator)
+ schema = _jsonschema('keyboard')
+ validator = pruning_draft_7_validator(schema).validate
+
+ return validator(kb_info_json)
+
+
+@cli.argument('-kb', '--keyboard', help='Keyboard to show info for.')
+@cli.argument('-km', '--keymap', help='Show the layers for a JSON keymap too.')
+@cli.subcommand('Generate an info.json file for a keyboard.', hidden=False if cli.config.user.developer else True)
+@automagic_keyboard
+@automagic_keymap
+def generate_info_json(cli):
+ """Generate an info.json file for a keyboard
+ """
+ # Determine our keyboard(s)
+ if not cli.config.generate_info_json.keyboard:
+ cli.log.error('Missing parameter: --keyboard')
+ cli.subcommands['info'].print_help()
+ return False
+
+ if not is_keyboard(cli.config.generate_info_json.keyboard):
+ cli.log.error('Invalid keyboard: "%s"', cli.config.generate_info_json.keyboard)
+ return False
+
+ # Build the info.json file
+ kb_info_json = info_json(cli.config.generate_info_json.keyboard)
+ strip_info_json(kb_info_json)
+
+ # Display the results
+ print(json.dumps(kb_info_json, indent=2, cls=InfoJSONEncoder))
diff --git a/lib/python/qmk/cli/generate/layouts.py b/lib/python/qmk/cli/generate/layouts.py
new file mode 100755
index 0000000000..b7baae0651
--- /dev/null
+++ b/lib/python/qmk/cli/generate/layouts.py
@@ -0,0 +1,98 @@
+"""Used by the make system to generate layouts.h from info.json.
+"""
+from milc import cli
+
+from qmk.constants import COL_LETTERS, ROW_LETTERS
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.info import info_json
+from qmk.path import is_keyboard, normpath
+
+usb_properties = {
+ 'vid': 'VENDOR_ID',
+ 'pid': 'PRODUCT_ID',
+ 'device_ver': 'DEVICE_VER',
+}
+
+
+@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', help='Keyboard to generate config.h for.')
+@cli.subcommand('Used by the make system to generate layouts.h from info.json', hidden=True)
+@automagic_keyboard
+@automagic_keymap
+def generate_layouts(cli):
+ """Generates the layouts.h file.
+ """
+ # Determine our keyboard(s)
+ if not cli.config.generate_layouts.keyboard:
+ cli.log.error('Missing paramater: --keyboard')
+ cli.subcommands['info'].print_help()
+ return False
+
+ if not is_keyboard(cli.config.generate_layouts.keyboard):
+ cli.log.error('Invalid keyboard: "%s"', cli.config.generate_layouts.keyboard)
+ return False
+
+ # Build the info.json file
+ kb_info_json = info_json(cli.config.generate_layouts.keyboard)
+
+ # Build the layouts.h file.
+ layouts_h_lines = ['/* This file was generated by `qmk generate-layouts`. Do not edit or copy.' ' */', '', '#pragma once']
+
+ if 'matrix_pins' in kb_info_json:
+ if 'direct' in kb_info_json['matrix_pins']:
+ col_num = len(kb_info_json['matrix_pins']['direct'][0])
+ row_num = len(kb_info_json['matrix_pins']['direct'])
+ elif 'cols' in kb_info_json['matrix_pins'] and 'rows' in kb_info_json['matrix_pins']:
+ col_num = len(kb_info_json['matrix_pins']['cols'])
+ row_num = len(kb_info_json['matrix_pins']['rows'])
+ else:
+ cli.log.error('%s: Invalid matrix config.', cli.config.generate_layouts.keyboard)
+ return False
+
+ for layout_name in kb_info_json['layouts']:
+ if kb_info_json['layouts'][layout_name]['c_macro']:
+ continue
+
+ if 'matrix' not in kb_info_json['layouts'][layout_name]['layout'][0]:
+ cli.log.debug('%s/%s: No matrix data!', cli.config.generate_layouts.keyboard, layout_name)
+ continue
+
+ layout_keys = []
+ layout_matrix = [['KC_NO' for i in range(col_num)] for i in range(row_num)]
+
+ for i, key in enumerate(kb_info_json['layouts'][layout_name]['layout']):
+ row = key['matrix'][0]
+ col = key['matrix'][1]
+ identifier = 'k%s%s' % (ROW_LETTERS[row], COL_LETTERS[col])
+
+ try:
+ layout_matrix[row][col] = identifier
+ layout_keys.append(identifier)
+ except IndexError:
+ key_name = key.get('label', identifier)
+ cli.log.error('Matrix data out of bounds for layout %s at index %s (%s): %s, %s', layout_name, i, key_name, row, col)
+ return False
+
+ layouts_h_lines.append('')
+ layouts_h_lines.append('#define %s(%s) {\\' % (layout_name, ', '.join(layout_keys)))
+
+ rows = ', \\\n'.join(['\t {' + ', '.join(row) + '}' for row in layout_matrix])
+ rows += ' \\'
+ layouts_h_lines.append(rows)
+ layouts_h_lines.append('}')
+
+ # Show the results
+ layouts_h = '\n'.join(layouts_h_lines) + '\n'
+
+ if cli.args.output:
+ cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+ if cli.args.output.exists():
+ cli.args.output.replace(cli.args.output.name + '.bak')
+ cli.args.output.write_text(layouts_h)
+
+ if not cli.args.quiet:
+ cli.log.info('Wrote info_config.h to %s.', cli.args.output)
+
+ else:
+ print(layouts_h)
diff --git a/lib/python/qmk/cli/generate/rules_mk.py b/lib/python/qmk/cli/generate/rules_mk.py
new file mode 100755
index 0000000000..b262e3c666
--- /dev/null
+++ b/lib/python/qmk/cli/generate/rules_mk.py
@@ -0,0 +1,78 @@
+"""Used by the make system to generate a rules.mk
+"""
+from milc import cli
+
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.info import info_json
+from qmk.path import is_keyboard, normpath
+
+info_to_rules = {
+ 'board': 'BOARD',
+ 'bootloader': 'BOOTLOADER',
+ 'processor': 'MCU',
+}
+
+
+@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', help='Keyboard to generate config.h for.')
+@cli.subcommand('Used by the make system to generate info_config.h from info.json', hidden=True)
+@automagic_keyboard
+@automagic_keymap
+def generate_rules_mk(cli):
+ """Generates a rules.mk file from info.json.
+ """
+ # Determine our keyboard(s)
+ if not cli.config.generate_rules_mk.keyboard:
+ cli.log.error('Missing paramater: --keyboard')
+ cli.subcommands['info'].print_help()
+ return False
+
+ if not is_keyboard(cli.config.generate_rules_mk.keyboard):
+ cli.log.error('Invalid keyboard: "%s"', cli.config.generate_rules_mk.keyboard)
+ return False
+
+ # Build the info.json file
+ kb_info_json = info_json(cli.config.generate_rules_mk.keyboard)
+ rules_mk_lines = ['# This file was generated by `qmk generate-rules-mk`. Do not edit or copy.', '']
+
+ # Bring in settings
+ for info_key, rule_key in info_to_rules.items():
+ if info_key in kb_info_json:
+ rules_mk_lines.append(f'{rule_key} ?= {kb_info_json[info_key]}')
+
+ # Find features that should be enabled
+ if 'features' in kb_info_json:
+ for feature, enabled in kb_info_json['features'].items():
+ if feature == 'bootmagic_lite' and enabled:
+ rules_mk_lines.append('BOOTMAGIC_ENABLE ?= lite')
+ else:
+ feature = feature.upper()
+ enabled = 'yes' if enabled else 'no'
+ rules_mk_lines.append(f'{feature}_ENABLE ?= {enabled}')
+
+ # Set the LED driver
+ if 'led_matrix' in kb_info_json and 'driver' in kb_info_json['led_matrix']:
+ driver = kb_info_json['led_matrix']['driver']
+ rules_mk_lines.append(f'LED_MATRIX_DRIVER ?= {driver}')
+
+ # Add community layouts
+ if 'community_layouts' in kb_info_json:
+ rules_mk_lines.append(f'LAYOUTS ?= {" ".join(kb_info_json["community_layouts"])}')
+
+ # Show the results
+ rules_mk = '\n'.join(rules_mk_lines) + '\n'
+
+ if cli.args.output:
+ cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+ if cli.args.output.exists():
+ cli.args.output.replace(cli.args.output.name + '.bak')
+ cli.args.output.write_text(rules_mk)
+
+ if cli.args.quiet:
+ print(cli.args.output)
+ else:
+ cli.log.info('Wrote info_config.h to %s.', cli.args.output)
+
+ else:
+ print(rules_mk)