Browse Source

document

tags/v0.6.7^0
wolfv6 7 years ago
parent
commit
256a247011

+ 6
- 0
doc/CHANGELOG.md View File

keybrd version 0.x.x is for initial development. keybrd version 0.x.x is for initial development.
keybrd version 1.0.0 will be released when the public API is stable. keybrd version 1.0.0 will be released when the public API is stable.
0.6.7 (2016-11-21)
------------------
* Enhancements
* change #define SAMPLE_COUNT_MACRO to const SAMPLE_COUNT
* add tutorial_7ab_mapping_layout_to_matix.md
0.6.6 (2016-11-16) 0.6.6 (2016-11-16)
------------------ ------------------
* Enhancements * Enhancements

+ 2
- 3
doc/PLANNED_FEATURES.md View File

Top priority Top priority
------------ ------------
* Add matrix-to-layout mapping (to decouple key matrix from layout)
* Add breadboard keyboard schematics to tutorials
Medium priority Medium priority
--------------- ---------------
* Add breadboard keyboard schematics to tutorials
* Getting user feedback
Low priority Low priority
------------ ------------
* Getting user feedback

+ 1
- 1
library.properties View File

name=keybrd name=keybrd
version=0.6.6
version=0.6.7
author=Wolfram Volpi author=Wolfram Volpi
maintainer=Wolfram Volpi maintainer=Wolfram Volpi
sentence=A library for creating custom-keyboard firmware. sentence=A library for creating custom-keyboard firmware.

+ 1
- 1
src/Row.h View File

#include "Debouncer_Not.h" #include "Debouncer_Not.h"
/* /*
strobePin has one of two formats: todo
strobePin has one of two formats:
* if strobe pin is on uC (strobe for Scanner_uC or Scanner_ShiftRegsRead), * if strobe pin is on uC (strobe for Scanner_uC or Scanner_ShiftRegsRead),
then strobePin is an Arduino pin number connected to this row. then strobePin is an Arduino pin number connected to this row.
* if strobe pin is on I/O expander (strobe for Scanner_IOE), then strobePin is bit pattern, * if strobe pin is on I/O expander (strobe for Scanner_IOE), then strobePin is bit pattern,

+ 1
- 1
tutorials/keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino View File

*/ */
Code_LayerHold l_fn(FN, layerState); Code_LayerHold l_fn(FN, layerState);


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_minus(KEY_MINUS); Code_Sc s_minus(KEY_MINUS);

+ 1
- 1
tutorials/keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino View File

Code_LayerLock l_normal(ALPHA, layerState); Code_LayerLock l_normal(ALPHA, layerState);
Code_LayerLock l_sym(SYM, layerState); Code_LayerLock l_sym(SYM, layerState);


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_minus(KEY_MINUS); Code_Sc s_minus(KEY_MINUS);

+ 1
- 1
tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino View File

*/ */
LayerStateInterface& Key_LayeredKeys::refLayerState = groupState; LayerStateInterface& Key_LayeredKeys::refLayerState = groupState;


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_c(KEY_C); Code_Sc s_c(KEY_C);

+ 1
- 1
tutorials/keybrd_3d_sublayerNestedKeys/keybrd_3d_sublayerNestedKeys.ino View File

*/ */
LayerStateInterface& Key_LayeredKeys1::refLayerState = subgroupState; LayerStateInterface& Key_LayeredKeys1::refLayerState = subgroupState;


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_c(KEY_C); Code_Sc s_c(KEY_C);

+ 1
- 1
tutorials/keybrd_3e_sublayerNestedScSc/keybrd_3e_sublayerNestedScSc.ino View File

*/ */
LayerStateInterface& Key_LayeredScSc::refLayerState = subgroupState; LayerStateInterface& Key_LayeredScSc::refLayerState = subgroupState;


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_c(KEY_C); Code_Sc s_c(KEY_C);

+ 1
- 1
tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino View File

LayerState layerState; LayerState layerState;
Code_LayerHold l_fn(FN, layerState); Code_LayerHold l_fn(FN, layerState);


/* ---------------- SCAN CODES -----------------
/* ----------------- SCANCODES -----------------
The "Sc" in Code_Sc means "scancode". The "Sc" in Code_Sc means "scancode".
When a Code_Sc is pressed, it sends its scancode. When a Code_Sc is pressed, it sends its scancode.
*/ */

+ 1
- 1
tutorials/keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino View File

Code_Shift s_shift(MODIFIERKEY_LEFT_SHIFT); Code_Shift s_shift(MODIFIERKEY_LEFT_SHIFT);
Code_LayerHoldShift l_shift(SHIFT, layerState, s_shift); Code_LayerHoldShift l_shift(SHIFT, layerState, s_shift);


/* ---------------- SCAN CODES -----------------
/* ----------------- SCANCODES -----------------
The "Sc" in Code_Sc means "scancode". The "Sc" in Code_Sc means "scancode".
When a Code_Sc is pressed, it sends its scancode. When a Code_Sc is pressed, it sends its scancode.
*/ */

+ 1
- 1
tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino View File



Code_LayerHold l_fn(FN, layerState); Code_LayerHold l_fn(FN, layerState);


/* ---------------- SCAN CODES -----------------
/* ----------------- SCANCODES -----------------
When a Code_LEDLock object is pressed, it sends its scancode and updates the its LED. When a Code_LEDLock object is pressed, it sends its scancode and updates the its LED.
Scancodes can be one of: KEY_CAPS_LOCK, KEY_SCROLL_LOCK, or KEY_NUM_LOCK. Scancodes can be one of: KEY_CAPS_LOCK, KEY_SCROLL_LOCK, or KEY_NUM_LOCK.
For example, when o_capsLock is pressed, it sends KEY_CAPS_LOCK scancode and updates LED_capsLck. For example, when o_capsLock is pressed, it sends KEY_CAPS_LOCK scancode and updates LED_capsLck.

+ 1
- 1
tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino View File



Code_LayerHold l_fn(FN, layerState); Code_LayerHold l_fn(FN, layerState);


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_c(KEY_C); Code_Sc s_c(KEY_C);

+ 1
- 1
tutorials/keybrd_7b_mapping_multi-layer/keybrd_7b_mapping_multi-layer.ino View File



Code_LayerHold l_fn(FN, layerState); Code_LayerHold l_fn(FN, layerState);


// ---------------- SCAN CODES -----------------
// ----------------- SCANCODES -----------------
Code_Sc s_a(KEY_A); Code_Sc s_a(KEY_A);
Code_Sc s_b(KEY_B); Code_Sc s_b(KEY_B);
Code_Sc s_minus(KEY_MINUS); Code_Sc s_minus(KEY_MINUS);