QMK Firmware là phần mềm khá hay dành cho những anh em build bàn phím cơ và muốn tùy chỉnh, nạp firmware cho chiếc bàn phím cơ của mình. Bài viết sau đây sẽ hướng dẫn sử dụng cơ bản QMK Firmware cho những anh em mới bắt đầu chơi phím.
1. Các cài đặt cần thiết để sử dụng cơ bản
1.1 Cài đặt trình chỉnh sửa code: có thể dùng notepad, notepad++, Microsoft visual basic hoặc bất cứ trình chỉnh sửa nào tương tự.
1.2 Cài đặt môi trường biên dịch (build environment)
Dành cho người dùng Windows:
- Tải xuống và cài đặt MSYS2 tại đây: https://www.msys2.org/
2. Có 2 cách để có thể download firmware về máy bằng nhiều cách, phổ biến có 2 cách như sau.
2.1 Download trực tiếp source code tại đây:
https://github.com/qmk/qmk_firmware/releases
Và tiếp tục đọc từ mục 3
2.2 Tạo một account github và fork code về github của mình (khuyên dùng).
- Truy cập github.com vào tạo một tài khoản
- Tải về và cài đặt Github Desktop tại địa chỉ: https://desktop.github.com/
- Sau khi đăng nhập, truy cập qmk trên github tại đường dẫn: https://github.com/qmk/qmk_firmware
- Nhấn chuột vào Fork (khung đỏ) để tự động tạo một bản sao (1) về tài khoản github của mình:
- Khởi động Github desktop và tiến hành đăng nhập.
- Tại cửa sổ chương trình, chọn File -> Clone Repository… (phím tắt Ctrl+Shift+o)
- Tại bảng chọn Clone a repository, chọn thư mục muốn tạo bản sao (1’) trên máy rồi nhấn vào Clone.
Sau khi 1’ đã được tải về. để thuận lợi cho việc thay đổi firmware hãy tạo cho mình một bản sao của 1’ (1’’) – hay còn gọi là nhánh (branch) – để dễ dàng chỉnh sửa và không ảnh hưởng đến bản sao chính (1’).
Để tạo branch. Tại cửa sổ chính, chắc chắn chọn bản sao (1’) muốn tạo nhánh. Nhấn chọn Branch -> New Branch… (phím tắt Ctrl+Shift+N)
Cửa sổ mới hiện ra, đặt tên cho nhánh muốn tạo.
Lưu ý hãy chọn tên dễ gợi nhớ, ví dụ muốn tạo một phím mới có tên ht75 nên đặt tên nhánh là dev_ht75 hoặc mechlovin-dev_ht75.
3. Tạo lập môi trường biên dịch và những khởi tạo đầu tiên
3.1 Tạo lập môi trường biên dịch.
Sau khi tạo xong nhánh, khởi chạy MSYS2, trỏ đến thư mục util trong qmk trên máy
Ví dụ trên máy tính đang lưu thư mục qmk tại ổ E:\Firmware\qmk_firmware gõ ký tự trong cửa sổ terminal như sau:
cd e:/Firmware/qmk_firmware
cd util
Chạy file qmk_install.sh để cài đặt các thư viện:
bash qmk_install.sh
Máy tính sẽ tự động tiến hành cài đặt môi trường phục vụ cho việc biên dịch code ra ngôn ngữ máy.
Sau khi cài đặt xong, hãy cẩn thận đóng lại tất cả cửa sổ và lưu lại công việc khác đang thực hiện dở, khởi động lại máy tính.
3.2 Những khởi tạo đầu tiên
Khởi động MSYS2 trỏ đến thư mục util trong qmk (câu lệnh ở phần 3.1)
Để tạo lập code cho bàn phím mới (pcb, mạch câu dây) tiến hành chạy file new_keyboard.sh D
Tại Keyboard Name đặt tên cho bàn phím. Lưu ý không có ký tự nào viết hoa, có thể phân cách giữa chữ và số bằng dấu gạch dưới.
Tại Keyboard Type chọn avr hoặc ps2avrgb (cho phím bootmapper client)
Tên người tạo code: điền tên bất kỳ ai
Sau khi chọn xong sẽ chương trình sẽ tự khởi tạo code cho bàn phím mới trong thư mục qmk_firmware/keyboards/ht75.
4. Tạo layout bàn phím muốn sử dụng
4.1 Tạo layout trên KLE:
Truy cập KLE tại địa chỉ: http://www.keyboard-layout-editor.com/#/
Tạo cho mình một layout muốn dùng, ví dụ dưới đây lấy layout được tạo sẵn keycool84
Sao chép toàn bộ dữ liệu tại thẻ Raw Data
Mở thẻ duyệt web mới, truy cập kbfirmware.com.
Dễ thấy một khung cho phép chỉnh sửa văn bản, dán toàn bộ dữ liệu raw layout vào ô này và nhấn vào import
Sau khi click import, tại thẻ wiring nhập đúng, chính xác số hàng, cột của bàn phím và chính xác vị trí hàng-cột của từng nút sao cho trùng với ma trận của bạn.
Sau đó tại thẻ pins, chọn đúng pinout (chỉ hỗ trợ vi điều khiển Atmega32u4) trùng với phím của bạn
Sau khi chọn trên máy tính trùng với ma trận và pinout trên pcb và trên mạch câu dây, chọn thẻ settings và chọn save configuration.
5. Chỉnh sửa trực tiếp trên code.
- Sau khi lưu tập tin từ kbfirmware.com, truy cập trang web https://noroadsleft.github.io/kbf_qmk_converter/và nạp tập tin từ kbfirmware sẽ được kết quả như hình
- Truy cập thư mục ht75 đã tạo từ 3.2 mở toàn bộ thư mục trong chương trình biên tập code đã cài đặt từ trước (khuyên dùng ms visual code)
- Sao chép toàn bộ dữ liệu trên KBFirmware Json to QMK Parser và dán đè lên từng file tương ứng trong thư mục ht75
- Dữ liệu trong config.h được đè lên file config.h trong ht75
- rules.mk được đè lên rules.mk trong ht75
- keyboard.c được đè lên ht75.c
- keyboard.h được đè lên ht75.h
- keymap.c được đè lên default/keymap.c
- Sau khỉ dán đè hết dữ liệu, bật cửa sổ msys và dẫn vào thư mục qmk, sau đó tiến hành biên dịch:
- make ht75:default
- câu lệnh sau khi biên dịch và nạp code lên pcb:
- make ht75:default:dfu
- Vũ Quang Nguyên – VKG Viet Nam Keyboard Group
