Merge pull request #90 from thomasrussellmurphy/master
Spellcheck of README.md and Documentation
This commit is contained in:
tmk
commit
a35cf0e458
14
README.md
14
README.md
@ -33,7 +33,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
|
||||
### converter
|
||||
* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
|
||||
* [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
|
||||
* [m0110_usb](converter/m0110_usb) - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
|
||||
* [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
|
||||
* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
|
||||
* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
|
||||
* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
|
||||
@ -91,7 +91,7 @@ See [doc/keymap.md](doc/keymap.md).
|
||||
|
||||
|
||||
|
||||
Magic Comannds
|
||||
Magic Commands
|
||||
--------------
|
||||
To see help press `Magic` + `H`.
|
||||
|
||||
@ -122,7 +122,7 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
|
||||
**TBD**
|
||||
|
||||
### Boot Magic Configuration - Virtual DIP Switch
|
||||
Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
|
||||
Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
|
||||
Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
|
||||
|
||||
To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [common/bootmagic.h](common/bootmagic.h).
|
||||
@ -142,7 +142,7 @@ To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be
|
||||
|
||||
#### Keymap
|
||||
- Swap Control and CapsLock(`Left Control`)
|
||||
- Change CapsLock to Control(`Casp Lock`)
|
||||
- Change CapsLock to Control(`Caps Lock`)
|
||||
- Swap LeftAlt and Gui(`Left Alt`)
|
||||
- Swap RightAlt and Gui(`Right Alt`)
|
||||
- Disable Gui(`Left Gui`)
|
||||
@ -211,7 +211,7 @@ Architecture
|
||||
|
||||
|
||||
|
||||
Debuging
|
||||
Debugging
|
||||
--------
|
||||
Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
|
||||
|
||||
@ -228,7 +228,7 @@ Files and Directories
|
||||
* converter/ - protocol converter projects
|
||||
* doc/ - documents
|
||||
* common.mk - Makefile for common
|
||||
* protoco.mk - Makefile for protocol
|
||||
* protocol.mk - Makefile for protocol
|
||||
* rules.mk - Makefile for build rules
|
||||
|
||||
### Common
|
||||
@ -264,7 +264,7 @@ Files and Directories
|
||||
|
||||
|
||||
|
||||
Conding Style
|
||||
Coding Style
|
||||
-------------
|
||||
- Doesn't use Tab to indent, use 4-spaces instead.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ dfj's NKRO(2010/06)
|
||||
http://geekhack.org/showthread.php?p=204389#post204389
|
||||
|
||||
|
||||
Terminogy
|
||||
Terminology
|
||||
---------
|
||||
NKRO
|
||||
ghost
|
||||
@ -26,7 +26,7 @@ membrane
|
||||
OS Support Status
|
||||
-----------------
|
||||
USB NKRO is possible *without* a custom driver.
|
||||
At least following OSes supports.
|
||||
At least following OS's supports.
|
||||
Windows7 64bit
|
||||
WindowsXP
|
||||
Windows2000 SP4
|
||||
@ -37,7 +37,7 @@ At least following OSes supports.
|
||||
Custom Driver for USB NKRO
|
||||
--------------------------
|
||||
NOT NEEDED
|
||||
at least when using fllowing report formats on Windows, Linux or MacOSX.
|
||||
at least when using following report formats on Windows, Linux or MacOSX.
|
||||
|
||||
|
||||
USB NKRO methods
|
||||
@ -47,8 +47,8 @@ USB NKRO methods
|
||||
If the keyboard has 2 virtual keyboard with Standard report(6KRO), it gets 12KRO.
|
||||
Using this method means the keyboard is a composite device.
|
||||
|
||||
2. Exteded report
|
||||
It needs large report size for this method to achive NKRO.
|
||||
2. Extended report
|
||||
It needs large report size for this method to achieve NKRO.
|
||||
If a keyboard has 101keys, it needs 103byte report. It seems to be inefficient.
|
||||
|
||||
3. Bitmap report
|
||||
@ -122,8 +122,8 @@ Considerations
|
||||
Compatibility
|
||||
boot protocol
|
||||
minor/old system
|
||||
Some BIOS doesn't send SET_PROTCOL request, a keyboard can't switch to boot protocol mode.
|
||||
This may cuase a problem on a keyboard which uses other report than Standard.
|
||||
Some BIOS doesn't send SET_PROTOCOL request, a keyboard can't switch to boot protocol mode.
|
||||
This may cause a problem on a keyboard which uses other report than Standard.
|
||||
Reactivity
|
||||
USB polling time
|
||||
OS/Driver processing time
|
||||
|
||||
10
doc/build.md
10
doc/build.md
@ -71,14 +71,14 @@ Or to program with `dfu-programmer` run:
|
||||
#### FLIP GUI tutorial
|
||||
1. On menu bar click Device -> Select, then. `ATmega32u4`.
|
||||
2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
|
||||
At this point you'll see greyouted widgets on the app get colored and ready.
|
||||
At this point you'll see grey-outed widgets on the app get colored and ready.
|
||||
|
||||
3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
|
||||
4. On 'Operations Flow' panel click 'Run' button to load the firmware binary to the chip. Note that you should keep 'Erase', 'Blank Check', 'Program' and 'Verify' check boxes selected.
|
||||
5. Re-plug USB cord or click 'Start Application' button to restart your controller.
|
||||
Done.
|
||||
|
||||
See also these instaructions if you need.
|
||||
See also these instructions if you need.
|
||||
|
||||
- <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
|
||||
- <http://www.atmel.com/Images/doc7769.pdf>
|
||||
@ -95,7 +95,7 @@ Or use this command if you have command line version of Teensy Loader installed.
|
||||
|
||||
|
||||
### 4. Program with Other programmer
|
||||
You may want to use other programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
|
||||
You may want to use other programmer like `avrdude` with AVRISPmkII, Arduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
|
||||
|
||||
$ make -f Makefile.<variant> program
|
||||
|
||||
@ -135,7 +135,7 @@ Optional. Note that ***comment out*** to disable them.
|
||||
#BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
|
||||
|
||||
### 3. Programmer
|
||||
Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teesy Loader`.
|
||||
Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teensy Loader`.
|
||||
|
||||
# avrdude with AVRISPmkII
|
||||
PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
|
||||
@ -158,7 +158,7 @@ Config.h Options
|
||||
|
||||
/* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
|
||||
#define CAPSLOCK_LOCKING_ENABLE
|
||||
/* Locking CapsLock resynchronize hack */
|
||||
/* Locking CapsLock re-synchronize hack */
|
||||
#define CAPSLOCK_LOCKING_RESYNC_ENABLE
|
||||
|
||||
### 3. Disable Debug and Print
|
||||
|
||||
@ -68,7 +68,7 @@ On the other hand, you shall change `layer_state` to overlay base layer with som
|
||||
Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
|
||||
|
||||
You can place `KC_TRNS` on overlay layer changes just part of layout to fall back on lower or base layer.
|
||||
Key with `KC_TRANS` doen't has its own keycode and refers to lower valid layers for keycode, instead.
|
||||
Key with `KC_TRANS` doesn't has its own keycode and refers to lower valid layers for keycode, instead.
|
||||
See example below.
|
||||
|
||||
|
||||
@ -155,12 +155,12 @@ You can find other keymap definitions in file `keymap.c` located on project dire
|
||||
|
||||
|
||||
## 1. Keycode
|
||||
See [`common/keycode.h`](../common/keycode.h) or keycode table below for the detail. Keycode is internal **8bit code** to inidicate action performed on key in keymap. Keycode has `KC_` prefixed symbol respectively. Most of keycodes like `KC_A` have simple action registers key to host on press and unregister on release, while some of other keycodes has some special actions like `Fn` keys, Media contorl keys, System control keys and Mousekeys.
|
||||
See [`common/keycode.h`](../common/keycode.h) or keycode table below for the detail. Keycode is internal **8bit code** to indicate action performed on key in keymap. Keycode has `KC_` prefixed symbol respectively. Most of keycodes like `KC_A` have simple action registers key to host on press and unregister on release, while some of other keycodes has some special actions like `Fn` keys, Media control keys, System control keys and Mousekeys.
|
||||
|
||||
***In `KEYMAP()` macro you should omit prefix part `KC_` of keycode to keep keymap compact.*** For example, just use `A` instead you place `KC_A` in `KEYMAP()`. Some keycodes has 4-letter **short name** in addition to descriptive name, you'll prefer short one in `KEYMAP()`.
|
||||
|
||||
### 1.0 Other key
|
||||
- `KC_NO` for no aciton
|
||||
- `KC_NO` for no action
|
||||
- `KC_TRNS` for layer transparency (See above)
|
||||
|
||||
### 1.1 Normal key
|
||||
@ -192,7 +192,7 @@ There are 8 modifiers which has discrimination between left and right.
|
||||
- `KC_WSCH`, `KC_WHOM`, `KC_WBAK`, `KC_WFWD`, `KC_WSTP`, `KC_WREF`, `KC_WFAV` for web browser operation
|
||||
|
||||
### 1.5 Fn key
|
||||
`KC_FNnn` are keycodes for `Fn` key which not given any actions at the beginning unlike most of keycodes has its own inborn action. To use these keycodes in `KEYMAP()` you need to assign action you want at first. Action of `Fn` key is defined in `fn_actions[]` and its index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` keyocde indicates the action defined in first element of the array. ***32 `Fn` keys can be defined at most.***
|
||||
`KC_FNnn` are keycodes for `Fn` key which not given any actions at the beginning unlike most of keycodes has its own inborn action. To use these keycodes in `KEYMAP()` you need to assign action you want at first. Action of `Fn` key is defined in `fn_actions[]` and its index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` keycode indicates the action defined in first element of the array. ***32 `Fn` keys can be defined at most.***
|
||||
|
||||
### 1.6 Keycode Table
|
||||
See keycode table in [`doc/keycode.txt`](./keycode.txt) for description of keycodes.
|
||||
@ -205,7 +205,7 @@ There are 8 modifiers which has discrimination between left and right.
|
||||
## 2. Action
|
||||
See [`common/action_code.h`](../common/action_code.h). Action is a **16bit code** and defines function to perform on events of a key like press, release, holding and tapping.
|
||||
|
||||
Most of keys just register 8bit scancode to host, but to support other complex features needs 16bit extended action codes internally. However, using 16bit action codes in keymap results in double size in memory compared to using jsut keycodes. To avoid this waste 8bit keycodes are used in `KEYMAP()` instead of action codes.
|
||||
Most of keys just register 8bit scancode to host, but to support other complex features needs 16bit extended action codes internally. However, using 16bit action codes in keymap results in double size in memory compared to using just keycodes. To avoid this waste 8bit keycodes are used in `KEYMAP()` instead of action codes.
|
||||
|
||||
***You can just use keycodes of `Normal key`, `Modifier`, `Mousekey` and `System & Media key` in keymap*** to indicate corresponding actions instead of using action codes. While ***to use other special actions you should use keycode of `Fn` key defined in `fn_actions[]`.***
|
||||
|
||||
@ -230,7 +230,7 @@ You can define these actions on *'A'* key and *'left shift'* modifier with:
|
||||
#### 2.1.2 Modified key
|
||||
This action is comprised of strokes of modifiers and a key. `Macro` action is needed if you want more complex key strokes.
|
||||
|
||||
Say you want to assign a key to `Shift + 1` to get charactor *'!'* or `Alt + Tab` to switch application windows.
|
||||
Say you want to assign a key to `Shift + 1` to get character *'!'* or `Alt + Tab` to switch application windows.
|
||||
|
||||
ACTION_MODS_KEY(MOD_LSFT, KC_1)
|
||||
ACTION_MODS_KEY(MOD_LALT, KC_TAB)
|
||||
@ -272,7 +272,7 @@ This sets Default Layer to given parameter `layer` and activate it.
|
||||
ACTION_DEFAULT_LAYER(layer)
|
||||
|
||||
|
||||
#### 2.2.2 Momentary Switch
|
||||
#### 2.2.2 Momentary
|
||||
Turns on `layer` momentarily while holding, in other words it activates when key is pressed and deactivate when released.
|
||||
|
||||
ACTION_LAYER_MOMENTARY(layer)
|
||||
@ -342,7 +342,7 @@ Turns on layer only and clear all layer on release..
|
||||
ACTION_LAYER_BIT_XOR(part, bits, on)
|
||||
ACTION_LAYER_BIT_SET(part, bits, on)
|
||||
|
||||
These actions works with prameters as following code.
|
||||
These actions works with parameters as following code.
|
||||
|
||||
uint8_t shift = part*4;
|
||||
uint32_t mask = (bits&0x10) ? ~(0xf<<shift) : 0;
|
||||
@ -368,7 +368,7 @@ Default Layer also has bitwise operations, they are executed when key is release
|
||||
MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END )
|
||||
|
||||
#### 2.3.1 Macro Commands
|
||||
- **I()** change interavl of stroke.
|
||||
- **I()** change interval of stroke.
|
||||
- **D()** press key
|
||||
- **U()** release key
|
||||
- **T()** type key(press and release)
|
||||
@ -377,7 +377,7 @@ Default Layer also has bitwise operations, they are executed when key is release
|
||||
|
||||
#### 2.3.2 Examples
|
||||
|
||||
***TODO: sample impl***
|
||||
***TODO: sample implementation***
|
||||
See `keyboard/hhkb/keymap.c` for sample.
|
||||
|
||||
|
||||
@ -403,7 +403,7 @@ To define tappable `Function` action in keymap use this.
|
||||
|
||||
void keymap_call_function(keyrecord_t *event, uint8_t id, uint8_t opt)
|
||||
|
||||
This C function is called every time key is operated, argument `id` selects action to be performed and `opt` can be used for option. Functon `id` can be 0-255 and `opt` can be 0-15.
|
||||
This C function is called every time key is operated, argument `id` selects action to be performed and `opt` can be used for option. Function `id` can be 0-255 and `opt` can be 0-15.
|
||||
|
||||
`keyrecord_t` is comprised of key event and tap count. `keyevent_t` indicates which and when key is pressed or released. From `tap_count` you can know tap state, 0 means no tap. These information will be used in user function to decide how action of key is performed.
|
||||
|
||||
@ -423,7 +423,7 @@ This C function is called every time key is operated, argument `id` selects acti
|
||||
uint8_t row;
|
||||
} key_t;
|
||||
|
||||
***TODO: sample impl***
|
||||
***TODO: sample implementation***
|
||||
See `keyboard/hhkb/keymap.c` for sample.
|
||||
|
||||
|
||||
@ -462,8 +462,8 @@ This action makes 'Layer 1' active(valid) on key press event and inactive on rel
|
||||
ACTION_LAYER_MOMENTARY(1)
|
||||
|
||||
|
||||
Note that after switching on press the actions on destinaton layer(Layer 1) are perfomed.
|
||||
***Thus you shall need to place an action to go back on destination layer***, or you will be stuck in destination layer without way to get back. Usually you need to palce same action or 'KC_TRNS` on destination layer to get back.
|
||||
Note that after switching on press the actions on destination layer(Layer 1) are performed.
|
||||
***Thus you shall need to place an action to go back on destination layer***, or you will be stuck in destination layer without way to get back. Usually you need to place same action or 'KC_TRNS` on destination layer to get back.
|
||||
|
||||
|
||||
### 3.2 Toggle switching
|
||||
@ -480,7 +480,7 @@ These actions switch a layer only while holding a key but register the key on ta
|
||||
|
||||
ACTION_LAYER_TAP_KEY(2, KC_SCLN)
|
||||
|
||||
With this you can place a layer switching action on normal key like ';' without losing its original key register function. This action allows you to have layer switchig action without necessity of a dedicated key. It means you can have it even on home row of keyboard.
|
||||
With this you can place a layer switching action on normal key like ';' without losing its original key register function. This action allows you to have layer switching action without necessity of a dedicated key. It means you can have it even on home row of keyboard.
|
||||
|
||||
|
||||
|
||||
@ -511,17 +511,17 @@ Layer switching with tap key:
|
||||
|
||||
|
||||
### 4.2 Tap Toggle
|
||||
This is a feature to assign both toggle layer and momentary switch layer action to just same one physical key. It works as mementary layer switch when holding a key but toggle switch with several taps.
|
||||
This is a feature to assign both toggle layer and momentary switch layer action to just same one physical key. It works as momentary layer switch when holding a key but toggle switch with several taps.
|
||||
|
||||
ACTION_LAYER_TAP_TOGGLE(1)
|
||||
|
||||
|
||||
### 4.3 Oneshot Modifier
|
||||
This runs onetime effect swhich modify only on just one following key. It works as normal modifier key when holding down while oneshot modifier when tapping.
|
||||
This runs onetime effects which modify only on just one following key. It works as normal modifier key when holding down while oneshot modifier when tapping.
|
||||
|
||||
ACTION_MODS_ONESHOT(MOD_LSFT)
|
||||
|
||||
Say you want to type 'The', you have to push and hold Shift key before type 't' then release it before type 'h' and 'e', otherwise you'll get 'THe' or 'the' unintentionally. With Oneshot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly here. This mean you can realease Shift before 't' is pressed down.
|
||||
Say you want to type 'The', you have to push and hold Shift key before type 't' then release it before type 'h' and 'e', otherwise you'll get 'THe' or 'the' unintentionally. With Oneshot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly here. This mean you can release Shift before 't' is pressed down.
|
||||
|
||||
Oneshot effect is cancel unless following key is pressed down within `ONESHOT_TIMEOUT` of `config.h`. No timeout when it is `0` or not defined.
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Other Keyboard Firmware Projects
|
||||
- <http://geekhack.org/index.php?topic=19458.0>
|
||||
|
||||
## kbdbabel.org[converter][vintage][protocol][8051]
|
||||
Great resourse of vintage keyboard protocol information and code
|
||||
Great resource of vintage keyboard protocol information and code
|
||||
|
||||
- <http://www.kbdbabel.org/>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user