qmk-firmware/lib/python/qmk/xap/gen_firmware/blob_generator.py
2022-10-16 13:25:48 +11:00

72 lines
2.2 KiB
Python

"""This script generates the XAP info.json payload header to be compiled into QMK.
"""
import json
import gzip
from pathlib import Path
from qmk.info import keymap_json
from qmk.commands import get_chunks, dump_lines
from qmk.json_schema import deep_update, json_load
from qmk.json_encoders import InfoJSONEncoder
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
def _build_info(keyboard, keymap):
"""Build the xap version of info.json
"""
defaults_json = json_load(Path('data/mappings/xap_defaults.json'))
km_info_json = keymap_json(keyboard, keymap)
info_json = {}
deep_update(info_json, defaults_json)
deep_update(info_json, km_info_json)
# TODO: Munge to XAP requirements
info_json.pop('config_h_features', None)
info_json.pop('keymaps', None)
info_json.pop('parse_errors', None)
info_json.pop('parse_warnings', None)
info_json.get('usb', {}).pop('device_ver', None)
for layout in info_json.get('layouts', {}).values():
layout.pop('filename', None)
layout.pop('c_macro', None)
for item in layout.get('layout', []):
item.pop('label', None)
return info_json
def generate_blob(output_file, keyboard, keymap):
"""Generate XAP payload
"""
info_json = _build_info(keyboard, keymap)
# Minify
str_data = json.dumps(info_json, separators=(',', ':'))
# Compress
compressed = gzip.compress(str_data.encode("utf-8"), compresslevel=9)
# split into lines to match xxd output
hex_array = ["0x{:02X}".format(b) for b in compressed]
data_len = len(hex_array)
data = ""
for chunk in get_chunks(hex_array, 12):
data += f' {", ".join(chunk)},\n'
lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '']
lines.append('#if 0')
lines.append('// Blob contains a minified+gzipped version of the following:')
lines.append(json.dumps(info_json, cls=InfoJSONEncoder))
lines.append('#endif')
lines.append('')
# Gen output file
lines.append('static const unsigned char config_blob_gz[] PROGMEM = {')
lines.append(data)
lines.append('};')
lines.append(f'#define CONFIG_BLOB_GZ_LEN {data_len}')
dump_lines(output_file, lines)