Skip to content

Commit c79cf09

Browse files
myst729myst729
committed
尝试支持磁轴键盘
1 parent ad7dcd2 commit c79cf09

File tree

7 files changed

+354
-0
lines changed

7 files changed

+354
-0
lines changed

‎keyboard/magnet/Makefile‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 此工程的根目录
2+
ROOT_DIR := ../..
3+
4+
# 特殊目录控制
5+
SDK_ROOT := $(ROOT_DIR)/SDK
6+
TEMPLATE_PATH := $(ROOT_DIR)/template
7+
APP_MAIN_DIR := $(ROOT_DIR)/application/main
8+
TMK_CORE_DIR := $(ROOT_DIR)/tmk/tmk_core
9+
USB_SOURCE_DIR := $(ROOT_DIR)/usb
10+
APP_PROJ_DIR := $(APP_MAIN_DIR)/project
11+
APP_SRC_DIR := $(APP_MAIN_DIR)/src
12+
INC_FOLDERS += .
13+
14+
# 配置文件文件名
15+
CONFIG_H = config.h
16+
CONFIG_H_DIR = .
17+
SRC_FILES += matrix_analog.c keymap_plain.c
18+
19+
include ./rules.mk
20+
21+
purge:
22+
-rm -rf $(OUTPUT_DIR)
23+
24+
go: purge ch554 package merge_bootloader_all
25+
26+
all: default ch554
27+
28+
include $(APP_PROJ_DIR)/kbd.mk
29+
include $(USB_SOURCE_DIR)/usb.mk

‎keyboard/magnet/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# magnet

‎keyboard/magnet/config.h‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
#pragma once
2+
3+
#include <stdint.h>
4+
5+
/* Device */
6+
#define VENDOR_ID 0xDE29
7+
#define PRODUCT_ID 0xD707
8+
#define CONF_VENDOR_ID 0x9A29
9+
#define CONF_PRODUCT_ID 0x9707
10+
#define DEVICE_VER 0x0001
11+
#define MANUFACTURER "Leo Deng"
12+
#define PRODUCT "Magnet"
13+
#define DEVICE_BLE_APPEARANCE BLE_APPEARANCE_HID_KEYBOARD
14+
#define MACADDR_SEPRATOR '_'
15+
16+
/* Key Matrix */
17+
// MUX: RS2522XS16; 1 enable pin, 2 channel pins, 2 analog output pins, 8 analog input pins
18+
#define MUX_COUNT 1
19+
static const uint8_t enable_pin_array[MUX_COUNT] = { 6 }; //mux enable, digital output
20+
#define MUX_CHANNELS 2
21+
static const uint8_t channel_pin_array[MUX_CHANNELS] = { 7, 8 }; // mux channel, digital output
22+
#define MATRIX_ROWS 4 // Used mux channels, max = 2 ^ MUX_CHANNELS
23+
#define MATRIX_COLS 2 // Total mux sig pins, MUX_COUNT * MUX_OUTPUT
24+
static const uint8_t row_pin_array[MATRIX_ROWS] = { 0 }; // fake
25+
static const uint8_t column_pin_array[MATRIX_COLS] = { 4, 5 }; // mux output, analog input
26+
#define DEBOUNCE 5
27+
#define MATRIX_SCAN_DELAY_CYCLE 36
28+
#define WAKE_UP_PIN 12
29+
30+
/* Magnet Switch Value Range */
31+
#define MAGNET_THRESHOLD_TOP 486 // stay still
32+
#define MAGNET_THRESHOLD_LIGHT 430
33+
#define MAGNET_THRESHOLD_DEFAULT 380
34+
#define MAGNET_THRESHOLD_HEAVY 330
35+
#define MAGNET_THRESHOLD_BOTTOM 270 // fully push down
36+
37+
/* Command Key */
38+
#define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KC_LEFT) | MOD_BIT(KC_RGHT)))
39+
40+
/* Power Saving */
41+
#define SLEEP_SLOW_TIMEOUT 15 // 键盘闲置多久后转入慢速扫描模式 (s)
42+
#define SLEEP_OFF_TIMEOUT 600 // 键盘闲置多久后转入自动关机 (s)
43+
#define KEYBOARD_SCAN_INTERVAL 1 // 键盘最小时间单位TICK (ms)
44+
#define KEYBOARD_FAST_SCAN_INTERVAL 10 // 通常模式下，多久扫描一次键盘 (ms)
45+
#define KEYBOARD_SLOW_SCAN_INTERVAL 100 // 慢速模式下，多久扫描一次键盘 (ms)
46+
#define LED_AUTOOFF_TIME 60 // LED自动熄灭时长(s)，设为0则不自动熄灭
47+
#define DYNAMIC_TX_POWER /* 启用自动发射功率调整 */
48+
// #define HIGH_TX_POWER /* 更改发射功率到+4dBm */
49+
50+
/* Extra Features */
51+
#define ENABLE_WATCHDOG /* 启用看门狗 */
52+
#define KEYMAP_STORAGE /* 启用keymap存储 */
53+
#define MACRO_STORAGE /* 启用宏存储功能 */
54+
#define CONFIG_STORAGE /* 启用配置存储功能 */
55+
#define BUTTONLESS_DFU /* 启用免按钮DFU */
56+
57+
/* USB HID */
58+
#define KEYBOARD_EPSIZE 8 /* 键盘上传端点大小，请不要修改 */
59+
#define NKRO_EPSIZE 28 /* 键盘NKRO端点大小，请不要修改 */
60+
61+
/* USB UART */
62+
#define HAS_USB // 启用与CH554的通信支持
63+
#define UART_RXD 26 // UART_RX IO
64+
#define UART_TXD 27 // UART_TX IO
65+
#define UART_BAUDRATE NRF_UART_BAUDRATE_115200 // 通信波特率，请不要修改
66+
67+
/* Battery */
68+
#define BATTERY_ADC_PIN NRF_SAADC_INPUT_AIN0 // 电量检测引脚
69+
#define PIN_CHARGING !UCC1 // CH554的充电检测。当UCC1拉低时表示正在充电
70+
#define PIN_STANDBY !UCC2 // CH554的充电检测。当UCC2拉低时表示充电完成。若不配置则只使用PIN_CHARGING作为是否充电的检测标志

‎keyboard/magnet/keymap_common.h‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#pragma once
2+
3+
#include <stdint.h>
4+
#include "keymap.h"
5+
#include "config.h"
6+
7+
extern const uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
8+
extern const action_t fn_actions[];
9+
10+
#define KEYMAP( \
11+
K00, K01, \
12+
K10, K11, \
13+
K20, K21, \
14+
K30, K31 \
15+
) { \
16+
{ K00, K01 }, \
17+
{ K10, K11 }, \
18+
{ K20, K21 }, \
19+
{ K30, K31 } \
20+
}

‎keyboard/magnet/keymap_plain.c‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#include "keymap_common.h"
2+
#include "keyboard_fn.h"
3+
4+
const uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
5+
KEYMAP(
6+
KC_1, KC_2,
7+
KC_Q, KC_W,
8+
KC_A, KC_S,
9+
KC_Z, KC_FN0
10+
),
11+
KEYMAP(
12+
KC_5, KC_6,
13+
KC_T, KC_Y,
14+
KC_G, KC_H,
15+
KC_B, KC_TRNS
16+
),
17+
};
18+
19+
const action_t fn_actions[] = {
20+
ACTION_LAYER_MOMENTARY(1),
21+
};

‎keyboard/magnet/matrix_analog.c‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
#include <stdbool.h>
2+
#include <stdint.h>
3+
4+
#include "nrf.h"
5+
#include "nrf_delay.h"
6+
#include "nrf_gpio.h"
7+
8+
#include "keyboard_config.h"
9+
#include "adc_convert.h"
10+
#include "ble_keyboard.h"
11+
#include "debug.h"
12+
#include "keyboard_matrix.h"
13+
#include "matrix.h"
14+
#include "print.h"
15+
#include "util.h"
16+
#include "wait.h"
17+
18+
// 行程触发阈值
19+
// TODO 先这样，动态调节的功能后面再加
20+
static uint16_t magnet_threshold = MAGNET_THRESHOLD_DEFAULT;
21+
22+
/* matrix state(1:on, 0:off) */
23+
static matrix_row_t matrix[MATRIX_ROWS];
24+
25+
void init_adc_col_pin(uint8_t pin) {
26+
uint8_t channel_index;
27+
nrf_saadc_input_t analog_input_pin;
28+
// NRF_SAADC_INPUT_AIN0 (P0.02) has been used to detect battery voltage
29+
switch (pin) {
30+
case 3:
31+
channel_index = 1;
32+
analog_input_pin = NRF_SAADC_INPUT_AIN1;
33+
break;
34+
case 4:
35+
channel_index = 2;
36+
analog_input_pin = NRF_SAADC_INPUT_AIN2;
37+
break;
38+
case 5:
39+
channel_index = 3;
40+
analog_input_pin = NRF_SAADC_INPUT_AIN3;
41+
break;
42+
case 28:
43+
channel_index = 4;
44+
analog_input_pin = NRF_SAADC_INPUT_AIN4;
45+
break;
46+
case 29:
47+
channel_index = 5;
48+
analog_input_pin = NRF_SAADC_INPUT_AIN5;
49+
break;
50+
case 30:
51+
channel_index = 6;
52+
analog_input_pin = NRF_SAADC_INPUT_AIN6;
53+
break;
54+
case 31:
55+
channel_index = 7;
56+
analog_input_pin = NRF_SAADC_INPUT_AIN7;
57+
break;
58+
default:
59+
channel_index = -1; // 理论上不可能走到这个分支?
60+
analog_input_pin = NRF_SAADC_INPUT_DISABLED;
61+
}
62+
63+
nrf_saadc_channel_config_t channel_config = {
64+
.resistor_p = NRF_SAADC_RESISTOR_DISABLED,
65+
.resistor_n = NRF_SAADC_RESISTOR_DISABLED,
66+
.gain = NRF_SAADC_GAIN1_2,
67+
.reference = NRF_SAADC_REFERENCE_INTERNAL,
68+
.acq_time = NRF_SAADC_ACQTIME_10US,
69+
.mode = NRF_SAADC_MODE_SINGLE_ENDED,
70+
.burst = NRF_SAADC_BURST_DISABLED,
71+
.pin_p = (nrf_saadc_input_t)(analog_input_pin),
72+
.pin_n = NRF_SAADC_INPUT_DISABLED
73+
};
74+
75+
ret_code_t err_code;
76+
err_code = nrfx_saadc_channel_init(channel_index, &channel_config);
77+
APP_ERROR_CHECK(err_code);
78+
}
79+
80+
/* 初始化键盘阵列 */
81+
void matrix_init(void) {
82+
// 拉低mux使能引脚，启用mux
83+
for (uint_fast8_t i = 0; i < MUX_COUNT; i++) {
84+
nrf_gpio_cfg_output(enable_pin_array[i]);
85+
nrf_gpio_pin_clear(enable_pin_array[i]);
86+
}
87+
88+
// 全部拉高，先选中最后一个通道
89+
for (uint_fast8_t i = 0; i < MUX_CHANNELS; i++) {
90+
nrf_gpio_cfg_output(channel_pin_array[i]);
91+
nrf_gpio_pin_set(channel_pin_array[i]);
92+
}
93+
94+
// 初始化模拟引脚
95+
for (uint_fast8_t i = 0; i < MATRIX_COLS; i++) {
96+
init_adc_col_pin(column_pin_array[i]);
97+
}
98+
99+
// 正常使用时禁用唤醒引脚
100+
nrf_gpio_cfg_default(WAKE_UP_PIN);
101+
}
102+
103+
/* Read all mux sig pins */
104+
matrix_row_t read_cols(void) {
105+
matrix_row_t result = 0;
106+
107+
for (uint_fast8_t c = 0; c < MATRIX_COLS; c++) {
108+
nrf_saadc_value_t adc_val = adc_read_sync(column_pin_array[c]);
109+
110+
if (adc_val < magnet_threshold) {
111+
// Pressed
112+
result |= (1 << c);
113+
} else {
114+
// Released
115+
result &= ~(1 << c);
116+
}
117+
}
118+
119+
return result;
120+
}
121+
122+
/* Select mux channel */
123+
void select_row(uint8_t channel) {
124+
for (uint_fast8_t i = 0; i < MUX_CHANNELS; i++) {
125+
uint8_t state = (channel >> i) & 1;
126+
if (state) {
127+
// set high
128+
nrf_gpio_cfg_output(channel_pin_array[i]);
129+
nrf_gpio_pin_set(channel_pin_array[i]);
130+
} else {
131+
// set low
132+
nrf_gpio_cfg_output(channel_pin_array[i]);
133+
nrf_gpio_pin_clear(channel_pin_array[i]);
134+
}
135+
}
136+
}
137+
138+
static inline void delay_us(void) {
139+
#ifdef __GNUC__
140+
#define __nop() __asm("NOP")
141+
#endif
142+
143+
#ifndef MATRIX_SCAN_DELAY_CYCLE
144+
#define MATRIX_SCAN_DELAY_CYCLE 36
145+
#endif
146+
for (int i = 0; i < MATRIX_SCAN_DELAY_CYCLE; i++) {
147+
__nop(); // 64mhz, 64 cycles = 1us
148+
}
149+
}
150+
151+
uint8_t matrix_scan(void) {
152+
for (uint_fast8_t i = 0; i < MATRIX_ROWS; i++) {
153+
select_row(i);
154+
delay_us(); // wait stable
155+
matrix_row_t cols = read_cols();
156+
matrix[i] = cols;
157+
}
158+
159+
return 1;
160+
}
161+
162+
bool matrix_is_modified(void) {
163+
return true;
164+
}
165+
166+
/* 禁用所有阵列针脚 */
167+
void matrix_deinit(void) {
168+
for (uint_fast8_t i = 0; i < MUX_COUNT; i++) {
169+
nrf_gpio_cfg_default(enable_pin_array[i]);
170+
}
171+
for (uint_fast8_t i = 0; i < MUX_CHANNELS; i++) {
172+
nrf_gpio_cfg_default(channel_pin_array[i]);
173+
}
174+
for (uint_fast8_t i = 0; i < MATRIX_COLS; i++) {
175+
nrf_gpio_cfg_default(column_pin_array[i]);
176+
}
177+
}
178+
179+
/* 阵列准备睡眠 */
180+
void matrix_wakeup_prepare(void) {
181+
// 拉高mux使能引脚，禁用mux
182+
for (uint_fast8_t i = 0; i < MUX_COUNT; i++) {
183+
nrf_gpio_cfg_output(enable_pin_array[i]);
184+
nrf_gpio_pin_set(enable_pin_array[i]);
185+
}
186+
187+
// 禁用其他引脚
188+
for (uint_fast8_t i = 0; i < MUX_CHANNELS; i++) {
189+
nrf_gpio_cfg_default(channel_pin_array[i]);
190+
}
191+
for (uint_fast8_t i = 0; i < MATRIX_COLS; i++) {
192+
nrf_gpio_cfg_default(column_pin_array[i]);
193+
}
194+
195+
// 只保留一个唤醒引脚，上拉即唤醒。
196+
// TODO 考虑用振动开关，或者TTP223电容触摸
197+
nrf_gpio_cfg_sense_input(WAKE_UP_PIN, NRF_GPIO_PIN_PULLDOWN, NRF_GPIO_PIN_SENSE_HIGH);
198+
}

‎keyboard/magnet/rules.mk‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 主控芯片类型：可选 nrf52810 或 nrf52832
2+
NRF_CHIP := nrf52832
3+
4+
# 功能选项：更多可配置项目，请参考doc目录下的相应文档
5+
BOOTMAGIC_ENABLE = no # 启用Bootmagic
6+
BOOTCHECK_ENABLE = no # 启用Bootcheck
7+
EXTRAKEY_ENABLE = yes # 启用媒体键功能
8+
MOUSEKEY_ENABLE = yes # 启用鼠标键功能
9+
USB_6KRO_ENABLE = yes # 启用USB的六键无冲功能
10+
NKRO_ENABLE = yes # 启用USB的全键无冲功能
11+
COMMAND_ENABLE = yes # 启用调试和配置的命令
12+
RGBLIGHT_ENABLE = no # 启用RGB灯
13+
THREE_LED_STATUS = no # 启用键盘运行状态灯
14+
ONBOARD_CMSIS_DAP = yes # 启用板载调试器
15+
NRF52_DISABLE_FPU = yes # 禁用FPU

0 commit comments

Comments
 (0)