mkbd65/vial-qmk
Watch
1
0
Fork
You've already forked vial-qmk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge remote-tracking branch 'upstream/master' into develop

Browse source
This commit is contained in:
fauxpark 2022-09-30 05:19:53 +10:00
commit dbb70871fc
87 changed files with 796 additions and 407 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/config_options.md
View file

@ -2,7 +2,17 @@
QMK is nearly infinitely configurable. Wherever possible we err on the side of allowing users to customize their keyboard, even at the expense of code size. That level of flexibility makes for a daunting configuration experience, however.
There are two main types of configuration files in QMK- `config.h` and `rules.mk`. These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
There are three main types of configuration files in QMK:
* `config.h`, which contains various preprocessor directives (`#define`, `#ifdef`)
* `rules.mk`, which contains additional variables
* `info.json`, which is utilized for [data-driven configuration](https://docs.qmk.fm/#/data_driven_config)
This page will only discuss the first two types, `config.h` and `rules.mk`.
?> While not all settings have data-driven equivalents yet, keyboard makers are encouraged to utilize the `info.json` file to set the metadata for their boards when possible. See the [`info.json` Format](https://docs.qmk.fm/#/reference_info_json) page for more details.
These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
* QMK Default
* Keyboard

29
docs/reference_info_json.md
View file

@ -1,12 +1,12 @@
# `info.json`
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.
The information contained in `info.json` is combined with the `config.h` and `rules.mk` files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the [QMK API](https://github.com/qmk/qmk_api), and contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard.
You can create `info.json` files at every level under `qmk_firmware/keyboards/<name>` to specify this metadata. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` specifies more specific information about Clueboard 66%.
You can create `info.json` files at every level under `qmk_firmware/keyboards/<name>`. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` specifies more specific information about Clueboard 66%.
## `info.json` Format
The `info.json` file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
The `info.json` file is a JSON formatted dictionary. The first six keys noted here must be defined in `info.json`, or your keyboard will not be accepted into the QMK repository.
* `keyboard_name`
* A free-form text string describing the keyboard.
@ -20,6 +20,11 @@ The `info.json` file is a JSON formatted dictionary with the following keys avai
* `maintainer`
* GitHub username of the maintainer, or `qmk` for community maintained boards.
* Example: `skullydazed`
* `usb`
* Configure USB VID, PID, and device version. See the [USB](#USB) section for more detail.
There are many more optional keys, some of which are described below. Others may be found by examining `data/schemas`.
* `debounce`
* The amount of time in milliseconds to wait for debounce to happen.
* Default: `5`
@ -33,8 +38,6 @@ The `info.json` file is a JSON formatted dictionary with the following keys avai
* Configure the pins corresponding to columns and rows, or direct pins. See the [Matrix Pins](#matrix-pins) section for more detail.
* `rgblight`
* Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb-lighting) section for more detail.
* `usb`
* Configure USB VID, PID, and other parameters. See the [USB](#USB) section for more detail.
### Layout Format
@ -45,7 +48,7 @@ Within our `info.json` file the `layouts` portion of the dictionary contains sev
### Key Dictionary Format
Each Key Dictionary in a layout describes the physical properties of a key. If you are familiar with the Raw Code for <https://keyboard-layout-editor.com> you will find many of the concepts the same. We re-use the same key names and layout choices wherever possible, but unlike keyboard-layout-editor each key is stateless, inheriting no properties from the keys that came before it.
Each Key Dictionary in a layout describes the physical properties of a key. If you are familiar with the Raw Data for <https://keyboard-layout-editor.com> you will find many of the concepts the same. We re-use the same key names and layout choices wherever possible, but unlike keyboard-layout-editor each key is stateless, inheriting no properties from the keys that came before it.
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
@ -115,7 +118,7 @@ Example:
This section controls basic 2-pin LEDs, which typically pass through keyswitches and are soldered into the PCB, or are placed in PCB sockets.
### Backlight
Enable by setting
Enable by setting
```json
"features": {
@ -155,6 +158,13 @@ Used for indicating Num Lock, Caps Lock, and Scroll Lock. May be soldered in-swi
* The pin that controls the `Caps Lock` LED
* `scroll_lock`
* The pin that controls the `Scroll Lock` LED
* `compose`
* The pin that controls the `Compose` LED
* `kana`
* The pin that controls the `Kana` LED
* `on_state`
* The state of the indicator pins when the LED is "on" - `1` for high, `0` for low
* Default: `1`
Example:
@ -208,7 +218,8 @@ Example:
"saturation_steps": 17,
"brightness_steps": 17,
"animations": {
"all": true
"knight": true,
"rainbow_swirl": true
}
}
}
@ -254,7 +265,7 @@ The device version is a BCD (binary coded decimal) value, in the format `MMmr`,
This section controls the basic [rotary encoder](feature_encoders.md) support.
Enable by setting
Enable by setting
```json
"features": {

8
keyboards/handwired/onekey/blackpill_f401/config.h
View file

@ -18,13 +18,9 @@
#include "config_common.h"
#define MATRIX_COL_PINS { B0 }
#define MATRIX_ROW_PINS { A7 }
#define BACKLIGHT_PIN A0
#define BACKLIGHT_PWM_DRIVER PWMD5
#define BACKLIGHT_PWM_CHANNEL 1
#define RGB_DI_PIN A1
#define ADC_PIN A0
#define RGB_CI_PIN A2

13
keyboards/handwired/onekey/blackpill_f401/info.json
View file

@ -1,3 +1,14 @@
{
"keyboard_name": "Onekey Blackpill STM32F401"
"keyboard_name": "Onekey Blackpill STM32F401",
"development_board": "blackpill_f401",
"matrix_pins": {
"cols": ["B0"],
"rows": ["A7"]
},
"backlight": {
"pin": "A0"
},
"rgblight": {
"pin": "A1"
}
}

7
keyboards/handwired/onekey/blackpill_f401/rules.mk
View file

@ -1,8 +1 @@
# MCU name
MCU = STM32F401
BOARD = BLACKPILL_STM32_F401
# Bootloader selection
BOOTLOADER = stm32-dfu
KEYBOARD_SHARED_EP = yes

8
keyboards/handwired/onekey/blackpill_f411/config.h
View file

@ -18,17 +18,13 @@
#include "config_common.h"
#define MATRIX_COL_PINS { B0 }
#define MATRIX_ROW_PINS { A7 }
#define BACKLIGHT_PIN A0
#define BACKLIGHT_PWM_DRIVER PWMD5
#define BACKLIGHT_PWM_CHANNEL 1
#define RGB_DI_PIN A1
#define ADC_PIN A0
#define RGB_CI_PIN A2
#define SOLENOID_PIN B12
#define SOLENOID_PINS { B12, B13, B14, B15 }
#define SOLENOID_PINS_ACTIVE_STATE { high, high, low }

13
keyboards/handwired/onekey/blackpill_f411/info.json
View file

@ -1,3 +1,14 @@
{
"keyboard_name": "Onekey Blackpill STM32F411"
"keyboard_name": "Onekey Blackpill STM32F411",
"development_board": "blackpill_f411",
"matrix_pins": {
"cols": ["B0"],
"rows": ["A7"]
},
"backlight": {
"pin": "A0"
},
"rgblight": {
"pin": "A1"
}
}

7
keyboards/handwired/onekey/blackpill_f411/rules.mk
View file

@ -1,8 +1 @@
# MCU name
MCU = STM32F411
BOARD = BLACKPILL_STM32_F411
# Bootloader selection
BOOTLOADER = stm32-dfu
KEYBOARD_SHARED_EP = yes

8
keyboards/handwired/onekey/blackpill_f411_tinyuf2/config.h
View file

@ -18,13 +18,9 @@
#include "config_common.h"
#define MATRIX_COL_PINS { B0 }
#define MATRIX_ROW_PINS { A7 }
#define BACKLIGHT_PIN A0
#define BACKLIGHT_PWM_DRIVER PWMD5
#define BACKLIGHT_PWM_CHANNEL 1
#define RGB_DI_PIN A1
#define ADC_PIN A0
#define RGB_CI_PIN A2

15
keyboards/handwired/onekey/blackpill_f411_tinyuf2/info.json
View file

@ -1,3 +1,16 @@
{
"keyboard_name": "Onekey Blackpill STM32F411 TinyUF2"
"keyboard_name": "Onekey Blackpill STM32F411 TinyUF2",
"processor": "STM32F411",
"bootloader": "tinyuf2",
"board": "BLACKPILL_STM32_F411",
"matrix_pins": {
"cols": ["B0"],
"rows": ["A7"]
},
"backlight": {
"pin": "A0"
},
"rgblight": {
"pin": "A1"
}
}

7
keyboards/handwired/onekey/blackpill_f411_tinyuf2/rules.mk
View file

@ -1,8 +1 @@
# MCU name
MCU = STM32F411
BOARD = BLACKPILL_STM32_F411
# Bootloader selection
BOOTLOADER = tinyuf2
KEYBOARD_SHARED_EP = yes

8
keyboards/handwired/onekey/bluepill/config.h
View file

@ -18,13 +18,9 @@
#include "config_common.h"
#define MATRIX_COL_PINS { B0 }
#define MATRIX_ROW_PINS { A7 }
#define BACKLIGHT_PIN A0
#define BACKLIGHT_PWM_DRIVER PWMD2
#define BACKLIGHT_PWM_CHANNEL 1
#define RGB_DI_PIN A1
#define ADC_PIN A0
#define RGB_CI_PIN A2

13
keyboards/handwired/onekey/bluepill/info.json
View file

@ -1,3 +1,14 @@
{
"keyboard_name": "Onekey Bluepill STM32F103"
"keyboard_name": "Onekey Bluepill STM32F103",
"development_board": "bluepill",
"matrix_pins": {
"cols": ["B0"],
"rows": ["A7"]
},
"backlight": {
"pin": "A0"
},
"rgblight": {
"pin": "A1"
}
}

6
keyboards/handwired/onekey/bluepill/rules.mk
View file

@ -1,8 +1,2 @@
# MCU name
MCU = STM32F103
# Bootloader selection
BOOTLOADER = stm32duino
# Enter lower-power sleep mode when on the ChibiOS idle thread
OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE

9
keyboards/handwired/onekey/bluepill_f103c6/config.h
View file

@ -18,18 +18,13 @@
#include "config_common.h"
#define MATRIX_COL_PINS { B0 }
#define MATRIX_ROW_PINS { A7 }
#define UNUSED_PINS
#define BACKLIGHT_PIN A0
#define BACKLIGHT_PWM_DRIVER PWMD2
#define BACKLIGHT_PWM_CHANNEL 1
#define RGB_DI_PIN A1
#define ADC_PIN A0
#define RGB_CI_PIN A2
// This code does not fit into the really small flash of STM32F103x6 together
// with CONSOLE_ENABLE=yes, and the debugging console is probably more
// important for the "okeney" testing firmware. In a real firmware you may be

14
keyboards/handwired/onekey/bluepill_f103c6/info.json
View file

@ -1,3 +1,15 @@
{
"keyboard_name": "Onekey Bluepill STM32F103C6"
"keyboard_name": "Onekey Bluepill STM32F103C6",
"processor": "STM32F103",
"board": "STM32_F103_STM32DUINO",
"matrix_pins": {
"cols": ["B0"],
"rows": ["A7"]
},
"backlight": {
"pin": "A0"
},
"rgblight": {
"pin": "A1"
}
}

4
keyboards/handwired/onekey/bluepill_f103c6/rules.mk
View file

@ -1,12 +1,8 @@
# MCU name
MCU = STM32F103
# Bootloader selection
# Cannot use `BOOTLOADER = stm32duino` due to the need to override
# `MCU_LDSCRIPT`, therefore all parameters need to be specified here manually.
OPT_DEFS += -DBOOTLOADER_STM32DUINO
MCU_LDSCRIPT = STM32F103x6_stm32duino_bootloader
BOARD = STM32_F103_STM32DUINO
BOOTLOADER_TYPE = stm32duino
DFU_ARGS = -d 1EAF:0003 -a 2 -R
DFU_SUFFIX_ARGS = -v 1EAF -p 0003

10
keyboards/handwired/onekey/config.h
View file

@ -17,16 +17,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#pragma once
/* key matrix size */
#define MATRIX_ROWS 1
#define MATRIX_COLS 1
/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5
/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST

6
keyboards/handwired/onekey/elite_c/config.h
View file

@ -18,12 +18,6 @@
#include "config_common.h"
#define MATRIX_COL_PINS { F4 }
#define MATRIX_ROW_PINS { F5 }
#define BACKLIGHT_PIN B6
#define RGB_DI_PIN F6
#define RGB_CI_PIN B1
#define ADC_PIN F6

13
keyboards/handwired/onekey/elite_c/info.json
View file

@ -1,3 +1,14 @@
{
"keyboard_name": "Onekey Elite-C"
"keyboard_name": "Onekey Elite-C",
"development_board": "elite_c",
"matrix_pins": {
"cols": ["F4"],
"rows": ["F5"]
},
"backlight": {
"pin": "B6"
},
"rgblight": {
"pin": "F6"
}
}

Some files were not shown because too many files have changed in this diff Show more