mirror of https://github.com/qmk/qmk_firmware synced 2024-11-17 17:35:30 +00:00

History

Drashna Jaelre 99f3df2893 Add support for 8 buttons to mouse report (#10807 ) * Add support for 8 buttons to mouse report This includes support for 8 buttons in mousekeys. However, this does move the keys around due to the fact that the last mousekey keycode is already 0xFF, so any past that would not work with register_code and the like, breaking them for tap hold keys, encoders, and other features. * Update mouse key docs * Add changes based on feedback * Fix VUSB report size comment Because drashna red gud * Fix typo in action.c * Fix IS_MOUSE_BUTTON check * Change start range for mousekeys so that the end is 0xFF properly * condense mousekeys check		2021-01-28 04:38:34 +11:00
..
common	Add support for 8 buttons to mouse report (#10807 )	2021-01-28 04:38:34 +11:00
protocol	Add support for 8 buttons to mouse report (#10807 )	2021-01-28 04:38:34 +11:00
arm_atsam.mk	arm_atsam: Use PROGRAM_CMD for :flash target if set (#11424 )	2021-01-04 07:30:22 +11:00
avr.mk	[fix] dfu-programmer <0.7 doesn't support --force flag (#10292 )	2020-09-13 02:17:47 +01:00
chibios.mk	Switch to nano specs on ChibiOS builds - Round 2 (#11607 )	2021-01-20 10:27:21 +11:00
common.mk	[Split] Sync Timer feature (#10997 )	2020-12-01 10:04:42 -08:00
make_dfu_header.sh	Missed a couple more `#pragma once`s (#11351 )	2020-12-30 15:44:53 +00:00
native.mk
protocol.mk
readme.md	Remove iWRAP protocol (#9284 )	2020-08-29 14:30:02 -07:00
ring_buffer.h	Change include guards in tmk_core/ and drivers/ to pragma once (#11240 )	2020-12-26 15:56:11 +11:00
rules.mk	Add build debug option to tmk_core/rules.mk (#11324 )	2021-01-06 07:27:10 +09:00

readme.md

TMK Keyboard Firmware Core Library

This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M.

Source code is available here: https://github.com/tmk/tmk_keyboard/tree/master/tmk_core

Updates

2016/02/10

flabbergast's Chibios protocol was merged from https://github.com/flabbergast/tmk_keyboard/tree/chibios. See protocol/chibios/README.md. Chibios protocol supports Cortex-M such as STM32 and Kinetis.

2015/04/22

separated with TMK Keyboard Firmware Collection

Features

These features can be used in your keyboard.

Multi-layer Keymap - Multiple keyboard layouts with layer switching
Mouse key - Mouse control with keyboard
System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
USB NKRO - 248 keys(+ 8 modifiers) simultaneously
PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
User Function - Customizable function of key with writing code
Macro - Very primitive at this time
Keyboard Tricks - Oneshot modifier and modifier with tapping feature
Debug Console - Messages for debug and interaction with firmware
Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
Locking CapsLock - Mechanical switch support for CapsLock
Breathing Sleep LED - Sleep indicator with charm during USB suspend
Backlight - Control backlight levels

TMK Keyboard Firmware Collection

Complete firmwares for various keyboards and protocol converters.

https://github.com/tmk/tmk_keyboard

License

GPLv2 or later. Some protocol files are under Modified BSD License. ChibiOS, LUFA and V-USB stack have their own license respectively.

Build Firmware and Program Controller

See doc/build.md.

Start Your Own Project

TBD

Config.h Options

1. USB vendor/product ID and device description

#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0xBEEF
#define MANUFACTURER    t.m.k.
#define PRODUCT         Macway mod

2. Keyboard matrix configuration

#define MATRIX_ROWS 8
#define MATRIX_COLS 8
#define MATRIX_HAS_GHOST

Architecture

Architecture Diagram
                           +---------------+---------------+-------------+
                           |    Host       |   Keyboard    | Matrix, LED |
   ___________             |-----------+-+ +-------------+ | +-----------|
  /          /| Keys/Mouse | Protocol  |d| | Action      | | | Protocol  |
 /__________/ |<-----------|  LUFA     |r| |  Layer, Tap | | |  Matrix   |
 |.--------.| |   LED      |  V-USB    |i| |-------------| | |  PS/2,IBM |             __________________
 ||        || |----------->|  UART     |v| | Keymap      | | |  ADB,M0110|  Keys      / /_/_/_/_/_/_/_/ /|
 ||  Host  || |  Console   |           |e| | Mousekey    | | |  SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
 ||________||/.<-----------|           |r| | Report      | | |  X68K/PC98| Control  / /_/_/_/_/_/_/_/ / /
 `_========_'/|            |---------------------------------------------|-------->/___ /_______/ ___/ /
 |_o______o_|/             | Sendchar, Print, Debug, Command, ...        |         |_________________|/
                           +---------------------------------------------+              Keyboard

Debugging

Use PJRC's hid_listen to see debug messages. You can use the tool for debug even if firmware use LUFA stack.

You can use xprintf() to display debug info on hid_listen, see common/xprintf.h.

Files and Directories

Top

common/ - common codes
protocol/ - keyboard protocol support
doc/ - documents
common.mk - Makefile for common
protocol.mk - Makefile for protocol
rules.mk - Makefile for build rules

Common

host.h
host_driver.h
keyboard.h
command.h
keymap.h
action.h
keycode.h
matrix.h
led.h
mousekey.h
report.h
debug.h
print.h
bootloader.h
sendchar.h
timer.h
util.h

Keyboard Protocols

lufa/ - LUFA USB stack
vusb/ - Objective Development V-USB
ps2.c - PS/2 protocol
adb.c - Apple Desktop Bus protocol
m0110.c - Macintosh 128K/512K/Plus keyboard protocol
news.c - Sony NEWS keyboard protocol
x68k.c - Sharp X68000 keyboard protocol
serial_soft.c - Asynchronous Serial protocol implemented by software

Coding Style

Doesn't use Tab to indent, use 4-spaces instead.