Привет, Хабр!

Зарегистрировался, чтобы поделиться статьёй о восстановлении работоспособности механической клавиатуры Royal Kludge R87 Pro. Быть может моя статья кому-то поможет в восстановлении своей клавиатуры, используя МК (STM32F103R8T6) или просто я опишу здесь некоторые моменты того, чего не было описано в других статьях на различных ресурсах, в т.ч. и вот здесь - https://habr.com/ru/articles/857914/. т.к. было потрачено очень много для первого раза, благо, свободного времени на её восстановление, хочу поделиться опытом. Не буду писать, как установить qmk на windows и т.д. Так же не буду описывать время на подбор, поиск, ожидание МК. Далее понимания, что это, возможно, не тот МК, т.к. я заказал аналог "stm32f103" - это "ch32f103", и заказ нового, плюс я из-за невнимательности ошибался и заказывал МК на 48 выводов, а еще, оказывается, эти МК могут не работать с кварцем на 12 мгц, установленным на плате, и еще какие-либо ошибки...

Ссылку на статью выше я буду использовать как скелет в написании этой.

ps для решения своих вопросов очень часто прибегал к ai. Но в статье уже будут этапы и готовый результат.

Начало

Итак, имеем клавиатуру Royal Kludge R87 Pro

с дефектом - нажимаешь 1, печатается 1 2 3 4 5, нажимаешь q, печатается q w e r t. И так далее по матрице клавиатуры. Про матрицу чуть ниже опишу. Разобрал клавиатуру, здесь используется МК(микроконтроллер) WB32FQ95RCT6 (кратко - Китай, который практически не найти у нас, да и в сети мало про него информации). Прозвонкой матрицы тестером пришел к выводу, что глючит сам МК, точнее его вывод, т.к. матрица к нему подключается напрямую без всяких диодов, резисторов и т.д. Решил искать аналоги МК, выбор пал на "STM32F103R8T6, МК ARM Cortex-M3 32-Bit 72MHz 64KB FLASH [LQFP-64]". Так же до этого приобретал RP2040zero, припаивался проводами к плате, но решил не применять этот колхоз, когда есть возможность заменить сам контроллер на плате, а к нему уже итак есть все необходимые дорожки. Далее перепаиваю МК. Использовал для выпайки WB32FQ95 фен, а для запаивания STM32F103 использовал паяльник и сплав розе на 92-95 градусов + оплетку(можно использовать многожильный провод) для удаления лишнего припоя

Про матрицу есть ссылка в предыдущей статье. Если кратко, чтобы не использовать 100500 выводов от микроконтроллера на каждую кнопку, придумали матрицу клавиш для экономии выводов. Т.е. есть строчки(ряды), в основном это 6 строк, нумерация в qmk начинается от 0 и заканчивая 5, где в первой нулевой ( 0 ) строке располагаются esc, f1, f2, f3 и так по ряду, далее на ряде 1 располагаются "ё, 1, 2, 3, 4". Ряд по номером 2, тут располагаются tab. q. w. e. r. t и так далее до ряда под цифрой 5, где идет ctrl, win, alt, space и т.д.

Так же есть колонки(столбцы) матрицы по такому же принципу. Отсчет так же начинается с 0. Тут индивидуально для каждого производителя клавиатуры и от количества клавиш в вашей клавиатуре. У меня на 88 клавиш получилось 17 колонок, и так же счет идет от 0 до 16. Для моей клавиатуры я нашел матрицу от производителя, но все равно для таких случаев нужен тестер, т.к. у меня 1 клавиша(точнее, энкодер) была не по этой матрице. Далее все это для удобства зарисовываем на бумаге. Далее я прозваниваю каждую колонку и каждый ряд матрицы, к какому выводу моей МК stm32f103 всё это дело идет:

По итогу каждая колонка(столбец) и каждый ряд(строчка) подключается к выводу МК. Получается у меня 6 строк и 17 столбцов и того 23 вывода.

По итогу матрицы всё это прописываю в файле keyboard.json с физическим расположением клавиш по координатам (x,y), где x это столбец, а y это ряд. Кстати, я так же использовал основу для клавиатуры от "moky88" для создания своей, т.к. расположение кнопок совпадало на 98%. В официальной документации QMK говорится, что координаты 0,0 это визуально левый верхний угол клавиатуры(кнопка ESC), а 224,64 это по диагонали правый нижний угол. Тут опять же, смотря какого размера у вас клавиатура, у меня на клавиатуре это стрелка вправо(см. изображение выше), у вас это может быть Enter. И вот пропорционально на каждую строку/столбец матрицы делятся эти значения.

Прошивка

Как я понял, что для создания прошивки в папке с названием клавиатуры должны использоваться такие файлы:

Забегая вперед сразу приложу содержимое моих файлов, которые получились по итогу рабочей прошивки для МК:

Файл config.h имеет следующий код:

Файл halfconf.h:

Файл mcuconf.h:

Файл rules.mk:

Файл keymap.c, который расположен в "имя_вашей_клавиатуры\keymaps\default"

[1] = LAYOUT(
    _______, KC_MYCM, KC_WHOM, KC_MAIL, KC_CALC, KC_MSEL, KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, _______,
    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RM_ON, RM_HUEU, RM_SATU,
    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RM_PREV, RM_NEXT, RM_TOGG, RM_OFF, RM_HUED, RM_SATD,
    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          RM_OFF,
    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,                   RM_VALU,
    _______, GU_TOGG, _______,                            _______,                            _______, _______, _______, _______, RM_SPDD, RM_VALD, RM_SPDU),

if (caps) {
    writePinLow(A9);   // LED ON (потому что минус на A9)
} else {
    writePinHigh(A9);  // LED OFF
}

            // === ИНДИКАТОР НА B8 ===
            if (keymap_config.no_gui) {
                writePinHigh(B8);    // LED ON (инвертированно)
            } else {
                writePinLow(B8);   // LED OFF
            }
        }
        return false;  // Не посылать GU_TOGG дальше — он чисто управляющий
}

С матрицей разобрался. Компилирую прошивку. Для прошивки МК использую программатор ST LINK Stlink ST-Link V2 (покупал на маркетплейсе). Выводы +3.3, SWDIO, SWCLK, GND (определил тестером) были на плате клавиатуры,

подпаял только ножки для подключения программатора. Заливаю прошивку через STM32CubeProgrammer, подключаю клаву к ПК ииии..... "USB-устройство не опознано". На этом моменте потрачено больше всего времени, пока я не купил дополнительно bluepill на stm32f103 и понял, что всё таки нужно было изначально прошивать сначала загрузчик в stm32f103, а потом прошивку qmk. Что самое интересное, я читал и знал, что на f103 нет встроенного загрузчика, но я думал что qmk сам его "подцепит". В итоге в rules.mk я использовал bootloader - "custom", т.к. отдельный бутлоадер я взял на гитхабе именно generic_boot20_pc13.bin т.к. пин c13 используется для подсветки светодиода на плате bluepill. Этот же bootloader я использовал и для своего мк STM32F103R8T6. После прошивки бутлоадера и скомпилированной прошивки, клавиатура определилась в винде как положено и заработали клавиши.

Далее пошла подсветка.

Подсветка

После того, как у меня заработали все кнопки я стал искать к какому пину у меня подключается подсветка. Светодиоды у меня адресные - ws2812 (в qmk они так же без проблем поддерживаются), где используются 4 пина, плюс, минус, дата+, дата-. Принцип простой. С питанием все понятно. На дата+ светодиод получает код от МК, далее он отрезает свой код и передает дальше через свой дата- на дата+ другого светодиода. Тот делает тоже самое: получает код, отрезает свой и передает дальше и так по цепочке светодиодов в вашей линейке. С помощью тестера определил пин на МК, откуда идет дата+ на светодиоды. Далее записываю, как у меня идет нумерация в линейке светодиодов на плате.

Получилось вот так в файле keymap.c:

У меня получается 88 светодиодов на клавиши + еще по 14 с каждой стороны(лево-право) и еще 5 светодиодов располагаются около индикатора caps и win. И того всего 121 светодиод. Линейка светодиодов от МК у меня начинается с резистора на 390 ом и после идет на клавишу "пробел". Это у меня светодиод под номером 0. Далее по цепочке/змейке на alt, fn,.... Прописываю все это в keymap.c Так же ниже в keymap.c прописывается значение каждого светодиода, где 4 означает что это подсветка клавиши, а 1 это просто подсветка. Так же для работы подсветки нужно прописать в файле rules.mk

RGB_MATRIX_ENABLE = yes
RGB_MATRIX_DRIVER = ws2812

Сами эффекты RGB Matrix можно найти вот здесь в официальной документации. Я использовал 24 эффекта.

Кстати, так же я указывал физическое расположение светодиодов для отдельных видов подсветки. Координаты светодиодов выглядели вот так, где 0 светодиод это "пробел" и располагался он по x,y вот здесь {84,64} и так далее по физическому расположение светодиодов на матрице:

Заливаю прошивку и у меня появляется новый глюк - при нажатии клавиш из столбца на F9, у меня вместо F9 нажимается F1, F2, F3, F4, F5 и так по матрице именно столбца F9. Глюк был именно после подключения подсветки. Так я еще провел некоторое время в поисках какого-либо лишнего резистора/диода на плате и было решено пересадить подсветку на другой вывод МК, путём подпаивания тонкой жилы от другого незадействованного вывода в прошивке МК к резистору 390 ом и отрезания дорожки от предыдущего вывода.

Теперь все заработало как надо, нет никаких глюков. Остается дело за малым, настроить слои клавиатуры через FN, подключить энкодер, индикатор caps. А так же чтобы работали мультимедийные клавиши(громкость+ и -, открытие браузера/калькулятора, пауза\стоп и т.д.)

Еще время...

С энкодером(крутилкой звука) тоже ушло у меня время. Пины самого энкодера я прописал сразу в config.h, но звук не хотел регулироваться. В итоге нужно было прописать в rules.mk EXTRAKEY_ENABLE = yes , после чего громкость звука начала регулироваться и остальные мультимедийные клавиши так же заработали, но на энкодере так же есть нажатие, что должно отключать звук. Опять взял тестер. Оказывается, визуально энкодер находится в 0 строке и 16 столбце, а его выводы, именно как кнопка нажатия, физически находятся на 3 строке и 14 столбце.

Пришлось еще раз корректировать keyboard.json с добавлением строки {"matrix": [3,14], "x": 196, "y": 39}, и убиранием строки {"matrix": [0,16], "x": 224, "y": 0}, Далее был момент с индикатором capslock. Индикатор (светодиод) есть и подключен напрямую к МК, а он не работает. Был использован код (в начале статьи описание keymap.c про вывод МК A9)

С добавлением второго слоя клавиатуры трудностей, как таковых, никаких не было. Копирую слой 0 в слой под номером 1, ненужные клавиши заменяю на ______. Оставляю только то, что будет активно при зажатой клавиши FN.

Изначально на нулевом слое на кнопку FN назначается параметр MO(1), где можно будет как раз таки использовать доп. кнопки второго слоя(он под номером 1 идет в qmk), а так же переключиться еще на 3 слой клавиатуры и т.д., если бы я его создавал и использовал, но мне не было в этом необходимости. (пример слоев и их переключение со значением клавиш можете посмотреть в moky88, ссылка выше)

Так же на плате клавиатуры совместно с WB32FQ95RCT6 была флешка spi 25d40, но в моём случае она осталась не задействованной. Физически я её оставил, но в коде для smt32f103 я нигде не упоминал её.

Финал

Итак, после всего проделанного, клавиатура имеет право на вторую жизнь, если даже не вечную(МК, как и свитчи, можно поменять, всё для этого есть). Все свои изначальные и основные функции клавиатура выполняет, работают все кнопки, так же подсветка с различными режимами. А что еще надо? А вот что! - в идеале использоваться другой МК stm32 с поддержкой встроенного бутлоадера, где можно будет назначить кнопку (обычно Esc, для перехода в режим загрузки прошивки).

А на этом все. Надеюсь, кому-нибудь это будет интересно и полезно.

P.S. сама клава, я считаю, не стоит своих финансов даже при условии, что не отказал бы вывод МК. Да, тут свитчи практически бесшумные и есть быстрая их замена, но они не прозрачные, и как и кейкапы - не подсвечивают само значение клавиши.