客制化键盘QMK固件入门-修改keyboard和keymap

客制化键盘，这是一个巨大的坑，形形色色的轴体、外壳、PCB、数据线、键帽、灯效、音效甚至掌托，对于热爱DIY的玩家们来说，确实很吸引人，但再看看价格，只能打扰了。作为一只程序猿，想要玩客制化键盘又玩不起，就只能对着键盘的固件深入研究一番了。在我的前一篇文章中，一步步搭建起了QMK固件在Windows系统中的编译环境，接下来就着手打造自己的键盘固件吧。

建立自己的KEYBOARD 和KEYMAP

在终端中使用命令./util/new_keyboard.sh，输入自己为键盘取的名称（mini01）、使用的芯片（默认AVR）、自己的github用户名，生成自己的KEYBOARD文件夹和配置文件。

再输入./util/new_keymap.sh KEYBOARD NAME，这里的KEYBOARD替换为上一步取的键盘名称mini01，NAME是自己的github用户名，生成自己的KEYMAP示例文件。两条命令中自己的名字主要是为了生成一些文档中的名字部分，让看到键盘文档的广大网友认识你，在意的话就好好想个好名字，不关心的话随意取都可以。

此时可看到在固件目录./keyboards中生成了一个以刚才输入名称（mini01）命名的文件夹，里面有rules.mk、config.h等示例配置文件，文件夹./keyboards/mini01/keymaps中为示例的KEYMAP相关文件。

修改KEYBOARD 和KEYMAP

这里以5个按键的小键盘为例，主控使用Arduino leonardo，为了快速入门，尽量只对固件做最少的修改，先让这个键盘能用起来。

/mini01/rules.mk

rules.mk是用来控制编译选项的文件，在该文件中可打开或关闭一些功能。文件中#号后是注释，为我们解释了相关编译选项的意义。

MCU是键盘所使用的主控型号，目前使用的Arduino leonardo，其主控是Atmega32u4，所以MCU = atmega32u4不用修改，如果使用了其他主控芯片，修改为相应的名称就好，比如MCU = STM32F303。

如果使用ATmel芯片作为主控，需要定义主控芯片使用的bootloader，示例文件中已经列出了可能的bootloader种类，通常使用默认的BOOTLOADER = atmel-dfu即可。如果使用STM32主控，由于STM32主控芯片的bootloader是固化在芯片内部的，仅与前面定义的MCU型号相关，因此注释掉此行即可。其他选项暂时不作修改。

/mini01/config.h

矩阵键盘电路均是将按键开关分为多行多列，这里的行列不是从表面上看到的键帽排列的行列，而是PCB上各个按键组成的矩阵键盘的排列。

MATRIXROWS定义为矩阵键盘的行数，此键盘为2；MATRIXCOLS定义为矩阵键盘的列数，此键盘为3。行列之间通过按键开关和防止按键冲突的二极管连接，这里需要定义二极管的从正极到负极的方向。大多数二极管都是有色环的一方为负极，从上图看，二极管有色环的一方连接到了矩阵键盘的行上，因此方向为列到行，#define DIODE_DIRECTION COL2ROW。

每一行和列分别连接到主控芯片的某一个GPIO（LEONARDO PINOUT中的Port Pin），在config.h文件中主要就是定义这些GPIO的连接情况。MATRIX_ROW_PINS 对应矩阵键盘PCB上每一行连接的GPIO，#define MATRIX_ROW_PINS { D1, D0 }，MATRIX_COL_PINS 对应矩阵键盘PCB上每一列连接的GPIO，#define MATRIX_COL_PINS { D4, C6, D7 }。

/mini01/mini01.h

此文件内定义的宏LAYOUT是一种映射关系，将从正面看键盘的键位布局映射为从透视到键盘背面的矩阵键盘电路连接情况。定义这个宏是为了方便后面的按键功能定义，LAYOUT后紧跟的()括号内，knm的n表示按键在第几行，m表示按键在第几列，排列与正面看的键位布局一致，方便定义功能时对应到相应键位，而不用关心PCB上的电路连接情况。{}括号内，是二维数组形式，必须满足前面定义的行列数，每一行为矩阵键盘电路上连接在一起的一行，如果某行某列无按键，必须使用KC_NO填充。

/mini01/datou/keymap.c

在keymap.c中就可以按照按键的位置来定义功能，对于标准的104键的键盘，普通的功能均可以使用下图的定义。

这里先把键盘定义为两层，第0层按键实现上下左右，第1层按键实现数字1234。

生成的默认文件内也是定义的两层，我们把每一层的名字修改一下，方便识别，当然也可以不修改。

keymaps[][MATRIX_ROWS][MATRIX_ROWS][MATRIX_COLS]就是定义键盘功能的数组了，每一层按键功能使用了一个的LAYOUT来定义功能。MO(NUMBER)表示按住该键时，键盘功能映射为NUMBER这一层，实现数字按键1234的功能。_______表示与n-1层的功能相同（n为按键所在的层），比如下图第1层的_______的功能就是第0层对应位置按键的功能，也就是MO(NUMBER)。

编译固件

至此，这个极其简单的5个按键的键盘固件就修改完了，最后使用命令qmk compile -kb mini01 -km datou编译生成固件，一切顺利。