Cutieguwu/qmk_firmware-mirror
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-07-20 12:21:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Decouple lighting_map from XAP

Browse Source
This commit is contained in:
zvecr
2023-03-21 15:05:40 +00:00
parent 5eed80c66b
commit 42895141de
13 changed files with 1206 additions and 1178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/python/qmk/cli/__init__.py
+1 -1
View File
@@ -58,6 +58,7 @@ subcommands = [
'qmk.cli.generate.keyboard_h',
'qmk.cli.generate.keycodes',
'qmk.cli.generate.keycodes_tests',
'qmk.cli.generate.lighting_map',
'qmk.cli.generate.rgb_breathe_table',
'qmk.cli.generate.rules_mk',
'qmk.cli.generate.version_h',
@@ -83,7 +84,6 @@ subcommands = [
'qmk.cli.xap',
'qmk.cli.xap.generate_docs',
'qmk.cli.xap.generate_json',
'qmk.cli.xap.generate_lighting',
'qmk.cli.xap.generate_python',
'qmk.cli.xap.generate_qmk',
]
lib/python/qmk/cli/xap/generate_lighting.py → lib/python/qmk/cli/generate/lighting_map.py
+38 -40
View File
@@ -2,7 +2,7 @@ from milc import cli
from qmk.path import normpath
from qmk.commands import dump_lines
from qmk.xap.common import load_lighting_spec
from qmk.lighting import load_lighting_spec
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
PREFIX_MAP = {
@@ -21,8 +21,21 @@ PREFIX_MAP = {
}
def _always_enabled(id):
"""Assumption that first effect is always enabled
"""
return id == '0x00'
def _wrap_ifdef(line, define):
return f'''
#ifdef {define}
{line}
#endif'''
def _append_lighting_map(lines, feature, spec):
"""TODO:
"""Translate effect to 'constant id'->'firmware id' lookup table
"""
groups = spec.get('groups', {})
ifdef_prefix = PREFIX_MAP[feature]['ifdef']
@@ -33,17 +46,14 @@ def _append_lighting_map(lines, feature, spec):
define = obj['define']
offset = f' + {obj["offset"]}' if obj['offset'] else ''
line = f'''
#ifdef {ifdef_prefix}_{define}
{{ {id}, {def_prefix}_{define}{offset}}},
#endif'''
line = f'{{ {id}, {def_prefix}_{define}{offset}}},'
if not _always_enabled(id):
line = _wrap_ifdef(line, f'{ifdef_prefix}_{define}')
group = groups.get(obj.get('group', None), {}).get('define', None)
if group:
line = f'''
#ifdef {group}
{line}
#endif'''
line = _wrap_ifdef(line, group)
lines.append(line)
@@ -52,7 +62,7 @@ def _append_lighting_map(lines, feature, spec):
# add helper funcs
lines.append(
f'''
uint8_t {feature}2xap(uint8_t val) {{
uint8_t {feature}_effect_to_id(uint8_t val) {{
for(uint8_t i = 0; i < ARRAY_SIZE({feature}_effect_map); i++) {{
if (pgm_read_byte(&{feature}_effect_map[i][1]) == val)
return pgm_read_byte(&{feature}_effect_map[i][0]);
@@ -60,7 +70,7 @@ uint8_t {feature}2xap(uint8_t val) {{
return 0xFF;
}}
uint8_t xap2{feature}(uint8_t val) {{
uint8_t {feature}_id_to_effect(uint8_t val) {{
for(uint8_t i = 0; i < ARRAY_SIZE({feature}_effect_map); i++) {{
if (pgm_read_byte(&{feature}_effect_map[i][0]) == val)
return pgm_read_byte(&{feature}_effect_map[i][1]);
@@ -70,8 +80,8 @@ uint8_t xap2{feature}(uint8_t val) {{
)
def _append_lighting_bitmask(lines, feature, spec):
"""TODO:
def _append_lighting_bit_field(lines, feature, spec):
"""Translate effect to bit of bit-field
"""
groups = spec.get('groups', {})
ifdef_prefix = PREFIX_MAP[feature]['ifdef']
@@ -80,49 +90,37 @@ def _append_lighting_bitmask(lines, feature, spec):
for id, obj in spec.get('effects', {}).items():
define = obj['define']
line = f'''
#ifdef {ifdef_prefix}_{define}
| (1ULL << {id})
#endif'''
line = f' | (1ULL << {id})'
if not _always_enabled(id):
line = _wrap_ifdef(line, f'{ifdef_prefix}_{define}')
group = groups.get(obj.get('group', None), {}).get('define', None)
if group:
line = f'''
#ifdef {group}
{line}
#endif'''
line = _wrap_ifdef(line, group)
lines.append(line)
lines.append('};')
def _append_lighting_mapping(lines):
"""TODO:
def _append_lighting_mapping(lines, feature):
"""Generate lookup table and bit-field of effect
"""
# TODO: remove bodge for always enabled effects
lines.append('''
#define RGBLIGHT_EFFECT_STATIC_LIGHT
#define ENABLE_RGB_MATRIX_SOLID_COLOR
#define ENABLE_LED_MATRIX_SOLID
''')
spec = load_lighting_spec(feature)
for feature in PREFIX_MAP.keys():
spec = load_lighting_spec(feature)
lines.append(f'#ifdef {feature.upper()}_ENABLE')
_append_lighting_map(lines, feature, spec)
_append_lighting_bitmask(lines, feature, spec)
lines.append(f'#endif //{feature.upper()}_ENABLE')
_append_lighting_bit_field(lines, feature, spec)
_append_lighting_map(lines, feature, spec)
@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('-q', '--quiet', arg_only=True, action='store_true', help='Quiet mode, only output error messages')
@cli.argument('-f', '--feature', required=True, help='Feature to generate map', choices=PREFIX_MAP.keys())
@cli.subcommand('Generates effect header.')
def xap_generate_lighting_map(cli):
def generate_lighting_map(cli):
# Preamble
lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '// clang-format off']
_append_lighting_mapping(lines)
_append_lighting_mapping(lines, cli.args.feature)
dump_lines(cli.args.output, lines, cli.args.quiet)
lib/python/qmk/lighting.py
+37
View File
@@ -0,0 +1,37 @@
import re
from pathlib import Path
from qmk.json_schema import json_load
def list_lighting_versions(feature):
"""Return available versions - sorted newest first
"""
ret = []
for file in Path('data/constants/lighting/').glob(f'{feature}_[0-9].[0-9].[0-9].hjson'):
ret.append(file.stem.split('_')[-1])
ret.sort(reverse=True)
return ret
def load_lighting_spec(feature, version='latest'):
"""Build lighting data from the requested spec file
"""
if version == 'latest':
version = list_lighting_versions(feature)[0]
spec = json_load(Path(f'data/constants/lighting/{feature}_{version}.hjson'))
# preprocess for gross rgblight "mode + n"
for obj in spec.get('effects', {}).values():
define = obj['key']
offset = 0
found = re.match('(.*)_(\\d+)$', define)
if found:
define = found.group(1)
offset = int(found.group(2)) - 1
obj['define'] = define
obj['offset'] = offset
return spec
lib/python/qmk/xap/common.py
+2 -36
View File
@@ -1,7 +1,5 @@
"""This script handles the XAP protocol data files.
"""
import re
import os
import hjson
import jsonschema
from pathlib import Path
@@ -10,6 +8,7 @@ from jinja2 import Environment, FileSystemLoader, select_autoescape
import qmk.constants
from qmk.git import git_get_version
from qmk.lighting import load_lighting_spec
from qmk.json_schema import json_load, validate, merge_ordered_dicts
from qmk.makefile import parse_rules_mk_file
from qmk.decorators import lru_cache
@@ -21,41 +20,8 @@ USERSPACE_DIR = Path('users')
XAP_SPEC = 'xap.hjson'
def list_lighting_versions(feature):
"""Return available versions - sorted newest first
"""
ret = []
for file in Path('data/constants/').glob(f'{feature}_[0-9].[0-9].[0-9].json'):
ret.append(file.stem.split('_')[-1])
ret.sort(reverse=True)
return ret
def load_lighting_spec(feature, version='latest'):
"""Build lighting data from the requested spec file
"""
if version == 'latest':
version = list_lighting_versions(feature)[0]
spec = json_load(Path(f'data/constants/{feature}_{version}.json'))
# preprocess for gross rgblight "mode + n"
for obj in spec.get('effects', {}).values():
define = obj['key']
offset = 0
found = re.match('(.*)_(\\d+)$', define)
if found:
define = found.group(1)
offset = int(found.group(2)) - 1
obj['define'] = define
obj['offset'] = offset
return spec
def _get_jinja2_env(data_templates_xap_subdir: str):
templates_dir = os.path.join(qmk.constants.QMK_FIRMWARE, 'data', 'templates', 'xap', data_templates_xap_subdir)
templates_dir = qmk.constants.QMK_FIRMWARE / 'data/templates/xap' / data_templates_xap_subdir
j2 = Environment(loader=FileSystemLoader(templates_dir), autoescape=select_autoescape(), lstrip_blocks=True, trim_blocks=True)
return j2