mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-27 11:31:13 +00:00
Compare commits
No commits in common. "master" and "0.27.0" have entirely different histories.
33
.clangd
33
.clangd
@ -1,33 +1,4 @@
|
|||||||
CompileFlags:
|
CompileFlags:
|
||||||
Add:
|
Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option]
|
||||||
[
|
Remove: [-W*, -mmcu=*, -mcpu=*, -mfpu=*, -mfloat-abi=*, -mno-unaligned-access, -mno-thumb-interwork, -mcall-prologues]
|
||||||
-Wno-unknown-attributes,
|
|
||||||
-Wno-maybe-uninitialized,
|
|
||||||
-Wno-unknown-warning-option,
|
|
||||||
-Wno-pointer-to-int-cast,
|
|
||||||
-Wno-int-to-void-pointer-cast,
|
|
||||||
-DPROGMEM=,
|
|
||||||
]
|
|
||||||
Remove:
|
|
||||||
[
|
|
||||||
-W*,
|
|
||||||
-mmcu=*,
|
|
||||||
-mcpu=*,
|
|
||||||
-mfpu=*,
|
|
||||||
-mfloat-abi=*,
|
|
||||||
-mno-unaligned-access,
|
|
||||||
-mno-thumb-interwork,
|
|
||||||
-mcall-prologues,
|
|
||||||
-D__has_include*,
|
|
||||||
-mlra,
|
|
||||||
]
|
|
||||||
Compiler: clang
|
Compiler: clang
|
||||||
Diagnostics:
|
|
||||||
UnusedIncludes: None
|
|
||||||
Suppress:
|
|
||||||
[
|
|
||||||
asm_invalid_output_constraint,
|
|
||||||
asm_invalid_input_constraint,
|
|
||||||
invalid_asm_value_for_constraint,
|
|
||||||
anyx86_interrupt_attribute,
|
|
||||||
]
|
|
||||||
|
4
.github/labeler.yml
vendored
4
.github/labeler.yml
vendored
@ -54,7 +54,3 @@ dd:
|
|||||||
- data/constants/**
|
- data/constants/**
|
||||||
- data/mappings/**
|
- data/mappings/**
|
||||||
- data/schemas/**
|
- data/schemas/**
|
||||||
community_module:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- modules/**
|
|
||||||
|
1
.github/workflows/auto_tag.yml
vendored
1
.github/workflows/auto_tag.yml
vendored
@ -15,7 +15,6 @@ on:
|
|||||||
- quantum/**/*
|
- quantum/**/*
|
||||||
- tests/**/*
|
- tests/**/*
|
||||||
- tmk_core/**/*
|
- tmk_core/**/*
|
||||||
- lib/python/**/*
|
|
||||||
- util/**/*
|
- util/**/*
|
||||||
- Makefile
|
- Makefile
|
||||||
- '*.mk'
|
- '*.mk'
|
||||||
|
2
.github/workflows/docs.yml
vendored
2
.github/workflows/docs.yml
vendored
@ -56,7 +56,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Deploy
|
- name: Deploy
|
||||||
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
|
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
|
||||||
uses: JamesIves/github-pages-deploy-action@v4.7.3
|
uses: JamesIves/github-pages-deploy-action@v4.6.9
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
branch: gh-pages
|
branch: gh-pages
|
||||||
|
3
.github/workflows/format.yml
vendored
3
.github/workflows/format.yml
vendored
@ -10,7 +10,6 @@ on:
|
|||||||
- 'lib/arm_atsam/**'
|
- 'lib/arm_atsam/**'
|
||||||
- 'lib/lib8tion/**'
|
- 'lib/lib8tion/**'
|
||||||
- 'lib/python/**'
|
- 'lib/python/**'
|
||||||
- 'modules/**'
|
|
||||||
- 'platforms/**'
|
- 'platforms/**'
|
||||||
- 'quantum/**'
|
- 'quantum/**'
|
||||||
- 'tests/**'
|
- 'tests/**'
|
||||||
@ -36,7 +35,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Get changed files
|
- name: Get changed files
|
||||||
id: file_changes
|
id: file_changes
|
||||||
uses: tj-actions/changed-files@v46
|
uses: tj-actions/changed-files@v45
|
||||||
with:
|
with:
|
||||||
use_rest_api: true
|
use_rest_api: true
|
||||||
|
|
||||||
|
2
.github/workflows/format_push.yml
vendored
2
.github/workflows/format_push.yml
vendored
@ -39,7 +39,7 @@ jobs:
|
|||||||
qmk format-text -a
|
qmk format-text -a
|
||||||
git diff
|
git diff
|
||||||
|
|
||||||
- uses: rlespinasse/github-slug-action@v5
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
|
|
||||||
- name: Become QMK Bot
|
- name: Become QMK Bot
|
||||||
run: |
|
run: |
|
||||||
|
2
.github/workflows/lint.yml
vendored
2
.github/workflows/lint.yml
vendored
@ -27,7 +27,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Get changed files
|
- name: Get changed files
|
||||||
id: file_changes
|
id: file_changes
|
||||||
uses: tj-actions/changed-files@v46
|
uses: tj-actions/changed-files@v45
|
||||||
with:
|
with:
|
||||||
use_rest_api: true
|
use_rest_api: true
|
||||||
|
|
||||||
|
2
.github/workflows/regen_push.yml
vendored
2
.github/workflows/regen_push.yml
vendored
@ -26,7 +26,7 @@ jobs:
|
|||||||
util/regen.sh
|
util/regen.sh
|
||||||
git diff
|
git diff
|
||||||
|
|
||||||
- uses: rlespinasse/github-slug-action@v5
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
|
|
||||||
- name: Become QMK Bot
|
- name: Become QMK Bot
|
||||||
run: |
|
run: |
|
||||||
|
2
.github/workflows/stale.yml
vendored
2
.github/workflows/stale.yml
vendored
@ -45,7 +45,7 @@ jobs:
|
|||||||
stale-pr-label: stale
|
stale-pr-label: stale
|
||||||
days-before-pr-stale: 45
|
days-before-pr-stale: 45
|
||||||
days-before-pr-close: 30
|
days-before-pr-close: 30
|
||||||
exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold,needs-core-wireless,crippled-firmware
|
exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold
|
||||||
|
|
||||||
stale-pr-message: >
|
stale-pr-message: >
|
||||||
Thank you for your contribution!
|
Thank you for your contribution!
|
||||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -64,7 +64,6 @@ build/
|
|||||||
cmake-build-debug
|
cmake-build-debug
|
||||||
CMakeLists.txt
|
CMakeLists.txt
|
||||||
*.pdf
|
*.pdf
|
||||||
*.zip
|
|
||||||
|
|
||||||
# Let these ones be user specific, since we have so many different configurations
|
# Let these ones be user specific, since we have so many different configurations
|
||||||
*.code-workspace
|
*.code-workspace
|
||||||
|
27
.vscode/settings.json
vendored
27
.vscode/settings.json
vendored
@ -10,13 +10,6 @@
|
|||||||
"**/*.uf2": true
|
"**/*.uf2": true
|
||||||
},
|
},
|
||||||
"files.associations": {
|
"files.associations": {
|
||||||
// QMK Filetypes
|
|
||||||
"keyboard.json": "jsonc",
|
|
||||||
"info.json": "jsonc",
|
|
||||||
"keymap.json": "jsonc",
|
|
||||||
"qmk.json": "jsonc",
|
|
||||||
"qmk_module.json": "jsonc",
|
|
||||||
// Standard filetypes
|
|
||||||
"*.h": "c",
|
"*.h": "c",
|
||||||
"*.c": "c",
|
"*.c": "c",
|
||||||
"*.inc": "c",
|
"*.inc": "c",
|
||||||
@ -35,23 +28,7 @@
|
|||||||
"[json]": {
|
"[json]": {
|
||||||
"editor.formatOnSave": false
|
"editor.formatOnSave": false
|
||||||
},
|
},
|
||||||
"clangd.arguments": ["--header-insertion=never"],
|
"clangd.arguments": [
|
||||||
"json.schemas": [
|
"--header-insertion=never"
|
||||||
{
|
|
||||||
"fileMatch": ["qmk.json"],
|
|
||||||
"url": "./data/schemas/user_repo_v1_1.jsonschema"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"fileMatch": ["qmk_module.json"],
|
|
||||||
"url": "./data/schemas/community_module.jsonschema"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"fileMatch": ["keyboard.json", "info.json"],
|
|
||||||
"url": "./data/schemas/keyboard.jsonschema"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"fileMatch": ["keymap.json"],
|
|
||||||
"url": "./data/schemas/keymap.jsonschema"
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
37
Makefile
37
Makefile
@ -59,7 +59,6 @@ ifeq ($(ROOT_DIR),)
|
|||||||
endif
|
endif
|
||||||
|
|
||||||
include paths.mk
|
include paths.mk
|
||||||
include $(BUILDDEFS_PATH)/support.mk
|
|
||||||
|
|
||||||
TEST_OUTPUT_DIR := $(BUILD_DIR)/test
|
TEST_OUTPUT_DIR := $(BUILD_DIR)/test
|
||||||
ERROR_FILE := $(BUILD_DIR)/error_occurred
|
ERROR_FILE := $(BUILD_DIR)/error_occurred
|
||||||
@ -114,29 +113,6 @@ endef
|
|||||||
# Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
|
# Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
|
||||||
TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
|
TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
|
||||||
|
|
||||||
# As TRY_TO_MATCH_RULE_FROM_LIST_HELPER, but with additional
|
|
||||||
# resolution of DEFAULT_FOLDER and keyboard_aliases.hjson for provided rule
|
|
||||||
define TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB
|
|
||||||
# Split on ":", padding with empty strings to avoid indexing issues
|
|
||||||
TOKEN1:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[0])" $$(RULE))
|
|
||||||
TOKENr:=$$(shell python3 -c "import sys; print((sys.argv[1].split(':',1)+[''])[1])" $$(RULE))
|
|
||||||
|
|
||||||
TOKEN1:=$$(shell $(QMK_BIN) resolve-alias --allow-unknown $$(TOKEN1))
|
|
||||||
|
|
||||||
FOUNDx:=$$(shell echo $1 | tr " " "\n" | grep -Fx $$(TOKEN1))
|
|
||||||
ifneq ($$(FOUNDx),)
|
|
||||||
RULE := $$(TOKENr)
|
|
||||||
RULE_FOUND := true
|
|
||||||
MATCHED_ITEM := $$(TOKEN1)
|
|
||||||
else
|
|
||||||
RULE_FOUND := false
|
|
||||||
MATCHED_ITEM :=
|
|
||||||
endif
|
|
||||||
endef
|
|
||||||
|
|
||||||
# Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST_KB
|
|
||||||
TRY_TO_MATCH_RULE_FROM_LIST_KB = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER_KB,$1))$(RULE_FOUND)
|
|
||||||
|
|
||||||
define ALL_IN_LIST_LOOP
|
define ALL_IN_LIST_LOOP
|
||||||
OLD_RULE$1 := $$(RULE)
|
OLD_RULE$1 := $$(RULE)
|
||||||
$$(eval $$(call $1,$$(ITEM$1)))
|
$$(eval $$(call $1,$$(ITEM$1)))
|
||||||
@ -162,7 +138,7 @@ define PARSE_RULE
|
|||||||
$$(eval $$(call PARSE_TEST))
|
$$(eval $$(call PARSE_TEST))
|
||||||
# If the rule starts with the name of a known keyboard, then continue
|
# If the rule starts with the name of a known keyboard, then continue
|
||||||
# the parsing from PARSE_KEYBOARD
|
# the parsing from PARSE_KEYBOARD
|
||||||
else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST_KB,$$(shell $(QMK_BIN) list-keyboards)),true)
|
else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)),true)
|
||||||
KEYBOARD_RULE=$$(MATCHED_ITEM)
|
KEYBOARD_RULE=$$(MATCHED_ITEM)
|
||||||
$$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
|
$$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
|
||||||
else
|
else
|
||||||
@ -194,6 +170,17 @@ define PARSE_KEYBOARD
|
|||||||
# include the correct makefile to determine the actual name of it
|
# include the correct makefile to determine the actual name of it
|
||||||
CURRENT_KB := $1
|
CURRENT_KB := $1
|
||||||
|
|
||||||
|
# KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
|
||||||
|
|
||||||
|
DEFAULT_FOLDER := $$(CURRENT_KB)
|
||||||
|
|
||||||
|
# We assume that every rules.mk will contain the full default value
|
||||||
|
$$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
|
||||||
|
ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
|
||||||
|
$$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
|
||||||
|
endif
|
||||||
|
CURRENT_KB := $$(DEFAULT_FOLDER)
|
||||||
|
|
||||||
# 5/4/3/2/1
|
# 5/4/3/2/1
|
||||||
KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
|
KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
|
||||||
KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
|
KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
|
||||||
|
@ -25,6 +25,8 @@ $(TEST_OUTPUT)_SRC := \
|
|||||||
tests/test_common/test_driver.cpp \
|
tests/test_common/test_driver.cpp \
|
||||||
tests/test_common/keyboard_report_util.cpp \
|
tests/test_common/keyboard_report_util.cpp \
|
||||||
tests/test_common/mouse_report_util.cpp \
|
tests/test_common/mouse_report_util.cpp \
|
||||||
|
tests/test_common/keycode_util.cpp \
|
||||||
|
tests/test_common/keycode_table.cpp \
|
||||||
tests/test_common/test_fixture.cpp \
|
tests/test_common/test_fixture.cpp \
|
||||||
tests/test_common/test_keymap_key.cpp \
|
tests/test_common/test_keymap_key.cpp \
|
||||||
tests/test_common/test_logger.cpp \
|
tests/test_common/test_logger.cpp \
|
||||||
|
@ -11,7 +11,6 @@ endif
|
|||||||
.DEFAULT_GOAL := all
|
.DEFAULT_GOAL := all
|
||||||
|
|
||||||
include paths.mk
|
include paths.mk
|
||||||
include $(BUILDDEFS_PATH)/support.mk
|
|
||||||
include $(BUILDDEFS_PATH)/message.mk
|
include $(BUILDDEFS_PATH)/message.mk
|
||||||
|
|
||||||
# Helper to add defines with a 'QMK_' prefix
|
# Helper to add defines with a 'QMK_' prefix
|
||||||
@ -98,44 +97,20 @@ endif
|
|||||||
|
|
||||||
|
|
||||||
# Pull in rules.mk files from all our subfolders
|
# Pull in rules.mk files from all our subfolders
|
||||||
-include $(KEYBOARD_PATH_5)/rules.mk
|
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/rules.mk)","")
|
||||||
-include $(KEYBOARD_PATH_4)/rules.mk
|
include $(KEYBOARD_PATH_5)/rules.mk
|
||||||
-include $(KEYBOARD_PATH_3)/rules.mk
|
|
||||||
-include $(KEYBOARD_PATH_2)/rules.mk
|
|
||||||
-include $(KEYBOARD_PATH_1)/rules.mk
|
|
||||||
|
|
||||||
# Create dependencies on DD keyboard config - structure validated elsewhere
|
|
||||||
DD_CONFIG_FILES :=
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json
|
|
||||||
endif
|
endif
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/rules.mk)","")
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json
|
include $(KEYBOARD_PATH_4)/rules.mk
|
||||||
endif
|
endif
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/rules.mk)","")
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json
|
include $(KEYBOARD_PATH_3)/rules.mk
|
||||||
endif
|
endif
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/rules.mk)","")
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json
|
include $(KEYBOARD_PATH_2)/rules.mk
|
||||||
endif
|
endif
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json
|
include $(KEYBOARD_PATH_1)/rules.mk
|
||||||
endif
|
|
||||||
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json
|
|
||||||
endif
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json
|
|
||||||
endif
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json
|
|
||||||
endif
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json
|
|
||||||
endif
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
|
|
||||||
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
|
|
||||||
endif
|
endif
|
||||||
|
|
||||||
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
|
MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
|
||||||
@ -222,27 +197,25 @@ ifneq ("$(wildcard $(KEYMAP_JSON))", "")
|
|||||||
KEYMAP_C := $(INTERMEDIATE_OUTPUT)/src/keymap.c
|
KEYMAP_C := $(INTERMEDIATE_OUTPUT)/src/keymap.c
|
||||||
KEYMAP_H := $(INTERMEDIATE_OUTPUT)/src/config.h
|
KEYMAP_H := $(INTERMEDIATE_OUTPUT)/src/config.h
|
||||||
|
|
||||||
ifeq ($(OTHER_KEYMAP_C),)
|
# Load the keymap-level rules.mk if exists
|
||||||
# Load the keymap-level rules.mk if exists (and we havent already loaded it for keymap.c)
|
|
||||||
-include $(KEYMAP_PATH)/rules.mk
|
-include $(KEYMAP_PATH)/rules.mk
|
||||||
endif
|
|
||||||
|
|
||||||
# Load any rules.mk content from keymap.json
|
# Load any rules.mk content from keymap.json
|
||||||
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
|
INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
|
||||||
include $(INFO_RULES_MK)
|
include $(INFO_RULES_MK)
|
||||||
|
|
||||||
# Add rules to generate the keymap files - indentation here is important
|
# Add rules to generate the keymap files - indentation here is important
|
||||||
$(INTERMEDIATE_OUTPUT)/src/keymap.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
$(INTERMEDIATE_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
||||||
$(eval CMD=$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON))
|
$(eval CMD=$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON))
|
||||||
@$(BUILD_CMD)
|
@$(BUILD_CMD)
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
$(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON)
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
||||||
$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
|
$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
|
||||||
@$(BUILD_CMD)
|
@$(BUILD_CMD)
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
$(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON)
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
||||||
$(eval CMD=$(QMK_BIN) generate-keymap-h --quiet --output $(INTERMEDIATE_OUTPUT)/src/keymap.h $(KEYMAP_JSON))
|
$(eval CMD=$(QMK_BIN) generate-keymap-h --quiet --output $(INTERMEDIATE_OUTPUT)/src/keymap.h $(KEYMAP_JSON))
|
||||||
@$(BUILD_CMD)
|
@$(BUILD_CMD)
|
||||||
@ -251,44 +224,6 @@ generated-files: $(INTERMEDIATE_OUTPUT)/src/config.h $(INTERMEDIATE_OUTPUT)/src/
|
|||||||
|
|
||||||
endif
|
endif
|
||||||
|
|
||||||
# Community modules
|
|
||||||
COMMUNITY_RULES_MK = $(shell $(QMK_BIN) generate-community-modules-rules-mk -kb $(KEYBOARD) --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/community_rules.mk $(KEYMAP_JSON))
|
|
||||||
include $(COMMUNITY_RULES_MK)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/community_modules.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-community-modules-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/community_modules.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-community-modules-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-led-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
$(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
|
|
||||||
@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
|
|
||||||
$(eval CMD=$(QMK_BIN) generate-rgb-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(KEYMAP_JSON))
|
|
||||||
@$(BUILD_CMD)
|
|
||||||
|
|
||||||
SRC += $(INTERMEDIATE_OUTPUT)/src/community_modules.c
|
|
||||||
|
|
||||||
generated-files: $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc
|
|
||||||
|
|
||||||
include $(BUILDDEFS_PATH)/converters.mk
|
include $(BUILDDEFS_PATH)/converters.mk
|
||||||
|
|
||||||
# Generate the board's version.h file.
|
# Generate the board's version.h file.
|
||||||
@ -378,14 +313,6 @@ endif
|
|||||||
|
|
||||||
# Find all of the config.h files and add them to our CONFIG_H define.
|
# Find all of the config.h files and add them to our CONFIG_H define.
|
||||||
CONFIG_H :=
|
CONFIG_H :=
|
||||||
|
|
||||||
define config_h_community_module_appender
|
|
||||||
ifneq ("$(wildcard $(1)/config.h)","")
|
|
||||||
CONFIG_H += $(1)/config.h
|
|
||||||
endif
|
|
||||||
endef
|
|
||||||
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call config_h_community_module_appender,$(module))))
|
|
||||||
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
|
||||||
CONFIG_H += $(KEYBOARD_PATH_5)/config.h
|
CONFIG_H += $(KEYBOARD_PATH_5)/config.h
|
||||||
endif
|
endif
|
||||||
@ -403,14 +330,6 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
|
|||||||
endif
|
endif
|
||||||
|
|
||||||
POST_CONFIG_H :=
|
POST_CONFIG_H :=
|
||||||
|
|
||||||
define post_config_h_community_module_appender
|
|
||||||
ifneq ("$(wildcard $(1)/post_config.h)","")
|
|
||||||
POST_CONFIG_H += $(1)/post_config.h
|
|
||||||
endif
|
|
||||||
endef
|
|
||||||
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_config_h_community_module_appender,$(module))))
|
|
||||||
|
|
||||||
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_config.h)","")
|
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_config.h)","")
|
||||||
POST_CONFIG_H += $(KEYBOARD_PATH_1)/post_config.h
|
POST_CONFIG_H += $(KEYBOARD_PATH_1)/post_config.h
|
||||||
endif
|
endif
|
||||||
@ -427,6 +346,40 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
|
|||||||
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
|
POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
|
||||||
endif
|
endif
|
||||||
|
|
||||||
|
# Create dependencies on DD keyboard config - structure validated elsewhere
|
||||||
|
DD_CONFIG_FILES :=
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
|
||||||
|
DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
|
||||||
|
endif
|
||||||
|
|
||||||
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
|
CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
|
||||||
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
|
KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
|
||||||
|
|
||||||
@ -491,18 +444,21 @@ ifneq ("$(CONVERTER)","")
|
|||||||
endif
|
endif
|
||||||
|
|
||||||
# Pull in post_rules.mk files from all our subfolders
|
# Pull in post_rules.mk files from all our subfolders
|
||||||
-include $(KEYBOARD_PATH_1)/post_rules.mk
|
ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_rules.mk)","")
|
||||||
-include $(KEYBOARD_PATH_2)/post_rules.mk
|
include $(KEYBOARD_PATH_1)/post_rules.mk
|
||||||
-include $(KEYBOARD_PATH_3)/post_rules.mk
|
endif
|
||||||
-include $(KEYBOARD_PATH_4)/post_rules.mk
|
ifneq ("$(wildcard $(KEYBOARD_PATH_2)/post_rules.mk)","")
|
||||||
-include $(KEYBOARD_PATH_5)/post_rules.mk
|
include $(KEYBOARD_PATH_2)/post_rules.mk
|
||||||
|
endif
|
||||||
define post_rules_mk_community_module_includer
|
ifneq ("$(wildcard $(KEYBOARD_PATH_3)/post_rules.mk)","")
|
||||||
ifneq ("$(wildcard $(1)/post_rules.mk)","")
|
include $(KEYBOARD_PATH_3)/post_rules.mk
|
||||||
include $(1)/post_rules.mk
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_4)/post_rules.mk)","")
|
||||||
|
include $(KEYBOARD_PATH_4)/post_rules.mk
|
||||||
|
endif
|
||||||
|
ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_rules.mk)","")
|
||||||
|
include $(KEYBOARD_PATH_5)/post_rules.mk
|
||||||
endif
|
endif
|
||||||
endef
|
|
||||||
$(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_rules_mk_community_module_includer,$(module))))
|
|
||||||
|
|
||||||
ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
|
ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
|
||||||
CONFIG_H += $(KEYMAP_PATH)/config.h
|
CONFIG_H += $(KEYMAP_PATH)/config.h
|
||||||
|
@ -7,7 +7,6 @@ endif
|
|||||||
OPT = g
|
OPT = g
|
||||||
|
|
||||||
include paths.mk
|
include paths.mk
|
||||||
include $(BUILDDEFS_PATH)/support.mk
|
|
||||||
include $(BUILDDEFS_PATH)/message.mk
|
include $(BUILDDEFS_PATH)/message.mk
|
||||||
|
|
||||||
TARGET=test/$(TEST_OUTPUT)
|
TARGET=test/$(TEST_OUTPUT)
|
||||||
|
@ -30,8 +30,6 @@ QUANTUM_SRC += \
|
|||||||
$(QUANTUM_DIR)/logging/sendchar.c \
|
$(QUANTUM_DIR)/logging/sendchar.c \
|
||||||
$(QUANTUM_DIR)/process_keycode/process_default_layer.c \
|
$(QUANTUM_DIR)/process_keycode/process_default_layer.c \
|
||||||
|
|
||||||
include $(QUANTUM_DIR)/nvm/rules.mk
|
|
||||||
|
|
||||||
VPATH += $(QUANTUM_DIR)/logging
|
VPATH += $(QUANTUM_DIR)/logging
|
||||||
# Fall back to lib/printf if there is no platform provided print
|
# Fall back to lib/printf if there is no platform provided print
|
||||||
ifeq ("$(wildcard $(PLATFORM_PATH)/$(PLATFORM_KEY)/printf.mk)","")
|
ifeq ("$(wildcard $(PLATFORM_PATH)/$(PLATFORM_KEY)/printf.mk)","")
|
||||||
@ -171,7 +169,6 @@ endif
|
|||||||
|
|
||||||
VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi wear_leveling legacy_stm32_flash
|
VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi wear_leveling legacy_stm32_flash
|
||||||
EEPROM_DRIVER ?= vendor
|
EEPROM_DRIVER ?= vendor
|
||||||
ifneq ($(strip $(EEPROM_DRIVER)),none)
|
|
||||||
ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
|
ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
|
||||||
$(call CATASTROPHIC_ERROR,Invalid EEPROM_DRIVER,EEPROM_DRIVER="$(EEPROM_DRIVER)" is not a valid EEPROM driver)
|
$(call CATASTROPHIC_ERROR,Invalid EEPROM_DRIVER,EEPROM_DRIVER="$(EEPROM_DRIVER)" is not a valid EEPROM driver)
|
||||||
else
|
else
|
||||||
@ -219,7 +216,7 @@ ifneq ($(strip $(EEPROM_DRIVER)),none)
|
|||||||
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
|
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
|
||||||
COMMON_VPATH += $(DRIVER_PATH)/flash
|
COMMON_VPATH += $(DRIVER_PATH)/flash
|
||||||
SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
|
SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
|
||||||
else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G0xx STM32G4xx WB32F3G71xx WB32FQ95xx AT32F415 GD32VF103),)
|
else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G4xx WB32F3G71xx WB32FQ95xx AT32F415 GD32VF103),)
|
||||||
# Wear-leveling EEPROM implementation, backed by MCU flash
|
# Wear-leveling EEPROM implementation, backed by MCU flash
|
||||||
OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
|
OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
|
||||||
SRC += eeprom_driver.c eeprom_wear_leveling.c
|
SRC += eeprom_driver.c eeprom_wear_leveling.c
|
||||||
@ -249,7 +246,6 @@ ifneq ($(strip $(EEPROM_DRIVER)),none)
|
|||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
endif
|
|
||||||
|
|
||||||
VALID_WEAR_LEVELING_DRIVER_TYPES := custom embedded_flash spi_flash rp2040_flash legacy
|
VALID_WEAR_LEVELING_DRIVER_TYPES := custom embedded_flash spi_flash rp2040_flash legacy
|
||||||
WEAR_LEVELING_DRIVER ?= none
|
WEAR_LEVELING_DRIVER ?= none
|
||||||
@ -267,14 +263,18 @@ ifneq ($(strip $(WEAR_LEVELING_DRIVER)),none)
|
|||||||
ifeq ($(strip $(WEAR_LEVELING_DRIVER)), embedded_flash)
|
ifeq ($(strip $(WEAR_LEVELING_DRIVER)), embedded_flash)
|
||||||
OPT_DEFS += -DHAL_USE_EFL
|
OPT_DEFS += -DHAL_USE_EFL
|
||||||
SRC += wear_leveling_efl.c
|
SRC += wear_leveling_efl.c
|
||||||
|
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_efl_config.h
|
||||||
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), spi_flash)
|
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), spi_flash)
|
||||||
FLASH_DRIVER := spi
|
FLASH_DRIVER := spi
|
||||||
SRC += wear_leveling_flash_spi.c
|
SRC += wear_leveling_flash_spi.c
|
||||||
|
POST_CONFIG_H += $(DRIVER_PATH)/wear_leveling/wear_leveling_flash_spi_config.h
|
||||||
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), rp2040_flash)
|
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), rp2040_flash)
|
||||||
SRC += wear_leveling_rp2040_flash.c
|
SRC += wear_leveling_rp2040_flash.c
|
||||||
|
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_PATH)/wear_leveling/wear_leveling_rp2040_flash_config.h
|
||||||
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), legacy)
|
else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), legacy)
|
||||||
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
|
COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
|
||||||
SRC += legacy_flash_ops.c wear_leveling_legacy.c
|
SRC += legacy_flash_ops.c wear_leveling_legacy.c
|
||||||
|
POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_legacy_config.h
|
||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
@ -433,13 +433,6 @@ ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
|
|||||||
SRC += snled27351-mono.c
|
SRC += snled27351-mono.c
|
||||||
endif
|
endif
|
||||||
|
|
||||||
ifeq ($(strip $(LED_MATRIX_CUSTOM_KB)), yes)
|
|
||||||
OPT_DEFS += -DLED_MATRIX_CUSTOM_KB
|
|
||||||
endif
|
|
||||||
|
|
||||||
ifeq ($(strip $(LED_MATRIX_CUSTOM_USER)), yes)
|
|
||||||
OPT_DEFS += -DLED_MATRIX_CUSTOM_USER
|
|
||||||
endif
|
|
||||||
endif
|
endif
|
||||||
|
|
||||||
# Deprecated driver names - do not use
|
# Deprecated driver names - do not use
|
||||||
@ -635,15 +628,6 @@ ifeq ($(strip $(VIA_ENABLE)), yes)
|
|||||||
TRI_LAYER_ENABLE := yes
|
TRI_LAYER_ENABLE := yes
|
||||||
endif
|
endif
|
||||||
|
|
||||||
ifeq ($(strip $(RAW_ENABLE)), yes)
|
|
||||||
OPT_DEFS += -DRAW_ENABLE
|
|
||||||
SRC += raw_hid.c
|
|
||||||
endif
|
|
||||||
|
|
||||||
ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
|
|
||||||
SEND_STRING_ENABLE := yes
|
|
||||||
endif
|
|
||||||
|
|
||||||
VALID_CUSTOM_MATRIX_TYPES:= yes lite no
|
VALID_CUSTOM_MATRIX_TYPES:= yes lite no
|
||||||
|
|
||||||
CUSTOM_MATRIX ?= no
|
CUSTOM_MATRIX ?= no
|
||||||
@ -722,7 +706,6 @@ ifeq ($(strip $(LIB8TION_ENABLE)), yes)
|
|||||||
# ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
|
# ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
|
||||||
OPT_DEFS += -DLIB8_ATTINY
|
OPT_DEFS += -DLIB8_ATTINY
|
||||||
endif
|
endif
|
||||||
OPT_DEFS += -DFASTLED_SCALE8_FIXED=1 -DFASTLED_BLEND_FIXED=1
|
|
||||||
SRC += $(LIB_PATH)/lib8tion/lib8tion.c
|
SRC += $(LIB_PATH)/lib8tion/lib8tion.c
|
||||||
endif
|
endif
|
||||||
|
|
||||||
@ -894,19 +877,19 @@ ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
|
|||||||
OPT_DEFS += -DBLUETOOTH_ENABLE
|
OPT_DEFS += -DBLUETOOTH_ENABLE
|
||||||
OPT_DEFS += -DBLUETOOTH_$(strip $(shell echo $(BLUETOOTH_DRIVER) | tr '[:lower:]' '[:upper:]'))
|
OPT_DEFS += -DBLUETOOTH_$(strip $(shell echo $(BLUETOOTH_DRIVER) | tr '[:lower:]' '[:upper:]'))
|
||||||
NO_USB_STARTUP_CHECK := yes
|
NO_USB_STARTUP_CHECK := yes
|
||||||
CONNECTION_ENABLE := yes
|
|
||||||
COMMON_VPATH += $(DRIVER_PATH)/bluetooth
|
COMMON_VPATH += $(DRIVER_PATH)/bluetooth
|
||||||
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
|
SRC += outputselect.c process_connection.c
|
||||||
|
|
||||||
ifeq ($(strip $(BLUETOOTH_DRIVER)), bluefruit_le)
|
ifeq ($(strip $(BLUETOOTH_DRIVER)), bluefruit_le)
|
||||||
SPI_DRIVER_REQUIRED = yes
|
SPI_DRIVER_REQUIRED = yes
|
||||||
SRC += $(DRIVER_PATH)/bluetooth/bluetooth_drivers.c
|
ANALOG_DRIVER_REQUIRED = yes
|
||||||
|
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
|
||||||
SRC += $(DRIVER_PATH)/bluetooth/bluefruit_le.cpp
|
SRC += $(DRIVER_PATH)/bluetooth/bluefruit_le.cpp
|
||||||
endif
|
endif
|
||||||
|
|
||||||
ifeq ($(strip $(BLUETOOTH_DRIVER)), rn42)
|
ifeq ($(strip $(BLUETOOTH_DRIVER)), rn42)
|
||||||
UART_DRIVER_REQUIRED = yes
|
UART_DRIVER_REQUIRED = yes
|
||||||
SRC += $(DRIVER_PATH)/bluetooth/bluetooth_drivers.c
|
SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
|
||||||
SRC += $(DRIVER_PATH)/bluetooth/rn42.c
|
SRC += $(DRIVER_PATH)/bluetooth/rn42.c
|
||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
@ -940,28 +923,6 @@ ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
|
|||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
|
|
||||||
VALID_BATTERY_DRIVER_TYPES := adc custom vendor
|
|
||||||
|
|
||||||
BATTERY_DRIVER ?= adc
|
|
||||||
ifeq ($(strip $(BATTERY_DRIVER_REQUIRED)), yes)
|
|
||||||
ifeq ($(filter $(BATTERY_DRIVER),$(VALID_BATTERY_DRIVER_TYPES)),)
|
|
||||||
$(call CATASTROPHIC_ERROR,Invalid BATTERY_DRIVER,BATTERY_DRIVER="$(BATTERY_DRIVER)" is not a valid battery driver)
|
|
||||||
endif
|
|
||||||
|
|
||||||
OPT_DEFS += -DBATTERY_DRIVER
|
|
||||||
OPT_DEFS += -DBATTERY_$(strip $(shell echo $(BATTERY_DRIVER) | tr '[:lower:]' '[:upper:]'))
|
|
||||||
|
|
||||||
COMMON_VPATH += $(DRIVER_PATH)/battery
|
|
||||||
|
|
||||||
SRC += battery.c
|
|
||||||
SRC += battery_$(strip $(BATTERY_DRIVER)).c
|
|
||||||
|
|
||||||
# add extra deps
|
|
||||||
ifeq ($(strip $(BATTERY_DRIVER)), adc)
|
|
||||||
ANALOG_DRIVER_REQUIRED = yes
|
|
||||||
endif
|
|
||||||
endif
|
|
||||||
|
|
||||||
VALID_WS2812_DRIVER_TYPES := bitbang custom i2c pwm spi vendor
|
VALID_WS2812_DRIVER_TYPES := bitbang custom i2c pwm spi vendor
|
||||||
|
|
||||||
WS2812_DRIVER ?= bitbang
|
WS2812_DRIVER ?= bitbang
|
||||||
@ -972,8 +933,6 @@ ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
|
|||||||
|
|
||||||
OPT_DEFS += -DWS2812_$(strip $(shell echo $(WS2812_DRIVER) | tr '[:lower:]' '[:upper:]'))
|
OPT_DEFS += -DWS2812_$(strip $(shell echo $(WS2812_DRIVER) | tr '[:lower:]' '[:upper:]'))
|
||||||
|
|
||||||
COMMON_VPATH += $(DRIVER_PATH)/led
|
|
||||||
|
|
||||||
SRC += ws2812.c ws2812_$(strip $(WS2812_DRIVER)).c
|
SRC += ws2812.c ws2812_$(strip $(WS2812_DRIVER)).c
|
||||||
|
|
||||||
ifeq ($(strip $(PLATFORM)), CHIBIOS)
|
ifeq ($(strip $(PLATFORM)), CHIBIOS)
|
||||||
|
@ -168,7 +168,7 @@ MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
|
|||||||
|
|
||||||
# For a ChibiOS build, ensure that the board files have the hook overrides injected
|
# For a ChibiOS build, ensure that the board files have the hook overrides injected
|
||||||
define BOARDSRC_INJECT_HOOKS
|
define BOARDSRC_INJECT_HOOKS
|
||||||
$(INTERMEDIATE_OUTPUT)/$(patsubst %.c,%.o,$(patsubst ./%,%,$1)): FILE_SPECIFIC_CFLAGS += -include $(TOP_DIR)/tmk_core/protocol/chibios/init_hooks.h
|
$(INTERMEDIATE_OUTPUT)/$(patsubst %.c,%.o,$(patsubst ./%,%,$1)): INIT_HOOK_CFLAGS += -include $(TOP_DIR)/tmk_core/protocol/chibios/init_hooks.h
|
||||||
endef
|
endef
|
||||||
$(foreach LOBJ, $(BOARDSRC), $(eval $(call BOARDSRC_INJECT_HOOKS,$(LOBJ))))
|
$(foreach LOBJ, $(BOARDSRC), $(eval $(call BOARDSRC_INJECT_HOOKS,$(LOBJ))))
|
||||||
|
|
||||||
@ -289,10 +289,10 @@ $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
|
|||||||
ifneq ($$(VERBOSE_C_INCLUDE),)
|
ifneq ($$(VERBOSE_C_INCLUDE),)
|
||||||
$$(if $$(filter $$(notdir $$(VERBOSE_C_INCLUDE)),$$(notdir $$<)),$$(eval CC_EXEC += -H))
|
$$(if $$(filter $$(notdir $$(VERBOSE_C_INCLUDE)),$$(notdir $$<)),$$(eval CC_EXEC += -H))
|
||||||
endif
|
endif
|
||||||
$$(eval CMD := $$(CC_EXEC) -c $$($1_CFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
$$(eval CMD := $$(CC_EXEC) -c $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
||||||
@$$(BUILD_CMD)
|
@$$(BUILD_CMD)
|
||||||
ifneq ($$(DUMP_C_MACROS),)
|
ifneq ($$(DUMP_C_MACROS),)
|
||||||
$$(eval CMD := $$(CC) -E -dM $$($1_CFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$<)
|
$$(eval CMD := $$(CC) -E -dM $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$<)
|
||||||
@$$(if $$(filter $$(notdir $$(DUMP_C_MACROS)),$$(notdir $$<)),$$(BUILD_CMD))
|
@$$(if $$(filter $$(notdir $$(DUMP_C_MACROS)),$$(notdir $$<)),$$(BUILD_CMD))
|
||||||
endif
|
endif
|
||||||
|
|
||||||
@ -300,13 +300,13 @@ $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
|
|||||||
$1/%.o : %.cpp $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
|
$1/%.o : %.cpp $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
|
||||||
@mkdir -p $$(@D)
|
@mkdir -p $$(@D)
|
||||||
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
|
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
|
||||||
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
||||||
@$$(BUILD_CMD)
|
@$$(BUILD_CMD)
|
||||||
|
|
||||||
$1/%.o : %.cc $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
|
$1/%.o : %.cc $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
|
||||||
@mkdir -p $$(@D)
|
@mkdir -p $$(@D)
|
||||||
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
|
@$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
|
||||||
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(FILE_SPECIFIC_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
$$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
|
||||||
@$$(BUILD_CMD)
|
@$$(BUILD_CMD)
|
||||||
|
|
||||||
# Assemble: create object files from assembler source files.
|
# Assemble: create object files from assembler source files.
|
||||||
|
@ -1,3 +1,10 @@
|
|||||||
|
# Note for new boards -- CTPC and CONVERT_TO_PROTON_C are deprecated terms
|
||||||
|
# and should not be replicated for new boards. These will be removed from
|
||||||
|
# documentation as well as existing keymaps in due course.
|
||||||
|
ifneq ($(findstring yes, $(CTPC)$(CONVERT_TO_PROTON_C)),)
|
||||||
|
$(call CATASTROPHIC_ERROR,The `CONVERT_TO_PROTON_C` and `CTPC` options are now deprecated. `CONVERT_TO=proton_c` should be used instead.)
|
||||||
|
endif
|
||||||
|
|
||||||
ifneq (,$(filter $(MCU),atmega32u4))
|
ifneq (,$(filter $(MCU),atmega32u4))
|
||||||
# TODO: opt in rather than assume everything uses a pro micro
|
# TODO: opt in rather than assume everything uses a pro micro
|
||||||
PIN_COMPATIBLE ?= promicro
|
PIN_COMPATIBLE ?= promicro
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"license": "GPL-2.0-or-later",
|
"license": "GPL-2.0-or-later",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vite": "^5.4.19",
|
"vite": "^5.2.14",
|
||||||
"vitepress": "^1.1.0",
|
"vitepress": "^1.1.0",
|
||||||
"vitepress-plugin-tabs": "^0.5.0",
|
"vitepress-plugin-tabs": "^0.5.0",
|
||||||
"vue": "^3.4.24"
|
"vue": "^3.4.24"
|
||||||
|
@ -178,220 +178,205 @@
|
|||||||
"@docsearch/css" "3.6.0"
|
"@docsearch/css" "3.6.0"
|
||||||
algoliasearch "^4.19.1"
|
algoliasearch "^4.19.1"
|
||||||
|
|
||||||
"@esbuild/aix-ppc64@0.21.5":
|
"@esbuild/aix-ppc64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz#c7184a326533fcdf1b8ee0733e21c713b975575f"
|
resolved "https://registry.yarnpkg.com/@esbuild/aix-ppc64/-/aix-ppc64-0.20.2.tgz#a70f4ac11c6a1dfc18b8bbb13284155d933b9537"
|
||||||
integrity sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==
|
integrity sha512-D+EBOJHXdNZcLJRBkhENNG8Wji2kgc9AZ9KiPr1JuZjsNtyHzrsfLRrY0tk2H2aoFu6RANO1y1iPPUCDYWkb5g==
|
||||||
|
|
||||||
"@esbuild/android-arm64@0.21.5":
|
"@esbuild/android-arm64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz#09d9b4357780da9ea3a7dfb833a1f1ff439b4052"
|
resolved "https://registry.yarnpkg.com/@esbuild/android-arm64/-/android-arm64-0.20.2.tgz#db1c9202a5bc92ea04c7b6840f1bbe09ebf9e6b9"
|
||||||
integrity sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==
|
integrity sha512-mRzjLacRtl/tWU0SvD8lUEwb61yP9cqQo6noDZP/O8VkwafSYwZ4yWy24kan8jE/IMERpYncRt2dw438LP3Xmg==
|
||||||
|
|
||||||
"@esbuild/android-arm@0.21.5":
|
"@esbuild/android-arm@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/android-arm/-/android-arm-0.21.5.tgz#9b04384fb771926dfa6d7ad04324ecb2ab9b2e28"
|
resolved "https://registry.yarnpkg.com/@esbuild/android-arm/-/android-arm-0.20.2.tgz#3b488c49aee9d491c2c8f98a909b785870d6e995"
|
||||||
integrity sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==
|
integrity sha512-t98Ra6pw2VaDhqNWO2Oph2LXbz/EJcnLmKLGBJwEwXX/JAN83Fym1rU8l0JUWK6HkIbWONCSSatf4sf2NBRx/w==
|
||||||
|
|
||||||
"@esbuild/android-x64@0.21.5":
|
"@esbuild/android-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/android-x64/-/android-x64-0.21.5.tgz#29918ec2db754cedcb6c1b04de8cd6547af6461e"
|
resolved "https://registry.yarnpkg.com/@esbuild/android-x64/-/android-x64-0.20.2.tgz#3b1628029e5576249d2b2d766696e50768449f98"
|
||||||
integrity sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==
|
integrity sha512-btzExgV+/lMGDDa194CcUQm53ncxzeBrWJcncOBxuC6ndBkKxnHdFJn86mCIgTELsooUmwUm9FkhSp5HYu00Rg==
|
||||||
|
|
||||||
"@esbuild/darwin-arm64@0.21.5":
|
"@esbuild/darwin-arm64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz#e495b539660e51690f3928af50a76fb0a6ccff2a"
|
resolved "https://registry.yarnpkg.com/@esbuild/darwin-arm64/-/darwin-arm64-0.20.2.tgz#6e8517a045ddd86ae30c6608c8475ebc0c4000bb"
|
||||||
integrity sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==
|
integrity sha512-4J6IRT+10J3aJH3l1yzEg9y3wkTDgDk7TSDFX+wKFiWjqWp/iCfLIYzGyasx9l0SAFPT1HwSCR+0w/h1ES/MjA==
|
||||||
|
|
||||||
"@esbuild/darwin-x64@0.21.5":
|
"@esbuild/darwin-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz#c13838fa57372839abdddc91d71542ceea2e1e22"
|
resolved "https://registry.yarnpkg.com/@esbuild/darwin-x64/-/darwin-x64-0.20.2.tgz#90ed098e1f9dd8a9381695b207e1cff45540a0d0"
|
||||||
integrity sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==
|
integrity sha512-tBcXp9KNphnNH0dfhv8KYkZhjc+H3XBkF5DKtswJblV7KlT9EI2+jeA8DgBjp908WEuYll6pF+UStUCfEpdysA==
|
||||||
|
|
||||||
"@esbuild/freebsd-arm64@0.21.5":
|
"@esbuild/freebsd-arm64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz#646b989aa20bf89fd071dd5dbfad69a3542e550e"
|
resolved "https://registry.yarnpkg.com/@esbuild/freebsd-arm64/-/freebsd-arm64-0.20.2.tgz#d71502d1ee89a1130327e890364666c760a2a911"
|
||||||
integrity sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==
|
integrity sha512-d3qI41G4SuLiCGCFGUrKsSeTXyWG6yem1KcGZVS+3FYlYhtNoNgYrWcvkOoaqMhwXSMrZRl69ArHsGJ9mYdbbw==
|
||||||
|
|
||||||
"@esbuild/freebsd-x64@0.21.5":
|
"@esbuild/freebsd-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz#aa615cfc80af954d3458906e38ca22c18cf5c261"
|
resolved "https://registry.yarnpkg.com/@esbuild/freebsd-x64/-/freebsd-x64-0.20.2.tgz#aa5ea58d9c1dd9af688b8b6f63ef0d3d60cea53c"
|
||||||
integrity sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==
|
integrity sha512-d+DipyvHRuqEeM5zDivKV1KuXn9WeRX6vqSqIDgwIfPQtwMP4jaDsQsDncjTDDsExT4lR/91OLjRo8bmC1e+Cw==
|
||||||
|
|
||||||
"@esbuild/linux-arm64@0.21.5":
|
"@esbuild/linux-arm64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz#70ac6fa14f5cb7e1f7f887bcffb680ad09922b5b"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-arm64/-/linux-arm64-0.20.2.tgz#055b63725df678379b0f6db9d0fa85463755b2e5"
|
||||||
integrity sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==
|
integrity sha512-9pb6rBjGvTFNira2FLIWqDk/uaf42sSyLE8j1rnUpuzsODBq7FvpwHYZxQ/It/8b+QOS1RYfqgGFNLRI+qlq2A==
|
||||||
|
|
||||||
"@esbuild/linux-arm@0.21.5":
|
"@esbuild/linux-arm@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz#fc6fd11a8aca56c1f6f3894f2bea0479f8f626b9"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-arm/-/linux-arm-0.20.2.tgz#76b3b98cb1f87936fbc37f073efabad49dcd889c"
|
||||||
integrity sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==
|
integrity sha512-VhLPeR8HTMPccbuWWcEUD1Az68TqaTYyj6nfE4QByZIQEQVWBB8vup8PpR7y1QHL3CpcF6xd5WVBU/+SBEvGTg==
|
||||||
|
|
||||||
"@esbuild/linux-ia32@0.21.5":
|
"@esbuild/linux-ia32@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz#3271f53b3f93e3d093d518d1649d6d68d346ede2"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-ia32/-/linux-ia32-0.20.2.tgz#c0e5e787c285264e5dfc7a79f04b8b4eefdad7fa"
|
||||||
integrity sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==
|
integrity sha512-o10utieEkNPFDZFQm9CoP7Tvb33UutoJqg3qKf1PWVeeJhJw0Q347PxMvBgVVFgouYLGIhFYG0UGdBumROyiig==
|
||||||
|
|
||||||
"@esbuild/linux-loong64@0.21.5":
|
"@esbuild/linux-loong64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz#ed62e04238c57026aea831c5a130b73c0f9f26df"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-loong64/-/linux-loong64-0.20.2.tgz#a6184e62bd7cdc63e0c0448b83801001653219c5"
|
||||||
integrity sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==
|
integrity sha512-PR7sp6R/UC4CFVomVINKJ80pMFlfDfMQMYynX7t1tNTeivQ6XdX5r2XovMmha/VjR1YN/HgHWsVcTRIMkymrgQ==
|
||||||
|
|
||||||
"@esbuild/linux-mips64el@0.21.5":
|
"@esbuild/linux-mips64el@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz#e79b8eb48bf3b106fadec1ac8240fb97b4e64cbe"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-mips64el/-/linux-mips64el-0.20.2.tgz#d08e39ce86f45ef8fc88549d29c62b8acf5649aa"
|
||||||
integrity sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==
|
integrity sha512-4BlTqeutE/KnOiTG5Y6Sb/Hw6hsBOZapOVF6njAESHInhlQAghVVZL1ZpIctBOoTFbQyGW+LsVYZ8lSSB3wkjA==
|
||||||
|
|
||||||
"@esbuild/linux-ppc64@0.21.5":
|
"@esbuild/linux-ppc64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz#5f2203860a143b9919d383ef7573521fb154c3e4"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-ppc64/-/linux-ppc64-0.20.2.tgz#8d252f0b7756ffd6d1cbde5ea67ff8fd20437f20"
|
||||||
integrity sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==
|
integrity sha512-rD3KsaDprDcfajSKdn25ooz5J5/fWBylaaXkuotBDGnMnDP1Uv5DLAN/45qfnf3JDYyJv/ytGHQaziHUdyzaAg==
|
||||||
|
|
||||||
"@esbuild/linux-riscv64@0.21.5":
|
"@esbuild/linux-riscv64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz#07bcafd99322d5af62f618cb9e6a9b7f4bb825dc"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-riscv64/-/linux-riscv64-0.20.2.tgz#19f6dcdb14409dae607f66ca1181dd4e9db81300"
|
||||||
integrity sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==
|
integrity sha512-snwmBKacKmwTMmhLlz/3aH1Q9T8v45bKYGE3j26TsaOVtjIag4wLfWSiZykXzXuE1kbCE+zJRmwp+ZbIHinnVg==
|
||||||
|
|
||||||
"@esbuild/linux-s390x@0.21.5":
|
"@esbuild/linux-s390x@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz#b7ccf686751d6a3e44b8627ababc8be3ef62d8de"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-s390x/-/linux-s390x-0.20.2.tgz#3c830c90f1a5d7dd1473d5595ea4ebb920988685"
|
||||||
integrity sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==
|
integrity sha512-wcWISOobRWNm3cezm5HOZcYz1sKoHLd8VL1dl309DiixxVFoFe/o8HnwuIwn6sXre88Nwj+VwZUvJf4AFxkyrQ==
|
||||||
|
|
||||||
"@esbuild/linux-x64@0.21.5":
|
"@esbuild/linux-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz#6d8f0c768e070e64309af8004bb94e68ab2bb3b0"
|
resolved "https://registry.yarnpkg.com/@esbuild/linux-x64/-/linux-x64-0.20.2.tgz#86eca35203afc0d9de0694c64ec0ab0a378f6fff"
|
||||||
integrity sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==
|
integrity sha512-1MdwI6OOTsfQfek8sLwgyjOXAu+wKhLEoaOLTjbijk6E2WONYpH9ZU2mNtR+lZ2B4uwr+usqGuVfFT9tMtGvGw==
|
||||||
|
|
||||||
"@esbuild/netbsd-x64@0.21.5":
|
"@esbuild/netbsd-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz#bbe430f60d378ecb88decb219c602667387a6047"
|
resolved "https://registry.yarnpkg.com/@esbuild/netbsd-x64/-/netbsd-x64-0.20.2.tgz#e771c8eb0e0f6e1877ffd4220036b98aed5915e6"
|
||||||
integrity sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==
|
integrity sha512-K8/DhBxcVQkzYc43yJXDSyjlFeHQJBiowJ0uVL6Tor3jGQfSGHNNJcWxNbOI8v5k82prYqzPuwkzHt3J1T1iZQ==
|
||||||
|
|
||||||
"@esbuild/openbsd-x64@0.21.5":
|
"@esbuild/openbsd-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz#99d1cf2937279560d2104821f5ccce220cb2af70"
|
resolved "https://registry.yarnpkg.com/@esbuild/openbsd-x64/-/openbsd-x64-0.20.2.tgz#9a795ae4b4e37e674f0f4d716f3e226dd7c39baf"
|
||||||
integrity sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==
|
integrity sha512-eMpKlV0SThJmmJgiVyN9jTPJ2VBPquf6Kt/nAoo6DgHAoN57K15ZghiHaMvqjCye/uU4X5u3YSMgVBI1h3vKrQ==
|
||||||
|
|
||||||
"@esbuild/sunos-x64@0.21.5":
|
"@esbuild/sunos-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz#08741512c10d529566baba837b4fe052c8f3487b"
|
resolved "https://registry.yarnpkg.com/@esbuild/sunos-x64/-/sunos-x64-0.20.2.tgz#7df23b61a497b8ac189def6e25a95673caedb03f"
|
||||||
integrity sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==
|
integrity sha512-2UyFtRC6cXLyejf/YEld4Hajo7UHILetzE1vsRcGL3earZEW77JxrFjH4Ez2qaTiEfMgAXxfAZCm1fvM/G/o8w==
|
||||||
|
|
||||||
"@esbuild/win32-arm64@0.21.5":
|
"@esbuild/win32-arm64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz#675b7385398411240735016144ab2e99a60fc75d"
|
resolved "https://registry.yarnpkg.com/@esbuild/win32-arm64/-/win32-arm64-0.20.2.tgz#f1ae5abf9ca052ae11c1bc806fb4c0f519bacf90"
|
||||||
integrity sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==
|
integrity sha512-GRibxoawM9ZCnDxnP3usoUDO9vUkpAxIIZ6GQI+IlVmr5kP3zUq+l17xELTHMWTWzjxa2guPNyrpq1GWmPvcGQ==
|
||||||
|
|
||||||
"@esbuild/win32-ia32@0.21.5":
|
"@esbuild/win32-ia32@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz#1bfc3ce98aa6ca9a0969e4d2af72144c59c1193b"
|
resolved "https://registry.yarnpkg.com/@esbuild/win32-ia32/-/win32-ia32-0.20.2.tgz#241fe62c34d8e8461cd708277813e1d0ba55ce23"
|
||||||
integrity sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==
|
integrity sha512-HfLOfn9YWmkSKRQqovpnITazdtquEW8/SoHW7pWpuEeguaZI4QnCRW6b+oZTztdBnZOS2hqJ6im/D5cPzBTTlQ==
|
||||||
|
|
||||||
"@esbuild/win32-x64@0.21.5":
|
"@esbuild/win32-x64@0.20.2":
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz#acad351d582d157bb145535db2a6ff53dd514b5c"
|
resolved "https://registry.yarnpkg.com/@esbuild/win32-x64/-/win32-x64-0.20.2.tgz#9c907b21e30a52db959ba4f80bb01a0cc403d5cc"
|
||||||
integrity sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==
|
integrity sha512-N49X4lJX27+l9jbLKSqZ6bKNjzQvHaT8IIFUy+YIqmXQdjYCToGWwOItDrfby14c78aDd5NHQl29xingXfCdLQ==
|
||||||
|
|
||||||
"@jridgewell/sourcemap-codec@^1.4.15":
|
"@jridgewell/sourcemap-codec@^1.4.15":
|
||||||
version "1.4.15"
|
version "1.4.15"
|
||||||
resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz#d7c6e6755c78567a951e04ab52ef0fd26de59f32"
|
resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz#d7c6e6755c78567a951e04ab52ef0fd26de59f32"
|
||||||
integrity sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==
|
integrity sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==
|
||||||
|
|
||||||
"@rollup/rollup-android-arm-eabi@4.31.0":
|
"@rollup/rollup-android-arm-eabi@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.31.0.tgz#d4dd60da0075a6ce9a6c76d71b8204f3e1822285"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.22.4.tgz#8b613b9725e8f9479d142970b106b6ae878610d5"
|
||||||
integrity sha512-9NrR4033uCbUBRgvLcBrJofa2KY9DzxL2UKZ1/4xA/mnTNyhZCWBuD8X3tPm1n4KxcgaraOYgrFKSgwjASfmlA==
|
integrity sha512-Fxamp4aEZnfPOcGA8KSNEohV8hX7zVHOemC8jVBoBUHu5zpJK/Eu3uJwt6BMgy9fkvzxDaurgj96F/NiLukF2w==
|
||||||
|
|
||||||
"@rollup/rollup-android-arm64@4.31.0":
|
"@rollup/rollup-android-arm64@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.31.0.tgz#25c4d33259a7a2ccd2f52a5ffcc0bb3ab3f0729d"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.22.4.tgz#654ca1049189132ff602bfcf8df14c18da1f15fb"
|
||||||
integrity sha512-iBbODqT86YBFHajxxF8ebj2hwKm1k8PTBQSojSt3d1FFt1gN+xf4CowE47iN0vOSdnd+5ierMHBbu/rHc7nq5g==
|
integrity sha512-VXoK5UMrgECLYaMuGuVTOx5kcuap1Jm8g/M83RnCHBKOqvPPmROFJGQaZhGccnsFtfXQ3XYa4/jMCJvZnbJBdA==
|
||||||
|
|
||||||
"@rollup/rollup-darwin-arm64@4.31.0":
|
"@rollup/rollup-darwin-arm64@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.31.0.tgz#d137dff254b19163a6b52ac083a71cd055dae844"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.22.4.tgz#6d241d099d1518ef0c2205d96b3fa52e0fe1954b"
|
||||||
integrity sha512-WHIZfXgVBX30SWuTMhlHPXTyN20AXrLH4TEeH/D0Bolvx9PjgZnn4H677PlSGvU6MKNsjCQJYczkpvBbrBnG6g==
|
integrity sha512-xMM9ORBqu81jyMKCDP+SZDhnX2QEVQzTcC6G18KlTQEzWK8r/oNZtKuZaCcHhnsa6fEeOBionoyl5JsAbE/36Q==
|
||||||
|
|
||||||
"@rollup/rollup-darwin-x64@4.31.0":
|
"@rollup/rollup-darwin-x64@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.31.0.tgz#58ff20b5dacb797d3adca19f02a21c532f9d55bf"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.22.4.tgz#42bd19d292a57ee11734c980c4650de26b457791"
|
||||||
integrity sha512-hrWL7uQacTEF8gdrQAqcDy9xllQ0w0zuL1wk1HV8wKGSGbKPVjVUv/DEwT2+Asabf8Dh/As+IvfdU+H8hhzrQQ==
|
integrity sha512-aJJyYKQwbHuhTUrjWjxEvGnNNBCnmpHDvrb8JFDbeSH3m2XdHcxDd3jthAzvmoI8w/kSjd2y0udT+4okADsZIw==
|
||||||
|
|
||||||
"@rollup/rollup-freebsd-arm64@4.31.0":
|
"@rollup/rollup-linux-arm-gnueabihf@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.31.0.tgz#96ce1a241c591ec3e068f4af765d94eddb24e60c"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.22.4.tgz#f23555ee3d8fe941c5c5fd458cd22b65eb1c2232"
|
||||||
integrity sha512-S2oCsZ4hJviG1QjPY1h6sVJLBI6ekBeAEssYKad1soRFv3SocsQCzX6cwnk6fID6UQQACTjeIMB+hyYrFacRew==
|
integrity sha512-j63YtCIRAzbO+gC2L9dWXRh5BFetsv0j0va0Wi9epXDgU/XUi5dJKo4USTttVyK7fGw2nPWK0PbAvyliz50SCQ==
|
||||||
|
|
||||||
"@rollup/rollup-freebsd-x64@4.31.0":
|
"@rollup/rollup-linux-arm-musleabihf@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.31.0.tgz#e59e7ede505be41f0b4311b0b943f8eb44938467"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.22.4.tgz#f3bbd1ae2420f5539d40ac1fde2b38da67779baa"
|
||||||
integrity sha512-pCANqpynRS4Jirn4IKZH4tnm2+2CqCNLKD7gAdEjzdLGbH1iO0zouHz4mxqg0uEMpO030ejJ0aA6e1PJo2xrPA==
|
integrity sha512-dJnWUgwWBX1YBRsuKKMOlXCzh2Wu1mlHzv20TpqEsfdZLb3WoJW2kIEsGwLkroYf24IrPAvOT/ZQ2OYMV6vlrg==
|
||||||
|
|
||||||
"@rollup/rollup-linux-arm-gnueabihf@4.31.0":
|
"@rollup/rollup-linux-arm64-gnu@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.31.0.tgz#e455ca6e4ff35bd46d62201c153352e717000a7b"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.22.4.tgz#7abe900120113e08a1f90afb84c7c28774054d15"
|
||||||
integrity sha512-0O8ViX+QcBd3ZmGlcFTnYXZKGbFu09EhgD27tgTdGnkcYXLat4KIsBBQeKLR2xZDCXdIBAlWLkiXE1+rJpCxFw==
|
integrity sha512-AdPRoNi3NKVLolCN/Sp4F4N1d98c4SBnHMKoLuiG6RXgoZ4sllseuGioszumnPGmPM2O7qaAX/IJdeDU8f26Aw==
|
||||||
|
|
||||||
"@rollup/rollup-linux-arm-musleabihf@4.31.0":
|
"@rollup/rollup-linux-arm64-musl@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.31.0.tgz#bc1a93d807d19e70b1e343a5bfea43723bcd6327"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.22.4.tgz#9e655285c8175cd44f57d6a1e8e5dedfbba1d820"
|
||||||
integrity sha512-w5IzG0wTVv7B0/SwDnMYmbr2uERQp999q8FMkKG1I+j8hpPX2BYFjWe69xbhbP6J9h2gId/7ogesl9hwblFwwg==
|
integrity sha512-Gl0AxBtDg8uoAn5CCqQDMqAx22Wx22pjDOjBdmG0VIWX3qUBHzYmOKh8KXHL4UpogfJ14G4wk16EQogF+v8hmA==
|
||||||
|
|
||||||
"@rollup/rollup-linux-arm64-gnu@4.31.0":
|
"@rollup/rollup-linux-powerpc64le-gnu@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.31.0.tgz#f38bf843f1dc3d5de680caf31084008846e3efae"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.22.4.tgz#9a79ae6c9e9d8fe83d49e2712ecf4302db5bef5e"
|
||||||
integrity sha512-JyFFshbN5xwy6fulZ8B/8qOqENRmDdEkcIMF0Zz+RsfamEW+Zabl5jAb0IozP/8UKnJ7g2FtZZPEUIAlUSX8cA==
|
integrity sha512-3aVCK9xfWW1oGQpTsYJJPF6bfpWfhbRnhdlyhak2ZiyFLDaayz0EP5j9V1RVLAAxlmWKTDfS9wyRyY3hvhPoOg==
|
||||||
|
|
||||||
"@rollup/rollup-linux-arm64-musl@4.31.0":
|
"@rollup/rollup-linux-riscv64-gnu@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.31.0.tgz#b3987a96c18b7287129cf735be2dbf83e94d9d05"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.22.4.tgz#67ac70eca4ace8e2942fabca95164e8874ab8128"
|
||||||
integrity sha512-kpQXQ0UPFeMPmPYksiBL9WS/BDiQEjRGMfklVIsA0Sng347H8W2iexch+IEwaR7OVSKtr2ZFxggt11zVIlZ25g==
|
integrity sha512-ePYIir6VYnhgv2C5Xe9u+ico4t8sZWXschR6fMgoPUK31yQu7hTEJb7bCqivHECwIClJfKgE7zYsh1qTP3WHUA==
|
||||||
|
|
||||||
"@rollup/rollup-linux-loongarch64-gnu@4.31.0":
|
"@rollup/rollup-linux-s390x-gnu@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.31.0.tgz#0f0324044e71c4f02e9f49e7ec4e347b655b34ee"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.22.4.tgz#9f883a7440f51a22ed7f99e1d070bd84ea5005fc"
|
||||||
integrity sha512-pMlxLjt60iQTzt9iBb3jZphFIl55a70wexvo8p+vVFK+7ifTRookdoXX3bOsRdmfD+OKnMozKO6XM4zR0sHRrQ==
|
integrity sha512-GqFJ9wLlbB9daxhVlrTe61vJtEY99/xB3C8e4ULVsVfflcpmR6c8UZXjtkMA6FhNONhj2eA5Tk9uAVw5orEs4Q==
|
||||||
|
|
||||||
"@rollup/rollup-linux-powerpc64le-gnu@4.31.0":
|
"@rollup/rollup-linux-x64-gnu@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.31.0.tgz#809479f27f1fd5b4eecd2aa732132ad952d454ba"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.22.4.tgz#70116ae6c577fe367f58559e2cffb5641a1dd9d0"
|
||||||
integrity sha512-D7TXT7I/uKEuWiRkEFbed1UUYZwcJDU4vZQdPTcepK7ecPhzKOYk4Er2YR4uHKme4qDeIh6N3XrLfpuM7vzRWQ==
|
integrity sha512-87v0ol2sH9GE3cLQLNEy0K/R0pz1nvg76o8M5nhMR0+Q+BBGLnb35P0fVz4CQxHYXaAOhE8HhlkaZfsdUOlHwg==
|
||||||
|
|
||||||
"@rollup/rollup-linux-riscv64-gnu@4.31.0":
|
"@rollup/rollup-linux-x64-musl@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.31.0.tgz#7bc75c4f22db04d3c972f83431739cfa41c6a36e"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.22.4.tgz#f473f88219feb07b0b98b53a7923be716d1d182f"
|
||||||
integrity sha512-wal2Tc8O5lMBtoePLBYRKj2CImUCJ4UNGJlLwspx7QApYny7K1cUYlzQ/4IGQBLmm+y0RS7dwc3TDO/pmcneTw==
|
integrity sha512-UV6FZMUgePDZrFjrNGIWzDo/vABebuXBhJEqrHxrGiU6HikPy0Z3LfdtciIttEUQfuDdCn8fqh7wiFJjCNwO+g==
|
||||||
|
|
||||||
"@rollup/rollup-linux-s390x-gnu@4.31.0":
|
"@rollup/rollup-win32-arm64-msvc@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.31.0.tgz#cfe8052345c55864d83ae343362cf1912480170e"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.22.4.tgz#4349482d17f5d1c58604d1c8900540d676f420e0"
|
||||||
integrity sha512-O1o5EUI0+RRMkK9wiTVpk2tyzXdXefHtRTIjBbmFREmNMy7pFeYXCFGbhKFwISA3UOExlo5GGUuuj3oMKdK6JQ==
|
integrity sha512-BjI+NVVEGAXjGWYHz/vv0pBqfGoUH0IGZ0cICTn7kB9PyjrATSkX+8WkguNjWoj2qSr1im/+tTGRaY+4/PdcQw==
|
||||||
|
|
||||||
"@rollup/rollup-linux-x64-gnu@4.31.0":
|
"@rollup/rollup-win32-ia32-msvc@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.31.0.tgz#c6b048f1e25f3fea5b4bd246232f4d07a159c5a0"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.22.4.tgz#a6fc39a15db618040ec3c2a24c1e26cb5f4d7422"
|
||||||
integrity sha512-zSoHl356vKnNxwOWnLd60ixHNPRBglxpv2g7q0Cd3Pmr561gf0HiAcUBRL3S1vPqRC17Zo2CX/9cPkqTIiai1g==
|
integrity sha512-SiWG/1TuUdPvYmzmYnmd3IEifzR61Tragkbx9D3+R8mzQqDBz8v+BvZNDlkiTtI9T15KYZhP0ehn3Dld4n9J5g==
|
||||||
|
|
||||||
"@rollup/rollup-linux-x64-musl@4.31.0":
|
"@rollup/rollup-win32-x64-msvc@4.22.4":
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.31.0.tgz#615273ac52d1a201f4de191cbd3389016a9d7d80"
|
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.22.4.tgz#3dd5d53e900df2a40841882c02e56f866c04d202"
|
||||||
integrity sha512-ypB/HMtcSGhKUQNiFwqgdclWNRrAYDH8iMYH4etw/ZlGwiTVxBz2tDrGRrPlfZu6QjXwtd+C3Zib5pFqID97ZA==
|
integrity sha512-j8pPKp53/lq9lMXN57S8cFz0MynJk8OWNuUnXct/9KCpKU7DgU3bYMJhwWmcqC0UU29p8Lr0/7KEVcaM6bf47Q==
|
||||||
|
|
||||||
"@rollup/rollup-win32-arm64-msvc@4.31.0":
|
|
||||||
version "4.31.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.31.0.tgz#32ed85810c1b831c648eca999d68f01255b30691"
|
|
||||||
integrity sha512-JuhN2xdI/m8Hr+aVO3vspO7OQfUFO6bKLIRTAy0U15vmWjnZDLrEgCZ2s6+scAYaQVpYSh9tZtRijApw9IXyMw==
|
|
||||||
|
|
||||||
"@rollup/rollup-win32-ia32-msvc@4.31.0":
|
|
||||||
version "4.31.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.31.0.tgz#d47effada68bcbfdccd30c4a788d42e4542ff4d3"
|
|
||||||
integrity sha512-U1xZZXYkvdf5MIWmftU8wrM5PPXzyaY1nGCI4KI4BFfoZxHamsIe+BtnPLIvvPykvQWlVbqUXdLa4aJUuilwLQ==
|
|
||||||
|
|
||||||
"@rollup/rollup-win32-x64-msvc@4.31.0":
|
|
||||||
version "4.31.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.31.0.tgz#7a2d89a82cf0388d60304964217dd7beac6de645"
|
|
||||||
integrity sha512-ul8rnCsUumNln5YWwz0ted2ZHFhzhRRnkpBZ+YRuHoRAlUji9KChpOUOndY7uykrPEPXVbHLlsdo6v5yXo/TXw==
|
|
||||||
|
|
||||||
"@shikijs/core@1.3.0", "@shikijs/core@^1.3.0":
|
"@shikijs/core@1.3.0", "@shikijs/core@^1.3.0":
|
||||||
version "1.3.0"
|
version "1.3.0"
|
||||||
@ -405,10 +390,10 @@
|
|||||||
dependencies:
|
dependencies:
|
||||||
shiki "1.3.0"
|
shiki "1.3.0"
|
||||||
|
|
||||||
"@types/estree@1.0.6":
|
"@types/estree@1.0.5":
|
||||||
version "1.0.6"
|
version "1.0.5"
|
||||||
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.6.tgz#628effeeae2064a1b4e79f78e81d87b7e5fc7b50"
|
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.5.tgz#a6ce3e556e00fd9895dd872dd172ad0d4bd687f4"
|
||||||
integrity sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==
|
integrity sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==
|
||||||
|
|
||||||
"@types/linkify-it@*":
|
"@types/linkify-it@*":
|
||||||
version "3.0.5"
|
version "3.0.5"
|
||||||
@ -604,34 +589,34 @@ entities@^4.5.0:
|
|||||||
resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48"
|
resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48"
|
||||||
integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==
|
integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==
|
||||||
|
|
||||||
esbuild@^0.21.3:
|
esbuild@^0.20.1:
|
||||||
version "0.21.5"
|
version "0.20.2"
|
||||||
resolved "https://registry.yarnpkg.com/esbuild/-/esbuild-0.21.5.tgz#9ca301b120922959b766360d8ac830da0d02997d"
|
resolved "https://registry.yarnpkg.com/esbuild/-/esbuild-0.20.2.tgz#9d6b2386561766ee6b5a55196c6d766d28c87ea1"
|
||||||
integrity sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==
|
integrity sha512-WdOOppmUNU+IbZ0PaDiTst80zjnrOkyJNHoKupIcVyU8Lvla3Ugx94VzkQ32Ijqd7UhHJy75gNWDMUekcrSJ6g==
|
||||||
optionalDependencies:
|
optionalDependencies:
|
||||||
"@esbuild/aix-ppc64" "0.21.5"
|
"@esbuild/aix-ppc64" "0.20.2"
|
||||||
"@esbuild/android-arm" "0.21.5"
|
"@esbuild/android-arm" "0.20.2"
|
||||||
"@esbuild/android-arm64" "0.21.5"
|
"@esbuild/android-arm64" "0.20.2"
|
||||||
"@esbuild/android-x64" "0.21.5"
|
"@esbuild/android-x64" "0.20.2"
|
||||||
"@esbuild/darwin-arm64" "0.21.5"
|
"@esbuild/darwin-arm64" "0.20.2"
|
||||||
"@esbuild/darwin-x64" "0.21.5"
|
"@esbuild/darwin-x64" "0.20.2"
|
||||||
"@esbuild/freebsd-arm64" "0.21.5"
|
"@esbuild/freebsd-arm64" "0.20.2"
|
||||||
"@esbuild/freebsd-x64" "0.21.5"
|
"@esbuild/freebsd-x64" "0.20.2"
|
||||||
"@esbuild/linux-arm" "0.21.5"
|
"@esbuild/linux-arm" "0.20.2"
|
||||||
"@esbuild/linux-arm64" "0.21.5"
|
"@esbuild/linux-arm64" "0.20.2"
|
||||||
"@esbuild/linux-ia32" "0.21.5"
|
"@esbuild/linux-ia32" "0.20.2"
|
||||||
"@esbuild/linux-loong64" "0.21.5"
|
"@esbuild/linux-loong64" "0.20.2"
|
||||||
"@esbuild/linux-mips64el" "0.21.5"
|
"@esbuild/linux-mips64el" "0.20.2"
|
||||||
"@esbuild/linux-ppc64" "0.21.5"
|
"@esbuild/linux-ppc64" "0.20.2"
|
||||||
"@esbuild/linux-riscv64" "0.21.5"
|
"@esbuild/linux-riscv64" "0.20.2"
|
||||||
"@esbuild/linux-s390x" "0.21.5"
|
"@esbuild/linux-s390x" "0.20.2"
|
||||||
"@esbuild/linux-x64" "0.21.5"
|
"@esbuild/linux-x64" "0.20.2"
|
||||||
"@esbuild/netbsd-x64" "0.21.5"
|
"@esbuild/netbsd-x64" "0.20.2"
|
||||||
"@esbuild/openbsd-x64" "0.21.5"
|
"@esbuild/openbsd-x64" "0.20.2"
|
||||||
"@esbuild/sunos-x64" "0.21.5"
|
"@esbuild/sunos-x64" "0.20.2"
|
||||||
"@esbuild/win32-arm64" "0.21.5"
|
"@esbuild/win32-arm64" "0.20.2"
|
||||||
"@esbuild/win32-ia32" "0.21.5"
|
"@esbuild/win32-ia32" "0.20.2"
|
||||||
"@esbuild/win32-x64" "0.21.5"
|
"@esbuild/win32-x64" "0.20.2"
|
||||||
|
|
||||||
estree-walker@^2.0.2:
|
estree-walker@^2.0.2:
|
||||||
version "2.0.2"
|
version "2.0.2"
|
||||||
@ -677,29 +662,29 @@ mitt@^3.0.1:
|
|||||||
resolved "https://registry.yarnpkg.com/mitt/-/mitt-3.0.1.tgz#ea36cf0cc30403601ae074c8f77b7092cdab36d1"
|
resolved "https://registry.yarnpkg.com/mitt/-/mitt-3.0.1.tgz#ea36cf0cc30403601ae074c8f77b7092cdab36d1"
|
||||||
integrity sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==
|
integrity sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==
|
||||||
|
|
||||||
nanoid@^3.3.8:
|
nanoid@^3.3.7:
|
||||||
version "3.3.8"
|
version "3.3.7"
|
||||||
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.8.tgz#b1be3030bee36aaff18bacb375e5cce521684baf"
|
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.7.tgz#d0c301a691bc8d54efa0a2226ccf3fe2fd656bd8"
|
||||||
integrity sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==
|
integrity sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==
|
||||||
|
|
||||||
perfect-debounce@^1.0.0:
|
perfect-debounce@^1.0.0:
|
||||||
version "1.0.0"
|
version "1.0.0"
|
||||||
resolved "https://registry.yarnpkg.com/perfect-debounce/-/perfect-debounce-1.0.0.tgz#9c2e8bc30b169cc984a58b7d5b28049839591d2a"
|
resolved "https://registry.yarnpkg.com/perfect-debounce/-/perfect-debounce-1.0.0.tgz#9c2e8bc30b169cc984a58b7d5b28049839591d2a"
|
||||||
integrity sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==
|
integrity sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==
|
||||||
|
|
||||||
picocolors@^1.1.1:
|
picocolors@^1.0.0:
|
||||||
version "1.1.1"
|
version "1.0.0"
|
||||||
resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b"
|
resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.0.0.tgz#cb5bdc74ff3f51892236eaf79d68bc44564ab81c"
|
||||||
integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==
|
integrity sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==
|
||||||
|
|
||||||
postcss@^8.4.38, postcss@^8.4.43:
|
postcss@^8.4.38:
|
||||||
version "8.5.1"
|
version "8.4.38"
|
||||||
resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.1.tgz#e2272a1f8a807fafa413218245630b5db10a3214"
|
resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.38.tgz#b387d533baf2054288e337066d81c6bee9db9e0e"
|
||||||
integrity sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ==
|
integrity sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==
|
||||||
dependencies:
|
dependencies:
|
||||||
nanoid "^3.3.8"
|
nanoid "^3.3.7"
|
||||||
picocolors "^1.1.1"
|
picocolors "^1.0.0"
|
||||||
source-map-js "^1.2.1"
|
source-map-js "^1.2.0"
|
||||||
|
|
||||||
preact@^10.0.0:
|
preact@^10.0.0:
|
||||||
version "10.20.2"
|
version "10.20.2"
|
||||||
@ -711,32 +696,29 @@ rfdc@^1.3.1:
|
|||||||
resolved "https://registry.yarnpkg.com/rfdc/-/rfdc-1.3.1.tgz#2b6d4df52dffe8bb346992a10ea9451f24373a8f"
|
resolved "https://registry.yarnpkg.com/rfdc/-/rfdc-1.3.1.tgz#2b6d4df52dffe8bb346992a10ea9451f24373a8f"
|
||||||
integrity sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg==
|
integrity sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg==
|
||||||
|
|
||||||
rollup@^4.20.0:
|
rollup@^4.13.0:
|
||||||
version "4.31.0"
|
version "4.22.4"
|
||||||
resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.31.0.tgz#b84af969a0292cb047dce2c0ec5413a9457597a4"
|
resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.22.4.tgz#4135a6446671cd2a2453e1ad42a45d5973ec3a0f"
|
||||||
integrity sha512-9cCE8P4rZLx9+PjoyqHLs31V9a9Vpvfo4qNcs6JCiGWYhw2gijSetFbH6SSy1whnkgcefnUwr8sad7tgqsGvnw==
|
integrity sha512-vD8HJ5raRcWOyymsR6Z3o6+RzfEPCnVLMFJ6vRslO1jt4LO6dUo5Qnpg7y4RkZFM2DMe3WUirkI5c16onjrc6A==
|
||||||
dependencies:
|
dependencies:
|
||||||
"@types/estree" "1.0.6"
|
"@types/estree" "1.0.5"
|
||||||
optionalDependencies:
|
optionalDependencies:
|
||||||
"@rollup/rollup-android-arm-eabi" "4.31.0"
|
"@rollup/rollup-android-arm-eabi" "4.22.4"
|
||||||
"@rollup/rollup-android-arm64" "4.31.0"
|
"@rollup/rollup-android-arm64" "4.22.4"
|
||||||
"@rollup/rollup-darwin-arm64" "4.31.0"
|
"@rollup/rollup-darwin-arm64" "4.22.4"
|
||||||
"@rollup/rollup-darwin-x64" "4.31.0"
|
"@rollup/rollup-darwin-x64" "4.22.4"
|
||||||
"@rollup/rollup-freebsd-arm64" "4.31.0"
|
"@rollup/rollup-linux-arm-gnueabihf" "4.22.4"
|
||||||
"@rollup/rollup-freebsd-x64" "4.31.0"
|
"@rollup/rollup-linux-arm-musleabihf" "4.22.4"
|
||||||
"@rollup/rollup-linux-arm-gnueabihf" "4.31.0"
|
"@rollup/rollup-linux-arm64-gnu" "4.22.4"
|
||||||
"@rollup/rollup-linux-arm-musleabihf" "4.31.0"
|
"@rollup/rollup-linux-arm64-musl" "4.22.4"
|
||||||
"@rollup/rollup-linux-arm64-gnu" "4.31.0"
|
"@rollup/rollup-linux-powerpc64le-gnu" "4.22.4"
|
||||||
"@rollup/rollup-linux-arm64-musl" "4.31.0"
|
"@rollup/rollup-linux-riscv64-gnu" "4.22.4"
|
||||||
"@rollup/rollup-linux-loongarch64-gnu" "4.31.0"
|
"@rollup/rollup-linux-s390x-gnu" "4.22.4"
|
||||||
"@rollup/rollup-linux-powerpc64le-gnu" "4.31.0"
|
"@rollup/rollup-linux-x64-gnu" "4.22.4"
|
||||||
"@rollup/rollup-linux-riscv64-gnu" "4.31.0"
|
"@rollup/rollup-linux-x64-musl" "4.22.4"
|
||||||
"@rollup/rollup-linux-s390x-gnu" "4.31.0"
|
"@rollup/rollup-win32-arm64-msvc" "4.22.4"
|
||||||
"@rollup/rollup-linux-x64-gnu" "4.31.0"
|
"@rollup/rollup-win32-ia32-msvc" "4.22.4"
|
||||||
"@rollup/rollup-linux-x64-musl" "4.31.0"
|
"@rollup/rollup-win32-x64-msvc" "4.22.4"
|
||||||
"@rollup/rollup-win32-arm64-msvc" "4.31.0"
|
|
||||||
"@rollup/rollup-win32-ia32-msvc" "4.31.0"
|
|
||||||
"@rollup/rollup-win32-x64-msvc" "4.31.0"
|
|
||||||
fsevents "~2.3.2"
|
fsevents "~2.3.2"
|
||||||
|
|
||||||
shiki@1.3.0, shiki@^1.3.0:
|
shiki@1.3.0, shiki@^1.3.0:
|
||||||
@ -751,11 +733,6 @@ source-map-js@^1.2.0:
|
|||||||
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.0.tgz#16b809c162517b5b8c3e7dcd315a2a5c2612b2af"
|
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.0.tgz#16b809c162517b5b8c3e7dcd315a2a5c2612b2af"
|
||||||
integrity sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==
|
integrity sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==
|
||||||
|
|
||||||
source-map-js@^1.2.1:
|
|
||||||
version "1.2.1"
|
|
||||||
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46"
|
|
||||||
integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==
|
|
||||||
|
|
||||||
speakingurl@^14.0.1:
|
speakingurl@^14.0.1:
|
||||||
version "14.0.1"
|
version "14.0.1"
|
||||||
resolved "https://registry.yarnpkg.com/speakingurl/-/speakingurl-14.0.1.tgz#f37ec8ddc4ab98e9600c1c9ec324a8c48d772a53"
|
resolved "https://registry.yarnpkg.com/speakingurl/-/speakingurl-14.0.1.tgz#f37ec8ddc4ab98e9600c1c9ec324a8c48d772a53"
|
||||||
@ -766,14 +743,14 @@ tabbable@^6.2.0:
|
|||||||
resolved "https://registry.yarnpkg.com/tabbable/-/tabbable-6.2.0.tgz#732fb62bc0175cfcec257330be187dcfba1f3b97"
|
resolved "https://registry.yarnpkg.com/tabbable/-/tabbable-6.2.0.tgz#732fb62bc0175cfcec257330be187dcfba1f3b97"
|
||||||
integrity sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==
|
integrity sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==
|
||||||
|
|
||||||
vite@^5.2.9, vite@^5.4.19:
|
vite@^5.2.14, vite@^5.2.9:
|
||||||
version "5.4.19"
|
version "5.2.14"
|
||||||
resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.19.tgz#20efd060410044b3ed555049418a5e7d1998f959"
|
resolved "https://registry.yarnpkg.com/vite/-/vite-5.2.14.tgz#fd5f60facf6b5f90ec7da6323c467a365d380c3d"
|
||||||
integrity sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==
|
integrity sha512-TFQLuwWLPms+NBNlh0D9LZQ+HXW471COABxw/9TEUBrjuHMo9BrYBPrN/SYAwIuVL+rLerycxiLT41t4f5MZpA==
|
||||||
dependencies:
|
dependencies:
|
||||||
esbuild "^0.21.3"
|
esbuild "^0.20.1"
|
||||||
postcss "^8.4.43"
|
postcss "^8.4.38"
|
||||||
rollup "^4.20.0"
|
rollup "^4.13.0"
|
||||||
optionalDependencies:
|
optionalDependencies:
|
||||||
fsevents "~2.3.3"
|
fsevents "~2.3.3"
|
||||||
|
|
||||||
|
@ -25,7 +25,6 @@ GENERIC_FEATURES = \
|
|||||||
CAPS_WORD \
|
CAPS_WORD \
|
||||||
COMBO \
|
COMBO \
|
||||||
COMMAND \
|
COMMAND \
|
||||||
CONNECTION \
|
|
||||||
CRC \
|
CRC \
|
||||||
DEFERRED_EXEC \
|
DEFERRED_EXEC \
|
||||||
DIGITIZER \
|
DIGITIZER \
|
||||||
@ -35,7 +34,6 @@ GENERIC_FEATURES = \
|
|||||||
DYNAMIC_TAPPING_TERM \
|
DYNAMIC_TAPPING_TERM \
|
||||||
GRAVE_ESC \
|
GRAVE_ESC \
|
||||||
HAPTIC \
|
HAPTIC \
|
||||||
KEYCODE_STRING \
|
|
||||||
KEY_LOCK \
|
KEY_LOCK \
|
||||||
KEY_OVERRIDE \
|
KEY_OVERRIDE \
|
||||||
LAYER_LOCK \
|
LAYER_LOCK \
|
||||||
@ -62,7 +60,6 @@ define HANDLE_GENERIC_FEATURE
|
|||||||
SRC += $$(wildcard $$(QUANTUM_DIR)/process_keycode/process_$2.c)
|
SRC += $$(wildcard $$(QUANTUM_DIR)/process_keycode/process_$2.c)
|
||||||
SRC += $$(wildcard $$(QUANTUM_DIR)/$2/$2.c)
|
SRC += $$(wildcard $$(QUANTUM_DIR)/$2/$2.c)
|
||||||
SRC += $$(wildcard $$(QUANTUM_DIR)/$2.c)
|
SRC += $$(wildcard $$(QUANTUM_DIR)/$2.c)
|
||||||
SRC += $$(wildcard $$(QUANTUM_DIR)/nvm/$$(NVM_DRIVER_LOWER)/nvm_$2.c)
|
|
||||||
VPATH += $$(wildcard $$(QUANTUM_DIR)/$2/)
|
VPATH += $$(wildcard $$(QUANTUM_DIR)/$2/)
|
||||||
OPT_DEFS += -D$1_ENABLE
|
OPT_DEFS += -D$1_ENABLE
|
||||||
endef
|
endef
|
||||||
|
@ -1,11 +0,0 @@
|
|||||||
# Helper to determine if a compiler option is supported
|
|
||||||
# Args:
|
|
||||||
# $(1) = option to test, if successful will be output
|
|
||||||
# $(2) = option to use if $(1) is not supported
|
|
||||||
# $(3) = additional arguments to pass to the compiler during the test, but aren't contained in the output
|
|
||||||
cc-option = $(shell \
|
|
||||||
if { echo 'int main(){return 0;}' | $(CC) $(1) $(3) -o /dev/null -x c /dev/null >/dev/null 2>&1; }; \
|
|
||||||
then echo "$(1)"; else echo "$(2)"; fi)
|
|
||||||
|
|
||||||
# Helper to pass comma character to make functions (use with `$(,)` to pass in `$(call ...)` arguments)
|
|
||||||
, := ,
|
|
@ -1,596 +0,0 @@
|
|||||||
{
|
|
||||||
"aliases": {
|
|
||||||
/*
|
|
||||||
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
|
|
||||||
* │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ │
|
|
||||||
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
|
|
||||||
* │ │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │
|
|
||||||
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
|
|
||||||
* │ │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ │
|
|
||||||
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
|
|
||||||
* │ │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ │
|
|
||||||
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │
|
|
||||||
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
|
|
||||||
*/
|
|
||||||
"KC_GRV": {
|
|
||||||
"key": "EU_GRV",
|
|
||||||
"label": "`",
|
|
||||||
}
|
|
||||||
"KC_1": {
|
|
||||||
"key": "EU_1",
|
|
||||||
"label": "1",
|
|
||||||
}
|
|
||||||
"KC_2": {
|
|
||||||
"key": "EU_2",
|
|
||||||
"label": "2",
|
|
||||||
}
|
|
||||||
"KC_3": {
|
|
||||||
"key": "EU_3",
|
|
||||||
"label": "3",
|
|
||||||
}
|
|
||||||
"KC_4": {
|
|
||||||
"key": "EU_4",
|
|
||||||
"label": "4",
|
|
||||||
}
|
|
||||||
"KC_5": {
|
|
||||||
"key": "EU_5",
|
|
||||||
"label": "5",
|
|
||||||
}
|
|
||||||
"KC_6": {
|
|
||||||
"key": "EU_6",
|
|
||||||
"label": "6",
|
|
||||||
}
|
|
||||||
"KC_7": {
|
|
||||||
"key": "EU_7",
|
|
||||||
"label": "7",
|
|
||||||
}
|
|
||||||
"KC_8": {
|
|
||||||
"key": "EU_8",
|
|
||||||
"label": "8",
|
|
||||||
}
|
|
||||||
"KC_9": {
|
|
||||||
"key": "EU_9",
|
|
||||||
"label": "9",
|
|
||||||
}
|
|
||||||
"KC_0": {
|
|
||||||
"key": "EU_0",
|
|
||||||
"label": "0",
|
|
||||||
}
|
|
||||||
"KC_MINS": {
|
|
||||||
"key": "EU_MINS",
|
|
||||||
"label": "-",
|
|
||||||
}
|
|
||||||
"KC_EQL": {
|
|
||||||
"key": "EU_EQL",
|
|
||||||
"label": "=",
|
|
||||||
}
|
|
||||||
"KC_Q": {
|
|
||||||
"key": "EU_Q",
|
|
||||||
"label": "Q",
|
|
||||||
}
|
|
||||||
"KC_W": {
|
|
||||||
"key": "EU_W",
|
|
||||||
"label": "W",
|
|
||||||
}
|
|
||||||
"KC_E": {
|
|
||||||
"key": "EU_E",
|
|
||||||
"label": "E",
|
|
||||||
}
|
|
||||||
"KC_R": {
|
|
||||||
"key": "EU_R",
|
|
||||||
"label": "R",
|
|
||||||
}
|
|
||||||
"KC_T": {
|
|
||||||
"key": "EU_T",
|
|
||||||
"label": "T",
|
|
||||||
}
|
|
||||||
"KC_Y": {
|
|
||||||
"key": "EU_Y",
|
|
||||||
"label": "Y",
|
|
||||||
}
|
|
||||||
"KC_U": {
|
|
||||||
"key": "EU_U",
|
|
||||||
"label": "U",
|
|
||||||
}
|
|
||||||
"KC_I": {
|
|
||||||
"key": "EU_I",
|
|
||||||
"label": "I",
|
|
||||||
}
|
|
||||||
"KC_O": {
|
|
||||||
"key": "EU_O",
|
|
||||||
"label": "O",
|
|
||||||
}
|
|
||||||
"KC_P": {
|
|
||||||
"key": "EU_P",
|
|
||||||
"label": "P",
|
|
||||||
}
|
|
||||||
"KC_LBRC": {
|
|
||||||
"key": "EU_LBRC",
|
|
||||||
"label": "[",
|
|
||||||
}
|
|
||||||
"KC_RBRC": {
|
|
||||||
"key": "EU_RBRC",
|
|
||||||
"label": "]",
|
|
||||||
}
|
|
||||||
"KC_BSLS": {
|
|
||||||
"key": "EU_BSLS",
|
|
||||||
"label": "\\",
|
|
||||||
}
|
|
||||||
"KC_A": {
|
|
||||||
"key": "EU_A",
|
|
||||||
"label": "A",
|
|
||||||
}
|
|
||||||
"KC_S": {
|
|
||||||
"key": "EU_S",
|
|
||||||
"label": "S",
|
|
||||||
}
|
|
||||||
"KC_D": {
|
|
||||||
"key": "EU_D",
|
|
||||||
"label": "D",
|
|
||||||
}
|
|
||||||
"KC_F": {
|
|
||||||
"key": "EU_F",
|
|
||||||
"label": "F",
|
|
||||||
}
|
|
||||||
"KC_G": {
|
|
||||||
"key": "EU_G",
|
|
||||||
"label": "G",
|
|
||||||
}
|
|
||||||
"KC_H": {
|
|
||||||
"key": "EU_H",
|
|
||||||
"label": "H",
|
|
||||||
}
|
|
||||||
"KC_J": {
|
|
||||||
"key": "EU_J",
|
|
||||||
"label": "J",
|
|
||||||
}
|
|
||||||
"KC_K": {
|
|
||||||
"key": "EU_K",
|
|
||||||
"label": "K",
|
|
||||||
}
|
|
||||||
"KC_L": {
|
|
||||||
"key": "EU_L",
|
|
||||||
"label": "L",
|
|
||||||
}
|
|
||||||
"KC_SCLN": {
|
|
||||||
"key": "EU_SCLN",
|
|
||||||
"label": ";",
|
|
||||||
}
|
|
||||||
"KC_QUOT": {
|
|
||||||
"key": "EU_QUOT",
|
|
||||||
"label": "'",
|
|
||||||
}
|
|
||||||
"KC_Z": {
|
|
||||||
"key": "EU_Z",
|
|
||||||
"label": "Z",
|
|
||||||
}
|
|
||||||
"KC_X": {
|
|
||||||
"key": "EU_X",
|
|
||||||
"label": "X",
|
|
||||||
}
|
|
||||||
"KC_C": {
|
|
||||||
"key": "EU_C",
|
|
||||||
"label": "C",
|
|
||||||
}
|
|
||||||
"KC_V": {
|
|
||||||
"key": "EU_V",
|
|
||||||
"label": "V",
|
|
||||||
}
|
|
||||||
"KC_B": {
|
|
||||||
"key": "EU_B",
|
|
||||||
"label": "B",
|
|
||||||
}
|
|
||||||
"KC_N": {
|
|
||||||
"key": "EU_N",
|
|
||||||
"label": "N",
|
|
||||||
}
|
|
||||||
"KC_M": {
|
|
||||||
"key": "EU_M",
|
|
||||||
"label": "M",
|
|
||||||
}
|
|
||||||
"KC_COMM": {
|
|
||||||
"key": "EU_COMM",
|
|
||||||
"label": ",",
|
|
||||||
}
|
|
||||||
"KC_DOT": {
|
|
||||||
"key": "EU_DOT",
|
|
||||||
"label": ".",
|
|
||||||
}
|
|
||||||
"KC_SLSH": {
|
|
||||||
"key": "EU_SLSH",
|
|
||||||
"label": "/",
|
|
||||||
}
|
|
||||||
/* Shifted symbols
|
|
||||||
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
|
|
||||||
* │ ~ │ ! │ @ │ # │ $ │ % │ ^ │ & │ * │ ( │ ) │ _ │ + │ │
|
|
||||||
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │ │ │ │ { │ } │ | │
|
|
||||||
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │ │ │ : │ " │ │
|
|
||||||
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │ < │ > │ ? │ │
|
|
||||||
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │
|
|
||||||
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
|
|
||||||
*/
|
|
||||||
"S(EU_GRV)": {
|
|
||||||
"key": "EU_TILD",
|
|
||||||
"label": "~",
|
|
||||||
}
|
|
||||||
"S(EU_1)": {
|
|
||||||
"key": "EU_EXLM",
|
|
||||||
"label": "!",
|
|
||||||
}
|
|
||||||
"S(EU_2)": {
|
|
||||||
"key": "EU_AT",
|
|
||||||
"label": "@",
|
|
||||||
}
|
|
||||||
"S(EU_3)": {
|
|
||||||
"key": "EU_HASH",
|
|
||||||
"label": "#",
|
|
||||||
}
|
|
||||||
"S(EU_4)": {
|
|
||||||
"key": "EU_DLR",
|
|
||||||
"label": "$",
|
|
||||||
}
|
|
||||||
"S(EU_5)": {
|
|
||||||
"key": "EU_PERC",
|
|
||||||
"label": "%",
|
|
||||||
}
|
|
||||||
"S(EU_6)": {
|
|
||||||
"key": "EU_CIRC",
|
|
||||||
"label": "^",
|
|
||||||
}
|
|
||||||
"S(EU_7)": {
|
|
||||||
"key": "EU_AMPR",
|
|
||||||
"label": "&",
|
|
||||||
}
|
|
||||||
"S(EU_8)": {
|
|
||||||
"key": "EU_ASTR",
|
|
||||||
"label": "*",
|
|
||||||
}
|
|
||||||
"S(EU_9)": {
|
|
||||||
"key": "EU_LPRN",
|
|
||||||
"label": "(",
|
|
||||||
}
|
|
||||||
"S(EU_0)": {
|
|
||||||
"key": "EU_RPRN",
|
|
||||||
"label": ")",
|
|
||||||
}
|
|
||||||
"S(EU_MINS)": {
|
|
||||||
"key": "EU_UNDS",
|
|
||||||
"label": "_",
|
|
||||||
}
|
|
||||||
"S(EU_EQL)": {
|
|
||||||
"key": "EU_PLUS",
|
|
||||||
"label": "+",
|
|
||||||
}
|
|
||||||
"S(EU_LBRC)": {
|
|
||||||
"key": "EU_LCBR",
|
|
||||||
"label": "{",
|
|
||||||
}
|
|
||||||
"S(EU_RBRC)": {
|
|
||||||
"key": "EU_RCBR",
|
|
||||||
"label": "}",
|
|
||||||
}
|
|
||||||
"S(EU_BSLS)": {
|
|
||||||
"key": "EU_PIPE",
|
|
||||||
"label": "|",
|
|
||||||
}
|
|
||||||
"S(EU_SCLN)": {
|
|
||||||
"key": "EU_COLN",
|
|
||||||
"label": ":",
|
|
||||||
}
|
|
||||||
"S(EU_QUOT)": {
|
|
||||||
"key": "EU_DQUO",
|
|
||||||
"label": "\"",
|
|
||||||
}
|
|
||||||
"S(EU_COMM)": {
|
|
||||||
"key": "EU_LABK",
|
|
||||||
"label": "<",
|
|
||||||
}
|
|
||||||
"S(EU_DOT)": {
|
|
||||||
"key": "EU_RABK",
|
|
||||||
"label": ">",
|
|
||||||
}
|
|
||||||
"S(EU_SLSH)": {
|
|
||||||
"key": "EU_QUES",
|
|
||||||
"label": "?",
|
|
||||||
}
|
|
||||||
/* AltGr symbols
|
|
||||||
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
|
|
||||||
* │ ` │ ¡ │ ª │ º │ £ │ € │ ^ │ ˚ │ „ │ “ │ ” │ – │ × │ │
|
|
||||||
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
|
|
||||||
* │ │ æ │ å │ ë │ ý │ þ │ ÿ │ ü │ ï │ ö │ œ │ « │ » │ ¬ │
|
|
||||||
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
|
|
||||||
* │ │ ä │ ß │ ð │ è │ é │ ù │ ú │ ij │ ø │ ° │ ´ │ │
|
|
||||||
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
|
|
||||||
* │ │ à │ á │ ç │ ì │ í │ ñ │ μ │ ò │ ó │ ¿ │ │
|
|
||||||
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │
|
|
||||||
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
|
|
||||||
*/
|
|
||||||
"ALGR(EU_GRV)": {
|
|
||||||
"key": "EU_DGRV",
|
|
||||||
"label": "` (dead)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_1)": {
|
|
||||||
"key": "EU_IEXL",
|
|
||||||
"label": "¡",
|
|
||||||
}
|
|
||||||
"ALGR(EU_2)": {
|
|
||||||
"key": "EU_FORD",
|
|
||||||
"label": "ª",
|
|
||||||
}
|
|
||||||
"ALGR(EU_3)": {
|
|
||||||
"key": "EU_MORD",
|
|
||||||
"label": "º",
|
|
||||||
}
|
|
||||||
"ALGR(EU_4)": {
|
|
||||||
"key": "EU_PND",
|
|
||||||
"label": "£",
|
|
||||||
}
|
|
||||||
"ALGR(EU_5)": {
|
|
||||||
"key": "EU_EURO",
|
|
||||||
"label": "€",
|
|
||||||
}
|
|
||||||
"ALGR(EU_6)": {
|
|
||||||
"key": "EU_DCIR",
|
|
||||||
"label": "^ (dead)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_7)": {
|
|
||||||
"key": "EU_RNGA",
|
|
||||||
"label": "˚ (dead)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_8)": {
|
|
||||||
"key": "EU_DLQU",
|
|
||||||
"label": "„",
|
|
||||||
}
|
|
||||||
"ALGR(EU_9)": {
|
|
||||||
"key": "EU_LDQU",
|
|
||||||
"label": "“",
|
|
||||||
}
|
|
||||||
"ALGR(EU_0)": {
|
|
||||||
"key": "EU_RDQU",
|
|
||||||
"label": "”",
|
|
||||||
}
|
|
||||||
"ALGR(EU_MINS)": {
|
|
||||||
"key": "EU_NDSH",
|
|
||||||
"label": "–",
|
|
||||||
}
|
|
||||||
"ALGR(EU_EQL)": {
|
|
||||||
"key": "EU_MUL",
|
|
||||||
"label": "×",
|
|
||||||
}
|
|
||||||
"ALGR(EU_Q)": {
|
|
||||||
"key": "EU_AE",
|
|
||||||
"label": "æ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_W)": {
|
|
||||||
"key": "EU_ARNG",
|
|
||||||
"label": "Å",
|
|
||||||
}
|
|
||||||
"ALGR(EU_E)": {
|
|
||||||
"key": "EU_EDIA",
|
|
||||||
"label": "Ë",
|
|
||||||
}
|
|
||||||
"ALGR(EU_R)": {
|
|
||||||
"key": "EU_YACU",
|
|
||||||
"label": "Ý",
|
|
||||||
}
|
|
||||||
"ALGR(EU_T)": {
|
|
||||||
"key": "EU_THRN",
|
|
||||||
"label": "Þ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_Y)": {
|
|
||||||
"key": "EU_YDIA",
|
|
||||||
"label": "Ÿ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_U)": {
|
|
||||||
"key": "EU_UDIA",
|
|
||||||
"label": "Ü",
|
|
||||||
}
|
|
||||||
"ALGR(EU_I)": {
|
|
||||||
"key": "EU_IDIA",
|
|
||||||
"label": "Ï",
|
|
||||||
}
|
|
||||||
"ALGR(EU_O)": {
|
|
||||||
"key": "EU_ODIA",
|
|
||||||
"label": "Ö",
|
|
||||||
}
|
|
||||||
"ALGR(EU_P)": {
|
|
||||||
"key": "EU_OE",
|
|
||||||
"label": "Œ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_LBRC)": {
|
|
||||||
"key": "EU_LDAQ",
|
|
||||||
"label": "«",
|
|
||||||
}
|
|
||||||
"ALGR(EU_RBRC)": {
|
|
||||||
"key": "EU_RDAQ",
|
|
||||||
"label": "»",
|
|
||||||
}
|
|
||||||
"ALGR(EU_BSLS)": {
|
|
||||||
"key": "EU_NOT",
|
|
||||||
"label": "¬",
|
|
||||||
}
|
|
||||||
"ALGR(EU_A)": {
|
|
||||||
"key": "EU_ADIA",
|
|
||||||
"label": "Ä",
|
|
||||||
}
|
|
||||||
"ALGR(EU_S)": {
|
|
||||||
"key": "EU_SS",
|
|
||||||
"label": "ß",
|
|
||||||
}
|
|
||||||
"ALGR(EU_D)": {
|
|
||||||
"key": "EU_ETH",
|
|
||||||
"label": "Ð",
|
|
||||||
}
|
|
||||||
"ALGR(EU_F)": {
|
|
||||||
"key": "EU_EGRV",
|
|
||||||
"label": "È",
|
|
||||||
}
|
|
||||||
"ALGR(EU_G)": {
|
|
||||||
"key": "EU_EACU",
|
|
||||||
"label": "É",
|
|
||||||
}
|
|
||||||
"ALGR(EU_H)": {
|
|
||||||
"key": "EU_UGRV",
|
|
||||||
"label": "Ù",
|
|
||||||
}
|
|
||||||
"ALGR(EU_J)": {
|
|
||||||
"key": "EU_UACU",
|
|
||||||
"label": "Ú",
|
|
||||||
}
|
|
||||||
"ALGR(EU_K)": {
|
|
||||||
"key": "EU_IJ",
|
|
||||||
"label": "IJ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_L)": {
|
|
||||||
"key": "EU_OSTR",
|
|
||||||
"label": "Ø",
|
|
||||||
}
|
|
||||||
"ALGR(EU_SCLN)": {
|
|
||||||
"key": "EU_DEG",
|
|
||||||
"label": "°",
|
|
||||||
}
|
|
||||||
"ALGR(EU_QUOT)": {
|
|
||||||
"key": "EU_ACUT",
|
|
||||||
"label": "´ (dead)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_Z)": {
|
|
||||||
"key": "EU_AGRV",
|
|
||||||
"label": "À",
|
|
||||||
}
|
|
||||||
"ALGR(EU_X)": {
|
|
||||||
"key": "EU_AACU",
|
|
||||||
"label": "Á",
|
|
||||||
}
|
|
||||||
"ALGR(EU_C)": {
|
|
||||||
"key": "EU_CCED",
|
|
||||||
"label": "Ç",
|
|
||||||
}
|
|
||||||
"ALGR(EU_V)": {
|
|
||||||
"key": "EU_IGRV",
|
|
||||||
"label": "Ì",
|
|
||||||
}
|
|
||||||
"ALGR(EU_B)": {
|
|
||||||
"key": "EU_IACU",
|
|
||||||
"label": "Í",
|
|
||||||
}
|
|
||||||
"ALGR(EU_N)": {
|
|
||||||
"key": "EU_NTIL",
|
|
||||||
"label": "Ñ",
|
|
||||||
}
|
|
||||||
"ALGR(EU_M)": {
|
|
||||||
"key": "EU_DGRK",
|
|
||||||
"label": "μ (dead Greek key)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_COMM)": {
|
|
||||||
"key": "EU_OGRV",
|
|
||||||
"label": "Ò",
|
|
||||||
}
|
|
||||||
"ALGR(EU_DOT)": {
|
|
||||||
"key": "EU_OACU",
|
|
||||||
"label": "Ó",
|
|
||||||
}
|
|
||||||
"ALGR(EU_SLSH)": {
|
|
||||||
"key": "EU_IQUE",
|
|
||||||
"label": "¿",
|
|
||||||
}
|
|
||||||
/* Shift+AltGr symbols
|
|
||||||
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
|
|
||||||
* │ ~ │ ¹ │ ² │ ³ │ ¥ │ ¢ │ ˇ │ ¯ │ ‚ │ ‘ │ ’ │ — │ ÷ │ │
|
|
||||||
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │ │ │ │ ‹ │ › │ ¦ │
|
|
||||||
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
|
|
||||||
* │ │ │ § │ │ │ │ │ │ │ │ · │ ¨ │ │
|
|
||||||
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │ │ │ … │ │
|
|
||||||
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
|
|
||||||
* │ │ │ │ │ │ │ │ │
|
|
||||||
* └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
|
|
||||||
*/
|
|
||||||
"ALGR(EU_TILD)": {
|
|
||||||
"key": "EU_DTIL",
|
|
||||||
"label": "~ (dead)",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_1))": {
|
|
||||||
"key": "EU_SUP1",
|
|
||||||
"label": "¹",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_2))": {
|
|
||||||
"key": "EU_SUP2",
|
|
||||||
"label": "²",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_3))": {
|
|
||||||
"key": "EU_SUP3",
|
|
||||||
"label": "³",
|
|
||||||
}
|
|
||||||
"ALGR(EU_DLR)": {
|
|
||||||
"key": "EU_YEN",
|
|
||||||
"label": "¥",
|
|
||||||
}
|
|
||||||
"S(EU_EURO)": {
|
|
||||||
"key": "EU_CENT",
|
|
||||||
"label": "¢",
|
|
||||||
}
|
|
||||||
"S(EU_DCIR)": {
|
|
||||||
"key": "EU_CARN",
|
|
||||||
"label": "ˇ (dead)",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_7))": {
|
|
||||||
"key": "EU_MACR",
|
|
||||||
"label": "¯ (dead)",
|
|
||||||
}
|
|
||||||
"S(EU_DLQU)": {
|
|
||||||
"key": "EU_SLQU",
|
|
||||||
"label": "‚",
|
|
||||||
}
|
|
||||||
"S(EU_LDQU)": {
|
|
||||||
"key": "EU_LSQU",
|
|
||||||
"label": "‘",
|
|
||||||
}
|
|
||||||
"S(EU_RDQU)": {
|
|
||||||
"key": "EU_RSQU",
|
|
||||||
"label": "’",
|
|
||||||
}
|
|
||||||
"S(EU_NDSH)": {
|
|
||||||
"key": "EU_MDSH",
|
|
||||||
"label": "—",
|
|
||||||
}
|
|
||||||
"S(EU_MUL)": {
|
|
||||||
"key": "EU_DIV",
|
|
||||||
"label": "÷",
|
|
||||||
}
|
|
||||||
"S(EU_LDAQ)": {
|
|
||||||
"key": "EU_LSAQ",
|
|
||||||
"label": "‹",
|
|
||||||
}
|
|
||||||
"S(EU_RDAQ)": {
|
|
||||||
"key": "EU_RSAQ",
|
|
||||||
"label": "›",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_BSLS))": {
|
|
||||||
"key": "EU_BRKP",
|
|
||||||
"label": "¦",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_S))": {
|
|
||||||
"key": "EU_SECT",
|
|
||||||
"label": "§",
|
|
||||||
}
|
|
||||||
"S(ALGR(EU_SCLN))": {
|
|
||||||
"key": "EU_MDDT",
|
|
||||||
"label": "·",
|
|
||||||
}
|
|
||||||
"ALGR(EU_DQUO)": {
|
|
||||||
"key": "EU_DIAE",
|
|
||||||
"label": "¨ (dead)",
|
|
||||||
}
|
|
||||||
"ALGR(EU_QUES)": {
|
|
||||||
"key": "EU_ELLP",
|
|
||||||
"label": "…",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -527,7 +527,7 @@
|
|||||||
"key": "FA_PIPE",
|
"key": "FA_PIPE",
|
||||||
"label": "|",
|
"label": "|",
|
||||||
}
|
}
|
||||||
"ALGR(FA_RE)": {
|
"ALGR(FA_RA)": {
|
||||||
"key": "FA_SUBA",
|
"key": "FA_SUBA",
|
||||||
"label": "ٖ",
|
"label": "ٖ",
|
||||||
}
|
}
|
||||||
|
@ -1140,7 +1140,7 @@
|
|||||||
"0x00AE": {
|
"0x00AE": {
|
||||||
"group": "media",
|
"group": "media",
|
||||||
"key": "KC_MEDIA_PLAY_PAUSE",
|
"key": "KC_MEDIA_PLAY_PAUSE",
|
||||||
"label": "Play/Pause Track",
|
"label": "Mute",
|
||||||
"aliases": [
|
"aliases": [
|
||||||
"KC_MPLY"
|
"KC_MPLY"
|
||||||
]
|
]
|
||||||
|
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"ranges": {
|
|
||||||
"0x77C0/0x003F": {
|
|
||||||
"define": "QK_COMMUNITY_MODULE"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,25 +0,0 @@
|
|||||||
{
|
|
||||||
keyboard_pre_init: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
}
|
|
||||||
keyboard_post_init: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
}
|
|
||||||
pre_process_record: {
|
|
||||||
ret_type: bool
|
|
||||||
args: uint16_t keycode, keyrecord_t *record
|
|
||||||
call_params: keycode, record
|
|
||||||
}
|
|
||||||
process_record: {
|
|
||||||
ret_type: bool
|
|
||||||
args: uint16_t keycode, keyrecord_t *record
|
|
||||||
call_params: keycode, record
|
|
||||||
}
|
|
||||||
post_process_record: {
|
|
||||||
ret_type: void
|
|
||||||
args: uint16_t keycode, keyrecord_t *record
|
|
||||||
call_params: keycode, record
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
housekeeping_task: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
}
|
|
||||||
suspend_power_down: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
}
|
|
||||||
suspend_wakeup_init: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
}
|
|
||||||
shutdown: {
|
|
||||||
ret_type: bool
|
|
||||||
args: bool jump_to_bootloader
|
|
||||||
call_params: jump_to_bootloader
|
|
||||||
}
|
|
||||||
process_detected_host_os: {
|
|
||||||
ret_type: bool
|
|
||||||
args: os_variant_t os
|
|
||||||
call_params: os
|
|
||||||
guard: defined(OS_DETECTION_ENABLE)
|
|
||||||
header: os_detection.h
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,55 +0,0 @@
|
|||||||
{
|
|
||||||
pointing_device_init: {
|
|
||||||
ret_type: void
|
|
||||||
args: void
|
|
||||||
guard: defined(POINTING_DEVICE_ENABLE)
|
|
||||||
}
|
|
||||||
pointing_device_task: {
|
|
||||||
ret_type: report_mouse_t
|
|
||||||
args: report_mouse_t mouse_report
|
|
||||||
call_params: mouse_report
|
|
||||||
guard: defined(POINTING_DEVICE_ENABLE)
|
|
||||||
header: report.h
|
|
||||||
}
|
|
||||||
rgb_matrix_indicators: {
|
|
||||||
ret_type: bool
|
|
||||||
args: void
|
|
||||||
guard: defined(RGB_MATRIX_ENABLE)
|
|
||||||
header: rgb_matrix.h
|
|
||||||
}
|
|
||||||
rgb_matrix_indicators_advanced: {
|
|
||||||
ret_type: bool
|
|
||||||
args: uint8_t led_min, uint8_t led_max
|
|
||||||
call_params: led_min, led_max
|
|
||||||
guard: defined(RGB_MATRIX_ENABLE)
|
|
||||||
header: rgb_matrix.h
|
|
||||||
}
|
|
||||||
led_matrix_indicators: {
|
|
||||||
ret_type: bool
|
|
||||||
args: void
|
|
||||||
guard: defined(LED_MATRIX_ENABLE)
|
|
||||||
header: led_matrix.h
|
|
||||||
}
|
|
||||||
led_matrix_indicators_advanced: {
|
|
||||||
ret_type: bool
|
|
||||||
args: uint8_t led_min, uint8_t led_max
|
|
||||||
call_params: led_min, led_max
|
|
||||||
guard: defined(LED_MATRIX_ENABLE)
|
|
||||||
header: led_matrix.h
|
|
||||||
}
|
|
||||||
default_layer_state_set: {
|
|
||||||
ret_type: layer_state_t
|
|
||||||
args: layer_state_t state
|
|
||||||
call_params: state
|
|
||||||
guard: !defined(NO_ACTION_LAYER)
|
|
||||||
header: action_layer.h
|
|
||||||
}
|
|
||||||
layer_state_set: {
|
|
||||||
ret_type: layer_state_t
|
|
||||||
args: layer_state_t state
|
|
||||||
call_params: state
|
|
||||||
guard: !defined(NO_ACTION_LAYER)
|
|
||||||
header: action_layer.h
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
// This version exists to signify addition of LED/RGB effect support.
|
|
||||||
}
|
|
@ -64,9 +64,6 @@
|
|||||||
"WEAR_LEVELING_BACKING_SIZE": {"info_key": "eeprom.wear_leveling.backing_size", "value_type": "int", "to_json": false},
|
"WEAR_LEVELING_BACKING_SIZE": {"info_key": "eeprom.wear_leveling.backing_size", "value_type": "int", "to_json": false},
|
||||||
"WEAR_LEVELING_LOGICAL_SIZE": {"info_key": "eeprom.wear_leveling.logical_size", "value_type": "int", "to_json": false},
|
"WEAR_LEVELING_LOGICAL_SIZE": {"info_key": "eeprom.wear_leveling.logical_size", "value_type": "int", "to_json": false},
|
||||||
|
|
||||||
// host
|
|
||||||
"NKRO_DEFAULT_ON": {"info_key": "host.default.nkro", "value_type": "bool"},
|
|
||||||
|
|
||||||
// Layer locking
|
// Layer locking
|
||||||
"LAYER_LOCK_IDLE_TIMEOUT": {"info_key": "layer_lock.timeout", "value_type": "int"},
|
"LAYER_LOCK_IDLE_TIMEOUT": {"info_key": "layer_lock.timeout", "value_type": "int"},
|
||||||
|
|
||||||
@ -203,8 +200,6 @@
|
|||||||
"SPLIT_WPM_ENABLE": {"info_key": "split.transport.sync.wpm", "value_type": "flag"},
|
"SPLIT_WPM_ENABLE": {"info_key": "split.transport.sync.wpm", "value_type": "flag"},
|
||||||
|
|
||||||
// Tapping
|
// Tapping
|
||||||
"CHORDAL_HOLD": {"info_key": "tapping.chordal_hold", "value_type": "flag"},
|
|
||||||
"FLOW_TAP_TERM": {"info_key": "tapping.flow_tap_term", "value_type": "int"},
|
|
||||||
"HOLD_ON_OTHER_KEY_PRESS": {"info_key": "tapping.hold_on_other_key_press", "value_type": "flag"},
|
"HOLD_ON_OTHER_KEY_PRESS": {"info_key": "tapping.hold_on_other_key_press", "value_type": "flag"},
|
||||||
"HOLD_ON_OTHER_KEY_PRESS_PER_KEY": {"info_key": "tapping.hold_on_other_key_press_per_key", "value_type": "flag"},
|
"HOLD_ON_OTHER_KEY_PRESS_PER_KEY": {"info_key": "tapping.hold_on_other_key_press_per_key", "value_type": "flag"},
|
||||||
"PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "flag"},
|
"PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "flag"},
|
||||||
@ -218,6 +213,7 @@
|
|||||||
"TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
|
"TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
|
||||||
|
|
||||||
// USB
|
// USB
|
||||||
|
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag"},
|
||||||
"USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
|
"USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
|
||||||
"USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
|
"USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
|
||||||
"USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
|
"USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
|
||||||
@ -255,7 +251,6 @@
|
|||||||
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
|
"PRODUCT": {"info_key": "keyboard_name", "warn_duplicate": false, "value_type": "str", "deprecated": true, "replace_with": "`keyboard_name` in info.json"},
|
||||||
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
|
"PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.pid` in info.json"},
|
||||||
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
|
"VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex", "deprecated": true, "replace_with": "`usb.vid` in info.json"},
|
||||||
"FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "flag", "deprecated": true, "replace_with": "`host.default.nkro` in info.json"},
|
|
||||||
|
|
||||||
// Items we want flagged in lint
|
// Items we want flagged in lint
|
||||||
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},
|
"VIAL_KEYBOARD_UID": {"info_key": "_invalid.vial_uid", "invalid": true},
|
||||||
|
@ -1,74 +0,0 @@
|
|||||||
{
|
|
||||||
"bootmagic": {
|
|
||||||
"matrix": [0, 0]
|
|
||||||
},
|
|
||||||
"backlight": {
|
|
||||||
"default": {
|
|
||||||
"on": true
|
|
||||||
},
|
|
||||||
"breathing_period": 6,
|
|
||||||
"levels": 3,
|
|
||||||
"on_state": 1
|
|
||||||
},
|
|
||||||
"debounce": 5,
|
|
||||||
"features": {
|
|
||||||
"command": false,
|
|
||||||
"console": false
|
|
||||||
},
|
|
||||||
"indicators": {
|
|
||||||
"on_state": 1
|
|
||||||
},
|
|
||||||
"led_matrix": {
|
|
||||||
"default": {
|
|
||||||
"animation": "solid",
|
|
||||||
"on": true,
|
|
||||||
"val": 255,
|
|
||||||
"speed": 128
|
|
||||||
},
|
|
||||||
"led_flush_limit": 16,
|
|
||||||
"max_brightness": 255,
|
|
||||||
"sleep": false,
|
|
||||||
"speed_steps": 16,
|
|
||||||
"val_steps": 16
|
|
||||||
},
|
|
||||||
"rgblight": {
|
|
||||||
"default": {
|
|
||||||
"animation": "static_light",
|
|
||||||
"on": true,
|
|
||||||
"hue": 0,
|
|
||||||
"sat": 255,
|
|
||||||
"val": 255,
|
|
||||||
"speed": 0
|
|
||||||
},
|
|
||||||
"brightness_steps": 17,
|
|
||||||
"hue_steps": 8,
|
|
||||||
"max_brightness": 255,
|
|
||||||
"saturation_steps": 17,
|
|
||||||
"sleep": false
|
|
||||||
},
|
|
||||||
"rgb_matrix": {
|
|
||||||
"default": {
|
|
||||||
"animation": "cycle_left_right",
|
|
||||||
"on": true,
|
|
||||||
"hue": 0,
|
|
||||||
"sat": 255,
|
|
||||||
"val": 255,
|
|
||||||
"speed": 128
|
|
||||||
},
|
|
||||||
"hue_steps": 8,
|
|
||||||
"led_flush_limit": 16,
|
|
||||||
"max_brightness": 255,
|
|
||||||
"sat_steps": 16,
|
|
||||||
"sleep": false,
|
|
||||||
"speed_steps": 16,
|
|
||||||
"val_steps": 16
|
|
||||||
},
|
|
||||||
"split": {
|
|
||||||
"serial": {
|
|
||||||
"driver": "bitbang"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"ws2812": {
|
|
||||||
"driver": "bitbang"
|
|
||||||
}
|
|
||||||
}
|
|
@ -53,8 +53,7 @@
|
|||||||
"WS2812_DRIVER": {"info_key": "ws2812.driver"},
|
"WS2812_DRIVER": {"info_key": "ws2812.driver"},
|
||||||
|
|
||||||
// Items we want flagged in lint
|
// Items we want flagged in lint
|
||||||
"DEFAULT_FOLDER": {"info_key": "_deprecated.default_folder", "deprecated": true},
|
"CTPC": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
|
||||||
"CTPC": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"},
|
"CONVERT_TO_PROTON_C": {"info_key": "_deprecated.ctpc", "deprecated": true, "replace_with": "CONVERT_TO=proton_c"},
|
||||||
"CONVERT_TO_PROTON_C": {"info_key": "_invalid.ctpc", "invalid": true, "replace_with": "CONVERT_TO=proton_c"},
|
|
||||||
"VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true}
|
"VIAL_ENABLE": {"info_key": "_invalid.vial", "invalid": true}
|
||||||
}
|
}
|
||||||
|
@ -140,15 +140,9 @@
|
|||||||
"custommk/genesis": {
|
"custommk/genesis": {
|
||||||
"target": "custommk/genesis/rev1"
|
"target": "custommk/genesis/rev1"
|
||||||
},
|
},
|
||||||
"cxt_studio":{
|
|
||||||
"target":"cxt_studio/12e4"
|
|
||||||
},
|
|
||||||
"daisy": {
|
"daisy": {
|
||||||
"target": "ktec/daisy"
|
"target": "ktec/daisy"
|
||||||
},
|
},
|
||||||
"deemen17/de60": {
|
|
||||||
"target": "deemen17/de60/r1"
|
|
||||||
},
|
|
||||||
"dp3000": {
|
"dp3000": {
|
||||||
"target": "dp3000/rev1"
|
"target": "dp3000/rev1"
|
||||||
},
|
},
|
||||||
@ -200,9 +194,6 @@
|
|||||||
"ergodone": {
|
"ergodone": {
|
||||||
"target": "ktec/ergodone"
|
"target": "ktec/ergodone"
|
||||||
},
|
},
|
||||||
"ergodox_stm32": {
|
|
||||||
"target": "handwired/ergodox_stm32"
|
|
||||||
},
|
|
||||||
"ergoinu": {
|
"ergoinu": {
|
||||||
"target": "dm9records/ergoinu"
|
"target": "dm9records/ergoinu"
|
||||||
},
|
},
|
||||||
@ -350,9 +341,6 @@
|
|||||||
"keycapsss/plaid_pad": {
|
"keycapsss/plaid_pad": {
|
||||||
"target": "keycapsss/plaid_pad/rev1"
|
"target": "keycapsss/plaid_pad/rev1"
|
||||||
},
|
},
|
||||||
"keyten/kt60hs_t": {
|
|
||||||
"target": "keyten/kt60hs_t/v1"
|
|
||||||
},
|
|
||||||
"kira75": {
|
"kira75": {
|
||||||
"target": "kira/kira75"
|
"target": "kira/kira75"
|
||||||
},
|
},
|
||||||
@ -587,9 +575,6 @@
|
|||||||
"ploopyco/trackball": {
|
"ploopyco/trackball": {
|
||||||
"target": "ploopyco/trackball/rev1_005"
|
"target": "ploopyco/trackball/rev1_005"
|
||||||
},
|
},
|
||||||
"plywrks/ply8x": {
|
|
||||||
"target": "plywrks/ply8x/solder"
|
|
||||||
},
|
|
||||||
"polilla": {
|
"polilla": {
|
||||||
"target": "polilla/rev1"
|
"target": "polilla/rev1"
|
||||||
},
|
},
|
||||||
@ -1042,7 +1027,7 @@
|
|||||||
"target": "kprepublic/bm68hsrgb/rev1"
|
"target": "kprepublic/bm68hsrgb/rev1"
|
||||||
},
|
},
|
||||||
"late9/rev1": {
|
"late9/rev1": {
|
||||||
"target": "ivndbt/late9/rev1"
|
"target": "rookiebwoy/late9/rev1"
|
||||||
},
|
},
|
||||||
"latin17rgb": {
|
"latin17rgb": {
|
||||||
"target": "latincompass/latin17rgb"
|
"target": "latincompass/latin17rgb"
|
||||||
@ -1207,7 +1192,7 @@
|
|||||||
"target": "spaceholdings/nebula68b"
|
"target": "spaceholdings/nebula68b"
|
||||||
},
|
},
|
||||||
"neopad/rev1": {
|
"neopad/rev1": {
|
||||||
"target": "ivndbt/neopad/rev1"
|
"target": "rookiebwoy/neopad/rev1"
|
||||||
},
|
},
|
||||||
"niu_mini": {
|
"niu_mini": {
|
||||||
"target": "kbdfans/niu_mini"
|
"target": "kbdfans/niu_mini"
|
||||||
@ -1530,9 +1515,6 @@
|
|||||||
"ymd96": {
|
"ymd96": {
|
||||||
"target": "ymdk/ymd96"
|
"target": "ymdk/ymd96"
|
||||||
},
|
},
|
||||||
"ymdk/id75": {
|
|
||||||
"target": "ymdk/id75/f103"
|
|
||||||
},
|
|
||||||
"ymdk_np21": {
|
"ymdk_np21": {
|
||||||
"target": "ymdk/np21"
|
"target": "ymdk/np21"
|
||||||
},
|
},
|
||||||
@ -1570,693 +1552,5 @@
|
|||||||
},
|
},
|
||||||
"dnworks/9973": {
|
"dnworks/9973": {
|
||||||
"target": "dnworks/tkl87"
|
"target": "dnworks/tkl87"
|
||||||
},
|
|
||||||
// DEFAULT_FOLDER removed during 2025 Q1 cycle
|
|
||||||
"0_sixty": {
|
|
||||||
"target": "0_sixty/base"
|
|
||||||
},
|
|
||||||
"0xcb/splaytoraid": {
|
|
||||||
"target": "0xcb/splaytoraid/rp2040_ce"
|
|
||||||
},
|
|
||||||
"1upkeyboards/pi40": {
|
|
||||||
"target": "1upkeyboards/pi40/mit_v1_0"
|
|
||||||
},
|
|
||||||
"1upkeyboards/pi50": {
|
|
||||||
"target": "1upkeyboards/pi50/grid"
|
|
||||||
},
|
|
||||||
"1upkeyboards/sweet16": {
|
|
||||||
"target": "1upkeyboards/sweet16/v1"
|
|
||||||
},
|
|
||||||
"25keys/aleth42": {
|
|
||||||
"target": "25keys/aleth42/rev1"
|
|
||||||
},
|
|
||||||
"25keys/zinc": {
|
|
||||||
"target": "25keys/zinc/rev1"
|
|
||||||
},
|
|
||||||
"40percentclub/i75": {
|
|
||||||
"target": "40percentclub/i75/promicro"
|
|
||||||
},
|
|
||||||
"40percentclub/polyandry": {
|
|
||||||
"target": "40percentclub/polyandry/promicro"
|
|
||||||
},
|
|
||||||
"8pack": {
|
|
||||||
"target": "8pack/rev12"
|
|
||||||
},
|
|
||||||
"adkb96": {
|
|
||||||
"target": "adkb96/rev1"
|
|
||||||
},
|
|
||||||
"adm42": {
|
|
||||||
"target": "adm42/rev4"
|
|
||||||
},
|
|
||||||
"aeboards/satellite": {
|
|
||||||
"target": "aeboards/satellite/rev1"
|
|
||||||
},
|
|
||||||
"atreus": {
|
|
||||||
"target": "atreus/astar"
|
|
||||||
},
|
|
||||||
"atreyu": {
|
|
||||||
"target": "atreyu/rev1"
|
|
||||||
},
|
|
||||||
"biacco42/ergo42": {
|
|
||||||
"target": "biacco42/ergo42/rev1"
|
|
||||||
},
|
|
||||||
"binepad/bn009": {
|
|
||||||
"target": "binepad/bn009/r2"
|
|
||||||
},
|
|
||||||
"binepad/bnr1": {
|
|
||||||
"target": "binepad/bnr1/v2"
|
|
||||||
},
|
|
||||||
"boston_meetup": {
|
|
||||||
"target": "boston_meetup/2019"
|
|
||||||
},
|
|
||||||
"bpiphany/frosty_flake": {
|
|
||||||
"target": "bpiphany/frosty_flake/20140521"
|
|
||||||
},
|
|
||||||
"buzzard": {
|
|
||||||
"target": "buzzard/rev1"
|
|
||||||
},
|
|
||||||
"cannonkeys/db60": {
|
|
||||||
"target": "cannonkeys/db60/rev2"
|
|
||||||
},
|
|
||||||
"clickety_split/leeloo": {
|
|
||||||
"target": "clickety_split/leeloo/rev3"
|
|
||||||
},
|
|
||||||
"converter/palm_usb": {
|
|
||||||
"target": "converter/palm_usb/stowaway"
|
|
||||||
},
|
|
||||||
"crkbd": {
|
|
||||||
"target": "crkbd/rev1"
|
|
||||||
},
|
|
||||||
"dailycraft/bat43": {
|
|
||||||
"target": "dailycraft/bat43/rev2"
|
|
||||||
},
|
|
||||||
"dailycraft/claw44": {
|
|
||||||
"target": "dailycraft/claw44/rev1"
|
|
||||||
},
|
|
||||||
"dailycraft/sandbox": {
|
|
||||||
"target": "dailycraft/sandbox/rev2"
|
|
||||||
},
|
|
||||||
"dailycraft/wings42": {
|
|
||||||
"target": "dailycraft/wings42/rev2"
|
|
||||||
},
|
|
||||||
"delikeeb/vanana": {
|
|
||||||
"target": "delikeeb/vanana/rev2"
|
|
||||||
},
|
|
||||||
"delikeeb/waaffle/rev3": {
|
|
||||||
"target": "delikeeb/waaffle/rev3/pro_micro"
|
|
||||||
},
|
|
||||||
"deltasplit75": {
|
|
||||||
"target": "deltasplit75/v2"
|
|
||||||
},
|
|
||||||
"drhigsby/ogurec": {
|
|
||||||
"target": "drhigsby/ogurec/left_pm"
|
|
||||||
},
|
|
||||||
"duck/octagon": {
|
|
||||||
"target": "duck/octagon/v2"
|
|
||||||
},
|
|
||||||
"duck/orion": {
|
|
||||||
"target": "duck/orion/v3"
|
|
||||||
},
|
|
||||||
"ducky/one2mini": {
|
|
||||||
"target": "ducky/one2mini/1861st"
|
|
||||||
},
|
|
||||||
"ducky/one2sf": {
|
|
||||||
"target": "ducky/one2sf/1967st"
|
|
||||||
},
|
|
||||||
"dumbpad": {
|
|
||||||
"target": "dumbpad/v0x"
|
|
||||||
},
|
|
||||||
"durgod/galaxy": {
|
|
||||||
"target": "durgod/dgk6x/galaxy"
|
|
||||||
},
|
|
||||||
"durgod/venus": {
|
|
||||||
"target": "durgod/dgk6x/venus"
|
|
||||||
},
|
|
||||||
"dztech/tofu/ii": {
|
|
||||||
"target": "dztech/tofu/ii/v1"
|
|
||||||
},
|
|
||||||
"dztech/tofu/jr": {
|
|
||||||
"target": "dztech/tofu/jr/v1"
|
|
||||||
},
|
|
||||||
"eco": {
|
|
||||||
"target": "eco/rev2"
|
|
||||||
},
|
|
||||||
"ergoslab": {
|
|
||||||
"target": "ergoslab/rev1"
|
|
||||||
},
|
|
||||||
"ergotravel": {
|
|
||||||
"target": "ergotravel/rev1"
|
|
||||||
},
|
|
||||||
"evyd13/atom47": {
|
|
||||||
"target": "evyd13/atom47/rev4"
|
|
||||||
},
|
|
||||||
"fortitude60": {
|
|
||||||
"target": "fortitude60/rev1"
|
|
||||||
},
|
|
||||||
"fruitykeeb/fruitbar/r1": {
|
|
||||||
"target": "fruitykeeb/fruitbar/r1/promicro"
|
|
||||||
},
|
|
||||||
"ghs/jem": {
|
|
||||||
"target": "ghs/jem/soldered"
|
|
||||||
},
|
|
||||||
"hadron": {
|
|
||||||
"target": "hadron/ver2"
|
|
||||||
},
|
|
||||||
"handwired/bento": {
|
|
||||||
"target": "handwired/bento/rev1"
|
|
||||||
},
|
|
||||||
"handwired/dactyl_manuform/6x6": {
|
|
||||||
"target": "handwired/dactyl_manuform/6x6/promicro"
|
|
||||||
},
|
|
||||||
"handwired/meck_tkl": {
|
|
||||||
"target": "handwired/meck_tkl/blackpill_f401"
|
|
||||||
},
|
|
||||||
"handwired/ms_sculpt_mobile": {
|
|
||||||
"target": "handwired/ms_sculpt_mobile/teensy2pp"
|
|
||||||
},
|
|
||||||
"handwired/onekey": {
|
|
||||||
"target": "handwired/onekey/promicro"
|
|
||||||
},
|
|
||||||
"handwired/pill60": {
|
|
||||||
"target": "handwired/pill60/bluepill"
|
|
||||||
},
|
|
||||||
"handwired/postageboard": {
|
|
||||||
"target": "handwired/postageboard/mini"
|
|
||||||
},
|
|
||||||
"handwired/qc60": {
|
|
||||||
"target": "handwired/qc60/proto"
|
|
||||||
},
|
|
||||||
"handwired/sono1": {
|
|
||||||
"target": "handwired/sono1/t2pp"
|
|
||||||
},
|
|
||||||
"handwired/splittest": {
|
|
||||||
"target": "handwired/splittest/promicro"
|
|
||||||
},
|
|
||||||
"handwired/stef9998/split_5x7": {
|
|
||||||
"target": "handwired/stef9998/split_5x7/rev1"
|
|
||||||
},
|
|
||||||
"handwired/symmetric70_proto/promicro": {
|
|
||||||
"target": "handwired/symmetric70_proto/promicro/base"
|
|
||||||
},
|
|
||||||
"handwired/symmetric70_proto/proton_c": {
|
|
||||||
"target": "handwired/symmetric70_proto/proton_c/base"
|
|
||||||
},
|
|
||||||
"handwired/unk": {
|
|
||||||
"target": "handwired/unk/rev1"
|
|
||||||
},
|
|
||||||
"handwired/xealous": {
|
|
||||||
"target": "handwired/xealous/rev1"
|
|
||||||
},
|
|
||||||
"hillside/46": {
|
|
||||||
"target": "hillside/46/0_1"
|
|
||||||
},
|
|
||||||
"hhkb/ansi": {
|
|
||||||
"target": "hhkb/ansi/32u4"
|
|
||||||
},
|
|
||||||
"hillside/48": {
|
|
||||||
"target": "hillside/48/0_1"
|
|
||||||
},
|
|
||||||
"hillside/52": {
|
|
||||||
"target": "hillside/52/0_1"
|
|
||||||
},
|
|
||||||
"ibnuda/squiggle": {
|
|
||||||
"target": "ibnuda/squiggle/rev1"
|
|
||||||
},
|
|
||||||
"idobao/id80/v1": {
|
|
||||||
"target": "idobao/id80/v2/ansi"
|
|
||||||
},
|
|
||||||
"idobao/id80/v3": {
|
|
||||||
"target": "idobao/id80/v3/ansi"
|
|
||||||
},
|
|
||||||
"inett_studio/sq80": {
|
|
||||||
"target": "inett_studio/sq80/hotswap_layout_i"
|
|
||||||
},
|
|
||||||
"input_club/infinity60": {
|
|
||||||
"target": "input_club/infinity60/led"
|
|
||||||
},
|
|
||||||
"jacky_studio/bear_65": {
|
|
||||||
"target": "jacky_studio/bear_65/rev1"
|
|
||||||
},
|
|
||||||
"jacky_studio/piggy60/rev1": {
|
|
||||||
"target": "jacky_studio/piggy60/rev1/solder"
|
|
||||||
},
|
|
||||||
"jadookb/jkb65": {
|
|
||||||
"target": "jadookb/jkb65/r1"
|
|
||||||
},
|
|
||||||
"jian": {
|
|
||||||
"target": "jian/rev2"
|
|
||||||
},
|
|
||||||
"jiran": {
|
|
||||||
"target": "jiran/rev1"
|
|
||||||
},
|
|
||||||
"jorne": {
|
|
||||||
"target": "jorne/rev1"
|
|
||||||
},
|
|
||||||
"junco": {
|
|
||||||
"target": "junco/rev1"
|
|
||||||
},
|
|
||||||
"kakunpc/angel17": {
|
|
||||||
"target": "kakunpc/angel17/rev1"
|
|
||||||
},
|
|
||||||
"kakunpc/angel64": {
|
|
||||||
"target": "kakunpc/angel64/rev1"
|
|
||||||
},
|
|
||||||
"kakunpc/business_card": {
|
|
||||||
"target": "kakunpc/business_card/beta"
|
|
||||||
},
|
|
||||||
"kakunpc/suihankey": {
|
|
||||||
"target": "kakunpc/suihankey/rev1"
|
|
||||||
},
|
|
||||||
"kakunpc/suihankey/split": {
|
|
||||||
"target": "kakunpc/suihankey/split/rev1"
|
|
||||||
},
|
|
||||||
"kapcave/paladinpad": {
|
|
||||||
"target": "kapcave/paladinpad/rev2"
|
|
||||||
},
|
|
||||||
"kapl": {
|
|
||||||
"target": "kapl/rev1"
|
|
||||||
},
|
|
||||||
"kbdfans/d45": {
|
|
||||||
"target": "kbdfans/d45/v2"
|
|
||||||
},
|
|
||||||
"kbdfans/kbd75": {
|
|
||||||
"target": "kbdfans/kbd75/rev1"
|
|
||||||
},
|
|
||||||
"keebio/bdn9": {
|
|
||||||
"target": "keebio/bdn9/rev1"
|
|
||||||
},
|
|
||||||
"keebio/convolution": {
|
|
||||||
"target": "keebio/convolution/rev1"
|
|
||||||
},
|
|
||||||
"keebio/foldkb": {
|
|
||||||
"target": "keebio/foldkb/rev1"
|
|
||||||
},
|
|
||||||
"keebio/kbo5000": {
|
|
||||||
"target": "keebio/kbo5000/rev1"
|
|
||||||
},
|
|
||||||
"keebio/levinson": {
|
|
||||||
"target": "keebio/levinson/rev2"
|
|
||||||
},
|
|
||||||
"keebio/quefrency": {
|
|
||||||
"target": "keebio/quefrency/rev1"
|
|
||||||
},
|
|
||||||
"keebio/rorschach": {
|
|
||||||
"target": "keebio/rorschach/rev1"
|
|
||||||
},
|
|
||||||
"keebio/sinc": {
|
|
||||||
"target": "keebio/sinc/rev1"
|
|
||||||
},
|
|
||||||
"keebio/viterbi": {
|
|
||||||
"target": "keebio/viterbi/rev2"
|
|
||||||
},
|
|
||||||
"keycapsss/kimiko": {
|
|
||||||
"target": "keycapsss/kimiko/rev2"
|
|
||||||
},
|
|
||||||
"keyhive/navi10": {
|
|
||||||
"target": "keyhive/navi10/rev3"
|
|
||||||
},
|
|
||||||
"keyhive/uno": {
|
|
||||||
"target": "keyhive/uno/rev1"
|
|
||||||
},
|
|
||||||
"kin80": {
|
|
||||||
"target": "kin80/blackpill401"
|
|
||||||
},
|
|
||||||
"kumaokobo/kudox_full": {
|
|
||||||
"target": "kumaokobo/kudox_full/rev1"
|
|
||||||
},
|
|
||||||
"kumaokobo/kudox_game": {
|
|
||||||
"target": "kumaokobo/kudox_game/rev2"
|
|
||||||
},
|
|
||||||
"kumaokobo/kudox": {
|
|
||||||
"target": "kumaokobo/kudox/rev3"
|
|
||||||
},
|
|
||||||
"kumaokobo/pico": {
|
|
||||||
"target": "kumaokobo/pico/65keys"
|
|
||||||
},
|
|
||||||
"lazydesigners/dimple": {
|
|
||||||
"target": "lazydesigners/dimple/staggered/rev1"
|
|
||||||
},
|
|
||||||
"lets_split": {
|
|
||||||
"target": "lets_split/rev2"
|
|
||||||
},
|
|
||||||
"lfkeyboards/lfk87": {
|
|
||||||
"target": "lfkeyboards/lfk78/revc"
|
|
||||||
},
|
|
||||||
"lily58": {
|
|
||||||
"target": "lily58/rev1"
|
|
||||||
},
|
|
||||||
"lime": {
|
|
||||||
"target": "lime/rev1"
|
|
||||||
},
|
|
||||||
"maple_computing/christmas_tree": {
|
|
||||||
"target": "maple_computing/christmas_tree/v2017"
|
|
||||||
},
|
|
||||||
"maple_computing/ivy": {
|
|
||||||
"target": "maple_computing/ivy/rev1"
|
|
||||||
},
|
|
||||||
"maple_computing/launchpad": {
|
|
||||||
"target": "maple_computing/launchpad/rev1"
|
|
||||||
},
|
|
||||||
"maple_computing/minidox": {
|
|
||||||
"target": "maple_computing/minidox/rev1"
|
|
||||||
},
|
|
||||||
"mariorion_v25": {
|
|
||||||
"target": "mariorion_v25/prod"
|
|
||||||
},
|
|
||||||
"marksard/rhymestone": {
|
|
||||||
"target": "marksard/rhymestone/rev1"
|
|
||||||
},
|
|
||||||
"marksard/treadstone32": {
|
|
||||||
"target": "marksard/treadstone32/rev1"
|
|
||||||
},
|
|
||||||
"marksard/treadstone48": {
|
|
||||||
"target": "marksard/treadstone48/rev1"
|
|
||||||
},
|
|
||||||
"maxipad": {
|
|
||||||
"target": "maxipad/promicro"
|
|
||||||
},
|
|
||||||
"mechkeys/mechmini": {
|
|
||||||
"target": "mechkeys/mechmini/v2"
|
|
||||||
},
|
|
||||||
"mechllama/g35": {
|
|
||||||
"target": "mechllama/g35/v2"
|
|
||||||
},
|
|
||||||
"mechlovin/adelais": {
|
|
||||||
"target": "mechlovin/adelais/standard_led/arm/rev2"
|
|
||||||
},
|
|
||||||
"mechlovin/adelais/standard_led/arm/rev4": {
|
|
||||||
"target": "mechlovin/adelais/standard_led/arm/rev4/stm32f303"
|
|
||||||
},
|
|
||||||
"mechlovin/adelais/standard_led/arm": {
|
|
||||||
"target": "mechlovin/adelais/standard_led/arm/rev2"
|
|
||||||
},
|
|
||||||
"mechlovin/adelais/standard_led/avr": {
|
|
||||||
"target": "mechlovin/adelais/standard_led/avr/rev1"
|
|
||||||
},
|
|
||||||
"mechlovin/hannah65/rev1": {
|
|
||||||
"target": "mechlovin/hannah65/rev1/haus"
|
|
||||||
},
|
|
||||||
"mechlovin/infinity87/rev1": {
|
|
||||||
"target": "mechlovin/infinity87/rev1/standard"
|
|
||||||
},
|
|
||||||
"mechlovin/infinity87": {
|
|
||||||
"target": "mechlovin/infinity87/rgb_rev1"
|
|
||||||
},
|
|
||||||
"mechlovin/mechlovin9": {
|
|
||||||
"target": "mechlovin/mechlovin9/rev1"
|
|
||||||
},
|
|
||||||
"mechlovin/olly/jf": {
|
|
||||||
"target": "mechlovin/olly/jf/rev1"
|
|
||||||
},
|
|
||||||
"mechlovin/zed1800": {
|
|
||||||
"target": "mechlovin/zed1800/saber"
|
|
||||||
},
|
|
||||||
"mechlovin/zed65/no_backlight": {
|
|
||||||
"target": "mechlovin/zed65/no_backlight/wearhaus66"
|
|
||||||
},
|
|
||||||
"mechlovin/zed65": {
|
|
||||||
"target": "mechlovin/zed65/no_backlight/wearhaus66"
|
|
||||||
},
|
|
||||||
"mechwild/bde": {
|
|
||||||
"target": "mechwild/bde/rev2"
|
|
||||||
},
|
|
||||||
"mechwild/mokulua": {
|
|
||||||
"target": "mechwild/mokulua/standard"
|
|
||||||
},
|
|
||||||
"mechwild/obe/f401": {
|
|
||||||
"target": "mechwild/obe/f401/base"
|
|
||||||
},
|
|
||||||
"mechwild/obe/f411": {
|
|
||||||
"target": "mechwild/obe/f411/base"
|
|
||||||
},
|
|
||||||
"mechwild/obe": {
|
|
||||||
"target": "mechwild/obe/f401/base"
|
|
||||||
},
|
|
||||||
"mechwild/waka60/f401": {
|
|
||||||
"target": "mechwild/waka60/f401/base"
|
|
||||||
},
|
|
||||||
"mechwild/waka60/f411": {
|
|
||||||
"target": "mechwild/waka60/f411/base"
|
|
||||||
},
|
|
||||||
"mechwild/waka60": {
|
|
||||||
"target": "mechwild/waka60/f401/base"
|
|
||||||
},
|
|
||||||
"murcielago": {
|
|
||||||
"target": "murcielago/rev1"
|
|
||||||
},
|
|
||||||
"nullbitsco/scramble": {
|
|
||||||
"target": "nullbitsco/scramble/v2"
|
|
||||||
},
|
|
||||||
"omkbd/ergodash": {
|
|
||||||
"target": "omkbd/ergodash/rev1"
|
|
||||||
},
|
|
||||||
"omkbd/runner3680": {
|
|
||||||
"target": "omkbd/runner3680/5x8"
|
|
||||||
},
|
|
||||||
"orthodox": {
|
|
||||||
"target": "orthodox/rev3"
|
|
||||||
},
|
|
||||||
"peej/rosaline": {
|
|
||||||
"target": "peej/rosaline/staggered"
|
|
||||||
},
|
|
||||||
"peej/tripel": {
|
|
||||||
"target": "peej/tripel/left"
|
|
||||||
},
|
|
||||||
"peranekofactory/tone": {
|
|
||||||
"target": "peranekofactory/tone/rev2"
|
|
||||||
},
|
|
||||||
"phase_studio/titan65": {
|
|
||||||
"target": "phase_studio/titan65/hotswap"
|
|
||||||
},
|
|
||||||
"pica40": {
|
|
||||||
"target": "pica40/rev2"
|
|
||||||
},
|
|
||||||
"pinky": {
|
|
||||||
"target": "pinky/3"
|
|
||||||
},
|
|
||||||
"ploopyco/madromys": {
|
|
||||||
"target": "ploopyco/madromys/rev1_001"
|
|
||||||
},
|
|
||||||
"ploopyco/trackball_mini": {
|
|
||||||
"target": "ploopyco/trackball_mini/rev1_001"
|
|
||||||
},
|
|
||||||
"ploopyco/trackball_nano": {
|
|
||||||
"target": "ploopyco/trackball_nano/rev1_001"
|
|
||||||
},
|
|
||||||
"ploopyco/trackball_thumb": {
|
|
||||||
"target": "ploopyco/trackball_thumb/rev1_001"
|
|
||||||
},
|
|
||||||
"primekb/meridian": {
|
|
||||||
"target": "primekb/meridian/ktr1010"
|
|
||||||
},
|
|
||||||
"primekb/prime_e": {
|
|
||||||
"target": "primekb/prime_e/std"
|
|
||||||
},
|
|
||||||
"program_yoink": {
|
|
||||||
"target": "program_yoink/staggered"
|
|
||||||
},
|
|
||||||
"projectcain/vault35": {
|
|
||||||
"target": "projectcain/vault35/atmega32u4"
|
|
||||||
},
|
|
||||||
"qpockets/space_space": {
|
|
||||||
"target": "qpockets/space_space/rev2"
|
|
||||||
},
|
|
||||||
"qwertyydox": {
|
|
||||||
"target": "qwertyydox/rev1"
|
|
||||||
},
|
|
||||||
"rate/pistachio": {
|
|
||||||
"target": "rate/pistachio/rev2"
|
|
||||||
},
|
|
||||||
"recompile_keys/choco60": {
|
|
||||||
"target": "recompile_keys/choco60/rev1"
|
|
||||||
},
|
|
||||||
"recompile_keys/nomu30": {
|
|
||||||
"target": "recompile_keys/nomu30/rev1"
|
|
||||||
},
|
|
||||||
"redox/rev1": {
|
|
||||||
"target": "redox/rev1/base"
|
|
||||||
},
|
|
||||||
"rgbkb/mun": {
|
|
||||||
"target": "rgbkb/mun/rev1"
|
|
||||||
},
|
|
||||||
"rgbkb/sol3": {
|
|
||||||
"target": "rgbkb/sol3/rev1"
|
|
||||||
},
|
|
||||||
"rgbkb/sol": {
|
|
||||||
"target": "rgbkb/sol/rev2"
|
|
||||||
},
|
|
||||||
"rgbkb/zen": {
|
|
||||||
"target": "rgbkb/zen/rev2"
|
|
||||||
},
|
|
||||||
"rgbkb/zygomorph": {
|
|
||||||
"target": "rgbkb/zygomorph/rev1"
|
|
||||||
},
|
|
||||||
"rmi_kb/herringbone": {
|
|
||||||
"target": "rmi_kb/herringbone/v1"
|
|
||||||
},
|
|
||||||
"rmi_kb/mona": {
|
|
||||||
"target": "rmi_kb/mona/v1_1"
|
|
||||||
},
|
|
||||||
"rmi_kb/tkl_ff": {
|
|
||||||
"target": "rmi_kb/tkl_ff/v1"
|
|
||||||
},
|
|
||||||
"rmi_kb/wete": {
|
|
||||||
"target": "rmi_kb/wete/v2"
|
|
||||||
},
|
|
||||||
"rookiebwoy/late9": {
|
|
||||||
"target": "ivndbt/late9/rev1"
|
|
||||||
},
|
|
||||||
"rookiebwoy/neopad": {
|
|
||||||
"target": "ivndbt/neopad/rev1"
|
|
||||||
},
|
|
||||||
"ivndbt/late9": {
|
|
||||||
"target": "ivndbt/late9/rev1"
|
|
||||||
},
|
|
||||||
"ivndbt/neopad": {
|
|
||||||
"target": "ivndbt/neopad/rev1"
|
|
||||||
},
|
|
||||||
"rura66": {
|
|
||||||
"target": "rura66/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/7skb": {
|
|
||||||
"target": "salicylic_acid3/7skb/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/getta25": {
|
|
||||||
"target": "salicylic_acid3/getta25/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/jisplit89": {
|
|
||||||
"target": "salicylic_acid3/jisplit89/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/naked48": {
|
|
||||||
"target": "salicylic_acid3/naked48/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/naked60": {
|
|
||||||
"target": "salicylic_acid3/naked60/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/naked64": {
|
|
||||||
"target": "salicylic_acid3/naked64/rev1"
|
|
||||||
},
|
|
||||||
"salicylic_acid3/setta21": {
|
|
||||||
"target": "salicylic_acid3/setta21/rev1"
|
|
||||||
},
|
|
||||||
"sawnsprojects/okayu": {
|
|
||||||
"target": "sawnsprojects/okayu/stm32f072"
|
|
||||||
},
|
|
||||||
"smoll/lefty": {
|
|
||||||
"target": "smoll/lefty/rev2"
|
|
||||||
},
|
|
||||||
"sofle": {
|
|
||||||
"target": "sofle/rev1"
|
|
||||||
},
|
|
||||||
"spaceholdings/nebula68b": {
|
|
||||||
"target": "spaceholdings/nebula68b/solder"
|
|
||||||
},
|
|
||||||
"spacetime": {
|
|
||||||
"target": "spacetime/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/aurora/corne": {
|
|
||||||
"target": "splitkb/aurora/corne/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/aurora/helix": {
|
|
||||||
"target": "splitkb/aurora/helix/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/aurora/lily58": {
|
|
||||||
"target": "splitkb/aurora/lily58/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/aurora/sofle_v2": {
|
|
||||||
"target": "splitkb/aurora/sofle_v2/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/aurora/sweep": {
|
|
||||||
"target": "splitkb/aurora/sweep/rev1"
|
|
||||||
},
|
|
||||||
"splitkb/kyria": {
|
|
||||||
"target": "splitkb/kyria/rev3"
|
|
||||||
},
|
|
||||||
"splitkb/kyria/rev1": {
|
|
||||||
"target": "splitkb/kyria/rev1/base"
|
|
||||||
},
|
|
||||||
"splitkb/kyria/rev2": {
|
|
||||||
"target": "splitkb/kyria/rev2/base"
|
|
||||||
},
|
|
||||||
"splitty": {
|
|
||||||
"target": "splitty/rev1"
|
|
||||||
},
|
|
||||||
"studiokestra/galatea": {
|
|
||||||
"target": "studiokestra/galatea/rev1"
|
|
||||||
},
|
|
||||||
"takashiski/hecomi": {
|
|
||||||
"target": "takashiski/hecomi/alpha"
|
|
||||||
},
|
|
||||||
"takashiski/namecard2x4": {
|
|
||||||
"target": "takashiski/namecard2x4/rev2"
|
|
||||||
},
|
|
||||||
"teleport/native": {
|
|
||||||
"target": "teleport/native/iso"
|
|
||||||
},
|
|
||||||
"themadnoodle/noodlepad": {
|
|
||||||
"target": "themadnoodle/noodlepad/v1"
|
|
||||||
},
|
|
||||||
"tkw/grandiceps": {
|
|
||||||
"target": "tkw/grandiceps/rev1"
|
|
||||||
},
|
|
||||||
"tominabox1/le_chiffre": {
|
|
||||||
"target": "tominabox1/le_chiffre/rev1"
|
|
||||||
},
|
|
||||||
"tominabox1/littlefoot_lx": {
|
|
||||||
"target": "tominabox1/littlefoot_lx/rev1"
|
|
||||||
},
|
|
||||||
"tominabox1/underscore33": {
|
|
||||||
"target": "tominabox1/underscore33/rev1"
|
|
||||||
},
|
|
||||||
"trnthsn/e8ghty": {
|
|
||||||
"target": "trnthsn/e8ghty/stm32f103"
|
|
||||||
},
|
|
||||||
"trnthsn/s6xty5neor2": {
|
|
||||||
"target": "trnthsn/s6xty5neor2/stm32f103"
|
|
||||||
},
|
|
||||||
"tweetydabird/lotus58": {
|
|
||||||
"target": "tweetydabird/lotus58/promicro"
|
|
||||||
},
|
|
||||||
"unison": {
|
|
||||||
"target": "unison/v04"
|
|
||||||
},
|
|
||||||
"uzu42": {
|
|
||||||
"target": "uzu42/rev1"
|
|
||||||
},
|
|
||||||
"vitamins_included": {
|
|
||||||
"target": "vitamins_included/rev2"
|
|
||||||
},
|
|
||||||
"westm/westm68": {
|
|
||||||
"target": "westm/westm68/rev2"
|
|
||||||
},
|
|
||||||
"westm/westm9": {
|
|
||||||
"target": "westm/westm9/rev2"
|
|
||||||
},
|
|
||||||
"woodkeys/meira": {
|
|
||||||
"target": "woodkeys/meira/promicro"
|
|
||||||
},
|
|
||||||
"work_louder/loop": {
|
|
||||||
"target": "work_louder/loop/rev3"
|
|
||||||
},
|
|
||||||
"work_louder/work_board": {
|
|
||||||
"target": "work_louder/work_board/rev3"
|
|
||||||
},
|
|
||||||
"yanghu/unicorne": {
|
|
||||||
"target": "yanghu/unicorne/f411"
|
|
||||||
},
|
|
||||||
"yosino58": {
|
|
||||||
"target": "yosino58/rev1"
|
|
||||||
},
|
|
||||||
"ymdk/yd60mq": {
|
|
||||||
"target": "ymdk/yd60mq/12led"
|
|
||||||
},
|
|
||||||
"yushakobo/navpad/10": {
|
|
||||||
"target": "yushakobo/navpad/10/rev1"
|
|
||||||
},
|
|
||||||
"yynmt/acperience12": {
|
|
||||||
"target": "yynmt/acperience12/rev1"
|
|
||||||
},
|
|
||||||
"zsa/planck_ez": {
|
|
||||||
"target": "zsa/planck_ez/base"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$id": "qmk.api.keyboard.v1",
|
"$id": "qmk.api.keyboard.v1",
|
||||||
"allOf": [
|
"allOf": [
|
||||||
{"$ref": "./keyboard.jsonschema#"},
|
{"$ref": "qmk.keyboard.v1"},
|
||||||
{
|
{
|
||||||
"properties": {
|
"properties": {
|
||||||
"keymaps": {
|
"keymaps": {
|
||||||
@ -10,8 +10,8 @@
|
|||||||
"url": {"type": "string"}
|
"url": {"type": "string"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"parse_errors": {"$ref": "./definitions.jsonschema#/string_array"},
|
"parse_errors": {"$ref": "qmk.definitions.v1#/string_array"},
|
||||||
"parse_warnings": {"$ref": "./definitions.jsonschema#/string_array"},
|
"parse_warnings": {"$ref": "qmk.definitions.v1#/string_array"},
|
||||||
"processor_type": {"type": "string"},
|
"processor_type": {"type": "string"},
|
||||||
"protocol": {"type": "string"},
|
"protocol": {"type": "string"},
|
||||||
"keyboard_folder": {"type": "string"},
|
"keyboard_folder": {"type": "string"},
|
||||||
|
@ -1,18 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json-schema.org/draft/2020-12/schema#",
|
|
||||||
"$id": "qmk.community_module.v1",
|
|
||||||
"title": "Community Module Information",
|
|
||||||
"type": "object",
|
|
||||||
"required": ["module_name", "maintainer"],
|
|
||||||
"properties": {
|
|
||||||
"module_name": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
|
||||||
"maintainer": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
|
||||||
"license": {"type": "string"},
|
|
||||||
"url": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri"
|
|
||||||
},
|
|
||||||
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
|
|
||||||
"features": {"$ref": "./keyboard.jsonschema#/definitions/features_config"}
|
|
||||||
}
|
|
||||||
}
|
|
@ -17,9 +17,9 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["pin_a", "pin_b"],
|
"required": ["pin_a", "pin_b"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"pin_a": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"pin_a": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"pin_b": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"pin_b": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"resolution": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -28,22 +28,17 @@
|
|||||||
"dip_switch_config": {
|
"dip_switch_config": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
|
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"features_config": {
|
|
||||||
"$ref": "./definitions.jsonschema#/boolean_array",
|
|
||||||
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
|
|
||||||
"not": {"required": ["lto"]}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"not": {"required": ["vendorId", "productId"]}, // reject via keys...
|
"not": {"required": ["vendorId", "productId"]}, // reject via keys...
|
||||||
"properties": {
|
"properties": {
|
||||||
"keyboard_name": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"keyboard_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"keyboard_folder": {"$ref": "./definitions.jsonschema#/keyboard"},
|
"keyboard_folder": {"$ref": "qmk.definitions.v1#/keyboard"},
|
||||||
"maintainer": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"manufacturer": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"manufacturer": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"url": {
|
"url": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "uri"
|
"format": "uri"
|
||||||
@ -84,7 +79,6 @@
|
|||||||
"STM32F407",
|
"STM32F407",
|
||||||
"STM32F411",
|
"STM32F411",
|
||||||
"STM32F446",
|
"STM32F446",
|
||||||
"STM32G0B1",
|
|
||||||
"STM32G431",
|
"STM32G431",
|
||||||
"STM32G474",
|
"STM32G474",
|
||||||
"STM32H723",
|
"STM32H723",
|
||||||
@ -119,8 +113,8 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"data_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"clock_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"default_brightness": {
|
"default_brightness": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0,
|
"minimum": 0,
|
||||||
@ -145,13 +139,13 @@
|
|||||||
"enum": ["dac_additive", "dac_basic", "pwm_software", "pwm_hardware"]
|
"enum": ["dac_additive", "dac_basic", "pwm_software", "pwm_hardware"]
|
||||||
},
|
},
|
||||||
"macro_beep": {"type": "boolean"},
|
"macro_beep": {"type": "boolean"},
|
||||||
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
|
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
|
||||||
"power_control": {
|
"power_control": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"on_state": {"$ref": "./definitions.jsonschema#/bit"},
|
"on_state": {"$ref": "qmk.definitions.v1#/bit"},
|
||||||
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"}
|
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"voices": {"type": "boolean"}
|
"voices": {"type": "boolean"}
|
||||||
@ -171,20 +165,20 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"on": {"type": "boolean"},
|
"on": {"type": "boolean"},
|
||||||
"breathing": {"type": "boolean"},
|
"breathing": {"type": "boolean"},
|
||||||
"brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"breathing": {"type": "boolean"},
|
"breathing": {"type": "boolean"},
|
||||||
"breathing_period": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"breathing_period": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"levels": {
|
"levels": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1,
|
"minimum": 1,
|
||||||
"maximum": 31
|
"maximum": 31
|
||||||
},
|
},
|
||||||
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"pins": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
|
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
|
||||||
"on_state": {"$ref": "./definitions.jsonschema#/bit"},
|
"on_state": {"$ref": "qmk.definitions.v1#/bit"},
|
||||||
"as_caps_lock": {"type": "boolean"}
|
"as_caps_lock": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -269,7 +263,7 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["COL2ROW", "ROW2COL"]
|
"enum": ["COL2ROW", "ROW2COL"]
|
||||||
},
|
},
|
||||||
"debounce": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"debounce": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"caps_word": {
|
"caps_word": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -277,20 +271,20 @@
|
|||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"both_shifts_turns_on": {"type": "boolean"},
|
"both_shifts_turns_on": {"type": "boolean"},
|
||||||
"double_tap_shift_turns_on": {"type": "boolean"},
|
"double_tap_shift_turns_on": {"type": "boolean"},
|
||||||
"idle_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"invert_on_shift": {"type": "boolean"}
|
"invert_on_shift": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"combo": {
|
"combo": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"term": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"community_layouts": {
|
"community_layouts": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {"$ref": "./definitions.jsonschema#/filename"}
|
"items": {"$ref": "qmk.definitions.v1#/filename"}
|
||||||
},
|
},
|
||||||
"dip_switch": {
|
"dip_switch": {
|
||||||
"$ref": "#/definitions/dip_switch_config",
|
"$ref": "#/definitions/dip_switch_config",
|
||||||
@ -320,10 +314,10 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"driver": {
|
"driver": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["none", "custom", "embedded_flash", "legacy", "rp2040_flash", "spi_flash"]
|
"enum": ["custom", "embedded_flash", "legacy", "rp2040_flash", "spi_flash"]
|
||||||
},
|
},
|
||||||
"backing_size": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"backing_size": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"logical_size": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"logical_size": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -334,16 +328,20 @@
|
|||||||
"enabled": {"type": "boolean"}
|
"enabled": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"features": { "$ref": "#/definitions/features_config" },
|
"features": {
|
||||||
|
"$ref": "qmk.definitions.v1#/boolean_array",
|
||||||
|
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
|
||||||
|
"not": {"required": ["lto"]}
|
||||||
|
},
|
||||||
"indicators": {
|
"indicators": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"caps_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"caps_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"num_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"num_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"scroll_lock": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"compose": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"compose": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"kana": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"kana": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"on_state": {"$ref": "./definitions.jsonschema#/bit"}
|
"on_state": {"$ref": "qmk.definitions.v1#/bit"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"joystick": {
|
"joystick": {
|
||||||
@ -351,20 +349,20 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"driver": {"type": "string"},
|
"driver": {"type": "string"},
|
||||||
"button_count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"button_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"axis_resolution": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"axis_resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"axes": {
|
"axes": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {"enum": ["x", "y", "z", "rx", "ry", "rz"]},
|
"propertyNames": {"enum": ["x", "y", "z", "rx", "ry", "rz"]}
|
||||||
"additionalProperties": {
|
"additionalProperties": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"input_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"input_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"low": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"low": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"rest": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"rest": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"high": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"high": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -376,20 +374,20 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
|
"keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
|
||||||
"layer_lock": {
|
"layer_lock": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"layout_aliases": {
|
"layout_aliases": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": {"$ref": "./definitions.jsonschema#/layout_macro"}
|
"additionalProperties": {"$ref": "qmk.definitions.v1#/layout_macro"}
|
||||||
},
|
},
|
||||||
"layouts": {
|
"layouts": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {"$ref": "./definitions.jsonschema#/layout_macro"},
|
"propertyNames": {"$ref": "qmk.definitions.v1#/layout_macro"},
|
||||||
"additionalProperties": {
|
"additionalProperties": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -404,7 +402,7 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["x", "y"],
|
"required": ["x", "y"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"encoder": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"encoder": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"label": {
|
"label": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^[^\\n]*$"
|
"pattern": "^[^\\n]*$"
|
||||||
@ -418,17 +416,13 @@
|
|||||||
"minimum": 0
|
"minimum": 0
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"r": {"$ref": "./definitions.jsonschema#/signed_decimal"},
|
"r": {"$ref": "qmk.definitions.v1#/signed_decimal"},
|
||||||
"rx": {"$ref": "./definitions.jsonschema#/unsigned_decimal"},
|
"rx": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
|
||||||
"ry": {"$ref": "./definitions.jsonschema#/unsigned_decimal"},
|
"ry": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
|
||||||
"h": {"$ref": "./definitions.jsonschema#/key_unit"},
|
"h": {"$ref": "qmk.definitions.v1#/key_unit"},
|
||||||
"w": {"$ref": "./definitions.jsonschema#/key_unit"},
|
"w": {"$ref": "qmk.definitions.v1#/key_unit"},
|
||||||
"x": {"$ref": "./definitions.jsonschema#/key_unit"},
|
"x": {"$ref": "qmk.definitions.v1#/key_unit"},
|
||||||
"y": {"$ref": "./definitions.jsonschema#/key_unit"},
|
"y": {"$ref": "qmk.definitions.v1#/key_unit"}
|
||||||
"hand": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["L", "R", "*"]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -444,24 +438,12 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"host": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"default": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"nkro": {"type": "boolean"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"leader_key": {
|
"leader_key": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"timing": {"type": "boolean"},
|
"timing": {"type": "boolean"},
|
||||||
"strict_processing": {"type": "boolean"},
|
"strict_processing": {"type": "boolean"},
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"matrix_pins": {
|
"matrix_pins": {
|
||||||
@ -471,38 +453,32 @@
|
|||||||
"custom": {"type": "boolean"},
|
"custom": {"type": "boolean"},
|
||||||
"custom_lite": {"type": "boolean"},
|
"custom_lite": {"type": "boolean"},
|
||||||
"ghost": {"type": "boolean"},
|
"ghost": {"type": "boolean"},
|
||||||
"input_pressed_state": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"input_pressed_state": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"io_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"io_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"direct": {
|
"direct": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
|
"items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
|
||||||
},
|
},
|
||||||
"cols": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
|
"cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
|
||||||
"rows": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
|
"rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
|
||||||
}
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"mouse_key": {
|
"mouse_key": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"delay": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"interval": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"max_speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"time_to_max": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"wheel_delay": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"wheel_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"oneshot": {
|
"oneshot": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"tap_toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"tap_toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"led_matrix": {
|
"led_matrix": {
|
||||||
@ -510,7 +486,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"animations": {
|
"animations": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
|
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
|
||||||
"additionalProperties": {"type": "boolean"}
|
"additionalProperties": {"type": "boolean"}
|
||||||
},
|
},
|
||||||
"default": {
|
"default": {
|
||||||
@ -519,8 +495,8 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"on": {"type": "boolean"},
|
"on": {"type": "boolean"},
|
||||||
"animation": {"type": "string"},
|
"animation": {"type": "string"},
|
||||||
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"driver": {
|
"driver": {
|
||||||
@ -546,28 +522,27 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2,
|
"maxItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
},
|
},
|
||||||
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"val_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"speed_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"led_flush_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"led_process_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"react_on_keyup": {"type": "boolean"},
|
"react_on_keyup": {"type": "boolean"},
|
||||||
"sleep": {"type": "boolean"},
|
"sleep": {"type": "boolean"},
|
||||||
"split_count": {
|
"split_count": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2,
|
"maxItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
},
|
},
|
||||||
"layout": {
|
"layout": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["x", "y"],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"matrix": {
|
"matrix": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -578,9 +553,9 @@
|
|||||||
"minimum": 0
|
"minimum": 0
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"y": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -591,7 +566,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"animations": {
|
"animations": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
|
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
|
||||||
"additionalProperties": {"type": "boolean"}
|
"additionalProperties": {"type": "boolean"}
|
||||||
},
|
},
|
||||||
"default": {
|
"default": {
|
||||||
@ -600,10 +575,10 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"on": {"type": "boolean"},
|
"on": {"type": "boolean"},
|
||||||
"animation": {"type": "string"},
|
"animation": {"type": "string"},
|
||||||
"hue": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"sat": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"driver": {
|
"driver": {
|
||||||
@ -631,30 +606,29 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2,
|
"maxItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
},
|
},
|
||||||
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"hue_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"sat_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"sat_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"val_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"val_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"speed_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"speed_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"led_flush_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"led_flush_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"led_process_limit": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"led_process_limit": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"react_on_keyup": {"type": "boolean"},
|
"react_on_keyup": {"type": "boolean"},
|
||||||
"sleep": {"type": "boolean"},
|
"sleep": {"type": "boolean"},
|
||||||
"split_count": {
|
"split_count": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2,
|
"maxItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
},
|
},
|
||||||
"layout": {
|
"layout": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["x", "y"],
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"matrix": {
|
"matrix": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -665,9 +639,9 @@
|
|||||||
"minimum": 0
|
"minimum": 0
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"x": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"y": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"flags": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -679,27 +653,27 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"animations": {
|
"animations": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {"$ref": "./definitions.jsonschema#/snake_case"},
|
"propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
|
||||||
"additionalProperties": {"type": "boolean"}
|
"additionalProperties": {"type": "boolean"}
|
||||||
},
|
},
|
||||||
"brightness_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"brightness_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"default": {
|
"default": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"on": {"type": "boolean"},
|
"on": {"type": "boolean"},
|
||||||
"animation": {"type": "string"},
|
"animation": {"type": "string"},
|
||||||
"hue": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"hue": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"sat": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"sat": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"val": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"val": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"speed": {"$ref": "./definitions.jsonschema#/unsigned_int_8"}
|
"speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"driver": {
|
"driver": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["apa102", "custom", "ws2812"]
|
"enum": ["apa102", "custom", "ws2812"]
|
||||||
},
|
},
|
||||||
"hue_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"layers": {
|
"layers": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -714,29 +688,29 @@
|
|||||||
"override_rgb": {"type": "boolean"}
|
"override_rgb": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"led_count": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"led_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"led_map": {
|
"led_map": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
},
|
},
|
||||||
"max_brightness": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"pin": {
|
"pin": {
|
||||||
"$ref": "./definitions.jsonschema#/mcu_pin",
|
"$ref": "qmk.definitions.v1#/mcu_pin",
|
||||||
"$comment": "Deprecated: use ws2812.pin instead"
|
"$comment": "Deprecated: use ws2812.pin instead"
|
||||||
},
|
},
|
||||||
"rgbw": {
|
"rgbw": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"$comment": "Deprecated: use ws2812.rgbw instead"
|
"$comment": "Deprecated: use ws2812.rgbw instead"
|
||||||
},
|
},
|
||||||
"saturation_steps": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"saturation_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"sleep": {"type": "boolean"},
|
"sleep": {"type": "boolean"},
|
||||||
"split": {"type": "boolean"},
|
"split": {"type": "boolean"},
|
||||||
"split_count": {
|
"split_count": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2,
|
"maxItems": 2,
|
||||||
"items": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -745,8 +719,8 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"unlock_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"unlock_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"idle_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"idle_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"unlock_sequence": {
|
"unlock_sequence": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"minItems": 1,
|
"minItems": 1,
|
||||||
@ -780,8 +754,8 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"mouse_enabled": {"type": "boolean"},
|
"mouse_enabled": {"type": "boolean"},
|
||||||
"clock_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"clock_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"data_pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"data_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"driver": {
|
"driver": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["busywait", "interrupt", "usart", "vendor"]
|
"enum": ["busywait", "interrupt", "usart", "vendor"]
|
||||||
@ -818,11 +792,11 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"direct": {
|
"direct": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
|
"items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
|
||||||
},
|
},
|
||||||
"cols": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
|
"cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
|
||||||
"rows": {"$ref": "./definitions.jsonschema#/mcu_pin_array"},
|
"rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
|
||||||
"unused": {"$ref": "./definitions.jsonschema#/mcu_pin_array"}
|
"unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -849,16 +823,16 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"matrix_grid": {
|
"matrix_grid": {
|
||||||
"$ref": "./definitions.jsonschema#/mcu_pin_array",
|
"$ref": "qmk.definitions.v1#/mcu_pin_array",
|
||||||
"minItems": 2,
|
"minItems": 2,
|
||||||
"maxItems": 2
|
"maxItems": 2
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"soft_serial_pin": {
|
"soft_serial_pin": {
|
||||||
"$ref": "./definitions.jsonschema#/mcu_pin",
|
"$ref": "qmk.definitions.v1#/mcu_pin",
|
||||||
"$comment": "Deprecated: use split.serial.pin instead"
|
"$comment": "Deprecated: use split.serial.pin instead"
|
||||||
},
|
},
|
||||||
"soft_serial_speed": {
|
"soft_serial_speed": {
|
||||||
@ -874,7 +848,7 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["bitbang", "usart", "vendor"]
|
"enum": ["bitbang", "usart", "vendor"]
|
||||||
},
|
},
|
||||||
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"}
|
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"transport": {
|
"transport": {
|
||||||
@ -902,7 +876,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"watchdog": {"type": "boolean"},
|
"watchdog": {"type": "boolean"},
|
||||||
"watchdog_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"watchdog_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"sync_matrix_state": {
|
"sync_matrix_state": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"$comment": "Deprecated: use sync.matrix_state instead"
|
"$comment": "Deprecated: use sync.matrix_state instead"
|
||||||
@ -918,8 +892,8 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {"type": "boolean"},
|
"enabled": {"type": "boolean"},
|
||||||
"polling_interval": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"main": {
|
"main": {
|
||||||
@ -929,7 +903,7 @@
|
|||||||
},
|
},
|
||||||
"matrix_grid": {
|
"matrix_grid": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"items": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"$comment": "Deprecated: use split.handedness.matrix_grid instead"
|
"$comment": "Deprecated: use split.handedness.matrix_grid instead"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -941,7 +915,6 @@
|
|||||||
"tapping": {
|
"tapping": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"chordal_hold": {"type": "boolean"},
|
|
||||||
"force_hold": {"type": "boolean"},
|
"force_hold": {"type": "boolean"},
|
||||||
"force_hold_per_key": {"type": "boolean"},
|
"force_hold_per_key": {"type": "boolean"},
|
||||||
"ignore_mod_tap_interrupt": {"type": "boolean"},
|
"ignore_mod_tap_interrupt": {"type": "boolean"},
|
||||||
@ -951,9 +924,9 @@
|
|||||||
"permissive_hold_per_key": {"type": "boolean"},
|
"permissive_hold_per_key": {"type": "boolean"},
|
||||||
"retro": {"type": "boolean"},
|
"retro": {"type": "boolean"},
|
||||||
"retro_per_key": {"type": "boolean"},
|
"retro_per_key": {"type": "boolean"},
|
||||||
"term": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"term": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"term_per_key": {"type": "boolean"},
|
"term_per_key": {"type": "boolean"},
|
||||||
"toggle": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"usb": {
|
"usb": {
|
||||||
@ -961,20 +934,16 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"device_ver": {
|
"device_ver": {
|
||||||
"$ref": "./definitions.jsonschema#/hex_number_4d",
|
"$ref": "qmk.definitions.v1#/hex_number_4d",
|
||||||
"$comment": "Deprecated: use device_version instead"
|
"$comment": "Deprecated: use device_version instead"
|
||||||
},
|
},
|
||||||
"device_version": {"$ref": "./definitions.jsonschema#/bcd_version"},
|
"device_version": {"$ref": "qmk.definitions.v1#/bcd_version"},
|
||||||
"force_nkro": {
|
"force_nkro": {"type": "boolean"},
|
||||||
"type": "boolean",
|
"pid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
|
||||||
"$comment": "Deprecated: use host.default.nkro instead"
|
"vid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
|
||||||
|
"max_power": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
},
|
|
||||||
"pid": {"$ref": "./definitions.jsonschema#/hex_number_4d"},
|
|
||||||
"vid": {"$ref": "./definitions.jsonschema#/hex_number_4d"},
|
|
||||||
"max_power": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
|
||||||
"no_startup_check": {"type": "boolean"},
|
"no_startup_check": {"type": "boolean"},
|
||||||
"polling_interval": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"shared_endpoint": {
|
"shared_endpoint": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -983,7 +952,7 @@
|
|||||||
"mouse": {"type": "boolean"}
|
"mouse": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"suspend_wakeup_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"wait_for_enumeration": {"type": "boolean"}
|
"wait_for_enumeration": {"type": "boolean"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -991,9 +960,9 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"keys_per_scan": {"$ref": "./definitions.jsonschema#/unsigned_int_8"},
|
"keys_per_scan": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
|
||||||
"tap_keycode_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"tap_capslock_delay": {"$ref": "./definitions.jsonschema#/unsigned_int"},
|
"tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
|
||||||
"locking": {
|
"locking": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -1008,10 +977,10 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"esc_output": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"esc_output": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"esc_input": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"esc_input": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"led": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"led": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"speaker": {"$ref": "./definitions.jsonschema#/mcu_pin"}
|
"speaker": {"$ref": "qmk.definitions.v1#/mcu_pin"}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"ws2812": {
|
"ws2812": {
|
||||||
@ -1022,10 +991,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["bitbang", "custom", "i2c", "pwm", "spi", "vendor"]
|
"enum": ["bitbang", "custom", "i2c", "pwm", "spi", "vendor"]
|
||||||
},
|
},
|
||||||
"pin": {"$ref": "./definitions.jsonschema#/mcu_pin"},
|
"pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
|
||||||
"rgbw": {"type": "boolean"},
|
"rgbw": {"type": "boolean"},
|
||||||
"i2c_address": {"$ref": "./definitions.jsonschema#/hex_number_2d"},
|
"i2c_address": {"$ref": "qmk.definitions.v1#/hex_number_2d"},
|
||||||
"i2c_timeout": {"$ref": "./definitions.jsonschema#/unsigned_int"}
|
"i2c_timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -30,10 +30,10 @@
|
|||||||
"keycodes": {
|
"keycodes": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"propertyNames": {
|
"propertyNames": {
|
||||||
"$ref": "./definitions.jsonschema#/hex_number_4d"
|
"$ref": "qmk.definitions.v1#/hex_number_4d"
|
||||||
},
|
},
|
||||||
"additionalProperties": {
|
"additionalProperties": {
|
||||||
"type": "object", // use './definitions.jsonschema#/keycode_decl' when problem keycodes are removed
|
"type": "object", // use 'qmk.definitions.v1#/keycode_decl' when problem keycodes are removed
|
||||||
"required": [
|
"required": [
|
||||||
"key"
|
"key"
|
||||||
],
|
],
|
||||||
|
@ -10,10 +10,10 @@
|
|||||||
"minLength": 1,
|
"minLength": 1,
|
||||||
"pattern": "^[a-z][0-9a-z_]*$"
|
"pattern": "^[a-z][0-9a-z_]*$"
|
||||||
},
|
},
|
||||||
"host_language": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"host_language": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"keyboard": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"keyboard": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"keymap": {"$ref": "./definitions.jsonschema#/text_identifier"},
|
"keymap": {"$ref": "qmk.definitions.v1#/text_identifier"},
|
||||||
"layout": {"$ref": "./definitions.jsonschema#/layout_macro"},
|
"layout": {"$ref": "qmk.definitions.v1#/layout_macro"},
|
||||||
"layers": {
|
"layers": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -55,11 +55,11 @@
|
|||||||
"keycodes": {
|
"keycodes": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "./definitions.jsonschema#/text_identifier"
|
"$ref": "qmk.definitions.v1#/text_identifier"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"duration": {
|
"duration": {
|
||||||
"$ref": "./definitions.jsonschema#/unsigned_int"
|
"$ref": "qmk.definitions.v1#/unsigned_int"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -67,16 +67,10 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"keycodes": {"$ref": "./definitions.jsonschema#/keycode_decl_array"},
|
"keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
|
||||||
"config": {"$ref": "./keyboard.jsonschema#"},
|
"config": {"$ref": "qmk.keyboard.v1"},
|
||||||
"notes": {
|
"notes": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
],
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"userspace_version": {
|
"userspace_version": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
}
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -6,10 +6,10 @@
|
|||||||
"definitions": {
|
"definitions": {
|
||||||
"build_target": {
|
"build_target": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{"$ref": "./definitions.jsonschema#/keyboard_keymap_tuple"},
|
{"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
|
||||||
{"$ref": "./definitions.jsonschema#/json_file_path"}
|
{"$ref": "qmk.definitions.v1#/json_file_path"}
|
||||||
]
|
]
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"userspace_version",
|
"userspace_version",
|
||||||
|
@ -6,11 +6,11 @@
|
|||||||
"definitions": {
|
"definitions": {
|
||||||
"build_target": {
|
"build_target": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{"$ref": "./definitions.jsonschema#/keyboard_keymap_tuple"},
|
{"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
|
||||||
{"$ref": "./definitions.jsonschema#/keyboard_keymap_env"},
|
{"$ref": "qmk.definitions.v1#/keyboard_keymap_env"},
|
||||||
{"$ref": "./definitions.jsonschema#/json_file_path"}
|
{"$ref": "qmk.definitions.v1#/json_file_path"}
|
||||||
]
|
]
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"userspace_version",
|
"userspace_version",
|
||||||
|
@ -14,6 +14,8 @@
|
|||||||
},
|
},
|
||||||
"features": {
|
"features": {
|
||||||
"bootmagic": true,
|
"bootmagic": true,
|
||||||
|
"command": false,
|
||||||
|
"console": false,
|
||||||
"extrakey": true,
|
"extrakey": true,
|
||||||
"mousekey": true,
|
"mousekey": true,
|
||||||
"nkro": true
|
"nkro": true
|
||||||
|
@ -1,135 +0,0 @@
|
|||||||
# QMK Breaking Changes - 2025 February 23 Changelog
|
|
||||||
|
|
||||||
## Notable Features
|
|
||||||
|
|
||||||
### Community Modules ([#24848](https://github.com/qmk/qmk_firmware/pull/24848))
|
|
||||||
|
|
||||||
Community Modules are a feature within QMK which allows code to be implemented by third parties, making it available for other people to import into their own builds.
|
|
||||||
|
|
||||||
These modules can provide implementations which override or enhance normal QMK processing; initialization, key processing, suspend, and shutdown are some of the provided hooks which modules may currently implement.
|
|
||||||
|
|
||||||
See the [Community Modules documentation](../features/community_modules) for more information, including the full list of available hooks.
|
|
||||||
|
|
||||||
First-class support for [External Userspace](../newbs_external_userspace) is included out of the box, so there's even more reason to take the plunge and convert your keymap builds to a userspace repository!
|
|
||||||
|
|
||||||
::: tip
|
|
||||||
An example with a new keycode and some debugging information in the QMK repository [lives here](https://github.com/qmk/qmk_firmware/tree/master/modules/qmk/hello_world), and a community module port of [getreuer's SOCD Cleaner](https://getreuer.info/posts/keyboards/socd-cleaner/) can be found in [tzarc's modules repo](https://github.com/tzarc/qmk_modules).
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Chordal Hold ([#24560](https://github.com/qmk/qmk_firmware/pull/24560))
|
|
||||||
|
|
||||||
Chordal Hold implements, by default, an "opposite hands" rule. Suppose a tap-hold key is pressed and then, before the tapping term, another key is pressed. With Chordal Hold, the tap-hold key is settled as tapped if the two keys are on the same hand.
|
|
||||||
|
|
||||||
Chordal Hold may be useful to avoid accidental modifier activation with mod-taps, particularly in rolled keypresses when using home row mods.
|
|
||||||
|
|
||||||
See the [Chordal Hold documentation](../tap_hold#chordal-hold) for more information.
|
|
||||||
|
|
||||||
## Changes Requiring User Action
|
|
||||||
|
|
||||||
### Updated Keyboard Codebases
|
|
||||||
|
|
||||||
| Old Keyboard Name | New Keyboard Name |
|
|
||||||
|-------------------------|-----------------------------|
|
|
||||||
| cxt_studio | cxt_studio/12e4 |
|
|
||||||
| ergodox_stm32 | handwired/ergodox_stm32 |
|
|
||||||
| ploopyco/mouse | ploopyco/mouse/rev1_002 |
|
|
||||||
| ploopyco/trackball/rev1 | ploopyco/trackball/rev1_004 |
|
|
||||||
| ymdk/id75 | ymdk/id75/f103 |
|
|
||||||
|
|
||||||
## Deprecation Notices
|
|
||||||
|
|
||||||
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
|
|
||||||
|
|
||||||
### DEFAULT_FOLDER removal ([#24836](https://github.com/qmk/qmk_firmware/pull/24836))
|
|
||||||
|
|
||||||
`DEFAULT_FOLDER` was originally introduced to work around limitations within the build system.
|
|
||||||
Parent folders containing common configuration would create invalid build targets.
|
|
||||||
|
|
||||||
With the introduction of [`keyboard.json`](./20240526#keyboard-json) as a configuration file, the build system now has a consistent method to detect build targets.
|
|
||||||
The `DEFAULT_FOLDER` functionality is now redundant and the intent is for `rules.mk` to become pure configuration.
|
|
||||||
|
|
||||||
Backwards compatibility of build targets has been maintained where possible.
|
|
||||||
|
|
||||||
## Full changelist
|
|
||||||
|
|
||||||
Core:
|
|
||||||
* Chaining OSL and MO ([#23065](https://github.com/qmk/qmk_firmware/pull/23065))
|
|
||||||
* Add extra keymap for EurKEY layout ([#24241](https://github.com/qmk/qmk_firmware/pull/24241))
|
|
||||||
* Add leader_add_user callback ([#24266](https://github.com/qmk/qmk_firmware/pull/24266))
|
|
||||||
* always return audio pin to 0 on ARM ([#24503](https://github.com/qmk/qmk_firmware/pull/24503))
|
|
||||||
* Update Starlight matrix effects ([#24521](https://github.com/qmk/qmk_firmware/pull/24521))
|
|
||||||
* Refactor Hue Breathing matrix effect with runner ([#24525](https://github.com/qmk/qmk_firmware/pull/24525))
|
|
||||||
* Ensure timer_read() is safe to call from interrupt handlers on ARM ([#24529](https://github.com/qmk/qmk_firmware/pull/24529))
|
|
||||||
* Update Raindrops effect to respect LED range limits ([#24531](https://github.com/qmk/qmk_firmware/pull/24531))
|
|
||||||
* Add Chordal Hold, an "opposite hands rule" tap-hold option similar to Achordion, Bilateral Combinations. ([#24560](https://github.com/qmk/qmk_firmware/pull/24560))
|
|
||||||
* Azoteq - improve I2C behaviour while polling. ([#24611](https://github.com/qmk/qmk_firmware/pull/24611))
|
|
||||||
* macOS install: remove bad ARM toolchains ([#24637](https://github.com/qmk/qmk_firmware/pull/24637))
|
|
||||||
* small refactoring of TIMER_DIFF ([#24678](https://github.com/qmk/qmk_firmware/pull/24678))
|
|
||||||
* Subscript alef correction ([#24707](https://github.com/qmk/qmk_firmware/pull/24707))
|
|
||||||
* Created SH1107 driver for quantum painter ([#24724](https://github.com/qmk/qmk_firmware/pull/24724))
|
|
||||||
* [CI] Regenerate Files ([#24772](https://github.com/qmk/qmk_firmware/pull/24772))
|
|
||||||
* Patch up issue for inverted complementary output on Backlight ([#24794](https://github.com/qmk/qmk_firmware/pull/24794))
|
|
||||||
* Patch up issue when compile with APA102 driver ([#24800](https://github.com/qmk/qmk_firmware/pull/24800))
|
|
||||||
* Consolidate send_string implementations. ([#24817](https://github.com/qmk/qmk_firmware/pull/24817))
|
|
||||||
* Consolidate timer_elapsed implementations ([#24830](https://github.com/qmk/qmk_firmware/pull/24830))
|
|
||||||
* `i2c_master`: remove deprecated functions ([#24832](https://github.com/qmk/qmk_firmware/pull/24832))
|
|
||||||
* Resolve keyboard_aliases when processing keyboard make targets ([#24834](https://github.com/qmk/qmk_firmware/pull/24834))
|
|
||||||
* LED drivers: remove deprecated defines ([#24837](https://github.com/qmk/qmk_firmware/pull/24837))
|
|
||||||
* `ferris/0_1`: update I2C API usage ([#24839](https://github.com/qmk/qmk_firmware/pull/24839))
|
|
||||||
* Unify i2c_master headers ([#24846](https://github.com/qmk/qmk_firmware/pull/24846))
|
|
||||||
* Community modules ([#24848](https://github.com/qmk/qmk_firmware/pull/24848))
|
|
||||||
* Relocate base WS2812 code ([#24850](https://github.com/qmk/qmk_firmware/pull/24850))
|
|
||||||
* Unify UART headers ([#24855](https://github.com/qmk/qmk_firmware/pull/24855))
|
|
||||||
* Unify spi_master headers ([#24857](https://github.com/qmk/qmk_firmware/pull/24857))
|
|
||||||
* Invoke `process_record_via` after `_user`/`_kb` have a chance to handle it. ([#24879](https://github.com/qmk/qmk_firmware/pull/24879))
|
|
||||||
|
|
||||||
CLI:
|
|
||||||
* Extend lint to reject 'blank' files ([#23994](https://github.com/qmk/qmk_firmware/pull/23994))
|
|
||||||
* `qmk docs`: restore `--port` and `--browser` arguments ([#24623](https://github.com/qmk/qmk_firmware/pull/24623))
|
|
||||||
* Update via2json layout macro searching ([#24640](https://github.com/qmk/qmk_firmware/pull/24640))
|
|
||||||
* Change `new-keymap` keymap name prompt ([#24701](https://github.com/qmk/qmk_firmware/pull/24701))
|
|
||||||
* default_keyboard.h generation tweaks ([#24715](https://github.com/qmk/qmk_firmware/pull/24715))
|
|
||||||
* Ensure `qmk flash` rejects invalid files for uf2 compatible bootloaders ([#24802](https://github.com/qmk/qmk_firmware/pull/24802))
|
|
||||||
* Reject readme dummy content ([#24913](https://github.com/qmk/qmk_firmware/pull/24913))
|
|
||||||
|
|
||||||
Submodule updates:
|
|
||||||
* chibios: usb_main: remove OTG sof workaround ([#24259](https://github.com/qmk/qmk_firmware/pull/24259))
|
|
||||||
* Update ChibiOS to latest stable branch. ([#24651](https://github.com/qmk/qmk_firmware/pull/24651))
|
|
||||||
* Update ChibiOS `stable_21.11.x`. ([#24714](https://github.com/qmk/qmk_firmware/pull/24714))
|
|
||||||
* Update ChibiOS-Contrib. ([#24803](https://github.com/qmk/qmk_firmware/pull/24803))
|
|
||||||
|
|
||||||
Keyboards:
|
|
||||||
* refactor: move ymdk/id75 to revision ([#24590](https://github.com/qmk/qmk_firmware/pull/24590))
|
|
||||||
* skyloong/gk61: Remove overriding of core keycode behaviour ([#24655](https://github.com/qmk/qmk_firmware/pull/24655))
|
|
||||||
* moky/moky88: Remove use of deprecated defines ([#24656](https://github.com/qmk/qmk_firmware/pull/24656))
|
|
||||||
* Updating Promenade keyboard (Missing keys in matrix, other minor changes to keymap) ([#24705](https://github.com/qmk/qmk_firmware/pull/24705))
|
|
||||||
* Moving cxt_studio keyboard to own folder ([#24748](https://github.com/qmk/qmk_firmware/pull/24748))
|
|
||||||
* Add CXT Studio 12E3 keyboard ([#24749](https://github.com/qmk/qmk_firmware/pull/24749))
|
|
||||||
* Add Silakka54 keyboard ([#24757](https://github.com/qmk/qmk_firmware/pull/24757))
|
|
||||||
* Add more layout for skiller_sgk50_s4 ([#24784](https://github.com/qmk/qmk_firmware/pull/24784))
|
|
||||||
* Add watchdog service to RGBKB Sol 3 ([#24786](https://github.com/qmk/qmk_firmware/pull/24786))
|
|
||||||
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24835](https://github.com/qmk/qmk_firmware/pull/24835))
|
|
||||||
* Remove DEFAULT_FOLDER where keyboard aliases already exists ([#24838](https://github.com/qmk/qmk_firmware/pull/24838))
|
|
||||||
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24845](https://github.com/qmk/qmk_firmware/pull/24845))
|
|
||||||
* Update for 'A-JAZZ AKC084' ('A-JAZZ AKP846') ([#24868](https://github.com/qmk/qmk_firmware/pull/24868))
|
|
||||||
* handwired/xealous - Remove DEFAULT_FOLDER ([#24877](https://github.com/qmk/qmk_firmware/pull/24877))
|
|
||||||
* Updates to Ploopy Classic, Mouse, and Thumb for RP2040 hardware upgrade ([#24880](https://github.com/qmk/qmk_firmware/pull/24880))
|
|
||||||
* Move Ergodox STM32 to handwired folder ([#24903](https://github.com/qmk/qmk_firmware/pull/24903))
|
|
||||||
* Remove readme dummy content ([#24912](https://github.com/qmk/qmk_firmware/pull/24912))
|
|
||||||
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24915](https://github.com/qmk/qmk_firmware/pull/24915))
|
|
||||||
* Migrate some DEFAULT_FOLDER to keyboard_aliases.hjson ([#24938](https://github.com/qmk/qmk_firmware/pull/24938))
|
|
||||||
|
|
||||||
Keyboard fixes:
|
|
||||||
* Fix up CI with `DEFAULT_FOLDER`. ([#24842](https://github.com/qmk/qmk_firmware/pull/24842))
|
|
||||||
* rgbkb/pan - Remove invalid build target ([#24844](https://github.com/qmk/qmk_firmware/pull/24844))
|
|
||||||
|
|
||||||
Others:
|
|
||||||
* Formally deprecate DEFAULT_FOLDER ([#24836](https://github.com/qmk/qmk_firmware/pull/24836))
|
|
||||||
* Correct I2C API reference ([#24840](https://github.com/qmk/qmk_firmware/pull/24840))
|
|
||||||
|
|
||||||
Bugs:
|
|
||||||
* Retro Tapping Re-Write; Key Roll Fix ([#23641](https://github.com/qmk/qmk_firmware/pull/23641))
|
|
||||||
* Fix Quantum Painter compiliation issues with heavy optimization ([#24667](https://github.com/qmk/qmk_firmware/pull/24667))
|
|
||||||
* Bugfix and update for AT32F415 ([#24807](https://github.com/qmk/qmk_firmware/pull/24807))
|
|
||||||
* Fix for Chordal Hold: stuck mods when mod-taps are pressed in a stuttered sequence. ([#24878](https://github.com/qmk/qmk_firmware/pull/24878))
|
|
||||||
* fix EEPROM driver for STM32L0/1 cat.1 devices ([#24928](https://github.com/qmk/qmk_firmware/pull/24928))
|
|
@ -1,299 +0,0 @@
|
|||||||
# QMK Breaking Changes - 2025 May 25 Changelog
|
|
||||||
|
|
||||||
## Notable Features
|
|
||||||
|
|
||||||
### Flow Tap ([#25125](https://github.com/qmk/qmk_firmware/pull/25125))
|
|
||||||
|
|
||||||
Adds Flow Tap as a core tap-hold option to disable HRMs during fast typing, aka Global Quick Tap, Require Prior Idle.
|
|
||||||
|
|
||||||
Flow Tap modifies mod-tap MT and layer-tap LT keys such that when pressed within a short timeout of the preceding key, the tapping behavior is triggered. It basically disables the hold behavior during fast typing, creating a "flow of taps." It also helps to reduce the input lag of tap-hold keys during fast typing, since the tapped behavior is sent immediately.
|
|
||||||
|
|
||||||
See the [Flow Tap documentation](../tap_hold#flow-tap) for more information.
|
|
||||||
|
|
||||||
### Community Modules `1.1.1` ([#25050](https://github.com/qmk/qmk_firmware/pull/25050), [#25187](https://github.com/qmk/qmk_firmware/pull/25187))
|
|
||||||
|
|
||||||
Version `1.1.1` introduces support for module defined RGB matrix effects and indicator callbacks, as well as pointing and layer state callbacks.
|
|
||||||
|
|
||||||
See the [Community Modules documentation](../features/community_modules) for more information, including the full list of available hooks.
|
|
||||||
|
|
||||||
## Changes Requiring User Action
|
|
||||||
|
|
||||||
### Updated Keyboard Codebases
|
|
||||||
|
|
||||||
| Old Keyboard Name | New Keyboard Name |
|
|
||||||
|------------------------|----------------------|
|
|
||||||
| chew | chew/split |
|
|
||||||
| deemen17/de60fs | deemen17/de60/r1 |
|
|
||||||
| keyten/kt60hs_t | keyten/kt60hs_t/v1 |
|
|
||||||
| plywrks/ply8x | plywrks/ply8x/solder |
|
|
||||||
| rookiebwoy/late9/rev1 | ivndbt/late9/rev1 |
|
|
||||||
| rookiebwoy/neopad/rev1 | ivndbt/neopad/rev1 |
|
|
||||||
|
|
||||||
## Deprecation Notices
|
|
||||||
|
|
||||||
In line with the [notice period](../support_deprecation_policy#how-much-advance-notice-will-be-given), deprecation notices for larger items are listed here.
|
|
||||||
|
|
||||||
### Deprecation of `qmk generate-compilation-database` ([#25237](https://github.com/qmk/qmk_firmware/pull/25237))
|
|
||||||
|
|
||||||
This command has been deprecated as it cannot take into account configurables such as [converters](/feature_converters) or environment variables normally specified on the command line; please use the `--compiledb` flag with `qmk compile` instead.
|
|
||||||
|
|
||||||
### Deprecation of `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
|
|
||||||
|
|
||||||
Unpicking the assumption that only USB can do NKRO, forcing of NKRO on every boot has been deprecated. As this setting persists, it produces unnecessary user confusion when the various NKRO keycodes (for example `NK_TOGG`) do not behave as expected.
|
|
||||||
|
|
||||||
The new defaults can be configured in the following ways:
|
|
||||||
|
|
||||||
:::::tabs
|
|
||||||
|
|
||||||
==== keyboard.json
|
|
||||||
|
|
||||||
```json [keyboard.json]
|
|
||||||
{
|
|
||||||
"host": { // [!code focus]
|
|
||||||
"default": { // [!code focus]
|
|
||||||
"nkro": true // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
==== keymap.json
|
|
||||||
|
|
||||||
```json [keymap.json]
|
|
||||||
{
|
|
||||||
"config": {
|
|
||||||
"host": { // [!code focus]
|
|
||||||
"default": { // [!code focus]
|
|
||||||
"nkro": true // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
==== config.h
|
|
||||||
|
|
||||||
```c [config.h]
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#define NKRO_DEFAULT_ON true // [!code focus]
|
|
||||||
```
|
|
||||||
|
|
||||||
:::::
|
|
||||||
|
|
||||||
The deprecated options will be removed in a future breaking changes cycle.
|
|
||||||
|
|
||||||
### `CTPC`/`CONVERT_TO_PROTON_C` removal ([#25111](https://github.com/qmk/qmk_firmware/pull/25111))
|
|
||||||
|
|
||||||
Deprecated build options `CTPC` and `CONVERT_TO_PROTON_C` have been removed. Users should of these should migrate to `CONVERT_TO=proton_c`.
|
|
||||||
|
|
||||||
see the [Converters Feature](../feature_converters) documentation for more information.
|
|
||||||
|
|
||||||
### `DEFAULT_FOLDER` removal ([#23281](https://github.com/qmk/qmk_firmware/pull/23281))
|
|
||||||
|
|
||||||
`DEFAULT_FOLDER` was originally introduced to work around limitations within the build system.
|
|
||||||
Parent folders containing common configuration would create invalid build targets.
|
|
||||||
|
|
||||||
With the introduction of [`keyboard.json`](./20240526#keyboard-json) as a configuration file, the build system now has a consistent method to detect build targets.
|
|
||||||
The `DEFAULT_FOLDER` functionality is now redundant and the intent is for `rules.mk` to become pure configuration.
|
|
||||||
|
|
||||||
Backwards compatibility of build targets has been maintained where possible.
|
|
||||||
|
|
||||||
### Converter `Pin Compatible` updates ([#20330](https://github.com/qmk/qmk_firmware/pull/20330))
|
|
||||||
|
|
||||||
Converter support will be further limited to only function if a keyboard declares that is is compatible.
|
|
||||||
|
|
||||||
This can be configured in the following ways:
|
|
||||||
|
|
||||||
:::::tabs
|
|
||||||
|
|
||||||
==== keyboard.json
|
|
||||||
|
|
||||||
```json [keyboard.json]
|
|
||||||
{
|
|
||||||
"development_board": "promicro", // [!code focus]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
==== rules.mk
|
|
||||||
|
|
||||||
```make [rules.mk]
|
|
||||||
PIN_COMPATIBLE = promicro
|
|
||||||
```
|
|
||||||
|
|
||||||
:::::
|
|
||||||
|
|
||||||
see the [Converters Feature](../feature_converters) documentation for more information.
|
|
||||||
|
|
||||||
### Deprecation of `encoder_update_{kb|user}`
|
|
||||||
|
|
||||||
These callbacks are now considered end-of-life and will be removed over the next breaking changes cycle, ending August 2025. PRs containing these callbacks will be asked to change to use [encoder mapping](/features/encoders#encoder-map).
|
|
||||||
|
|
||||||
`ENCODER_MAP_ENABLE` will subsequently be changed to "default-on" when encoders are enabled, and future breaking changes cycles will remove this flag entirely.
|
|
||||||
|
|
||||||
To migrate usage of `encoder_update_user` to encoder map you'll need to handle all of the following changes in your `keymap.c`:
|
|
||||||
|
|
||||||
:::::tabs
|
|
||||||
|
|
||||||
=== 1. Add keycode definitions
|
|
||||||
|
|
||||||
Define new keycodes:
|
|
||||||
|
|
||||||
```c
|
|
||||||
enum {
|
|
||||||
MY_ENCODER_LEFT = QK_USER, // [!code focus]
|
|
||||||
MY_ENCODER_RIGHT, // [!code focus]
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
=== 2. Add encoder mapping
|
|
||||||
|
|
||||||
Add the keycodes to a new encoder map (optionally with transparent layers above, if you want identical functionality of layer-independence):
|
|
||||||
|
|
||||||
```c
|
|
||||||
#if defined(ENCODER_MAP_ENABLE)
|
|
||||||
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
|
|
||||||
[0] = { ENCODER_CCW_CW(MY_ENCODER_LEFT, MY_ENCODER_RIGHT) }, // [!code focus]
|
|
||||||
[1] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
|
|
||||||
[2] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
|
|
||||||
[3] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }, // [!code focus]
|
|
||||||
};
|
|
||||||
#endif
|
|
||||||
```
|
|
||||||
|
|
||||||
=== 3. Add keycode processing
|
|
||||||
|
|
||||||
Handle the new keycodes within `process_record_user`, much like any other keycode in your keymap:
|
|
||||||
|
|
||||||
```c
|
|
||||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
||||||
switch (keycode) {
|
|
||||||
case MY_ENCODER_LEFT: // [!code focus]
|
|
||||||
if (record->event.pressed) { // [!code focus]
|
|
||||||
// Add the same code you had in your `encoder_update_user` for the left-rotation code // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
return false; // Skip all further processing of this keycode // [!code focus]
|
|
||||||
case MY_ENCODER_RIGHT: // [!code focus]
|
|
||||||
if (record->event.pressed) { // [!code focus]
|
|
||||||
// Add the same code you had in your `encoder_update_user` for the right-rotation code // [!code focus]
|
|
||||||
} // [!code focus]
|
|
||||||
return false; // Skip all further processing of this keycode // [!code focus]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
=== 4. Remove old code
|
|
||||||
|
|
||||||
Remove your implementation of `encoder_update_user` from your `keymap.c`.
|
|
||||||
|
|
||||||
::::::
|
|
||||||
|
|
||||||
If your board has multiple encoders, each encoder will need its own pair of keycodes defined as per above.
|
|
||||||
|
|
||||||
## Full changelist
|
|
||||||
|
|
||||||
Core:
|
|
||||||
* Non-volatile memory data repository pattern ([#24356](https://github.com/qmk/qmk_firmware/pull/24356))
|
|
||||||
* High resolution scrolling (without feature report parsing) ([#24423](https://github.com/qmk/qmk_firmware/pull/24423))
|
|
||||||
* Implement battery level interface ([#24666](https://github.com/qmk/qmk_firmware/pull/24666))
|
|
||||||
* get_keycode_string(): function to format keycodes as strings, for more readable debug logging. ([#24787](https://github.com/qmk/qmk_firmware/pull/24787))
|
|
||||||
* [Cleanup] Handling of optional `*.mk` files ([#24952](https://github.com/qmk/qmk_firmware/pull/24952))
|
|
||||||
* Add EOL to non-keyboard files ([#24990](https://github.com/qmk/qmk_firmware/pull/24990))
|
|
||||||
* use `keycode_string` in unit tests ([#25042](https://github.com/qmk/qmk_firmware/pull/25042))
|
|
||||||
* Add additional hooks for Community modules ([#25050](https://github.com/qmk/qmk_firmware/pull/25050))
|
|
||||||
* Remove `CTPC`/`CONVERT_TO_PROTON_C` options ([#25111](https://github.com/qmk/qmk_firmware/pull/25111))
|
|
||||||
* Flow Tap tap-hold option to disable HRMs during fast typing (aka Global Quick Tap, Require Prior Idle). ([#25125](https://github.com/qmk/qmk_firmware/pull/25125))
|
|
||||||
* Remove `bluefruit_le_read_battery_voltage` function ([#25129](https://github.com/qmk/qmk_firmware/pull/25129))
|
|
||||||
* Avoid duplication in generated community modules `rules.mk` ([#25135](https://github.com/qmk/qmk_firmware/pull/25135))
|
|
||||||
* [chore]: move and rename mouse/scroll min/max defines ([#25141](https://github.com/qmk/qmk_firmware/pull/25141))
|
|
||||||
* Ignore the Layer Lock key in Repeat Key and Caps Word. ([#25171](https://github.com/qmk/qmk_firmware/pull/25171))
|
|
||||||
* Allow for disabling EEPROM subsystem entirely. ([#25173](https://github.com/qmk/qmk_firmware/pull/25173))
|
|
||||||
* Implement connection keycode logic ([#25176](https://github.com/qmk/qmk_firmware/pull/25176))
|
|
||||||
* Align ChibiOS `USB_WAIT_FOR_ENUMERATION` implementation ([#25184](https://github.com/qmk/qmk_firmware/pull/25184))
|
|
||||||
* Enable community modules to define LED matrix and RGB matrix effects. ([#25187](https://github.com/qmk/qmk_firmware/pull/25187))
|
|
||||||
* Bind Bluetooth driver to `host_driver_t` ([#25199](https://github.com/qmk/qmk_firmware/pull/25199))
|
|
||||||
* Enhance Flow Tap to work better for rolls over multiple tap-hold keys. ([#25200](https://github.com/qmk/qmk_firmware/pull/25200))
|
|
||||||
* Remove force disable of NKRO when Bluetooth enabled ([#25201](https://github.com/qmk/qmk_firmware/pull/25201))
|
|
||||||
* [New Feature/Core] New RGB Matrix Animation "Starlight Smooth" ([#25203](https://github.com/qmk/qmk_firmware/pull/25203))
|
|
||||||
* Add battery changed callbacks ([#25207](https://github.com/qmk/qmk_firmware/pull/25207))
|
|
||||||
* Generate versions to keycode headers ([#25219](https://github.com/qmk/qmk_firmware/pull/25219))
|
|
||||||
* Add raw_hid support to host driver ([#25255](https://github.com/qmk/qmk_firmware/pull/25255))
|
|
||||||
* Deprecate `usb.force_nkro`/`FORCE_NKRO` ([#25262](https://github.com/qmk/qmk_firmware/pull/25262))
|
|
||||||
* [Chore] use {rgblight,rgb_matrix}_hsv_to_rgb overrides ([#25271](https://github.com/qmk/qmk_firmware/pull/25271))
|
|
||||||
* Remove outdated `nix` support due to bit-rot. ([#25280](https://github.com/qmk/qmk_firmware/pull/25280))
|
|
||||||
|
|
||||||
CLI:
|
|
||||||
* Align to latest CLI dependencies ([#24553](https://github.com/qmk/qmk_firmware/pull/24553))
|
|
||||||
* Exclude external userspace from lint checking ([#24680](https://github.com/qmk/qmk_firmware/pull/24680))
|
|
||||||
* [Modules] Provide access to current path in `rules.mk`. ([#25061](https://github.com/qmk/qmk_firmware/pull/25061))
|
|
||||||
* Add "license" field to Community Module JSON schema. ([#25085](https://github.com/qmk/qmk_firmware/pull/25085))
|
|
||||||
* Prompt for converter when creating new keymap ([#25116](https://github.com/qmk/qmk_firmware/pull/25116))
|
|
||||||
* Extend lint checks to reject duplication of defaults ([#25149](https://github.com/qmk/qmk_firmware/pull/25149))
|
|
||||||
* Add lint warning for empty url ([#25182](https://github.com/qmk/qmk_firmware/pull/25182))
|
|
||||||
* Deprecate `qmk generate-compilation-database`. ([#25237](https://github.com/qmk/qmk_firmware/pull/25237))
|
|
||||||
* Use relative paths for schemas, instead of $id. Enables VScode validation. ([#25251](https://github.com/qmk/qmk_firmware/pull/25251))
|
|
||||||
|
|
||||||
Submodule updates:
|
|
||||||
* STM32G0x1 support ([#24301](https://github.com/qmk/qmk_firmware/pull/24301))
|
|
||||||
* Update develop branch to Pico SDK 1.5.1 ([#25178](https://github.com/qmk/qmk_firmware/pull/25178))
|
|
||||||
* Add `compiler_support.h` ([#25274](https://github.com/qmk/qmk_firmware/pull/25274))
|
|
||||||
|
|
||||||
Keyboards:
|
|
||||||
* add 75_(ansi|iso) Community Layouts to mechlovin/olly/octagon ([#22459](https://github.com/qmk/qmk_firmware/pull/22459))
|
|
||||||
* Add the plywrks ply8x hotswap variant. ([#23558](https://github.com/qmk/qmk_firmware/pull/23558))
|
|
||||||
* Add Community Layout support to daskeyboard4 ([#23884](https://github.com/qmk/qmk_firmware/pull/23884))
|
|
||||||
* New standard layout for Savage65 (65_ansi_blocker_tsangan_split_bs) ([#24690](https://github.com/qmk/qmk_firmware/pull/24690))
|
|
||||||
* Add Icebreaker keyboard ([#24723](https://github.com/qmk/qmk_firmware/pull/24723))
|
|
||||||
* Update Tractyl Manuform and add F405 (weact) variant ([#24764](https://github.com/qmk/qmk_firmware/pull/24764))
|
|
||||||
* Chew folders ([#24785](https://github.com/qmk/qmk_firmware/pull/24785))
|
|
||||||
* modelh: add prerequisites for via support ([#24932](https://github.com/qmk/qmk_firmware/pull/24932))
|
|
||||||
* Only configure `STM32_HSECLK` within `board.h` ([#25001](https://github.com/qmk/qmk_firmware/pull/25001))
|
|
||||||
* Allow LVGL onekey keymap to be able compile for other board ([#25005](https://github.com/qmk/qmk_firmware/pull/25005))
|
|
||||||
* Remove Sofle `rgb_default` keymap & tidy readme's ([#25010](https://github.com/qmk/qmk_firmware/pull/25010))
|
|
||||||
* Migrate remaining `split.soft_serial_pin` to `split.serial.pin` ([#25046](https://github.com/qmk/qmk_firmware/pull/25046))
|
|
||||||
* Update keymap for keycult 1800 ([#25070](https://github.com/qmk/qmk_firmware/pull/25070))
|
|
||||||
* Add kt60HS-T v2 PCB ([#25080](https://github.com/qmk/qmk_firmware/pull/25080))
|
|
||||||
* Refactor Deemen17 Works DE60 ([#25088](https://github.com/qmk/qmk_firmware/pull/25088))
|
|
||||||
* Rookiebwoy to ivndbt ([#25142](https://github.com/qmk/qmk_firmware/pull/25142))
|
|
||||||
* Remove duplication of RGB Matrix defaults ([#25146](https://github.com/qmk/qmk_firmware/pull/25146))
|
|
||||||
* ymdk/id75/rp2040 ([#25157](https://github.com/qmk/qmk_firmware/pull/25157))
|
|
||||||
* Remove duplication of RGBLight defaults ([#25169](https://github.com/qmk/qmk_firmware/pull/25169))
|
|
||||||
* Remove empty `url` fields ([#25181](https://github.com/qmk/qmk_firmware/pull/25181))
|
|
||||||
* Remove more duplication of defaults ([#25189](https://github.com/qmk/qmk_firmware/pull/25189))
|
|
||||||
* Remove `"console":false` from keyboards ([#25190](https://github.com/qmk/qmk_firmware/pull/25190))
|
|
||||||
* Remove `"command":false` from keyboards ([#25193](https://github.com/qmk/qmk_firmware/pull/25193))
|
|
||||||
* Remove redundant keyboard headers ([#25208](https://github.com/qmk/qmk_firmware/pull/25208))
|
|
||||||
* Add debounce to duplicated defaults check ([#25246](https://github.com/qmk/qmk_firmware/pull/25246))
|
|
||||||
* Remove duplicate of SPI default config from keyboards ([#25266](https://github.com/qmk/qmk_firmware/pull/25266))
|
|
||||||
* Resolve miscellaneous keyboard lint warnings ([#25268](https://github.com/qmk/qmk_firmware/pull/25268))
|
|
||||||
* Configure boards to use development_board - 0-9 ([#25287](https://github.com/qmk/qmk_firmware/pull/25287))
|
|
||||||
* Configure boards to use development_board - UVWXYZ ([#25288](https://github.com/qmk/qmk_firmware/pull/25288))
|
|
||||||
* Configure boards to use development_board - S ([#25293](https://github.com/qmk/qmk_firmware/pull/25293))
|
|
||||||
* Configure boards to use development_board - T ([#25294](https://github.com/qmk/qmk_firmware/pull/25294))
|
|
||||||
|
|
||||||
Keyboard fixes:
|
|
||||||
* Fix `boardsource/beiwagon` RGB Matrix coordinates ([#25018](https://github.com/qmk/qmk_firmware/pull/25018))
|
|
||||||
* amptrics/0422 - Prevent OOB in `update_leds_for_layer` ([#25209](https://github.com/qmk/qmk_firmware/pull/25209))
|
|
||||||
* salicylic_acid3/getta25 - Fix oled keymap ([#25295](https://github.com/qmk/qmk_firmware/pull/25295))
|
|
||||||
|
|
||||||
Others:
|
|
||||||
* Require 'x'/'y' properties for LED/RGB Matrix layout ([#24997](https://github.com/qmk/qmk_firmware/pull/24997))
|
|
||||||
* Align `new-keyboard` template to current standards ([#25191](https://github.com/qmk/qmk_firmware/pull/25191))
|
|
||||||
|
|
||||||
Bugs:
|
|
||||||
* Fix OS_DETECTION_KEYBOARD_RESET ([#25015](https://github.com/qmk/qmk_firmware/pull/25015))
|
|
||||||
* Fix outdated GPIO control function usage ([#25060](https://github.com/qmk/qmk_firmware/pull/25060))
|
|
||||||
* Cater for use of `__errno_r()` in ChibiOS syscalls.c with newer picolibc revisions ([#25121](https://github.com/qmk/qmk_firmware/pull/25121))
|
|
||||||
* Fixup eeconfig lighting reset. ([#25166](https://github.com/qmk/qmk_firmware/pull/25166))
|
|
||||||
* Fix for Flow Tap: fix handling of distinct taps and timer updates. ([#25175](https://github.com/qmk/qmk_firmware/pull/25175))
|
|
||||||
* Minimise force-included files ([#25194](https://github.com/qmk/qmk_firmware/pull/25194))
|
|
||||||
* Ensure `qmk_userspace_paths` maintains detected order ([#25204](https://github.com/qmk/qmk_firmware/pull/25204))
|
|
||||||
* Resolve alias for `qmk new-keymap` keyboard prompts ([#25210](https://github.com/qmk/qmk_firmware/pull/25210))
|
|
||||||
* gcc15 AVR compilation fixes ([#25238](https://github.com/qmk/qmk_firmware/pull/25238))
|
|
||||||
* Fix typos introduced by PR #25050 ([#25250](https://github.com/qmk/qmk_firmware/pull/25250))
|
|
||||||
* Fix Wear Leveling compilation ([#25254](https://github.com/qmk/qmk_firmware/pull/25254))
|
|
||||||
* Remove more USB only branches from NKRO handling ([#25263](https://github.com/qmk/qmk_firmware/pull/25263))
|
|
||||||
* [Fix] lib8tion: enable fixed scale8 and blend functions ([#25272](https://github.com/qmk/qmk_firmware/pull/25272))
|
|
||||||
* Fix tap_hold code blocks ([#25298](https://github.com/qmk/qmk_firmware/pull/25298))
|
|
@ -21,8 +21,7 @@
|
|||||||
{ "text": "Debugging QMK", "link": "/faq_debug" },
|
{ "text": "Debugging QMK", "link": "/faq_debug" },
|
||||||
{ "text": "Keymap FAQ", "link": "/faq_keymap" },
|
{ "text": "Keymap FAQ", "link": "/faq_keymap" },
|
||||||
{ "text": "Squeezing Space from AVR", "link": "/squeezing_avr" },
|
{ "text": "Squeezing Space from AVR", "link": "/squeezing_avr" },
|
||||||
{ "text": "Glossary", "link": "/reference_glossary" },
|
{ "text": "Glossary", "link": "/reference_glossary" }
|
||||||
{ "text": "License Violations", "link": "/license_violations" }
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -60,7 +59,6 @@
|
|||||||
"items": [
|
"items": [
|
||||||
{ "text": "Customizing Functionality", "link": "/custom_quantum_functions" },
|
{ "text": "Customizing Functionality", "link": "/custom_quantum_functions" },
|
||||||
{ "text": "Driver Installation with Zadig", "link": "/driver_installation_zadig" },
|
{ "text": "Driver Installation with Zadig", "link": "/driver_installation_zadig" },
|
||||||
{ "text": "Community Modules", "link": "/features/community_modules" },
|
|
||||||
{ "text": "Keymap Overview", "link": "/keymap" },
|
{ "text": "Keymap Overview", "link": "/keymap" },
|
||||||
{
|
{
|
||||||
"text": "Development Environments",
|
"text": "Development Environments",
|
||||||
@ -207,7 +205,7 @@
|
|||||||
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
|
{ "text": "My Pull Request Was Flagged", "link": "/breaking_changes_instructions" },
|
||||||
{
|
{
|
||||||
"text": "Most Recent ChangeLog",
|
"text": "Most Recent ChangeLog",
|
||||||
"link": "/ChangeLog/20250525"
|
"link": "/ChangeLog/20241124"
|
||||||
},
|
},
|
||||||
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
|
{ "text": "Past Breaking Changes", "link": "/breaking_changes_history" },
|
||||||
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }
|
{ "text": "Deprecation Policy", "link": "/support_deprecation_policy" }
|
||||||
@ -227,7 +225,6 @@
|
|||||||
{ "text": "ADC Driver", "link": "/drivers/adc" },
|
{ "text": "ADC Driver", "link": "/drivers/adc" },
|
||||||
{ "text": "APA102 Driver", "link": "/drivers/apa102" },
|
{ "text": "APA102 Driver", "link": "/drivers/apa102" },
|
||||||
{ "text": "Audio Driver", "link": "/drivers/audio" },
|
{ "text": "Audio Driver", "link": "/drivers/audio" },
|
||||||
{ "text": "Battery Driver", "link": "/drivers/battery" },
|
|
||||||
{ "text": "EEPROM Driver", "link": "/drivers/eeprom" },
|
{ "text": "EEPROM Driver", "link": "/drivers/eeprom" },
|
||||||
{ "text": "Flash Driver", "link": "/drivers/flash" },
|
{ "text": "Flash Driver", "link": "/drivers/flash" },
|
||||||
{ "text": "I2C Driver", "link": "/drivers/i2c" },
|
{ "text": "I2C Driver", "link": "/drivers/i2c" },
|
||||||
|
@ -10,25 +10,25 @@ Practically, this means QMK merges the `develop` branch into the `master` branch
|
|||||||
|
|
||||||
## What has been included in past Breaking Changes?
|
## What has been included in past Breaking Changes?
|
||||||
|
|
||||||
* [2025 May 25](ChangeLog/20250525)
|
|
||||||
* [2025 Feb 23](ChangeLog/20250223)
|
|
||||||
* [2024 Nov 24](ChangeLog/20241124)
|
* [2024 Nov 24](ChangeLog/20241124)
|
||||||
|
* [2024 Aug 25](ChangeLog/20240825)
|
||||||
|
* [2024 May 26](ChangeLog/20240526)
|
||||||
* [Older Breaking Changes](breaking_changes_history)
|
* [Older Breaking Changes](breaking_changes_history)
|
||||||
|
|
||||||
## When is the next Breaking Change?
|
## When is the next Breaking Change?
|
||||||
|
|
||||||
The next Breaking Change is scheduled for Aug 31, 2025.
|
The next Breaking Change is scheduled for February 23, 2025.
|
||||||
|
|
||||||
### Important Dates
|
### Important Dates
|
||||||
|
|
||||||
* 2025 May 25 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
|
* 2024 Nov 24 - `develop` is tagged with a new release version. Each push to `master` is subsequently merged to `develop` by GitHub actions.
|
||||||
* 2025 Aug 3 - `develop` closed to new PRs.
|
* 2025 Jan 26 - `develop` closed to new PRs.
|
||||||
* 2025 Aug 3 - Call for testers.
|
* 2025 Jan 26 - Call for testers.
|
||||||
* 2025 Aug 17 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
|
* 2025 Feb 9 - Last day for merges -- after this point `develop` is locked for testing and accepts only bugfixes
|
||||||
* 2025 Aug 24 - `develop` is locked, only critical bugfix PRs merged.
|
* 2025 Feb 16 - `develop` is locked, only critical bugfix PRs merged.
|
||||||
* 2025 Aug 29 - `master` is locked, no PRs merged.
|
* 2024 Nov 21 - `master` is locked, no PRs merged.
|
||||||
* 2025 Aug 31 - Merge `develop` to `master`.
|
* 2025 Feb 23 - Merge `develop` to `master`.
|
||||||
* 2025 Aug 31 - `master` is unlocked. PRs can be merged again.
|
* 2025 Feb 23 - `master` is unlocked. PRs can be merged again.
|
||||||
|
|
||||||
## What changes will be included?
|
## What changes will be included?
|
||||||
|
|
||||||
|
@ -2,8 +2,6 @@
|
|||||||
|
|
||||||
This page links to all previous changelogs from the QMK Breaking Changes process.
|
This page links to all previous changelogs from the QMK Breaking Changes process.
|
||||||
|
|
||||||
* [2025 May 25](ChangeLog/20250525) - version 0.29.0
|
|
||||||
* [2025 Feb 23](ChangeLog/20250223) - version 0.28.0
|
|
||||||
* [2024 Nov 24](ChangeLog/20241124) - version 0.27.0
|
* [2024 Nov 24](ChangeLog/20241124) - version 0.27.0
|
||||||
* [2024 Aug 25](ChangeLog/20240825) - version 0.26.0
|
* [2024 Aug 25](ChangeLog/20240825) - version 0.26.0
|
||||||
* [2024 May 26](ChangeLog/20240526) - version 0.25.0
|
* [2024 May 26](ChangeLog/20240526) - version 0.25.0
|
||||||
|
16
docs/cli.md
16
docs/cli.md
@ -6,7 +6,7 @@ The QMK CLI (command line interface) makes building and working with QMK keyboar
|
|||||||
|
|
||||||
### Requirements {#requirements}
|
### Requirements {#requirements}
|
||||||
|
|
||||||
QMK requires Python 3.9 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI.
|
QMK requires Python 3.7 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI.
|
||||||
|
|
||||||
### Install Using Homebrew (macOS, some Linux) {#install-using-homebrew}
|
### Install Using Homebrew (macOS, some Linux) {#install-using-homebrew}
|
||||||
|
|
||||||
@ -18,21 +18,9 @@ export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
|
|||||||
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
|
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install Using uv {#install-using-uv}
|
|
||||||
|
|
||||||
If you have installed [uv](https://docs.astral.sh/uv/), the QMK CLI can be installed and managed as a uv tool:
|
|
||||||
|
|
||||||
```
|
|
||||||
uv tool install qmk
|
|
||||||
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
|
|
||||||
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
|
|
||||||
```
|
|
||||||
|
|
||||||
This installation can be updated via `uv tool upgrade qmk`. See [Upgrading tools](https://docs.astral.sh/uv/guides/tools/#upgrading-tools) for more information.
|
|
||||||
|
|
||||||
### Install Using pip {#install-using-easy_install-or-pip}
|
### Install Using pip {#install-using-easy_install-or-pip}
|
||||||
|
|
||||||
If your system is not listed above you can install QMK manually. First ensure that you have Python 3.9 (or later) installed and have installed pip. Then install QMK with this command:
|
If your system is not listed above you can install QMK manually. First ensure that you have Python 3.7 (or later) installed and have installed pip. Then install QMK with this command:
|
||||||
|
|
||||||
```
|
```
|
||||||
python3 -m pip install qmk
|
python3 -m pip install qmk
|
||||||
|
@ -17,12 +17,12 @@ qmk compile [-c] <configuratorExport.json>
|
|||||||
**Usage for Keymaps**:
|
**Usage for Keymaps**:
|
||||||
|
|
||||||
```
|
```
|
||||||
qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard> -km <keymap>
|
qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Usage in Keyboard Directory**:
|
**Usage in Keyboard Directory**:
|
||||||
|
|
||||||
Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap>`
|
Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap_name>`
|
||||||
```
|
```
|
||||||
qmk compile
|
qmk compile
|
||||||
```
|
```
|
||||||
@ -30,7 +30,7 @@ qmk compile
|
|||||||
**Usage for building all keyboards that support a specific keymap**:
|
**Usage for building all keyboards that support a specific keymap**:
|
||||||
|
|
||||||
```
|
```
|
||||||
qmk compile -kb all -km <keymap>
|
qmk compile -kb all -km <keymap_name>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Example**:
|
**Example**:
|
||||||
@ -62,7 +62,7 @@ $ qmk compile
|
|||||||
|
|
||||||
Must be under `qmk_firmware/layouts/`, and in a keymap folder.
|
Must be under `qmk_firmware/layouts/`, and in a keymap folder.
|
||||||
```
|
```
|
||||||
qmk compile -kb <keyboard>
|
qmk compile -kb <keyboard_name>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Example**:
|
**Example**:
|
||||||
@ -77,30 +77,11 @@ $ qmk compile -kb dz60
|
|||||||
|
|
||||||
It is possible to speed up compilation by adding the `-j`/`--parallel` flag.
|
It is possible to speed up compilation by adding the `-j`/`--parallel` flag.
|
||||||
```
|
```
|
||||||
qmk compile -j <num_jobs> -kb <keyboard>
|
qmk compile -j <num_jobs> -kb <keyboard_name>
|
||||||
```
|
```
|
||||||
The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs.
|
The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs.
|
||||||
```
|
```
|
||||||
qmk compile -j 0 -kb <keyboard>
|
qmk compile -j 0 -kb <keyboard_name>
|
||||||
```
|
|
||||||
|
|
||||||
**Compilation Database**:
|
|
||||||
|
|
||||||
Creates a `compile_commands.json` file.
|
|
||||||
|
|
||||||
Does your IDE/editor use a language server but doesn't _quite_ find all the necessary include files? Do you hate red squigglies? Do you wish your editor could figure out `#include QMK_KEYBOARD_H`? You might need a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)! Compiling using this argument can create this for you.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
|
|
||||||
$ qmk compile --compiledb
|
|
||||||
Ψ Making clean
|
|
||||||
Ψ Gathering build instructions from make ........
|
|
||||||
Ψ Found 63 compile commands
|
|
||||||
Ψ Writing build database to /Users/you/src/qmk_firmware/compile_commands.json
|
|
||||||
Ψ Compiling keymap with make ........
|
|
||||||
... build log continues ...
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## `qmk flash`
|
## `qmk flash`
|
||||||
@ -120,7 +101,7 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat
|
|||||||
**Usage for Keymaps**:
|
**Usage for Keymaps**:
|
||||||
|
|
||||||
```
|
```
|
||||||
qmk flash -kb <keyboard> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
|
qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
|
||||||
```
|
```
|
||||||
|
|
||||||
**Usage for pre-compiled firmwares**:
|
**Usage for pre-compiled firmwares**:
|
||||||
@ -713,28 +694,52 @@ qmk format-c
|
|||||||
qmk format-c -b branch_name
|
qmk format-c -b branch_name
|
||||||
```
|
```
|
||||||
|
|
||||||
## `qmk docs`
|
## `qmk generate-compilation-database`
|
||||||
|
|
||||||
This command starts a local HTTP server which you can use for browsing or improving the docs, and provides live reload capability whilst editing. Default port is 8936.
|
|
||||||
Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
|
|
||||||
|
|
||||||
Requires `node` and `yarn` to be installed as prerequisites.
|
|
||||||
|
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
```
|
```
|
||||||
usage: qmk docs [-h] [-b] [-p PORT]
|
qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]
|
||||||
|
```
|
||||||
|
|
||||||
|
Creates a `compile_commands.json` file.
|
||||||
|
|
||||||
|
Does your IDE/editor use a language server but doesn't _quite_ find all the necessary include files? Do you hate red squigglies? Do you wish your editor could figure out `#include QMK_KEYBOARD_H`? You might need a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)! The qmk tool can build this for you.
|
||||||
|
|
||||||
|
This command needs to know which keyboard and keymap to build. It uses the same configuration options as the `qmk compile` command: arguments, current directory, and config files.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
|
||||||
|
$ qmk generate-compilation-database
|
||||||
|
Ψ Making clean
|
||||||
|
Ψ Gathering build instructions from make -n gh60/satan:colemak
|
||||||
|
Ψ Found 50 compile commands
|
||||||
|
Ψ Writing build database to /Users/you/src/qmk_firmware/compile_commands.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Now open your dev environment and live a squiggly-free life.
|
||||||
|
|
||||||
|
## `qmk docs`
|
||||||
|
|
||||||
|
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 5173.
|
||||||
|
|
||||||
|
This command requires `node` and `yarn` to be installed as prerequisites, and provides live reload capability whilst editing.
|
||||||
|
|
||||||
|
**Usage**:
|
||||||
|
|
||||||
|
```
|
||||||
|
usage: qmk docs [-h]
|
||||||
|
|
||||||
options:
|
options:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-b, --browser Open the docs in the default browser.
|
|
||||||
-p, --port PORT Port number to use.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## `qmk generate-docs`
|
## `qmk generate-docs`
|
||||||
|
|
||||||
This command generates QMK documentation for production.
|
This command allows you to generate QMK documentation locally. It can be uses for general browsing or improving the docs.
|
||||||
Use the `-s`/`--serve` flag to also serve the static site on port 4173 once built. Note that this does not provide live reloading; use `qmk docs` instead for development purposes.
|
Use the `-s`/`--serve` flag to also serve the static site once built. Default port is 4173.
|
||||||
|
|
||||||
This command requires `node` and `yarn` to be installed as prerequisites, and requires the operating system to support symlinks.
|
This command requires `node` and `yarn` to be installed as prerequisites, and requires the operating system to support symlinks.
|
||||||
|
|
||||||
@ -877,13 +882,3 @@ Run single test:
|
|||||||
```
|
```
|
||||||
qmk test-c --test basic
|
qmk test-c --test basic
|
||||||
```
|
```
|
||||||
|
|
||||||
## `qmk generate-compilation-database`
|
|
||||||
|
|
||||||
**Usage**:
|
|
||||||
|
|
||||||
```
|
|
||||||
qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]
|
|
||||||
```
|
|
||||||
|
|
||||||
This command has been deprecated as it cannot take into account configurables such as [converters](/feature_converters) or environment variables normally specified on the command line; please use the `--compiledb` flag with `qmk compile` instead.
|
|
||||||
|
@ -44,7 +44,7 @@ def hello(cli):
|
|||||||
|
|
||||||
First we import the `cli` object from `milc`. This is how we interact with the user and control the script's behavior. We use `@cli.argument()` to define a command line flag, `--name`. This also creates a configuration variable named `hello.name` (and the corresponding `user.name`) which the user can set so they don't have to specify the argument. The `cli.subcommand()` decorator designates this function as a subcommand. The name of the subcommand will be taken from the name of the function.
|
First we import the `cli` object from `milc`. This is how we interact with the user and control the script's behavior. We use `@cli.argument()` to define a command line flag, `--name`. This also creates a configuration variable named `hello.name` (and the corresponding `user.name`) which the user can set so they don't have to specify the argument. The `cli.subcommand()` decorator designates this function as a subcommand. The name of the subcommand will be taken from the name of the function.
|
||||||
|
|
||||||
Once inside our function we find a typical "Hello, World!" program. We use `cli.log` to access the underlying [Logger Object](https://docs.python.org/3.9/library/logging.html#logger-objects), whose behavior is user controllable. We also access the value for name supplied by the user as `cli.config.hello.name`. The value for `cli.config.hello.name` will be determined by looking at the `--name` argument supplied by the user, if not provided it will use the value in the `qmk.ini` config file, and if neither of those is provided it will fall back to the default supplied in the `cli.argument()` decorator.
|
Once inside our function we find a typical "Hello, World!" program. We use `cli.log` to access the underlying [Logger Object](https://docs.python.org/3.7/library/logging.html#logger-objects), whose behavior is user controllable. We also access the value for name supplied by the user as `cli.config.hello.name`. The value for `cli.config.hello.name` will be determined by looking at the `--name` argument supplied by the user, if not provided it will use the value in the `qmk.ini` config file, and if neither of those is provided it will fall back to the default supplied in the `cli.argument()` decorator.
|
||||||
|
|
||||||
# User Interaction
|
# User Interaction
|
||||||
|
|
||||||
@ -56,13 +56,13 @@ There are two main methods for outputting text in a subcommand- `cli.log` and `c
|
|||||||
|
|
||||||
You can use special tokens to colorize your text, to make it easier to understand the output of your program. See [Colorizing Text](#colorizing-text) below.
|
You can use special tokens to colorize your text, to make it easier to understand the output of your program. See [Colorizing Text](#colorizing-text) below.
|
||||||
|
|
||||||
Both of these methods support built-in string formatting using python's [printf style string format operations](https://docs.python.org/3.9/library/stdtypes.html#old-string-formatting). You can use tokens such as `%s` and `%d` within your text strings then pass the values as arguments. See our Hello, World program above for an example.
|
Both of these methods support built-in string formatting using python's [printf style string format operations](https://docs.python.org/3.7/library/stdtypes.html#old-string-formatting). You can use tokens such as `%s` and `%d` within your text strings then pass the values as arguments. See our Hello, World program above for an example.
|
||||||
|
|
||||||
You should never use the format operator (`%`) directly, always pass values as arguments.
|
You should never use the format operator (`%`) directly, always pass values as arguments.
|
||||||
|
|
||||||
### Logging (`cli.log`)
|
### Logging (`cli.log`)
|
||||||
|
|
||||||
The `cli.log` object gives you access to a [Logger Object](https://docs.python.org/3.9/library/logging.html#logger-objects). We have configured our log output to show the user a nice emoji for each log level (or the log level name if their terminal does not support unicode.) This way the user can tell at a glance which messages are most important when something goes wrong.
|
The `cli.log` object gives you access to a [Logger Object](https://docs.python.org/3.7/library/logging.html#logger-objects). We have configured our log output to show the user a nice emoji for each log level (or the log level name if their terminal does not support unicode.) This way the user can tell at a glance which messages are most important when something goes wrong.
|
||||||
|
|
||||||
The default log level is `INFO`. If the user runs `qmk -v <subcommand>` the default log level will be set to `DEBUG`.
|
The default log level is `INFO`. If the user runs `qmk -v <subcommand>` the default log level will be set to `DEBUG`.
|
||||||
|
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Most of our style follows PEP8 with some local modifications to make things less nit-picky.
|
Most of our style follows PEP8 with some local modifications to make things less nit-picky.
|
||||||
|
|
||||||
* We target Python 3.9 for compatibility with all supported platforms.
|
* We target Python 3.7 for compatibility with all supported platforms.
|
||||||
* We indent using four (4) spaces (soft tabs)
|
* We indent using four (4) spaces (soft tabs)
|
||||||
* We encourage liberal use of comments
|
* We encourage liberal use of comments
|
||||||
* Think of them as a story describing the feature
|
* Think of them as a story describing the feature
|
||||||
@ -317,7 +317,7 @@ At the time of this writing our tests are not very comprehensive. Looking at the
|
|||||||
|
|
||||||
## Integration Tests
|
## Integration Tests
|
||||||
|
|
||||||
Integration tests can be found in `lib/python/qmk/tests/test_cli_commands.py`. This is where CLI commands are actually run and their overall behavior is verified. We use [`subprocess`](https://docs.python.org/3.9/library/subprocess.html#module-subprocess) to launch each CLI command and a combination of checking output and returncode to determine if the right thing happened.
|
Integration tests can be found in `lib/python/qmk/tests/test_cli_commands.py`. This is where CLI commands are actually run and their overall behavior is verified. We use [`subprocess`](https://docs.python.org/3.7/library/subprocess.html#module-subprocess) to launch each CLI command and a combination of checking output and returncode to determine if the right thing happened.
|
||||||
|
|
||||||
## Unit Tests
|
## Unit Tests
|
||||||
|
|
||||||
|
@ -140,6 +140,8 @@ If you define these options you will enable the associated feature, which may in
|
|||||||
|
|
||||||
* `#define ENABLE_COMPILE_KEYCODE`
|
* `#define ENABLE_COMPILE_KEYCODE`
|
||||||
* Enables the `QK_MAKE` keycode
|
* Enables the `QK_MAKE` keycode
|
||||||
|
* `#define FORCE_NKRO`
|
||||||
|
* NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
|
||||||
* `#define STRICT_LAYER_RELEASE`
|
* `#define STRICT_LAYER_RELEASE`
|
||||||
* force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
|
* force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
|
||||||
|
|
||||||
@ -399,7 +401,6 @@ This is a [make](https://www.gnu.org/software/make/manual/make.html) file that i
|
|||||||
* `atmel-dfu`
|
* `atmel-dfu`
|
||||||
* `lufa-dfu`
|
* `lufa-dfu`
|
||||||
* `qmk-dfu`
|
* `qmk-dfu`
|
||||||
* `qmk-hid`
|
|
||||||
* `halfkay`
|
* `halfkay`
|
||||||
* `caterina`
|
* `caterina`
|
||||||
* `bootloadhid`
|
* `bootloadhid`
|
||||||
|
@ -54,7 +54,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
|||||||
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
|
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
|
||||||
|
|
||||||
[1] = LAYOUT_all(
|
[1] = LAYOUT_all(
|
||||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, UG_TOGG, UG_NEXT, UG_HUED, UG_HUEU, UG_SATD, UG_SATU, UG_VALD, UG_VALU, BL_TOGG, BL_DOWN, BL_UP,
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI, BL_TOGG, BL_DOWN, BL_UP,
|
||||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_VOLU,
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_VOLU,
|
||||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, QK_BOOT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY, KC_MNXT, KC_VOLD,
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, QK_BOOT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY, KC_MNXT, KC_VOLD,
|
||||||
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
|
||||||
@ -82,7 +82,7 @@ The default keymap uses the `LAYOUT_all` macro, so that will be the value of the
|
|||||||
"KC_LCTL", "KC_LGUI", "KC_LALT", "KC_SPC", "KC_RALT", "MO(1)", "KC_RGUI", "KC_RCTL", "KC_LEFT", "KC_DOWN", "KC_RGHT"
|
"KC_LCTL", "KC_LGUI", "KC_LALT", "KC_SPC", "KC_RALT", "MO(1)", "KC_RGUI", "KC_RCTL", "KC_LEFT", "KC_DOWN", "KC_RGHT"
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "UG_TOGG", "UG_NEXT", "UG_HUED", "UG_HUEU", "UG_SATD", "UG_SATU", "UG_VALD", "UG_VALU", "BL_TOGG", "BL_DOWN", "BL_UP",
|
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "RGB_TOG", "RGB_MOD", "RGB_HUD", "RGB_HUI", "RGB_SAD", "RGB_SAI", "RGB_VAD", "RGB_VAI", "BL_TOGG", "BL_DOWN", "BL_UP",
|
||||||
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_VOLU",
|
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_VOLU",
|
||||||
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "QK_BOOT", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_MPLY", "KC_MNXT", "KC_VOLD",
|
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "QK_BOOT", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_MPLY", "KC_MNXT", "KC_VOLD",
|
||||||
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",
|
"KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS",
|
||||||
|
@ -106,10 +106,10 @@ enum my_keycodes {
|
|||||||
Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
|
Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
|
||||||
|
|
||||||
```
|
```
|
||||||
qmk docs -b
|
qmk docs
|
||||||
```
|
```
|
||||||
|
|
||||||
Which should automatically open your browser; otherwise, navigate to `http://localhost:8936/`.
|
and navigating to `http://localhost:5173/`.
|
||||||
|
|
||||||
## Keyboards
|
## Keyboards
|
||||||
|
|
||||||
|
@ -9,19 +9,12 @@ This page does not assume any special knowledge about QMK, but reading [Understa
|
|||||||
We have structured QMK as a hierarchy:
|
We have structured QMK as a hierarchy:
|
||||||
|
|
||||||
* Core (`_quantum`)
|
* Core (`_quantum`)
|
||||||
* Community Module (`_<module>`)
|
|
||||||
* Community Module -> Keyboard/Revision (`_<module>_kb`)
|
|
||||||
* Community Module -> Keymap (`_<module>_user`)
|
|
||||||
* Keyboard/Revision (`_kb`)
|
* Keyboard/Revision (`_kb`)
|
||||||
* Keymap (`_user`)
|
* Keymap (`_user`)
|
||||||
|
|
||||||
Each of the functions described below can be defined with a `_kb()` suffix or a `_user()` suffix. We intend for you to use the `_kb()` suffix at the Keyboard/Revision level, while the `_user()` suffix should be used at the Keymap level.
|
Each of the functions described below can be defined with a `_kb()` suffix or a `_user()` suffix. We intend for you to use the `_kb()` suffix at the Keyboard/Revision level, while the `_user()` suffix should be used at the Keymap level.
|
||||||
|
|
||||||
When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` at an appropriate location, otherwise the keymap level function will never be called.
|
When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called.
|
||||||
|
|
||||||
Functions at the `_<module>_xxx()` level are intended to allow keyboards or keymaps to override or enhance the processing associated with a [community module](/features/community_modules).
|
|
||||||
|
|
||||||
When defining module overrides such as `process_record_<module>()`, the same pattern should be used; the module must invoke `process_record_<module>_kb()` as appropriate.
|
|
||||||
|
|
||||||
# Custom Keycodes
|
# Custom Keycodes
|
||||||
|
|
||||||
@ -106,7 +99,7 @@ These are the three main initialization functions, listed in the order that they
|
|||||||
* `keyboard_post_init_*` - Happens at the end of the firmware's startup process. This is where you'd want to put "customization" code, for the most part.
|
* `keyboard_post_init_*` - Happens at the end of the firmware's startup process. This is where you'd want to put "customization" code, for the most part.
|
||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
For most people, the `keyboard_post_init_user` function is what you want to implement. For instance, this is where you want to set up things for RGB Underglow.
|
For most people, the `keyboard_post_init_user` function is what you want to call. For instance, this is where you want to set up things for RGB Underglow.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Keyboard Pre Initialization code
|
## Keyboard Pre Initialization code
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
SPI 18x12 LED matrix driver by Awinic. Supports a maximum of four drivers, each controlling up to 216 single-color LEDs, or 72 RGB LEDs.
|
SPI 18x12 LED matrix driver by Awinic. Supports a maximum of four drivers, each controlling up to 216 single-color LEDs, or 72 RGB LEDs.
|
||||||
|
|
||||||
[AW20216S Datasheet](https://doc.awinic.com/doc/202412/a055779b-49c0-4d09-8f04-73029f44b72b.pdf)
|
[AW20216S Datasheet](https://doc.awinic.com/doc/20230609wm/b6a9c70b-e1bd-495b-925f-bcbed3fc2620.pdf)
|
||||||
|
|
||||||
## Usage {#usage}
|
## Usage {#usage}
|
||||||
|
|
||||||
@ -44,7 +44,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {
|
const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {
|
||||||
|
@ -1,73 +0,0 @@
|
|||||||
# Battery Driver
|
|
||||||
|
|
||||||
This driver provides support for sampling battery level.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
To use this driver, add the following to your `rules.mk`:
|
|
||||||
|
|
||||||
```make
|
|
||||||
BATTERY_DRIVER_REQUIRED = yes
|
|
||||||
```
|
|
||||||
|
|
||||||
## Basic Configuration {#basic-configuration}
|
|
||||||
|
|
||||||
Add the following to your `config.h`:
|
|
||||||
|
|
||||||
|Define |Default |Description |
|
|
||||||
|--------------------------|--------|--------------------------------------------------|
|
|
||||||
|`BATTERY_SAMPLE_INTERVAL` |`30000` |The time between battery samples in milliseconds. |
|
|
||||||
|
|
||||||
## Driver Configuration {#driver-configuration}
|
|
||||||
|
|
||||||
Driver selection can be configured in `rules.mk` as `BATTERY_DRIVER`. Valid values are `adc` (default), `vendor`, or `custom`. See below for information on individual drivers.
|
|
||||||
|
|
||||||
### ADC Driver {#adc-driver}
|
|
||||||
|
|
||||||
This is the default battery driver. The default configuration assumes the battery is connected to a ADC capable pin through a voltage divider.
|
|
||||||
|
|
||||||
```make
|
|
||||||
BATTERY_DRIVER = adc
|
|
||||||
```
|
|
||||||
|
|
||||||
The following `#define`s apply only to the `adc` driver:
|
|
||||||
|
|
||||||
|Define |Default |Description |
|
|
||||||
|-----------------------------|--------------|--------------------------------------------------------------|
|
|
||||||
|`BATTERY_PIN` |*Not defined* |The GPIO pin connected to the voltage divider. |
|
|
||||||
|`BATTERY_REF_VOLTAGE_MV` |`3300` |The ADC reverence voltage, in millivolts. |
|
|
||||||
|`BATTERY_VOLTAGE_DIVIDER_R1` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
|
|
||||||
|`BATTERY_VOLTAGE_DIVIDER_R2` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
|
|
||||||
|`BATTERY_ADC_RESOLUTION` |`10` |The ADC resolution configured for the ADC Driver. |
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
### `uint8_t battery_get_percent(void)` {#api-battery-get-percent}
|
|
||||||
|
|
||||||
Sample battery level.
|
|
||||||
|
|
||||||
#### Return Value {#api-battery-get-percent-return}
|
|
||||||
|
|
||||||
The battery percentage, in the range 0-100.
|
|
||||||
|
|
||||||
## Callbacks
|
|
||||||
|
|
||||||
### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user}
|
|
||||||
|
|
||||||
User hook called when battery level changed.
|
|
||||||
|
|
||||||
### Arguments {#api-battery-percent-changed-user-arguments}
|
|
||||||
|
|
||||||
- `uint8_t level`
|
|
||||||
The battery percentage, in the range 0-100.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb}
|
|
||||||
|
|
||||||
Keyboard hook called when battery level changed.
|
|
||||||
|
|
||||||
### Arguments {#api-battery-percent-changed-kb-arguments}
|
|
||||||
|
|
||||||
- `uint8_t level`
|
|
||||||
The battery percentage, in the range 0-100.
|
|
@ -16,22 +16,17 @@ You can then call the I2C API by including `i2c_master.h` in your code.
|
|||||||
|
|
||||||
## I2C Addressing {#note-on-i2c-addresses}
|
## I2C Addressing {#note-on-i2c-addresses}
|
||||||
|
|
||||||
I2C addresses listed on datasheets and the internet are usually represented as a 7-bit value. The eighth bit (the least significant bit) controls whether the operation is a read or a write.
|
All of the addresses expected by this driver should be pushed to the upper 7 bits of the address byte. Setting
|
||||||
|
the lower bit (indicating read/write) will be done by the respective functions. Almost all I2C addresses listed
|
||||||
|
on datasheets and the internet will be represented as 7 bits occupying the lower 7 bits and will need to be
|
||||||
|
shifted to the left (more significant) by one bit. This is easy to do via the bitwise shift operator `<< 1`.
|
||||||
|
|
||||||
All of the address parameters expected by the driver API should therefore be pushed to the upper 7 bits of the address byte; the driver will take care of setting the read/write bit as appropriate.
|
You can either do this on each call to the functions below, or once in your definition of the address. For example, if your device has an address of `0x18`:
|
||||||
|
|
||||||
This is easy to do via the bitwise left shift operator. For example, if your device has an address of `0x18` you might create a define for convenience:
|
|
||||||
|
|
||||||
```c
|
```c
|
||||||
#define MY_I2C_ADDRESS (0x18 << 1)
|
#define MY_I2C_ADDRESS (0x18 << 1)
|
||||||
```
|
```
|
||||||
|
|
||||||
Or, you can shift the address ahead of time:
|
|
||||||
|
|
||||||
```c
|
|
||||||
#define MY_I2C_ADDRESS 0x30
|
|
||||||
```
|
|
||||||
|
|
||||||
See https://www.robot-electronics.co.uk/i2c-tutorial for more information about I2C addressing and other technical details.
|
See https://www.robot-electronics.co.uk/i2c-tutorial for more information about I2C addressing and other technical details.
|
||||||
|
|
||||||
## AVR Configuration {#avr-configuration}
|
## AVR Configuration {#avr-configuration}
|
||||||
@ -45,7 +40,7 @@ The following defines can be used to configure the I2C master driver:
|
|||||||
No further setup is required - just connect the `SDA` and `SCL` pins of your I2C devices to the matching pins on the MCU:
|
No further setup is required - just connect the `SDA` and `SCL` pins of your I2C devices to the matching pins on the MCU:
|
||||||
|
|
||||||
|MCU |`SCL`|`SDA`|
|
|MCU |`SCL`|`SDA`|
|
||||||
|-------------|-----|-----|
|
|------------------|-----|-----|
|
||||||
|ATmega16/32U4 |`D0` |`D1` |
|
|ATmega16/32U4 |`D0` |`D1` |
|
||||||
|AT90USB64/128 |`D0` |`D1` |
|
|AT90USB64/128 |`D0` |`D1` |
|
||||||
|ATmega32A |`C0` |`C1` |
|
|ATmega32A |`C0` |`C1` |
|
||||||
@ -57,7 +52,7 @@ The ATmega16/32U2 does not possess I2C functionality, and so cannot use this dri
|
|||||||
|
|
||||||
## ChibiOS/ARM Configuration {#arm-configuration}
|
## ChibiOS/ARM Configuration {#arm-configuration}
|
||||||
|
|
||||||
You'll need to determine which pins can be used for I2C -- as an example, STM32 parts generally have multiple I2C peripherals, labeled I2C1, I2C2, I2C3 etc.
|
You'll need to determine which pins can be used for I2C -- a an example, STM32 parts generally have multiple I2C peripherals, labeled I2C1, I2C2, I2C3 etc.
|
||||||
|
|
||||||
To enable I2C, modify your board's `halconf.h` to enable I2C, then modify your board's `mcuconf.h` to enable the peripheral you've chosen:
|
To enable I2C, modify your board's `halconf.h` to enable I2C, then modify your board's `mcuconf.h` to enable the peripheral you've chosen:
|
||||||
|
|
||||||
@ -88,19 +83,15 @@ To enable I2C, modify your board's `halconf.h` to enable I2C, then modify your b
|
|||||||
|
|
||||||
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
|
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
|
||||||
|
|
||||||
|`config.h` Override|Description |Default|
|
|`config.h` Overrride |Description |Default|
|
||||||
|-------------------|-------------------------------------------------------------|-------|
|
|------------------------|--------------------------------------------------------------|-------|
|
||||||
|`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc. |`I2CD1`|
|
|`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc. |`I2CD1`|
|
||||||
|`I2C1_SCL_PIN` |The pin to use for SCL |`B6` |
|
|`I2C1_SCL_PIN` |The pin definition for SCL |`B6` |
|
||||||
|`I2C1_SCL_PAL_MODE` |The alternate function mode for SCL |`4` |
|
|`I2C1_SCL_PAL_MODE` |The alternate function mode for SCL |`4` |
|
||||||
|`I2C1_SDA_PIN` |The pin to use for SDA |`B7` |
|
|`I2C1_SDA_PIN` |The pin definition for SDA |`B7` |
|
||||||
|`I2C1_SDA_PAL_MODE` |The alternate function mode for SDA |`4` |
|
|`I2C1_SDA_PAL_MODE` |The alternate function mode for SDA |`4` |
|
||||||
|
|
||||||
::: tip
|
The following configuration values depend on the specific MCU in use.
|
||||||
Currently only a single I2C peripheral is supported, therefore the `I2C1_*` defines are used for configuration regardless of the selected peripheral.
|
|
||||||
:::
|
|
||||||
|
|
||||||
The following configuration values are dependent on the ChibiOS I2C LLD, which is dictated by the microcontroller.
|
|
||||||
|
|
||||||
### I2Cv1 {#arm-configuration-i2cv1}
|
### I2Cv1 {#arm-configuration-i2cv1}
|
||||||
|
|
||||||
@ -156,7 +147,7 @@ void i2c_init(void) {
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### `i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit}
|
### `i2c_status_t i2c_transmit(uint8_t address, uint8_t *data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit}
|
||||||
|
|
||||||
Send multiple bytes to the selected I2C device.
|
Send multiple bytes to the selected I2C device.
|
||||||
|
|
||||||
@ -164,7 +155,7 @@ Send multiple bytes to the selected I2C device.
|
|||||||
|
|
||||||
- `uint8_t address`
|
- `uint8_t address`
|
||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `const uint8_t* data`
|
- `uint8_t *data`
|
||||||
A pointer to the data to transmit.
|
A pointer to the data to transmit.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to write. Take care not to overrun the length of `data`.
|
The number of bytes to write. Take care not to overrun the length of `data`.
|
||||||
@ -177,29 +168,6 @@ Send multiple bytes to the selected I2C device.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### `i2c_status_t i2c_transmit_P(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-transmit-p}
|
|
||||||
|
|
||||||
Send multiple bytes from PROGMEM to the selected I2C device.
|
|
||||||
|
|
||||||
On ARM devices, this function is simply an alias for `i2c_transmit(address, data, length, timeout)`.
|
|
||||||
|
|
||||||
#### Arguments {#api-i2c-transmit-p-arguments}
|
|
||||||
|
|
||||||
- `uint8_t address`
|
|
||||||
The 7-bit I2C address of the device.
|
|
||||||
- `const uint8_t* data`
|
|
||||||
A pointer to the data to transmit.
|
|
||||||
- `uint16_t length`
|
|
||||||
The number of bytes to write. Take care not to overrun the length of `data`.
|
|
||||||
- `uint16_t timeout`
|
|
||||||
The time in milliseconds to wait for a response from the target device.
|
|
||||||
|
|
||||||
#### Return Value {#api-i2c-transmit-p-return}
|
|
||||||
|
|
||||||
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-receive}
|
### `i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-receive}
|
||||||
|
|
||||||
Receive multiple bytes from the selected I2C device.
|
Receive multiple bytes from the selected I2C device.
|
||||||
@ -209,7 +177,7 @@ Receive multiple bytes from the selected I2C device.
|
|||||||
- `uint8_t address`
|
- `uint8_t address`
|
||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `uint8_t *data`
|
- `uint8_t *data`
|
||||||
A pointer to a buffer to read into.
|
A pointer to the buffer to read into.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to read. Take care not to overrun the length of `data`.
|
The number of bytes to read. Take care not to overrun the length of `data`.
|
||||||
- `uint16_t timeout`
|
- `uint16_t timeout`
|
||||||
@ -221,9 +189,9 @@ Receive multiple bytes from the selected I2C device.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### `i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register}
|
### `i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register}
|
||||||
|
|
||||||
Write to a register with an 8-bit address on the I2C device.
|
Writes to a register with an 8-bit address on the I2C device.
|
||||||
|
|
||||||
#### Arguments {#api-i2c-write-register-arguments}
|
#### Arguments {#api-i2c-write-register-arguments}
|
||||||
|
|
||||||
@ -231,7 +199,7 @@ Write to a register with an 8-bit address on the I2C device.
|
|||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `uint8_t regaddr`
|
- `uint8_t regaddr`
|
||||||
The register address to write to.
|
The register address to write to.
|
||||||
- `const uint8_t* data`
|
- `uint8_t *data`
|
||||||
A pointer to the data to transmit.
|
A pointer to the data to transmit.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to write. Take care not to overrun the length of `data`.
|
The number of bytes to write. Take care not to overrun the length of `data`.
|
||||||
@ -244,9 +212,9 @@ Write to a register with an 8-bit address on the I2C device.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### `i2c_status_t i2c_write_register16(uint8_t devaddr, uint16_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register16}
|
### `i2c_status_t i2c_write_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-write-register16}
|
||||||
|
|
||||||
Write to a register with a 16-bit address (big endian) on the I2C device.
|
Writes to a register with a 16-bit address (big endian) on the I2C device.
|
||||||
|
|
||||||
#### Arguments {#api-i2c-write-register16-arguments}
|
#### Arguments {#api-i2c-write-register16-arguments}
|
||||||
|
|
||||||
@ -254,7 +222,7 @@ Write to a register with a 16-bit address (big endian) on the I2C device.
|
|||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `uint16_t regaddr`
|
- `uint16_t regaddr`
|
||||||
The register address to write to.
|
The register address to write to.
|
||||||
- `const uint8_t* data`
|
- `uint8_t *data`
|
||||||
A pointer to the data to transmit.
|
A pointer to the data to transmit.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to write. Take care not to overrun the length of `data`.
|
The number of bytes to write. Take care not to overrun the length of `data`.
|
||||||
@ -269,7 +237,7 @@ Write to a register with a 16-bit address (big endian) on the I2C device.
|
|||||||
|
|
||||||
### `i2c_status_t i2c_read_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register}
|
### `i2c_status_t i2c_read_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register}
|
||||||
|
|
||||||
Read from a register with an 8-bit address on the I2C device.
|
Reads from a register with an 8-bit address on the I2C device.
|
||||||
|
|
||||||
#### Arguments {#api-i2c-read-register-arguments}
|
#### Arguments {#api-i2c-read-register-arguments}
|
||||||
|
|
||||||
@ -277,8 +245,6 @@ Read from a register with an 8-bit address on the I2C device.
|
|||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `uint8_t regaddr`
|
- `uint8_t regaddr`
|
||||||
The register address to read from.
|
The register address to read from.
|
||||||
- `uint8_t data`
|
|
||||||
A pointer to a buffer to read into.
|
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to read. Take care not to overrun the length of `data`.
|
The number of bytes to read. Take care not to overrun the length of `data`.
|
||||||
- `uint16_t timeout`
|
- `uint16_t timeout`
|
||||||
@ -292,7 +258,7 @@ Read from a register with an 8-bit address on the I2C device.
|
|||||||
|
|
||||||
### `i2c_status_t i2c_read_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register16}
|
### `i2c_status_t i2c_read_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout)` {#api-i2c-read-register16}
|
||||||
|
|
||||||
Read from a register with a 16-bit address (big endian) on the I2C device.
|
Reads from a register with a 16-bit address (big endian) on the I2C device.
|
||||||
|
|
||||||
#### Arguments {#api-i2c-read-register16-arguments}
|
#### Arguments {#api-i2c-read-register16-arguments}
|
||||||
|
|
||||||
@ -300,8 +266,6 @@ Read from a register with a 16-bit address (big endian) on the I2C device.
|
|||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device.
|
||||||
- `uint16_t regaddr`
|
- `uint16_t regaddr`
|
||||||
The register address to read from.
|
The register address to read from.
|
||||||
- `uint8_t* data`
|
|
||||||
A pointer to a buffer to read into.
|
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to read. Take care not to overrun the length of `data`.
|
The number of bytes to read. Take care not to overrun the length of `data`.
|
||||||
- `uint16_t timeout`
|
- `uint16_t timeout`
|
||||||
@ -315,19 +279,19 @@ Read from a register with a 16-bit address (big endian) on the I2C device.
|
|||||||
|
|
||||||
### `i2c_status_t i2c_ping_address(uint8_t address, uint16_t timeout)` {#api-i2c-ping-address}
|
### `i2c_status_t i2c_ping_address(uint8_t address, uint16_t timeout)` {#api-i2c-ping-address}
|
||||||
|
|
||||||
Ping the I2C bus for a specific address.
|
Pings the I2C bus for a specific address.
|
||||||
|
|
||||||
On ChibiOS a "best effort" attempt is made by reading a single byte from register 0 at the given address. This should generally work except for I2C devices that do not not respond to a register 0 read request, which will result in a false negative result (unsuccessful response to ping attempt).
|
On ChibiOS a "best effort" attempt is made by reading a single byte from register 0 at the requested address. This should generally work except for I2C devices that do not not respond to a register 0 read request, which will result in a false negative result (unsucessful response to ping attempt).
|
||||||
|
|
||||||
This function is weakly defined, meaning it can be overridden if necessary for your particular use case.
|
This function is weakly defined, meaning it can be overridden if necessary for your particular use case:
|
||||||
|
|
||||||
#### Arguments {#api-i2c-ping-address-arguments}
|
#### Arguments
|
||||||
|
|
||||||
- `uint8_t address`
|
- `uint8_t address`
|
||||||
The 7-bit I2C address of the device.
|
The 7-bit I2C address of the device (ie. without the read/write bit - this will be set automatically).
|
||||||
- `uint16_t timeout`
|
- `uint16_t timeout`
|
||||||
The time in milliseconds to wait for a response from the target device.
|
The time in milliseconds to wait for a response from the target device.
|
||||||
|
|
||||||
#### Return Value {#api-i2c-ping-address-return}
|
#### Return Value
|
||||||
|
|
||||||
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.
|
`I2C_STATUS_TIMEOUT` if the timeout period elapses, `I2C_STATUS_ERROR` if some other error occurs, otherwise `I2C_STATUS_SUCCESS`.
|
||||||
|
@ -37,7 +37,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {
|
const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {
|
||||||
|
@ -50,7 +50,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {
|
const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {
|
||||||
|
@ -120,7 +120,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {
|
const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {
|
||||||
|
@ -61,7 +61,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
|
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
|
||||||
|
@ -145,7 +145,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
|
const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
|
||||||
|
@ -129,7 +129,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {
|
const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {
|
||||||
|
@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {
|
const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {
|
||||||
|
@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {
|
const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {
|
||||||
|
@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {
|
const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {
|
||||||
|
@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {
|
const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {
|
||||||
|
@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {
|
const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {
|
||||||
|
@ -132,7 +132,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {
|
const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {
|
||||||
|
@ -52,7 +52,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
|
|||||||
|
|
||||||
## LED Mapping {#led-mapping}
|
## LED Mapping {#led-mapping}
|
||||||
|
|
||||||
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
|
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
|
||||||
|
|
||||||
```c
|
```c
|
||||||
const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {
|
const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {
|
||||||
|
@ -39,6 +39,8 @@ To enable SPI, modify your board's `halconf.h` to enable SPI, then modify your b
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#define HAL_USE_SPI TRUE // [!code focus]
|
#define HAL_USE_SPI TRUE // [!code focus]
|
||||||
|
#define SPI_USE_WAIT TRUE // [!code focus]
|
||||||
|
#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD // [!code focus]
|
||||||
|
|
||||||
#include_next <halconf.h>
|
#include_next <halconf.h>
|
||||||
```
|
```
|
||||||
@ -86,7 +88,7 @@ Start an SPI transaction.
|
|||||||
#### Arguments {#api-spi-start-arguments}
|
#### Arguments {#api-spi-start-arguments}
|
||||||
|
|
||||||
- `pin_t slavePin`
|
- `pin_t slavePin`
|
||||||
The GPIO pin connected to the desired device's `SS` line.
|
The QMK pin to assert as the slave select pin, eg. `B4`.
|
||||||
- `bool lsbFirst`
|
- `bool lsbFirst`
|
||||||
Determines the endianness of the transmission. If `true`, the least significant bit of each byte is sent first.
|
Determines the endianness of the transmission. If `true`, the least significant bit of each byte is sent first.
|
||||||
- `uint8_t mode`
|
- `uint8_t mode`
|
||||||
@ -104,7 +106,7 @@ Start an SPI transaction.
|
|||||||
|
|
||||||
#### Return Value {#api-spi-start-return}
|
#### Return Value {#api-spi-start-return}
|
||||||
|
|
||||||
`true` if the operation was successful, otherwise `false` if the supplied parameters are invalid or the SPI peripheral is already in use.
|
`false` if the supplied parameters are invalid or the SPI peripheral is already in use, or `true`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -129,7 +131,7 @@ Read a byte from the selected SPI device.
|
|||||||
|
|
||||||
#### Return Value {#api-spi-read-return}
|
#### Return Value {#api-spi-read-return}
|
||||||
|
|
||||||
`SPI_STATUS_TIMEOUT` if the timeout period elapses, otherwise the byte read from the device.
|
`SPI_STATUS_TIMEOUT` if the timeout period elapses, or the byte read from the device.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -157,7 +159,7 @@ Receive multiple bytes from the selected SPI device.
|
|||||||
#### Arguments {#api-spi-receive-arguments}
|
#### Arguments {#api-spi-receive-arguments}
|
||||||
|
|
||||||
- `uint8_t *data`
|
- `uint8_t *data`
|
||||||
A pointer to a buffer to read into.
|
A pointer to the buffer to read into.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to read. Take care not to overrun the length of `data`.
|
The number of bytes to read. Take care not to overrun the length of `data`.
|
||||||
|
|
||||||
|
@ -45,17 +45,17 @@ To enable UART, modify your board's `mcuconf.h` to enable the peripheral you've
|
|||||||
|
|
||||||
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
|
Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303.
|
||||||
|
|
||||||
|`config.h` Override|Description |Default|
|
| `config.h` override | Description | Default Value |
|
||||||
|-------------------|---------------------------------------------------------------|-------|
|
| --------------------------- | --------------------------------------------------------------- | ------------- |
|
||||||
|`UART_DRIVER` |USART peripheral to use - USART1 -> `SD1`, USART2 -> `SD2` etc.|`SD1` |
|
| `#define UART_DRIVER` | USART peripheral to use - USART1 -> `SD1`, USART2 -> `SD2` etc. | `SD1` |
|
||||||
|`UART_TX_PIN` |The pin to use for TX |`A9` |
|
| `#define UART_TX_PIN` | The pin to use for TX | `A9` |
|
||||||
|`UART_TX_PAL_MODE` |The alternate function mode for TX |`7` |
|
| `#define UART_TX_PAL_MODE` | The alternate function mode for TX | `7` |
|
||||||
|`UART_RX_PIN` |The pin to use for RX |`A10` |
|
| `#define UART_RX_PIN` | The pin to use for RX | `A10` |
|
||||||
|`UART_RX_PAL_MODE` |The alternate function mode for RX |`7` |
|
| `#define UART_RX_PAL_MODE` | The alternate function mode for RX | `7` |
|
||||||
|`UART_CTS_PIN` |The pin to use for CTS |`A11` |
|
| `#define UART_CTS_PIN` | The pin to use for CTS | `A11` |
|
||||||
|`UART_CTS_PAL_MODE`|The alternate function mode for CTS |`7` |
|
| `#define UART_CTS_PAL_MODE` | The alternate function mode for CTS | `7` |
|
||||||
|`UART_RTS_PIN` |The pin to use for RTS |`A12` |
|
| `#define UART_RTS_PIN` | The pin to use for RTS | `A12` |
|
||||||
|`UART_RTS_PAL_MODE`|The alternate function mode for RTS |`7` |
|
| `#define UART_RTS_PAL_MODE` | The alternate function mode for RTS | `7` |
|
||||||
|
|
||||||
## API {#api}
|
## API {#api}
|
||||||
|
|
||||||
@ -111,7 +111,7 @@ Receive multiple bytes.
|
|||||||
#### Arguments {#api-uart-receive-arguments}
|
#### Arguments {#api-uart-receive-arguments}
|
||||||
|
|
||||||
- `uint8_t *data`
|
- `uint8_t *data`
|
||||||
A pointer to a buffer to read into.
|
A pointer to the buffer to read into.
|
||||||
- `uint16_t length`
|
- `uint16_t length`
|
||||||
The number of bytes to read. Take care not to overrun the length of `data`.
|
The number of bytes to read. Take care not to overrun the length of `data`.
|
||||||
|
|
||||||
@ -123,4 +123,4 @@ Return whether the receive buffer contains data. Call this function to determine
|
|||||||
|
|
||||||
#### Return Value {#api-uart-available-return}
|
#### Return Value {#api-uart-available-return}
|
||||||
|
|
||||||
`true` if there is data available to read.
|
`true` if the receive buffer length is non-zero.
|
||||||
|
@ -144,30 +144,18 @@ The following defines apply only to ARM devices:
|
|||||||
|`WS2812_T1L`|`(WS2812_TIMING - WS2812_T1H)`|The length of a "1" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
|
|`WS2812_T1L`|`(WS2812_TIMING - WS2812_T1H)`|The length of a "1" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
|
||||||
|`WS2812_T0L`|`(WS2812_TIMING - WS2812_T0H)`|The length of a "0" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
|
|`WS2812_T0L`|`(WS2812_TIMING - WS2812_T0H)`|The length of a "0" bit's low phase in nanoseconds (bitbang and PIO drivers only)|
|
||||||
|
|
||||||
### Logic Levels {#logic-levels}
|
### Push-Pull and Open Drain {#push-pull-open-drain}
|
||||||
|
|
||||||
WS2812 LEDs usually operate at 5V, but some microcontrollers, particularly ARM-based ones, run on 3.3V. This can pose an issue when driving the LED chain as the logic level voltage is lower than the power supply voltage, leading to unreliable data transmission. There are two main workarounds:
|
By default, the GPIO used for data transmission is configured as a *push-pull* output, meaning the pin is effectively always driven either to VCC or to ground.
|
||||||
|
|
||||||
#### 1. Open Drain Circuit {#open-drain-circuit}
|
For situations where the logic level voltage is lower than the power supply voltage, however, this can pose an issue. The solution is to configure the pin for *open drain* mode instead, and use a pullup resistor between the DI pin and VCC. In this mode, the MCU can only pull the GPIO *low*, or leave it floating. The pullup resistor is then responsible for pulling the line high, when the MCU is not driving the GPIO.
|
||||||
|
|
||||||
By default, `WS2812_DI_PIN` is configured as a *push-pull* output, meaning the pin is effectively always driven either to VCC or to ground; however, it can be configured in *open drain* mode instead.
|
To configure the DI pin for open drain configuration, add the following to your `config.h`:
|
||||||
|
|
||||||
In this mode, the MCU will only pull the GPIO *low*, and leaves it floating otherwise. A pullup resistor (typically around 10kΩ) between DI and 5V is then responsible for pulling the line high when the MCU is not driving the GPIO.
|
|
||||||
|
|
||||||
To use the DI pin in open drain configuration, add the following to your `config.h`:
|
|
||||||
|
|
||||||
```c
|
```c
|
||||||
#define WS2812_EXTERNAL_PULLUP
|
#define WS2812_EXTERNAL_PULLUP
|
||||||
```
|
```
|
||||||
|
|
||||||
::: warning
|
|
||||||
Because the GPIO is being pulled to 5V in this situation rather than VCC (3.3V), **it must be a 5V tolerant pin**. Consult your MCU's datasheet first – if there are no eligible pins, you must use a level shifter instead.
|
|
||||||
:::
|
|
||||||
|
|
||||||
#### 2. Level Shifter {#level-shifter}
|
|
||||||
|
|
||||||
A level shifter IC, such as the SN74LV1T34, can be placed between the GPIO and the first LED's DI pin to convert the 3.3V logic to 5V. This requires no additional configuration in the firmware, nor a 5V tolerant GPIO, but may be more expensive and is generally less handwire-friendly.
|
|
||||||
|
|
||||||
### SPI Driver {#arm-spi-driver}
|
### SPI Driver {#arm-spi-driver}
|
||||||
|
|
||||||
Depending on the ChibiOS board configuration, you may need to enable SPI at the keyboard level. For STM32, this would look like:
|
Depending on the ChibiOS board configuration, you may need to enable SPI at the keyboard level. For STM32, this would look like:
|
||||||
|
@ -77,17 +77,6 @@ KL: kc: 172, col: 2, row: 0, pressed: 1, time: 16303, int: 0, count: 0
|
|||||||
KL: kc: 172, col: 2, row: 0, pressed: 0, time: 16411, int: 0, count: 0
|
KL: kc: 172, col: 2, row: 0, pressed: 0, time: 16411, int: 0, count: 0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Which keycode is this keypress?
|
|
||||||
|
|
||||||
Keycodes are logged in the example above as numerical codes, which may be difficult to interpret. For more readable logging, add `KEYCODE_STRING_ENABLE = yes` in your `rules.mk` and use `get_keycode_string(kc)`. For example:
|
|
||||||
|
|
||||||
```c
|
|
||||||
uprintf("kc: %s\n", get_keycode_string(keycode));
|
|
||||||
```
|
|
||||||
|
|
||||||
This logs the keycode as a human-readable string like "`LT(2,KC_D)`" rather than a numerical code like "`0x4207`." See the [Keycode String](unit_testing#keycode-string) section of the Unit Testing page for more information.
|
|
||||||
|
|
||||||
|
|
||||||
### How long did it take to scan for a keypress?
|
### How long did it take to scan for a keypress?
|
||||||
|
|
||||||
When testing performance issues, it can be useful to know the frequency at which the switch matrix is being scanned. To enable logging for this scenario, add the following code to your keymaps `config.h`
|
When testing performance issues, it can be useful to know the frequency at which the switch matrix is being scanned. To enable logging for this scenario, add the following code to your keymaps `config.h`
|
||||||
@ -140,7 +129,7 @@ needed for older distros.
|
|||||||
## Can't Get Message on Console
|
## Can't Get Message on Console
|
||||||
Check:
|
Check:
|
||||||
- *hid_listen* finds your device. See above.
|
- *hid_listen* finds your device. See above.
|
||||||
- Enable debug by pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard/wiki#magic-commands-for-debug).
|
- Enable debug by pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
|
||||||
- Set `debug_enable=true`. See [Debugging](#debugging)
|
- Set `debug_enable=true`. See [Debugging](#debugging)
|
||||||
- Try using `print` function instead of debug print. See **common/print.h**.
|
- Try using `print` function instead of debug print. See **common/print.h**.
|
||||||
- Disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
|
- Disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
|
||||||
|
@ -3,39 +3,28 @@
|
|||||||
These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
|
These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|----------|----------------------------------|-------------------------------------------------------------------------------|
|
|----------|----------------------------------|------------------------------------------------------|
|
||||||
|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
|
|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
|
||||||
|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
|
|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
|
||||||
|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
|
|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
|
||||||
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` |
|
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` |
|
||||||
|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` |
|
|
||||||
|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` |
|
|
||||||
|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` |
|
|
||||||
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|
|
||||||
|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and Left GUI and press `kc` |
|
|
||||||
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|
|
||||||
|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` |
|
|
||||||
|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` |
|
|
||||||
|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` |
|
|
||||||
|`RCTL(kc)`| |Hold Right Control and press `kc` |
|
|`RCTL(kc)`| |Hold Right Control and press `kc` |
|
||||||
|`RSFT(kc)`| |Hold Right Shift and press `kc` |
|
|`RSFT(kc)`| |Hold Right Shift and press `kc` |
|
||||||
|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
|
|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
|
||||||
|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
|
|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
|
||||||
|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` |
|
|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` |
|
||||||
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|
||||||
|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` |
|
|
||||||
|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt and press `kc` |
|
|
||||||
|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
|
|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
|
||||||
|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
|
|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
|
||||||
|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` |
|
|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
|
||||||
|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` |
|
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|
||||||
|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` |
|
|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt (AltGr) and press `kc` |
|
||||||
|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` |
|
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|
||||||
|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`<sup>1</sup>|
|
|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
|
||||||
|
|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
|
||||||
|
|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc` |
|
||||||
|
|
||||||
<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup>
|
You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
|
||||||
|
|
||||||
You can also chain them, for example `LCTL(LALT(KC_DEL))`, `C(A(KC_DEL))`, or `LCA(KC_DEL)` all make a key that sends Control+Alt+Delete with a single keypress.
|
|
||||||
|
|
||||||
# Checking Modifier State {#checking-modifier-state}
|
# Checking Modifier State {#checking-modifier-state}
|
||||||
|
|
||||||
|
@ -117,9 +117,7 @@ If yes, we send the string `"QMK is the best thing ever!"` to the computer via t
|
|||||||
We return `true` to indicate to the caller that the key press we just processed should continue to be processed as normal (as we didn't replace or alter the functionality).
|
We return `true` to indicate to the caller that the key press we just processed should continue to be processed as normal (as we didn't replace or alter the functionality).
|
||||||
Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
|
Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
|
||||||
|
|
||||||
::: tip
|
?>It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions).
|
||||||
It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions).
|
|
||||||
:::
|
|
||||||
|
|
||||||
You might want to add more than one macro.
|
You might want to add more than one macro.
|
||||||
You can do that by adding another keycode and adding another case to the switch statement, like so:
|
You can do that by adding another keycode and adding another case to the switch statement, like so:
|
||||||
|
@ -74,9 +74,8 @@ Additionally, `config.h` here will be processed like the same file in your keyma
|
|||||||
|
|
||||||
The reason for this, is that `<name>.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `<name.h>` file in any `config.h` files will result in compile issues.
|
The reason for this, is that `<name>.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `<name.h>` file in any `config.h` files will result in compile issues.
|
||||||
|
|
||||||
::: warning
|
!>You should use the `config.h` for [configuration options](config_options), and the `<name>.h` file for user or keymap specific settings (such as the enum for layer or keycodes)
|
||||||
You should use the `config.h` for [configuration options](config_options), and the `<name>.h` file for user or keymap specific settings (such as the enum for layer or keycodes)
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Readme (`readme.md`)
|
## Readme (`readme.md`)
|
||||||
|
|
||||||
@ -119,7 +118,7 @@ This is ideal for when you want ensure everything compiles successfully when pre
|
|||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
For a brief example, checkout [`/users/_example/`](https://github.com/qmk/qmk_firmware/tree/master/users/_example).
|
For a brief example, checkout [`/users/_example/`](https://github.com/qmk/qmk_firmware/tree/master/users/_example).
|
||||||
For more complicated examples, checkout the [`awesome-qmk` colletion](https://github.com/qmk/awesome-qmk).
|
For a more complicated example, checkout [`/users/drashna/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna)'s userspace.
|
||||||
|
|
||||||
|
|
||||||
### Customized Functions
|
### Customized Functions
|
||||||
|
@ -1,164 +0,0 @@
|
|||||||
# Community Modules
|
|
||||||
|
|
||||||
Community Modules are a feature within QMK which allows code to be implemented by third parties, making it available for other people to import into their own builds.
|
|
||||||
|
|
||||||
These modules can provide implementations which override or enhance normal QMK processing; initialization, key processing, suspend, and shutdown are some of the provided hooks which modules may implement.
|
|
||||||
|
|
||||||
## Adding a Community Module to your build
|
|
||||||
|
|
||||||
Community Modules have first-class support for [External Userspace](/newbs_external_userspace), and QMK strongly recommends using External Userspace for hosting keymaps and Community Modules together.
|
|
||||||
|
|
||||||
Modules must live in either of two locations:
|
|
||||||
|
|
||||||
* `<QMK_USERSPACE>/modules/`
|
|
||||||
* `<QMK_FIRMWARE>/modules/`
|
|
||||||
|
|
||||||
A basic module is provided within QMK itself -- `qmk/hello_world` -- which prints out a notification over [HID console](/faq_debug) after 10 seconds, and adds a new keycode, `COMMUNITY_MODULE_HELLO` (aliased to `CM_HELO`) which types `Hello there.` to the active application when the corresponding key is pressed.
|
|
||||||
|
|
||||||
To add this module to your build, in your keymap's directory create a `keymap.json` with the following content:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"modules": [
|
|
||||||
"qmk/hello_world"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
If you already have a `keymap.json`, you'll need to manually merge the `modules` section into your keymap.
|
|
||||||
|
|
||||||
::: warning
|
|
||||||
Community Modules are not supported by QMK Configurator. If you wish to use Community Modules, you must build your own firmware.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Adding a Community Module to your External Userspace
|
|
||||||
|
|
||||||
Module authors are encouraged to provide a git repository on GitHub which may be imported into a user's external userspace. If a user wishes to import a module repository, they can do the following:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
cd /path/to/your/external/userspace
|
|
||||||
mkdir -p modules
|
|
||||||
# Replace the following {user} and {repo} with the author's community module repository
|
|
||||||
git submodule add https://github.com/{user}/{repo}.git modules/{user}
|
|
||||||
git submodule update --init --recursive
|
|
||||||
```
|
|
||||||
|
|
||||||
This will ensure the copy of the module is made in your userspace.
|
|
||||||
|
|
||||||
Add a new entry into your `keymap.json` with the desired modules, replacing `{user}` and `{module_name}` as appropriate:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"modules": [
|
|
||||||
"qmk/hello_world",
|
|
||||||
"{user}/{module_name}"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
::: info
|
|
||||||
The module listed in `keymap.json` is the relative path within the `modules/` directory. So long as the module is present _somewhere_ under `modules/`, then the `keymap.json` can refer to that path.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Writing a QMK Community Module
|
|
||||||
|
|
||||||
As stated earlier, Community Module authors are strongly encouraged to provide their modules through git, allowing users to leverage submodules to import functionality.
|
|
||||||
|
|
||||||
### `qmk_module.json`
|
|
||||||
|
|
||||||
A Community Module is denoted by a `qmk_module.json` file such as the following:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"module_name": "Hello World",
|
|
||||||
"maintainer": "QMK Maintainers",
|
|
||||||
"license": "GPL-2.0-or-later",
|
|
||||||
"features": {
|
|
||||||
"deferred_exec": true
|
|
||||||
},
|
|
||||||
"keycodes": [
|
|
||||||
{
|
|
||||||
"key": "COMMUNITY_MODULE_HELLO",
|
|
||||||
"aliases": ["CM_HELO"]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
At minimum, the module must provide the `module_name` and `maintainer` fields.
|
|
||||||
|
|
||||||
The `license` field is encouraged to indicate the terms for using and sharing the module. It is recommended to use a [SPDX license identifier](https://spdx.org/licenses/) like "`Apache-2.0`" or "`GPL-2.0-or-later`" if possible.
|
|
||||||
|
|
||||||
The `url` field may specify a URL to more information about the module.
|
|
||||||
|
|
||||||
The use of `features` matches the definition normally provided within `keyboard.json` and `info.json`, allowing a module to signal to the build system that it has its own dependencies. In the example above, it enables the _deferred executor_ feature whenever the above module is used in a build.
|
|
||||||
|
|
||||||
The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap.
|
|
||||||
|
|
||||||
### `rules.mk` / `post_rules.mk`
|
|
||||||
|
|
||||||
These two files follows standard QMK build system logic, allowing for `Makefile`-style customisation as if it were present in the keyboard or keymap.
|
|
||||||
|
|
||||||
### `<module>.c`
|
|
||||||
|
|
||||||
This file will be automatically added to the build if the filename matches the directory name. For example, the `qmk/hello_world` module contains a `hello_world.c` file, which is automatically added to the build.
|
|
||||||
|
|
||||||
::: info
|
|
||||||
Other files intended to be included must use the normal method of `SRC += my_file.c` inside `rules.mk`.
|
|
||||||
:::
|
|
||||||
|
|
||||||
::: tip
|
|
||||||
This file should use `ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(1,0,0);` to enforce a minimum version of the API that it requires, ensuring the Community Module is built with a compatible version of QMK. The list of APIs and corresponding version is given at the bottom of this document. Note the use of commas instead of periods.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### `introspection.c` / `introspection.h`
|
|
||||||
|
|
||||||
These two files hook into the keymap introspection logic -- the header is prepended before the user keymap, and the C source file is appended after the user keymap.
|
|
||||||
|
|
||||||
The header may provide definitions which are useful to the user's `keymap.c`.
|
|
||||||
|
|
||||||
The source file may provide functions which allow access to information specified in the user's `keymap.c`.
|
|
||||||
|
|
||||||
::: warning
|
|
||||||
Introspection is a relatively advanced topic within QMK, and existing patterns should be followed. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/qmk).
|
|
||||||
:::
|
|
||||||
|
|
||||||
### `led_matrix_module.inc`
|
|
||||||
|
|
||||||
This file defines LED matrix effects in the same form as used with `led_matrix_kb.inc` and `led_matrix_user.inc` (see [Custom LED Matrix Effects](led_matrix#custom-led-matrix-effects)). Effect mode names are prepended with `LED_MATRIX_COMMUNITY_MODULE_`.
|
|
||||||
|
|
||||||
### `rgb_matrix_module.inc`
|
|
||||||
|
|
||||||
This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.
|
|
||||||
|
|
||||||
### Compatible APIs
|
|
||||||
|
|
||||||
Community Modules may provide specializations for the following APIs:
|
|
||||||
|
|
||||||
| Base API | API Format | Example (`hello_world` module) | API Version |
|
|
||||||
|----------------------------------|-------------------------------------------|---------------------------------------------|-------------|
|
|
||||||
| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |
|
|
||||||
| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |
|
|
||||||
| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |
|
|
||||||
| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |
|
|
||||||
| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |
|
|
||||||
| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |
|
|
||||||
| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |
|
|
||||||
| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |
|
|
||||||
| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |
|
|
||||||
| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |
|
|
||||||
| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |
|
|
||||||
| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |
|
|
||||||
| `led_matrix_indicators` | `led_matrix_indicators_<module>` | `led_matrix_indicators_hello_world` | `1.1.0` |
|
|
||||||
| `led_matrix_indicators_advanced` | `led_matrix_indicators_advanced_<module>` | `led_matrix_indicators_advanced_hello_world` | `1.1.0` |
|
|
||||||
| `rgb_matrix_indicators` | `rgb_matrix_indicators_<module>` | `rgb_matrix_indicators_hello_world` | `1.1.0` |
|
|
||||||
| `rgb_matrix_indicators_advanced` | `rgb_matrix_indicators_advanced_<module>` | `rgb_matrix_indicators_advanced_hello_world` | `1.1.0` |
|
|
||||||
| `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_world` | `1.1.0` |
|
|
||||||
| `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_world` | `1.1.0` |
|
|
||||||
|
|
||||||
|
|
||||||
::: info
|
|
||||||
An unspecified API is disregarded if a Community Module does not provide a specialization for it.
|
|
||||||
:::
|
|
||||||
|
|
||||||
Each API has an equivalent `_<module>_kb()` and `_<module>_user()` hook, as per the normal QMK [`_quantum`, `_kb`, and `_user` functions](/custom_quantum_functions#a-word-on-core-vs-keyboards-vs-keymap).
|
|
@ -135,11 +135,11 @@ bool momentary_layer(bool key_down, void *layer) {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //
|
const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), //
|
||||||
.layers = ~(1 << LAYER_FN), //
|
.layers = ~(1 << LAYER_FN), //
|
||||||
.suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //
|
.suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), //
|
||||||
.options = ko_option_no_unregister_on_other_key_down, //
|
.options = ko_option_no_unregister_on_other_key_down, //
|
||||||
.negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT)), //
|
.negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL)), //
|
||||||
.custom_action = momentary_layer, //
|
.custom_action = momentary_layer, //
|
||||||
.context = (void *)LAYER_FN, //
|
.context = (void *)LAYER_FN, //
|
||||||
.trigger = KC_NO, //
|
.trigger = KC_NO, //
|
||||||
|
@ -154,21 +154,6 @@ User callback, invoked when the leader sequence ends.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### `bool leader_add_user(uint16_t keycode)` {#api-leader-add-user}
|
|
||||||
|
|
||||||
User callback, invoked when a keycode is added to the leader sequence.
|
|
||||||
|
|
||||||
#### Arguments {#api-leader-add-user-arguments}
|
|
||||||
|
|
||||||
- `uint16_t keycode`
|
|
||||||
The keycode to added to the leader sequence.
|
|
||||||
|
|
||||||
#### Return Value {#api-leader-add-user-return}
|
|
||||||
|
|
||||||
`true` to finish the key sequence, `false` to continue.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `void leader_start(void)` {#api-leader-start}
|
### `void leader_start(void)` {#api-leader-start}
|
||||||
|
|
||||||
Begin the leader sequence, resetting the buffer and timer.
|
Begin the leader sequence, resetting the buffer and timer.
|
||||||
|
@ -227,8 +227,6 @@ For inspiration and examples, check out the built-in effects under `quantum/led_
|
|||||||
#define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set
|
#define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set
|
||||||
#define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
|
#define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
|
||||||
#define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
|
#define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
|
||||||
#define LED_MATRIX_VAL_STEP 8 // The value by which to increment the brightness per adjustment action
|
|
||||||
#define LED_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action
|
|
||||||
#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
|
#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
|
||||||
#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
||||||
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||||
|
@ -214,9 +214,7 @@ When additional overlapping mouse key is pressed, the mouse cursor will continue
|
|||||||
|`MOUSEKEY_OVERLAP_WHEEL_DELTA`|`MOUSEKEY_WHEEL_DELTA`|Step size of reset mouse wheel acceleration |
|
|`MOUSEKEY_OVERLAP_WHEEL_DELTA`|`MOUSEKEY_WHEEL_DELTA`|Step size of reset mouse wheel acceleration |
|
||||||
|`MOUSEKEY_OVERLAP_INTERVAL` |`MOUSEKEY_INTERVAL` |Reset time between cursor movements in milliseconds (Kinetic mode only)|
|
|`MOUSEKEY_OVERLAP_INTERVAL` |`MOUSEKEY_INTERVAL` |Reset time between cursor movements in milliseconds (Kinetic mode only)|
|
||||||
|
|
||||||
::: tip
|
?> This feature will not be applied on Inertial mode
|
||||||
This feature will not be applied on Inertial mode
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Use with PS/2 Mouse and Pointing Device
|
## Use with PS/2 Mouse and Pointing Device
|
||||||
|
|
||||||
|
@ -419,32 +419,6 @@ The `POINTING_DEVICE_CS_PIN`, `POINTING_DEVICE_SDIO_PIN`, and `POINTING_DEVICE_S
|
|||||||
Any pointing device with a lift/contact status can integrate inertial cursor feature into its driver, controlled by `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE`. e.g. PMW3360 can use Lift_Stat from Motion register. Note that `POINTING_DEVICE_MOTION_PIN` cannot be used with this feature; continuous polling of `get_report()` is needed to generate glide reports.
|
Any pointing device with a lift/contact status can integrate inertial cursor feature into its driver, controlled by `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE`. e.g. PMW3360 can use Lift_Stat from Motion register. Note that `POINTING_DEVICE_MOTION_PIN` cannot be used with this feature; continuous polling of `get_report()` is needed to generate glide reports.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## High Resolution Scrolling
|
|
||||||
|
|
||||||
| Setting | Description | Default |
|
|
||||||
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------- |
|
|
||||||
| `POINTING_DEVICE_HIRES_SCROLL_ENABLE` | (Optional) Enables high resolution scrolling. | _not defined_ |
|
|
||||||
| `POINTING_DEVICE_HIRES_SCROLL_MULTIPLIER`| (Optional) Resolution mutiplier value used by high resolution scrolling. Must be between 1 and 127, inclusive. | `120` |
|
|
||||||
| `POINTING_DEVICE_HIRES_SCROLL_EXPONENT` | (Optional) Resolution exponent value used by high resolution scrolling. Must be between 0 and 127, inclusive. | `0` |
|
|
||||||
|
|
||||||
The `POINTING_DEVICE_HIRES_SCROLL_ENABLE` setting enables smooth and continuous scrolling when using trackballs or high-end encoders as mouse wheels (as opposed to the typical stepped behavior of most mouse wheels).
|
|
||||||
This works by adding a resolution multiplier to the HID descriptor for mouse wheel reports, causing the host computer to interpret each wheel tick sent by the keyboard as a fraction of a normal wheel tick.
|
|
||||||
The resolution multiplier is set to `1 / (POINTING_DEVICE_HIRES_SCROLL_MULTIPLIER * (10 ^ POINTING_DEVICE_HIRES_SCROLL_EXPONENT))`, which is `1 / 120` by default.
|
|
||||||
If even smoother scrolling than provided by this default value is desired, first try using `#define POINTING_DEVICE_HIRES_SCROLL_EXPONENT 1` which will result in a multiplier of `1 / 1200`.
|
|
||||||
|
|
||||||
The function `pointing_device_get_hires_scroll_resolution()` can be called to get the pre-computed resolution multiplier value as a `uint16_t`.
|
|
||||||
|
|
||||||
::: warning
|
|
||||||
High resolution scrolling usually results in larger and/or more frequent mouse reports. This can result in overflow errors and overloading of the host computer's input buffer.
|
|
||||||
To deal with these issues, define `WHEEL_EXTENDED_REPORT` and throttle the rate at which mouse reports are sent.
|
|
||||||
:::
|
|
||||||
|
|
||||||
::: warning
|
|
||||||
Many programs, especially those that implement their own smoothing for scrolling, don't work well when they receive simultaneous vertical and horizontal wheel inputs (e.g. from high resolution drag-scroll using a trackball).
|
|
||||||
These programs typically implement their smoothing in a way that assumes the user will only scroll in one axis at a time, resulting in slow or jittery motion when trying to scroll at an angle.
|
|
||||||
This can be addressed by snapping scrolling to one axis at a time.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Split Keyboard Configuration
|
## Split Keyboard Configuration
|
||||||
|
|
||||||
The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](split_keyboard#data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.
|
The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](split_keyboard#data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.
|
||||||
|
@ -23,11 +23,8 @@ MODULE 5+ --------+--+--------- PWR CONTROLLER
|
|||||||
CLK ------+------------ PIN
|
CLK ------+------------ PIN
|
||||||
```
|
```
|
||||||
|
|
||||||
## Driver Configuration {#driver-configuration}
|
|
||||||
|
|
||||||
Driver selection can be configured in `rules.mk` as `PS2_DRIVER`, or in `info.json` as `ps2.driver`. Valid values are `busywait` (default), `interrupt`, `usart`, or `vendor`. See below for information on individual drivers.
|
## Busywait Version {#busywait-version}
|
||||||
|
|
||||||
### Busywait Driver {#busywait-driver}
|
|
||||||
|
|
||||||
Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
|
Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
|
||||||
|
|
||||||
@ -48,7 +45,7 @@ In your keyboard config.h:
|
|||||||
#endif
|
#endif
|
||||||
```
|
```
|
||||||
|
|
||||||
### Interrupt Driver (AVR/ATMega32u4) {#interrupt-driver-avr}
|
### Interrupt Version (AVR/ATMega32u4) {#interrupt-version-avr}
|
||||||
|
|
||||||
The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
|
The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
|
||||||
|
|
||||||
@ -81,7 +78,7 @@ In your keyboard config.h:
|
|||||||
#endif
|
#endif
|
||||||
```
|
```
|
||||||
|
|
||||||
### Interrupt Driver (ARM chibios) {#interrupt-driver-chibios}
|
### Interrupt Version (ARM chibios) {#interrupt-version-chibios}
|
||||||
|
|
||||||
Pretty much any two pins can be used for the (software) interrupt variant on ARM cores. The example below uses A8 for clock, and A9 for data.
|
Pretty much any two pins can be used for the (software) interrupt variant on ARM cores. The example below uses A8 for clock, and A9 for data.
|
||||||
|
|
||||||
@ -110,7 +107,7 @@ And in the ChibiOS specific `halconf.h`:
|
|||||||
#include_next <halconf.h>
|
#include_next <halconf.h>
|
||||||
```
|
```
|
||||||
|
|
||||||
### USART Driver {#usart-driver}
|
### USART Version {#usart-version}
|
||||||
|
|
||||||
To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
|
To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
|
||||||
|
|
||||||
@ -162,7 +159,7 @@ In your keyboard config.h:
|
|||||||
#endif
|
#endif
|
||||||
```
|
```
|
||||||
|
|
||||||
### RP2040 PIO Driver {#rp2040-pio-driver}
|
### RP2040 PIO Version {#rp2040-pio-version}
|
||||||
|
|
||||||
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
|
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
|
||||||
|
|
||||||
|
@ -150,7 +150,6 @@ enum rgb_matrix_effects {
|
|||||||
RGB_MATRIX_SOLID_SPLASH, // Hue & value pulse away from a single key hit then fades value out
|
RGB_MATRIX_SOLID_SPLASH, // Hue & value pulse away from a single key hit then fades value out
|
||||||
RGB_MATRIX_SOLID_MULTISPLASH, // Hue & value pulse away from multiple key hits then fades value out
|
RGB_MATRIX_SOLID_MULTISPLASH, // Hue & value pulse away from multiple key hits then fades value out
|
||||||
RGB_MATRIX_STARLIGHT, // LEDs turn on and off at random at varying brightness, maintaining user set color
|
RGB_MATRIX_STARLIGHT, // LEDs turn on and off at random at varying brightness, maintaining user set color
|
||||||
RGB_MATRIX_STARLIGHT_SMOOTH, // LEDs slowly increase and decrease in brightness randomly
|
|
||||||
RGB_MATRIX_STARLIGHT_DUAL_HUE, // LEDs turn on and off at random at varying brightness, modifies user set hue by +- 30
|
RGB_MATRIX_STARLIGHT_DUAL_HUE, // LEDs turn on and off at random at varying brightness, modifies user set hue by +- 30
|
||||||
RGB_MATRIX_STARLIGHT_DUAL_SAT, // LEDs turn on and off at random at varying brightness, modifies user set saturation by +- 30
|
RGB_MATRIX_STARLIGHT_DUAL_SAT, // LEDs turn on and off at random at varying brightness, modifies user set saturation by +- 30
|
||||||
RGB_MATRIX_RIVERFLOW, // Modification to breathing animation, offset's animation depending on key location to simulate a river flowing
|
RGB_MATRIX_RIVERFLOW, // Modification to breathing animation, offset's animation depending on key location to simulate a river flowing
|
||||||
@ -194,7 +193,6 @@ You can enable a single effect by defining `ENABLE_[EFFECT_NAME]` in your `confi
|
|||||||
|`#define ENABLE_RGB_MATRIX_PIXEL_FLOW` |Enables `RGB_MATRIX_PIXEL_FLOW` |
|
|`#define ENABLE_RGB_MATRIX_PIXEL_FLOW` |Enables `RGB_MATRIX_PIXEL_FLOW` |
|
||||||
|`#define ENABLE_RGB_MATRIX_PIXEL_RAIN` |Enables `RGB_MATRIX_PIXEL_RAIN` |
|
|`#define ENABLE_RGB_MATRIX_PIXEL_RAIN` |Enables `RGB_MATRIX_PIXEL_RAIN` |
|
||||||
|`#define ENABLE_RGB_MATRIX_STARLIGHT` |Enables `RGB_MATRIX_STARLIGHT` |
|
|`#define ENABLE_RGB_MATRIX_STARLIGHT` |Enables `RGB_MATRIX_STARLIGHT` |
|
||||||
|`#define ENABLE_RGB_MATRIX_STARLIGHT_SMOOTH` |Enables `RGB_MATRIX_STARLIGHT_SMOOTH` |
|
|
||||||
|`#define ENABLE_RGB_MATRIX_STARLIGHT_DUAL_HUE` |Enables `RGB_MATRIX_STARLIGHT_DUAL_HUE` |
|
|`#define ENABLE_RGB_MATRIX_STARLIGHT_DUAL_HUE` |Enables `RGB_MATRIX_STARLIGHT_DUAL_HUE` |
|
||||||
|`#define ENABLE_RGB_MATRIX_STARLIGHT_DUAL_SAT` |Enables `RGB_MATRIX_STARLIGHT_DUAL_SAT` |
|
|`#define ENABLE_RGB_MATRIX_STARLIGHT_DUAL_SAT` |Enables `RGB_MATRIX_STARLIGHT_DUAL_SAT` |
|
||||||
|`#define ENABLE_RGB_MATRIX_RIVERFLOW` |Enables `RGB_MATRIX_RIVERFLOW` |
|
|`#define ENABLE_RGB_MATRIX_RIVERFLOW` |Enables `RGB_MATRIX_RIVERFLOW` |
|
||||||
@ -380,10 +378,6 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
|
|||||||
#define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set
|
#define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set
|
||||||
#define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
|
#define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
|
||||||
#define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
|
#define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
|
||||||
#define RGB_MATRIX_HUE_STEP 8 // The value by which to increment the hue per adjustment action
|
|
||||||
#define RGB_MATRIX_SAT_STEP 16 // The value by which to increment the saturation per adjustment action
|
|
||||||
#define RGB_MATRIX_VAL_STEP 16 // The value by which to increment the brightness per adjustment action
|
|
||||||
#define RGB_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action
|
|
||||||
#define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
|
#define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
|
||||||
#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
||||||
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||||
@ -486,7 +480,7 @@ This example sets the modifiers to be a specific color based on the layer state.
|
|||||||
bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
|
bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
|
||||||
hsv_t hsv = {0, 255, 255};
|
hsv_t hsv = {0, 255, 255};
|
||||||
|
|
||||||
if (get_highest_layer(layer_state|default_layer_state) == 2) {
|
if (layer_state_is(layer_state, 2)) {
|
||||||
hsv = (hsv_t){130, 255, 255};
|
hsv = (hsv_t){130, 255, 255};
|
||||||
} else {
|
} else {
|
||||||
hsv = (hsv_t){30, 255, 255};
|
hsv = (hsv_t){30, 255, 255};
|
||||||
|
@ -97,9 +97,9 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
|
|||||||
|
|
||||||
|Define |Default |Description |
|
|Define |Default |Description |
|
||||||
|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
||||||
|`RGBLIGHT_HUE_STEP` |`8` |The value by which to increment the hue per adjustment action |
|
|`RGBLIGHT_HUE_STEP` |`8` |The number of steps to cycle through the hue by |
|
||||||
|`RGBLIGHT_SAT_STEP` |`17` |The value by which to increment the saturation per adjustment action |
|
|`RGBLIGHT_SAT_STEP` |`17` |The number of steps to increment the saturation by |
|
||||||
|`RGBLIGHT_VAL_STEP` |`17` |The value by which to increment the brightness per adjustment action |
|
|`RGBLIGHT_VAL_STEP` |`17` |The number of steps to increment the brightness by |
|
||||||
|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |
|
|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |
|
||||||
|`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep |
|
|`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep |
|
||||||
|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added |
|
|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added |
|
||||||
|
@ -444,7 +444,7 @@ This setting implies that `RGBLIGHT_SPLIT` is enabled, and will forcibly enable
|
|||||||
#define SPLIT_USB_DETECT
|
#define SPLIT_USB_DETECT
|
||||||
```
|
```
|
||||||
|
|
||||||
Enabling this option changes the startup behavior to listen for an active USB communication to delegate which part is master and which is slave. With this option enabled and active USB communication, then that half assumes it is the master, otherwise it assumes it is the slave.
|
Enabling this option changes the startup behavior to listen for an active USB communication to delegate which part is master and which is slave. With this option enabled and theres's USB communication, then that half assumes it is the master, otherwise it assumes it is the slave.
|
||||||
|
|
||||||
Without this option, the master is the half that can detect voltage on the physical USB connection (VBUS detection).
|
Without this option, the master is the half that can detect voltage on the physical USB connection (VBUS detection).
|
||||||
|
|
||||||
|
@ -4,32 +4,24 @@
|
|||||||
|
|
||||||
The [Open Steno Project](https://www.openstenoproject.org/) has built an open-source program called Plover that provides real-time translation of steno strokes into words and commands. It has an established dictionary and supports
|
The [Open Steno Project](https://www.openstenoproject.org/) has built an open-source program called Plover that provides real-time translation of steno strokes into words and commands. It has an established dictionary and supports
|
||||||
|
|
||||||
## Steno Support in QMK
|
|
||||||
|
|
||||||
There are three ways that QMK keyboards can support steno, with varying degrees of configuration required:
|
|
||||||
|
|
||||||
1. Plover with [Arpeggiation](https://plover.wiki/index.php/Glossary#Arpeggiate) requires no changes to any keyboard and is supported by QMK as well as any other QWERTY keyboard.
|
|
||||||
2. Plover with [NKRO](https://plover.wiki/index.php/Using_a_standard_keyboard_with_Plover#NKRO). If your keyboard supports NKRO in hardware and you have NKRO enabled as a USB endpoint, you can chord with the keyboard. Many devices will arrive stock like this and will require no changes.
|
|
||||||
3. Steno Machine Protocols. This requires the most configuration, but this has the advantage of allowing you to use your keyboard keys normally (either on another layer or another piece of hardware) without enabling and disabling your steno software.
|
|
||||||
|
|
||||||
## Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}
|
## Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}
|
||||||
|
|
||||||
Plover can work with any standard QWERTY keyboard, although it is more efficient if the keyboard supports NKRO (n-key rollover) to allow Plover to see all the pressed keys at once. An example keymap for Plover can be found in `planck/keymaps/default`. Switching to the `PLOVER` layer adjusts the position of the keyboard to support the number bar.
|
Plover can work with any standard QWERTY keyboard, although it is more efficient if the keyboard supports NKRO (n-key rollover) to allow Plover to see all the pressed keys at once. An example keymap for Plover can be found in `planck/keymaps/default`. Switching to the `PLOVER` layer adjusts the position of the keyboard to support the number bar.
|
||||||
|
|
||||||
To enable NKRO, add `NKRO_ENABLE = yes` in your `rules.mk` and make sure to press `NK_ON` to turn it on because `NKRO_ENABLE = yes` merely adds the possibility of switching to NKRO mode but it doesn't automatically switch to it. If you want to automatically switch, add `#define NKRO_DEFAULT_ON true` in your `config.h`.
|
To enable NKRO, add `NKRO_ENABLE = yes` in your `rules.mk` and make sure to press `NK_ON` to turn it on because `NKRO_ENABLE = yes` merely adds the possibility of switching to NKRO mode but it doesn't automatically switch to it. If you want to automatically switch, add `#define FORCE_NKRO` in your `config.h`.
|
||||||
|
|
||||||
You may also need to adjust your layout, either in QMK or in Plover, if you have anything other than a standard layout. You may also want to purchase some steno-friendly keycaps to make it easier to hit multiple keys.
|
You may also need to adjust your layout, either in QMK or in Plover, if you have anything other than a standard layout. You may also want to purchase some steno-friendly keycaps to make it easier to hit multiple keys.
|
||||||
|
|
||||||
## Plover with Steno Protocol {#plover-with-steno-protocol}
|
## Plover with Steno Protocol {#plover-with-steno-protocol}
|
||||||
|
|
||||||
Plover also understands the language of several steno machines. QMK can speak a couple of these languages: TX Bolt and GeminiPR. An example layout can be found in `splitography/keymaps/default`.
|
Plover also understands the language of several steno machines. QMK can speak a couple of these languages: TX Bolt and GeminiPR. An example layout can be found in `planck/keymaps/steno`.
|
||||||
|
|
||||||
When QMK speaks to Plover over a steno protocol, Plover will not use the keyboard as input. This means that you can switch back and forth between a standard keyboard and your steno keyboard, or even switch layers from Plover to standard and back without needing to activate/deactivate Plover.
|
When QMK speaks to Plover over a steno protocol, Plover will not use the keyboard as input. This means that you can switch back and forth between a standard keyboard and your steno keyboard, or even switch layers from Plover to standard and back without needing to activate/deactivate Plover.
|
||||||
|
|
||||||
In this mode, Plover expects to speak with a steno machine over a serial port so QMK will present itself to the operating system as a virtual serial port in addition to a keyboard.
|
In this mode, Plover expects to speak with a steno machine over a serial port so QMK will present itself to the operating system as a virtual serial port in addition to a keyboard.
|
||||||
|
|
||||||
::: info
|
::: info
|
||||||
Due to hardware limitations, you might not be able to run both a virtual serial port and other features (mouse keys, NKRO, or MIDI support) at the same time. You will likely encounter a compile time error if this is the case. Disable those other features as necessary.
|
Note: Due to hardware limitations, you might not be able to run both a virtual serial port and mouse emulation at the same time.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
@ -164,7 +156,7 @@ At the end of this scenario given as an example, `chord` would have five bits se
|
|||||||
## Keycode Reference {#keycode-reference}
|
## Keycode Reference {#keycode-reference}
|
||||||
|
|
||||||
::: info
|
::: info
|
||||||
TX Bolt does not support the full set of keys. The TX Bolt implementation in QMK will map the GeminiPR keys to the nearest TX Bolt key so that one key map will work for both.
|
Note: TX Bolt does not support the full set of keys. The TX Bolt implementation in QMK will map the GeminiPR keys to the nearest TX Bolt key so that one key map will work for both.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|GeminiPR|TX Bolt|Steno Key|
|
|GeminiPR|TX Bolt|Steno Key|
|
||||||
|
@ -170,6 +170,20 @@ typedef struct {
|
|||||||
uint16_t held;
|
uint16_t held;
|
||||||
} tap_dance_tap_hold_t;
|
} tap_dance_tap_hold_t;
|
||||||
|
|
||||||
|
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
||||||
|
tap_dance_action_t *action;
|
||||||
|
|
||||||
|
switch (keycode) {
|
||||||
|
case TD(CT_CLN): // list all tap dance keycodes with tap-hold configurations
|
||||||
|
action = &tap_dance_actions[QK_TAP_DANCE_GET_INDEX(keycode)];
|
||||||
|
if (!record->event.pressed && action->state.count && !action->state.finished) {
|
||||||
|
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
|
||||||
|
tap_code16(tap_hold->tap);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
void tap_dance_tap_hold_finished(tap_dance_state_t *state, void *user_data) {
|
void tap_dance_tap_hold_finished(tap_dance_state_t *state, void *user_data) {
|
||||||
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)user_data;
|
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)user_data;
|
||||||
|
|
||||||
@ -198,28 +212,11 @@ void tap_dance_tap_hold_reset(tap_dance_state_t *state, void *user_data) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#define ACTION_TAP_DANCE_TAP_HOLD(tap, hold) \
|
#define ACTION_TAP_DANCE_TAP_HOLD(tap, hold) \
|
||||||
{ \
|
{ .fn = {NULL, tap_dance_tap_hold_finished, tap_dance_tap_hold_reset}, .user_data = (void *)&((tap_dance_tap_hold_t){tap, hold, 0}), }
|
||||||
.fn = {NULL, tap_dance_tap_hold_finished, tap_dance_tap_hold_reset}, \
|
|
||||||
.user_data = (void *)&((tap_dance_tap_hold_t){tap, hold, 0}), \
|
|
||||||
}
|
|
||||||
|
|
||||||
tap_dance_action_t tap_dance_actions[] = {
|
tap_dance_action_t tap_dance_actions[] = {
|
||||||
[CT_CLN] = ACTION_TAP_DANCE_TAP_HOLD(KC_COLN, KC_SCLN),
|
[CT_CLN] = ACTION_TAP_DANCE_TAP_HOLD(KC_COLN, KC_SCLN),
|
||||||
};
|
};
|
||||||
|
|
||||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
|
|
||||||
tap_dance_action_t *action;
|
|
||||||
|
|
||||||
switch (keycode) {
|
|
||||||
case TD(CT_CLN): // list all tap dance keycodes with tap-hold configurations
|
|
||||||
action = &tap_dance_actions[QK_TAP_DANCE_GET_INDEX(keycode)];
|
|
||||||
if (!record->event.pressed && action->state.count && !action->state.finished) {
|
|
||||||
tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;
|
|
||||||
tap_code16(tap_hold->tap);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example 4: 'Quad Function Tap-Dance' {#example-4}
|
#### Example 4: 'Quad Function Tap-Dance' {#example-4}
|
||||||
|
@ -50,13 +50,6 @@ By default docker or podman are automatically detected and docker is preferred o
|
|||||||
RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
|
RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
|
||||||
```
|
```
|
||||||
|
|
||||||
If flashing is not required, it's possible to run the container as unprivileged (on Linux), and without docker-machine (on Windows/macOS):
|
|
||||||
|
|
||||||
```
|
|
||||||
SKIP_FLASHING_SUPPORT=1 util/docker_build.sh keyboard:keymap:target
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### Why can't I flash on Windows/macOS
|
### Why can't I flash on Windows/macOS
|
||||||
|
@ -19,8 +19,8 @@ Within the folder `keyboards`, its subfolder `handwired` and its vendor and manu
|
|||||||
* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
|
* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
|
||||||
* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information.
|
* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information.
|
||||||
* `readme.md`: A brief overview of the keyboard.
|
* `readme.md`: A brief overview of the keyboard.
|
||||||
* `<keyboard>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
|
* `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
|
||||||
* `<keyboard>.c`: This file is where you can find custom code for the keyboard.
|
* `<keyboardName>.c`: This file is where you can find custom code for the keyboard.
|
||||||
|
|
||||||
For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines).
|
For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines).
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
# More Detailed `make` Instructions
|
# More Detailed `make` Instructions
|
||||||
|
|
||||||
The full syntax of the `make` command is `<keyboard>:<keymap>:<target>`, where:
|
The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where:
|
||||||
|
|
||||||
* `<keyboard>` is the path of the keyboard, for example `planck`
|
* `<keyboard_folder>` is the path of the keyboard, for example `planck`
|
||||||
* Use `all` to compile all keyboards
|
* Use `all` to compile all keyboards
|
||||||
* Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3`
|
* Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3`
|
||||||
* If the keyboard doesn't have any folders, it can be left out
|
* If the keyboard doesn't have any folders, it can be left out
|
||||||
|
@ -231,7 +231,7 @@ Once you have confirmed that the keyboard is working, if you have used a seperat
|
|||||||
|
|
||||||
If you found this fullfilling you could experiment by adding additional features such as [in switch LEDs](https://geekhack.org/index.php?topic=94258.0), [in switch RGB](https://www.reddit.com/r/MechanicalKeyboards/comments/5s1l5u/photoskeyboard_science_i_made_a_handwired_rgb/), [RGB underglow](https://medium.com/@DavidNZ/hand-wired-custom-keyboard-cdd14429c7b3#.7a1ovebsk) or even an [OLED display!](https://www.reddit.com/r/olkb/comments/5zy7og/adding_ssd1306_oled_display_to_your_build/)
|
If you found this fullfilling you could experiment by adding additional features such as [in switch LEDs](https://geekhack.org/index.php?topic=94258.0), [in switch RGB](https://www.reddit.com/r/MechanicalKeyboards/comments/5s1l5u/photoskeyboard_science_i_made_a_handwired_rgb/), [RGB underglow](https://medium.com/@DavidNZ/hand-wired-custom-keyboard-cdd14429c7b3#.7a1ovebsk) or even an [OLED display!](https://www.reddit.com/r/olkb/comments/5zy7og/adding_ssd1306_oled_display_to_your_build/)
|
||||||
|
|
||||||
There are a lot of possibilities inside the firmware - explore [the documentation](/) for a full feature list, and dive into the different keyboards to see how people use all of them. You can always stop by [the OLKB subreddit](https://reddit.com/r/olkb) or [QMK Discord](https://discord.gg/qmk) for help!
|
There are a lot of possibilities inside the firmware - explore [docs.qmk.fm](https://docs.qmk.fm) for a full feature list, and dive into the different keyboards to see how people use all of them. You can always stop by [the OLKB subreddit](https://reddit.com/r/olkb) or [QMK Discord](https://discord.gg/qmk) for help!
|
||||||
|
|
||||||
## Links to Other Guides
|
## Links to Other Guides
|
||||||
|
|
||||||
|
@ -44,11 +44,7 @@ QMK uses sub-folders both for organization and to share code between revisions o
|
|||||||
qmk_firmware/keyboards/top_folder/sub_1/sub_2/sub_3/sub_4
|
qmk_firmware/keyboards/top_folder/sub_1/sub_2/sub_3/sub_4
|
||||||
```
|
```
|
||||||
|
|
||||||
If a sub-folder has a `keyboard.json` file it will be considered a compilable keyboard. It will be available in QMK Configurator and tested with `make all`. If you are using a folder to organize several keyboards from the same maker you should not have a `keyboard.json` file.
|
If a sub-folder has a `rules.mk` file it will be considered a compilable keyboard. It will be available in QMK Configurator and tested with `make all`. If you are using a folder to organize several keyboards from the same maker you should not have a `rules.mk` file.
|
||||||
|
|
||||||
::: tip
|
|
||||||
When configuring a keyboard with multiple revisions (like the `clueboard/66` example below), an `info.json` file at the top keyboard level (eg. `clueboard/66`) should be used for configuration shared between revisions. Then `keyboard.json` in each revision directory containing revision-specific configuration, and indicating a buildable keyboard.
|
|
||||||
:::
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
@ -56,49 +52,35 @@ Clueboard uses sub-folders for both purposes, organization and keyboard revision
|
|||||||
|
|
||||||
* [`qmk_firmware`](https://github.com/qmk/qmk_firmware/tree/master)
|
* [`qmk_firmware`](https://github.com/qmk/qmk_firmware/tree/master)
|
||||||
* [`keyboards`](https://github.com/qmk/qmk_firmware/tree/master/keyboards)
|
* [`keyboards`](https://github.com/qmk/qmk_firmware/tree/master/keyboards)
|
||||||
* [`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) ← This is the organization folder, there's no `keyboard.json` file
|
* [`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) ← This is the organization folder, there's no `rules.mk` file
|
||||||
* [`60`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/60) ← This is a compilable keyboard - it has a `keyboard.json` file
|
* [`60`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/60) ← This is a compilable keyboard, it has a `rules.mk` file
|
||||||
* [`66`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66) ← This is not a compilable keyboard - a revision must be specified
|
* [`66`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66) ← This is also compilable- it uses `DEFAULT_FOLDER` to specify `rev3` as the default revision
|
||||||
* [`rev1`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev1) ← compilable: `make clueboard/66/rev1`
|
* [`rev1`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev1) ← compilable: `make clueboard/66/rev1`
|
||||||
* [`rev2`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev2) ← compilable: `make clueboard/66/rev2`
|
* [`rev2`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev2) ← compilable: `make clueboard/66/rev2`
|
||||||
* [`rev3`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev3) ← compilable: `make clueboard/66/rev3`
|
* [`rev3`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev3) ← compilable: `make clueboard/66/rev3` or `make clueboard/66`
|
||||||
|
|
||||||
## Keyboard Folder Structure
|
## Keyboard Folder Structure
|
||||||
|
|
||||||
Your keyboard should be located in `qmk_firmware/keyboards/` and the folder name should be your keyboard's name as described in the previous section. Inside this folder should be several files, some of which are optional:
|
Your keyboard should be located in `qmk_firmware/keyboards/` and the folder name should be your keyboard's name as described in the previous section. Inside this folder should be several files:
|
||||||
|
|
||||||
* `readme.md`
|
* `readme.md`
|
||||||
* `keyboard.json` (or `info.json`)
|
* `info.json`
|
||||||
* `config.h`
|
* `config.h`
|
||||||
* `rules.mk`
|
* `rules.mk`
|
||||||
* `<keyboard>.c`
|
* `<keyboard_name>.c`
|
||||||
* `<keyboard>.h`
|
* `<keyboard_name>.h`
|
||||||
|
|
||||||
### `readme.md`
|
### `readme.md`
|
||||||
|
|
||||||
All projects need to have a `readme.md` file that explains what the keyboard is, who made it and where it's available. If applicable, it should also contain links to more information, such as the maker's website. Please follow the [published template](documentation_templates#keyboard-readmemd-template).
|
All projects need to have a `readme.md` file that explains what the keyboard is, who made it and where it's available. If applicable, it should also contain links to more information, such as the maker's website. Please follow the [published template](documentation_templates#keyboard-readmemd-template).
|
||||||
|
|
||||||
### `keyboard.json`/`info.json`
|
### `info.json`
|
||||||
|
|
||||||
The `keyboard.json` file is necessary for your keyboard (or keyboard revision) to be considered a buildable keyboard. The same content is valid in both `info.json` and `keyboard.json`. For the available configuration options of this file, see the [reference page](reference_info_json). This file is also used by the [QMK API](https://github.com/qmk/qmk_api), and by the [QMK Configurator](https://config.qmk.fm/) to display a representation of the available layouts of your keyboard.
|
This file is used by the [QMK API](https://github.com/qmk/qmk_api). It contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. You can also set metadata here. For more information see the [reference page](reference_info_json).
|
||||||
|
|
||||||
Additionally, this is where layouts available on your keyboard are defined. If you only have a single layout, it should be named `LAYOUT`. When defining multiple layouts, you should have a base layout, named `LAYOUT_all`, that supports all possible switch positions in your matrix, even if that layout is impossible to build physically. This is the layout that should be used in the `default` keymap. You should then have additional keymaps named `default_<layout>` that configure keymaps for the other layouts. Layout macro names are entirely lowercase, except for the prefix of `LAYOUT`.
|
|
||||||
|
|
||||||
As an example, if you have a 60% PCB that supports ANSI and ISO, you might define the following layouts and keymaps:
|
|
||||||
|
|
||||||
| Layout Name | Keymap Name | Description |
|
|
||||||
|-------------|--------------|------------------------------------------|
|
|
||||||
| LAYOUT_all | default | A layout that supports both ISO and ANSI |
|
|
||||||
| LAYOUT_ansi | default_ansi | An ANSI layout |
|
|
||||||
| LAYOUT_iso | default_iso | An ISO layout |
|
|
||||||
|
|
||||||
::: tip
|
|
||||||
Providing only `LAYOUT_all` is invalid, as is providing a `LAYOUT` when multiple layouts are present.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### `config.h`
|
### `config.h`
|
||||||
|
|
||||||
Some projects will need to have a `config.h` that configures parameters that are not possible to be set in `keyboard.json`. This is not a required file.
|
All projects need to have a `config.h` file that sets things like the matrix size, product name, USB VID/PID, description and other settings. In general, use this file to set essential information and defaults for your keyboard that will always work.
|
||||||
|
|
||||||
The `config.h` files can also be placed in sub-folders, and the order in which they are read is as follows:
|
The `config.h` files can also be placed in sub-folders, and the order in which they are read is as follows:
|
||||||
|
|
||||||
@ -129,7 +111,7 @@ The `post_config.h` file can be used for additional post-processing, depending o
|
|||||||
#define USB_MAX_POWER_CONSUMPTION 400
|
#define USB_MAX_POWER_CONSUMPTION 400
|
||||||
#else
|
#else
|
||||||
// fix iPhone and iPad power adapter issue
|
// fix iPhone and iPad power adapter issue
|
||||||
// iOS devices need less than 100
|
// iOS device need lessthan 100
|
||||||
#define USB_MAX_POWER_CONSUMPTION 100
|
#define USB_MAX_POWER_CONSUMPTION 100
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@ -156,7 +138,7 @@ If you define options using `post_config.h` as in the above example, you should
|
|||||||
|
|
||||||
### `rules.mk`
|
### `rules.mk`
|
||||||
|
|
||||||
This file is typically used to configure hardware drivers (eg. pointing device), or to include additional C files in compilation. This is not a required file.
|
The presence of this file means that the folder is a keyboard target and can be used in `make` commands. This is where you setup the build environment for your keyboard and configure the default set of features.
|
||||||
|
|
||||||
The `rules.mk` file can also be placed in a sub-folder, and its reading order is as follows:
|
The `rules.mk` file can also be placed in a sub-folder, and its reading order is as follows:
|
||||||
|
|
||||||
@ -203,9 +185,9 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
|
|||||||
See `build_keyboard.mk` and `common_features.mk` for more details.
|
See `build_keyboard.mk` and `common_features.mk` for more details.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
### `<keyboard>.c`
|
### `<keyboard_name.c>`
|
||||||
|
|
||||||
This file should contain C code required for the functionality of your keyboard, for example hardware initialisation code, OLED display code, and so on. This file should only contain code necessary for the keyboard to work, and *not* things that should be left to the end user to configure in their keymap. This file is automatically included in compilation if it exists. This is not a required file.
|
This is where you will write custom code for your keyboard. Typically you will write code to initialize and interface with the hardware in your keyboard. If your keyboard consists of only a key matrix with no LEDs, speakers, or other auxiliary hardware this file can be blank.
|
||||||
|
|
||||||
The following functions are typically defined in this file:
|
The following functions are typically defined in this file:
|
||||||
|
|
||||||
@ -214,13 +196,33 @@ The following functions are typically defined in this file:
|
|||||||
* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
|
* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
|
||||||
* `bool led_update_kb(led_t led_state)`
|
* `bool led_update_kb(led_t led_state)`
|
||||||
|
|
||||||
### `<keyboard>.h`
|
### `<keyboard_name.h>`
|
||||||
|
|
||||||
This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard>.c`. The `<keyboard>.c` file should include this file. This is not a required file.
|
This file is used to define the matrix for your keyboard. You should define at least one C macro which translates an array into a matrix representing the physical switch matrix for your keyboard. If it's possible to build your keyboard with multiple layouts you should define additional macros.
|
||||||
|
|
||||||
|
If you have only a single layout you should call this macro `LAYOUT`.
|
||||||
|
|
||||||
|
When defining multiple layouts you should have a base layout, named `LAYOUT_all`, that supports all possible switch positions on your matrix, even if that layout is impossible to build physically. This is the macro you should use in your `default` keymap. You should then have additional keymaps named `default_<layout>` that use your other layout macros. This will make it easier for people to use the layouts you define.
|
||||||
|
|
||||||
|
Layout macro names are entirely lowercase, except for the word `LAYOUT` at the front.
|
||||||
|
|
||||||
|
As an example, if you have a 60% PCB that supports ANSI and ISO you might define the following layouts and keymaps:
|
||||||
|
|
||||||
|
| Layout Name | Keymap Name | Description |
|
||||||
|
|-------------|-------------|-------------|
|
||||||
|
| LAYOUT_all | default | A layout that supports both ISO and ANSI |
|
||||||
|
| LAYOUT_ansi | default_ansi | An ANSI layout |
|
||||||
|
| LAYOUT_iso | default_iso | An ISO layout |
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
Providing only `LAYOUT_all` is invalid - especially when implementing the additional layouts within 3rd party tooling.
|
||||||
|
:::
|
||||||
|
|
||||||
## Image/Hardware Files
|
## Image/Hardware Files
|
||||||
|
|
||||||
In an effort to keep the repo size down we do not accept binary files of any format, with few exceptions. Hosting them elsewhere (such as <https://imgur.com>) and linking them in the `readme.md` is preferred. Hardware files such as plates, cases, and PCBs can be published in a personal repository or elsewhere, and linked to by your keyboard's `readme.md` file.
|
In an effort to keep the repo size down we're no longer accepting binary files of any format, with few exceptions. Hosting them elsewhere (such as <https://imgur.com>) and linking them in the `readme.md` is preferred.
|
||||||
|
|
||||||
|
Hardware files (such as plates, cases, pcb) can be contributed to the [qmk.fm repo](https://github.com/qmk/qmk.fm) and they will be made available on [qmk.fm](https://qmk.fm). Downloadable files are stored in `/<keyboard>/` (name follows the same format as above) which are served at `https://qmk.fm/<keyboard>/`, and pages are generated from `/_pages/<keyboard>/` which are served at the same location (.md files are generated into .html files through Jekyll). Check out the `lets_split` folder for an example.
|
||||||
|
|
||||||
## Keyboard Defaults
|
## Keyboard Defaults
|
||||||
|
|
||||||
@ -230,6 +232,8 @@ Given the amount of functionality that QMK exposes it's very easy to confuse new
|
|||||||
|
|
||||||
[Magic Keycodes](keycodes_magic) and [Command](features/command) are two related features that allow a user to control their keyboard in non-obvious ways. We recommend you think long and hard about if you're going to enable either feature, and how you will expose this functionality. Keep in mind that users who want this functionality can enable it in their personal keymaps without affecting all the novice users who may be using your keyboard as their first programmable board.
|
[Magic Keycodes](keycodes_magic) and [Command](features/command) are two related features that allow a user to control their keyboard in non-obvious ways. We recommend you think long and hard about if you're going to enable either feature, and how you will expose this functionality. Keep in mind that users who want this functionality can enable it in their personal keymaps without affecting all the novice users who may be using your keyboard as their first programmable board.
|
||||||
|
|
||||||
|
By far the most common problem new users encounter is accidentally triggering Bootmagic while they're plugging in their keyboard. They're holding the keyboard by the bottom, unknowingly pressing in alt and spacebar, and then they find that these keys have been swapped on them. We recommend leaving this feature disabled by default, but if you do turn it on consider setting `BOOTMAGIC_KEY_SALT` to a key that is hard to press while plugging your keyboard in.
|
||||||
|
|
||||||
If your keyboard does not have 2 shift keys you should provide a working default for `IS_COMMAND`, even when you have set `COMMAND_ENABLE = no`. This will give your users a default to conform to if they do enable Command.
|
If your keyboard does not have 2 shift keys you should provide a working default for `IS_COMMAND`, even when you have set `COMMAND_ENABLE = no`. This will give your users a default to conform to if they do enable Command.
|
||||||
|
|
||||||
## Custom Keyboard Programming
|
## Custom Keyboard Programming
|
||||||
@ -238,7 +242,7 @@ As documented on [Customizing Functionality](custom_quantum_functions) you can d
|
|||||||
|
|
||||||
## Non-Production/Handwired Projects
|
## Non-Production/Handwired Projects
|
||||||
|
|
||||||
We're happy to accept any project that uses QMK, including handwired ones, but we have a separate `/keyboards/handwired/` folder for them, so the main `/keyboards/` folder doesn't get overcrowded. If a prototype project becomes a production project at some point in the future, we'd be happy to move it to the main `/keyboards/` folder!
|
We're happy to accept any project that uses QMK, including prototypes and handwired ones, but we have a separate `/keyboards/handwired/` folder for them, so the main `/keyboards/` folder doesn't get overcrowded. If a prototype project becomes a production project at some point in the future, we'd be happy to move it to the main `/keyboards/` folder!
|
||||||
|
|
||||||
## Warnings as Errors
|
## Warnings as Errors
|
||||||
|
|
||||||
|
113
docs/keycodes.md
113
docs/keycodes.md
@ -176,11 +176,11 @@ See also: [Basic Keycodes](keycodes_basic)
|
|||||||
|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |✔ |✔ |✔ |
|
|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |✔ |✔ |✔ |
|
||||||
|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |✔ |✔ |✔ |
|
|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |✔ |✔ |✔ |
|
||||||
|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |✔ |✔ |✔ |
|
|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |✔ |✔ |✔ |
|
||||||
|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Super key) |✔ |✔ |✔ |
|
|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |✔ |✔ |✔ |
|
||||||
|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |✔ |✔ |✔ |
|
|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |✔ |✔ |✔ |
|
||||||
|`KC_RIGHT_SHIFT` |`KC_RSFT` |Right Shift |✔ |✔ |✔ |
|
|`KC_RIGHT_SHIFT` |`KC_RSFT` |Right Shift |✔ |✔ |✔ |
|
||||||
|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |✔ |✔ |✔ |
|
|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |✔ |✔ |✔ |
|
||||||
|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Super key) |✔ |✔ |✔ |
|
|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key) |✔ |✔ |✔ |
|
||||||
|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down |✔ |✔<sup>3</sup>|✔ |
|
|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down |✔ |✔<sup>3</sup>|✔ |
|
||||||
|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep |✔ |✔<sup>3</sup>|✔ |
|
|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep |✔ |✔<sup>3</sup>|✔ |
|
||||||
|`KC_SYSTEM_WAKE` |`KC_WAKE` |System Wake | |✔<sup>3</sup>|✔ |
|
|`KC_SYSTEM_WAKE` |`KC_WAKE` |System Wake | |✔<sup>3</sup>|✔ |
|
||||||
@ -404,6 +404,7 @@ See also: [Layer Switching](feature_layers#switching-and-toggling-layers)
|
|||||||
|`DF(layer)` |Set the base (default) layer until the keyboard loses power |
|
|`DF(layer)` |Set the base (default) layer until the keyboard loses power |
|
||||||
|`PDF(layer)` |Set the base (default) layer in EEPROM |
|
|`PDF(layer)` |Set the base (default) layer in EEPROM |
|
||||||
|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
|
|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
|
||||||
|
|`OSL(layer)` |Momentarily activates `layer` until a key is pressed. See [One Shot Keys](one_shot_keys) for details. |
|
||||||
|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. Where `mod` is a mods_bit. Mods can be viewed [here](mod_tap). Example Implementation: `LM(LAYER_1, MOD_LALT)`|
|
|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. Where `mod` is a mods_bit. Mods can be viewed [here](mod_tap). Example Implementation: `LM(LAYER_1, MOD_LALT)`|
|
||||||
|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
|
|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
|
||||||
|`TG(layer)` |Toggle `layer` on or off |
|
|`TG(layer)` |Toggle `layer` on or off |
|
||||||
@ -658,73 +659,57 @@ See also: [Mouse Keys](features/mouse_keys)
|
|||||||
See also: [Modifier Keys](feature_advanced_keycodes#modifier-keys)
|
See also: [Modifier Keys](feature_advanced_keycodes#modifier-keys)
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|----------|----------------------------------|-------------------------------------------------------------------|
|
|----------|----------------------------------|------------------------------------------------------|
|
||||||
|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
|
|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
|
||||||
|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
|
|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
|
||||||
|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
|
|`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` |
|
||||||
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` |
|
|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)` |Hold Left GUI and press `kc` |
|
||||||
|`LCS(kc)` | |Hold Left Control and Left Shift and press `kc` |
|
|
||||||
|`LCA(kc)` | |Hold Left Control and Left Alt and press `kc` |
|
|
||||||
|`LCG(kc)` | |Hold Left Control and Left GUI and press `kc` |
|
|
||||||
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|
|
||||||
|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and Left GUI and press `kc` |
|
|
||||||
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|
|
||||||
|`LCSG(kc)`| |Hold Left Control, Left Shift and Left GUI and press `kc` |
|
|
||||||
|`LCAG(kc)`| |Hold Left Control, Left Alt and Left GUI and press `kc` |
|
|
||||||
|`LSAG(kc)`| |Hold Left Shift, Left Alt and Left GUI and press `kc` |
|
|
||||||
|`RCTL(kc)`| |Hold Right Control and press `kc` |
|
|`RCTL(kc)`| |Hold Right Control and press `kc` |
|
||||||
|`RSFT(kc)`| |Hold Right Shift and press `kc` |
|
|`RSFT(kc)`| |Hold Right Shift and press `kc` |
|
||||||
|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` |
|
|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt (AltGr) and press `kc` |
|
||||||
|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
|
|`RGUI(kc)`|`RCMD(kc)`, `RWIN(kc)` |Hold Right GUI and press `kc` |
|
||||||
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|
|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and Left GUI and press `kc` |
|
||||||
|`RCA(kc)` | |Hold Right Control and Right Alt and press `kc` |
|
|`LAG(kc)` | |Hold Left Alt and Left GUI and press `kc` |
|
||||||
|`RCG(kc)` | |Hold Right Control and Right GUI and press `kc` |
|
|
||||||
|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt and press `kc` |
|
|
||||||
|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
|
|`RSG(kc)` | |Hold Right Shift and Right GUI and press `kc` |
|
||||||
|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
|
|`RAG(kc)` | |Hold Right Alt and Right GUI and press `kc` |
|
||||||
|`RCSG(kc)`| |Hold Right Control, Right Shift and Right GUI and press `kc` |
|
|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
|
||||||
|`RCAG(kc)`| |Hold Right Control, Right Alt and Right GUI and press `kc` |
|
|`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` |
|
||||||
|`RSAG(kc)`| |Hold Right Shift, Right Alt and Right GUI and press `kc` |
|
|`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt (AltGr) and press `kc` |
|
||||||
|`MEH(kc)` | |Hold Left Control, Left Shift and Left Alt and press `kc` |
|
|`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` |
|
||||||
|`HYPR(kc)`| |Hold Left Control, Left Shift, Left Alt and Left GUI and press `kc`|
|
|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
|
||||||
|`KC_MEH` | |Left Control, Left Shift and Left Alt |
|
|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
|
||||||
|`KC_HYPR` | |Left Control, Left Shift, Left Alt and Left GUI |
|
|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc` |
|
||||||
|
|`KC_MEH` | |Left Control, Shift and Alt |
|
||||||
|
|`KC_HYPR` | |Left Control, Shift, Alt and GUI |
|
||||||
|
|
||||||
## Mod-Tap Keys {#mod-tap-keys}
|
## Mod-Tap Keys {#mod-tap-keys}
|
||||||
|
|
||||||
See also: [Mod-Tap](mod_tap)
|
See also: [Mod-Tap](mod_tap)
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|-------------|-----------------------------------------------------------------|---------------------------------------------------------------------------|
|
|-------------|-----------------------------------------------------------------|--------------------------------------------------------------|
|
||||||
|`MT(mod, kc)`| |`mod` when held, `kc` when tapped |
|
|`MT(mod, kc)`| |`mod` when held, `kc` when tapped |
|
||||||
|`LCTL_T(kc)` |`CTL_T(kc)` |Left Control when held, `kc` when tapped |
|
|`LCTL_T(kc)` |`CTL_T(kc)` |Left Control when held, `kc` when tapped |
|
||||||
|`LSFT_T(kc)` |`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
|
|`LSFT_T(kc)` |`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
|
||||||
|`LALT_T(kc)` |`ALT_T(kc)`, `LOPT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
|
|`LALT_T(kc)` |`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
|
||||||
|`LGUI_T(kc)` |`GUI_T(kc)`, `LCMD_T(kc)`, `LWIN_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
|
|`LGUI_T(kc)` |`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
|
||||||
|`LCS_T(kc)` | |Left Control and Left Shift when held, `kc` when tapped |
|
|
||||||
|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped |
|
|
||||||
|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped |
|
|
||||||
|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LCSG_T(kc)` | |Left Control, Left Shift and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LCAG_T(kc)` | |Left Control, Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LSAG_T(kc)` | |Left Shift, Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`RCTL_T(kc)` | |Right Control when held, `kc` when tapped |
|
|`RCTL_T(kc)` | |Right Control when held, `kc` when tapped |
|
||||||
|`RSFT_T(kc)` | |Right Shift when held, `kc` when tapped |
|
|`RSFT_T(kc)` | |Right Shift when held, `kc` when tapped |
|
||||||
|`RALT_T(kc)` |`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
|
|`RALT_T(kc)` |`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt (AltGr) when held, `kc` when tapped |
|
||||||
|`RGUI_T(kc)` |`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
|
|`RGUI_T(kc)` |`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
|
||||||
|
|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
|
||||||
|
|`LAG_T(kc)` | |Left Alt and GUI when held, `kc` when tapped |
|
||||||
|
|`RSG_T(kc)` | |Right Shift and GUI when held, `kc` when tapped |
|
||||||
|
|`RAG_T(kc)` | |Right Alt and GUI when held, `kc` when tapped |
|
||||||
|
|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
|
||||||
|
|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped |
|
||||||
|
|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt (AltGr) when held, `kc` when tapped |
|
||||||
|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
|
|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
|
||||||
|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped |
|
|`LCAG_T(kc)` | |Left Control, Alt and GUI when held, `kc` when tapped |
|
||||||
|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped |
|
|`RCAG_T(kc)` | |Right Control, Alt and GUI when held, `kc` when tapped |
|
||||||
|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt when held, `kc` when tapped |
|
|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
|
||||||
|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped |
|
|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped |
|
||||||
|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped |
|
|`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
|
||||||
|`RCSG_T(kc)` | |Right Control, Right Shift and Right GUI when held, `kc` when tapped |
|
|
||||||
|`RCAG_T(kc)` | |Right Control, Right Alt and Right GUI when held, `kc` when tapped |
|
|
||||||
|`RSAG_T(kc)` | |Right Shift, Right Alt and Right GUI when held, `kc` when tapped |
|
|
||||||
|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped |
|
|
||||||
|`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped|
|
|
||||||
|
|
||||||
## Tapping Term Keys {#tapping-term-keys}
|
## Tapping Term Keys {#tapping-term-keys}
|
||||||
|
|
||||||
@ -817,40 +802,12 @@ See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted)
|
|||||||
See also: [One Shot Keys](one_shot_keys)
|
See also: [One Shot Keys](one_shot_keys)
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|--------------------|---------|---------------------------------------------------------------------|
|
|--------------------|---------|----------------------------------|
|
||||||
|
|`OSM(mod)` | |Hold `mod` for one keypress |
|
||||||
|
|`OSL(layer)` | |Switch to `layer` for one keypress|
|
||||||
|`QK_ONE_SHOT_TOGGLE`|`OS_TOGG`|Toggles One Shot keys status |
|
|`QK_ONE_SHOT_TOGGLE`|`OS_TOGG`|Toggles One Shot keys status |
|
||||||
|`QK_ONE_SHOT_ON` |`OS_ON` |Turns One Shot keys on |
|
|`QK_ONE_SHOT_ON` |`OS_ON` |Turns One Shot keys on |
|
||||||
|`QK_ONE_SHOT_OFF` |`OS_OFF` |Turns One Shot keys off |
|
|`QK_ONE_SHOT_OFF` |`OS_OFF` |Turns One Shot keys off |
|
||||||
|`OSL(layer)` | |Switch to `layer` for one keypress |
|
|
||||||
|`OSM(mod)` | |Hold `mod` for one keypress |
|
|
||||||
|`OS_LCTL` | |Hold Left Control for one keypress |
|
|
||||||
|`OS_LSFT` | |Hold Left Shift for one keypress |
|
|
||||||
|`OS_LALT` | |Hold Left Alt for one keypress |
|
|
||||||
|`OS_LGUI` | |Hold Left GUI for one keypress |
|
|
||||||
|`OS_LCS` | |Hold Left Control and Left Shift for one keypress |
|
|
||||||
|`OS_LCA` | |Hold Left Control and left Alt for one keypress |
|
|
||||||
|`OS_LCG` | |Hold Left Control and Left GUI for one keypress |
|
|
||||||
|`OS_LSA` | |Hold Left Shift and Left Alt for one keypress |
|
|
||||||
|`OS_LSG` | |Hold Left Shift and Left GUI for one keypress |
|
|
||||||
|`OS_LAG` | |Hold Left Alt and Left GUI for one keypress |
|
|
||||||
|`OS_LCSG` | |Hold Left Control, Left Shift and Left GUI for one keypress |
|
|
||||||
|`OS_LCAG` | |Hold Left Control, Left Alt and Left GUI for one keypress |
|
|
||||||
|`OS_LSAG` | |Hold Left Shift, Left Alt and Left GUI for one keypress |
|
|
||||||
|`OS_RCTL` | |Hold Right Control for one keypress |
|
|
||||||
|`OS_RSFT` | |Hold Right Shift for one keypress |
|
|
||||||
|`OS_RALT` | |Hold Right Alt for one keypress |
|
|
||||||
|`OS_RGUI` | |Hold Right GUI for one keypress |
|
|
||||||
|`OS_RCS` | |Hold Right Control and Right Shift for one keypress |
|
|
||||||
|`OS_RCA` | |Hold Right Control and Right Alt for one keypress |
|
|
||||||
|`OS_RCG` | |Hold Right Control and Right GUI for one keypress |
|
|
||||||
|`OS_RSA` | |Hold Right Shift and Right Alt for one keypress |
|
|
||||||
|`OS_RSG` | |Hold Right Shift and Right GUI for one keypress |
|
|
||||||
|`OS_RAG` | |Hold Right Alt and Right GUI for one keypress |
|
|
||||||
|`OS_RCSG` | |Hold Right Control, Right Shift and Right GUI for one keypress |
|
|
||||||
|`OS_RCAG` | |Hold Right Control, Right Alt and Right GUI for one keypress |
|
|
||||||
|`OS_RSAG` | |Hold Right Shift, Right Alt and Right GUI for one keypress |
|
|
||||||
|`OS_MEH` | |Hold Left Control, Left Shift and Left Alt for one keypress |
|
|
||||||
|`OS_HYPR` | |Hold Left Control, Left Shift, Left Alt and Left GUI for one keypress|
|
|
||||||
|
|
||||||
## Programmable Button Support {#programmable-button}
|
## Programmable Button Support {#programmable-button}
|
||||||
|
|
||||||
|
@ -109,15 +109,15 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07
|
|||||||
## Modifiers
|
## Modifiers
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|----------------|-------------------------------|-------------------------------------|
|
|----------------|-------------------------------|------------------------------------|
|
||||||
|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |
|
|`KC_LEFT_CTRL` |`KC_LCTL` |Left Control |
|
||||||
|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |
|
|`KC_LEFT_SHIFT` |`KC_LSFT` |Left Shift |
|
||||||
|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |
|
|`KC_LEFT_ALT` |`KC_LALT`, `KC_LOPT` |Left Alt (Option) |
|
||||||
|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Super key) |
|
|`KC_LEFT_GUI` |`KC_LGUI`, `KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) |
|
||||||
|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |
|
|`KC_RIGHT_CTRL` |`KC_RCTL` |Right Control |
|
||||||
|`KC_RIGHT_SHIFT`|`KC_RSFT` |Right Shift |
|
|`KC_RIGHT_SHIFT`|`KC_RSFT` |Right Shift |
|
||||||
|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
|
|`KC_RIGHT_ALT` |`KC_RALT`, `KC_ROPT`, `KC_ALGR`|Right Alt (Option/AltGr) |
|
||||||
|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Super key)|
|
|`KC_RIGHT_GUI` |`KC_RGUI`, `KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)|
|
||||||
|
|
||||||
## International
|
## International
|
||||||
|
|
||||||
|
@ -1,105 +0,0 @@
|
|||||||
# License Violations
|
|
||||||
|
|
||||||
QMK Firmware has seen its fair share of license violations, which hurts the community and frustrates the QMK maintainers.
|
|
||||||
|
|
||||||
Typical non-compliance includes:
|
|
||||||
|
|
||||||
* Not providing any source code
|
|
||||||
* Providing "crippled" source code, such as a wired-only firmware for a wireless-capable board
|
|
||||||
|
|
||||||
Boards from vendors who don't provide source code are proving to be a significant time sink as the QMK team and other support helpers volunteer their time trying to determine which board someone has before they can help -- and in these cases they can't help. Occasionally this is followed by abuse; something that QMK and its volunteers should not be subjected to, rather redirected to the vendor in question.
|
|
||||||
|
|
||||||
The QMK team now actively directs support requests back to each vendor - vendors must provide their own product support for their boards. The QMK team are volunteers, the vendor must not expect the team to act as their support staff.
|
|
||||||
|
|
||||||
## Offending Vendors
|
|
||||||
|
|
||||||
The QMK team cannot tell you which boards you should or should not purchase, but please consider the lack of license compliance from the following vendors before making your decision. If you wish to look at the boards upstream QMK Firmware currently supports, you can search [here](https://browse.qmk.fm/).
|
|
||||||
|
|
||||||
If you own a board from one of the following vendors already, consider asking them for the equivalent QMK source code if it's not already available. With enough customers demanding corresponding source code, vendors may start to change their policies.
|
|
||||||
|
|
||||||
| Vendor | Reason |
|
|
||||||
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| Ajazz | Selling tri-mode boards based on QMK without sources. |
|
|
||||||
| Alpaca / Apos | Selling wireless boards with "open" source code, but linking against closed-source wireless libraries. Crippled source code already unknowingly merged to QMK. |
|
|
||||||
| Attack Shark | Selling tri-mode boards based on QMK without sources. (Clones of Ajazz?) |
|
|
||||||
| BBB Keyboard | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
|
|
||||||
| Chosfox | Selling L75 wired/wireless boards based on QMK without sources, just `via.json` provided. Raised on discord over multiple weeks without response. |
|
|
||||||
| CIDOO | Selling wired boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| ColorReco | Selling tri-mode boards based on QMK without sources. |
|
|
||||||
| CrossDIY | Selling wired boards based on QMK without sources. |
|
|
||||||
| Darmoshark | Selling wired boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| Epomaker | Lots of historical keyboards with `via.json` but no corresponding sources. Wireless code for a small handful provided, pending core cleanup for QMK upstreaming. Most other boards have source nowhere to be seen. |
|
|
||||||
| Ergokbd (IFKB) | At least their crkbd clone ships with QMK+Vial, seemingly refuses to disclose sources despite multiple customers requesting them. |
|
|
||||||
| iLovBee | Official 30-day copyright source code request issued Sep 11 2024 due to deception on PR, no response received. Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
|
|
||||||
| KiiBOOM | Seems to use the same OEM as Epomaker, same problems. |
|
|
||||||
| kprepublic | Makes no attempt to release source code, all boards in QMK are reverse-engineered, created, and supported by the community. New board variants magically appear without telling customers they're incompatible with existing QMK versions, in some cases bricking boards or requiring ISP flashing. |
|
|
||||||
| Luminkey | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| Meletrix | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| mmd / Smartmmd / i-game.tech | Ambiguity on PRs -- marketing says wireless, PR author said wired-only, then included wireless code anyway. Seemingly intentionally deceptive. |
|
|
||||||
| MyKeyClub | Community-supported JRIS75, vendor was contacted by community members and refused to cooperate. |
|
|
||||||
| owlab | Selling wired based on QMK without sources, just `via.json` provided. Ambiguous as to whether or not wireless firmware is based on QMK, given that their configuration tool looks very similar to VIA. |
|
|
||||||
| pressplayid | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided |
|
|
||||||
| qwertykeys | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| Redragon | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
|
|
||||||
| Riccks | Selling tri-mode boards based on QMK without sources. |
|
|
||||||
| Royal Kludge | PRs for fake boards in order to attain VIA compatibility identified. Lots of other keyboards with `via.json` but no corresponding sources, attempted upstreaming crippled firmware without wireless. Wireless code for some provided, pending core cleanup for QMK upstreaming. PRs including different manufacturer names as well. |
|
|
||||||
| Shenzhen Hangsheng | PR submissions with crippled firmware, debating with maintainers about wireless despite marketing material clearly stating tri-mode. |
|
|
||||||
| Tacworks | Selling tri-mode boards based on QMK, crippled firmware already merged into QMK without wireless without QMK team realising. |
|
|
||||||
| TKD / Vertex | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
|
|
||||||
| WOBKEY | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
|
|
||||||
| Weikav | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| Womier | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
|
|
||||||
| Wuque Studio | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
| XVX | Ambiguity on PRs -- marketing says wireless, PR author said wired-only. Seemingly intentionally deceptive. |
|
|
||||||
| Yunzii | Selling tri-mode boards based on QMK without sources, just `via.json` provided. Refuses to release sources due to proprietary wireless driver, in direct violation of the GPL. |
|
|
||||||
| Zuoya | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
|
|
||||||
|
|
||||||
::: danger Violations
|
|
||||||
Links are not provided above as the QMK team does not wish to inadvertently promote purchases of boards in violation of QMK's license.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Licensing
|
|
||||||
|
|
||||||
QMK Firmware's license requires full disclosure of source code for any firmware which is based on QMK. This includes any of the following scenarios:
|
|
||||||
|
|
||||||
* Use of public QMK Firmware, but with "closed source" privately-held board definitions
|
|
||||||
* Vendor-customised QMK Firmware, which the vendor keeps private for building their own boards
|
|
||||||
* Any other non-QMK firmware which includes portions of QMK Firmware, such as adaptation of `via.c` into any other non-QMK firmware, even if used as a reference when translated to another programming language.
|
|
||||||
|
|
||||||
As per the GPL license requirements, vendors must provide entire source code for the as-shipped firmware.
|
|
||||||
|
|
||||||
QMK has traditionally been lenient with this clause -- providing source code to the QMK community is necessary but reproducing the exact build may not be possible. QMK has required functionally-equivalent source code to be made available. In rare cases exact code may be requested; vendors must keep copies regardless.
|
|
||||||
|
|
||||||
At minimum, vendors must provide the source code through some distribution mechanism. This could potentially be an clearly available downloadable copy of the code online, a fork of QMK Firmware, or even a DVD accompanying the product in the box.
|
|
||||||
|
|
||||||
If sources are unable to be provided in a timely fashion, QMK may revoke the vendor's license, effectively rendering them unable to leverage QMK.
|
|
||||||
|
|
||||||
Vendors choosing to keep things closed-source because of a desire to have a "competitive edge" compared to other vendors is unacceptable to both QMK and the community, and is a breach of the QMK license. There's no reason to do so; any new or interesting vendor-specific feature will be quickly replicated by other vendors or the community anyway.
|
|
||||||
|
|
||||||
## QMK PR Considerations
|
|
||||||
|
|
||||||
Vendors who submit PRs to QMK Firmware whilst not providing full sources for all of their license-violating boards will be put on hold until source code for all violating boards is provided. Intentional deception may result in boards being removed from QMK and all future PRs for that manufacturer being denied outright.
|
|
||||||
|
|
||||||
Submitting crippled source code in order to attain a merge into QMK Firmware to pave the way for VIA support is unacceptable. This includes submitting a wired-only firmware for a wireless-capable board, or any other PR which does not include key features as-advertised.
|
|
||||||
|
|
||||||
Reusing the `VID` and `PID` for multiple boards (such as for two variants, wired and wireless) is an unacceptable scenario as this creates confusion for support. Many customers have flashed boards with the wrong firmware, which could have been avoided if vendors were obvious about their board identification mechanisms.
|
|
||||||
|
|
||||||
If there is sufficient ambiguity about a board, supporting evidence will need to be presented to the QMK team. This may include impartial third parties who can demonstrate a board's existence and can confirm its feature set, such as well-known content producers; popular review sites or notable video creators may be leveraged. If such evidence is unavailable, as a last resort the vendor may be required to ship a fully functional board in full retail packaging to QMK maintainers for verification. Engineering samples will not be accepted, as one-off boards have been deceptively used in the past.
|
|
||||||
|
|
||||||
PRs submitted to upstream QMK should not expect an instant merge just because source code has been provided -- code from OEMs has historically been of a quality lower than QMK standards, so as per the [PR checklist](pr_checklist) submitters should make the changes as small as possible and be prepared to change their implementation.
|
|
||||||
|
|
||||||
## Detection
|
|
||||||
|
|
||||||
If the QMK team identifies or is informed of a license violation from a vendor:
|
|
||||||
|
|
||||||
* Any current and future PRs for that vendor will be indefinitely put on hold, preventing merge into QMK Firmware, thus preventing any out-of-the-box VIA support
|
|
||||||
* Any existing keyboards from the vendor may be removed from QMK Firmware
|
|
||||||
* Vendors will be added to the _offending vendors_ list above
|
|
||||||
|
|
||||||
Repeated violations may result in that vendor being disallowed from contributing the QMK in its entirety. In the worst case, the QMK team may choose to revoke a vendor's license to use QMK Firmware outright.
|
|
||||||
|
|
||||||
## Remediation
|
|
||||||
|
|
||||||
Vendors must provide fully-featured source code for each of their identified violations, matching the feature capabilities of their as-shipped products. This will usually be in their own fork of QMK Firmware while awaiting a merge into upstream.
|
|
||||||
|
|
||||||
Once all identified violations have been remediated, current and future PRs will no longer be on hold and the vendor will be removed from the offending vendors list above.
|
|
@ -2,18 +2,18 @@
|
|||||||
|
|
||||||
The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.
|
The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.
|
||||||
|
|
||||||
The modifiers (`mod`) argument to the `MT()` macro are prefixed with `MOD_`, not `KC_`:
|
The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`:
|
||||||
|
|
||||||
|Modifier |Description |
|
|Modifier |Description |
|
||||||
|----------|----------------------------------------|
|
|----------|----------------------------------------|
|
||||||
|`MOD_LCTL`|Left Control |
|
|`MOD_LCTL`|Left Control |
|
||||||
|`MOD_LSFT`|Left Shift |
|
|`MOD_LSFT`|Left Shift |
|
||||||
|`MOD_LALT`|Left Alt |
|
|`MOD_LALT`|Left Alt |
|
||||||
|`MOD_LGUI`|Left GUI (Windows/Command/Super key) |
|
|`MOD_LGUI`|Left GUI (Windows/Command/Meta key) |
|
||||||
|`MOD_RCTL`|Right Control |
|
|`MOD_RCTL`|Right Control |
|
||||||
|`MOD_RSFT`|Right Shift |
|
|`MOD_RSFT`|Right Shift |
|
||||||
|`MOD_RALT`|Right Alt (AltGr) |
|
|`MOD_RALT`|Right Alt (AltGr) |
|
||||||
|`MOD_RGUI`|Right GUI (Windows/Command/Super key) |
|
|`MOD_RGUI`|Right GUI (Windows/Command/Meta key) |
|
||||||
|`MOD_HYPR`|Hyper (Left Control, Shift, Alt and GUI)|
|
|`MOD_HYPR`|Hyper (Left Control, Shift, Alt and GUI)|
|
||||||
|`MOD_MEH` |Meh (Left Control, Shift, and Alt) |
|
|`MOD_MEH` |Meh (Left Control, Shift, and Alt) |
|
||||||
|
|
||||||
@ -28,37 +28,28 @@ This key would activate Left Control and Left Shift when held, and send Escape w
|
|||||||
For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap:
|
For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap:
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|------------|-----------------------------------------------------------------|---------------------------------------------------------------------------------------|
|
|------------|-----------------------------------------------------------------|--------------------------------------------------------------|
|
||||||
|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
|
|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
|
||||||
|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
|
|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
|
||||||
|`LALT_T(kc)`|`ALT_T(kc)`, `LOPT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
|
|`LALT_T(kc)`|`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped |
|
||||||
|`LGUI_T(kc)`|`GUI_T(kc)`, `LCMD_T(kc)`, `LWIN_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
|
|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
|
||||||
|`LCS_T(kc)` | |Left Control and Left Shift when held, `kc` when tapped |
|
|
||||||
|`LCA_T(kc)` | |Left Control and Left Alt when held, `kc` when tapped |
|
|
||||||
|`LCG_T(kc)` | |Left Control and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LSA_T(kc)` | |Left Shift and Left Alt when held, `kc` when tapped |
|
|
||||||
|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LAG_T(kc)` | |Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LCSG_T(kc)`| |Left Control, Left Shift and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LCAG_T(kc)`| |Left Control, Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`LSAG_T(kc)`| |Left Shift, Left Alt and Left GUI when held, `kc` when tapped |
|
|
||||||
|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
|
|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
|
||||||
|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
|
|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
|
||||||
|`RALT_T(kc)`|`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
|
|`RALT_T(kc)`|`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
|
||||||
|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
|
|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
|
||||||
|
|`LSG_T(kc)` |`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
|
||||||
|
|`LAG_T(kc)` | |Left Alt and GUI when held, `kc` when tapped |
|
||||||
|
|`RSG_T(kc)` | |Right Shift and GUI when held, `kc` when tapped |
|
||||||
|
|`RAG_T(kc)` | |Right Alt and GUI when held, `kc` when tapped |
|
||||||
|
|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
|
||||||
|
|`LSA_T(kc)` | |Left Shift and Alt when held, `kc` when tapped |
|
||||||
|
|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt (AltGr) when held, `kc` when tapped |
|
||||||
|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
|
|`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped |
|
||||||
|`RCA_T(kc)` | |Right Control and Right Alt when held, `kc` when tapped |
|
|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
|
||||||
|`RCG_T(kc)` | |Right Control and Right GUI when held, `kc` when tapped |
|
|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
|
||||||
|`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt when held, `kc` when tapped |
|
|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
|
||||||
|`RSG_T(kc)` | |Right Shift and Right GUI when held, `kc` when tapped |
|
|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped |
|
||||||
|`RAG_T(kc)` | |Right Alt and Right GUI when held, `kc` when tapped |
|
|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
|
||||||
|`RCSG_T(kc)`| |Right Control, Right Shift and Right GUI when held, `kc` when tapped |
|
|
||||||
|`RCAG_T(kc)`| |Right Control, Right Alt and Right GUI when held, `kc` when tapped |
|
|
||||||
|`RSAG_T(kc)`| |Right Shift, Right Alt and Right GUI when held, `kc` when tapped |
|
|
||||||
|`MEH_T(kc)` | |Left Control, Left Shift and Left Alt when held, `kc` when tapped |
|
|
||||||
|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Left Shift, Left Alt and Left GUI when held, `kc` when tapped<sup>1</sup>|
|
|
||||||
|
|
||||||
<sup>1. More information on the Hyper key can be found on [this blog post by Brett Terpstra](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/).</sup>
|
|
||||||
|
|
||||||
## Caveats
|
## Caveats
|
||||||
|
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user