From 256a2470117961e46a58bfa9989b3ec4f5b48382 Mon Sep 17 00:00:00 2001 From: wolfv6 Date: Mon, 21 Nov 2016 06:13:44 -0700 Subject: [PATCH] document --- doc/CHANGELOG.md | 6 ++++++ doc/PLANNED_FEATURES.md | 5 ++--- library.properties | 2 +- src/Row.h | 2 +- .../keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino | 2 +- .../keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino | 2 +- tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino | 2 +- .../keybrd_3d_sublayerNestedKeys.ino | 2 +- .../keybrd_3e_sublayerNestedScSc.ino | 2 +- tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino | 2 +- .../keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino | 2 +- tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino | 2 +- tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino | 2 +- .../keybrd_7b_mapping_multi-layer.ino | 2 +- 14 files changed, 20 insertions(+), 15 deletions(-) diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index 40eb3f8..3168f25 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -6,6 +6,12 @@ This project adheres to [Semantic Versioning 2.0.0](http://semver.org/). keybrd version 0.x.x is for initial development. 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) ------------------ * Enhancements diff --git a/doc/PLANNED_FEATURES.md b/doc/PLANNED_FEATURES.md index fbdf6fb..4a560a3 100644 --- a/doc/PLANNED_FEATURES.md +++ b/doc/PLANNED_FEATURES.md @@ -2,12 +2,11 @@ planned_features is a view of where the keybrd project is headed. Top priority ------------ -* Add matrix-to-layout mapping (to decouple key matrix from layout) +* Add breadboard keyboard schematics to tutorials Medium priority --------------- -* Add breadboard keyboard schematics to tutorials +* Getting user feedback Low priority ------------ -* Getting user feedback diff --git a/library.properties b/library.properties index 0d1a12d..6f15ff9 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=keybrd -version=0.6.6 +version=0.6.7 author=Wolfram Volpi maintainer=Wolfram Volpi sentence=A library for creating custom-keyboard firmware. diff --git a/src/Row.h b/src/Row.h index 391ac48..5d4c8d5 100644 --- a/src/Row.h +++ b/src/Row.h @@ -10,7 +10,7 @@ #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), 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, diff --git a/tutorials/keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino b/tutorials/keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino index 974315e..c2792a5 100644 --- a/tutorials/keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino +++ b/tutorials/keybrd_3a_multi-layerHold/keybrd_3a_multi-layerHold.ino @@ -62,7 +62,7 @@ and layerState restores the active layer to default layerId 0 (NORMAL). */ Code_LayerHold l_fn(FN, layerState); -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_minus(KEY_MINUS); diff --git a/tutorials/keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino b/tutorials/keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino index 9339aae..bd5d299 100644 --- a/tutorials/keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino +++ b/tutorials/keybrd_3b_multi-layerLock/keybrd_3b_multi-layerLock.ino @@ -53,7 +53,7 @@ When l_sym is pressed, SYM becomes the active layer. Code_LayerLock l_normal(ALPHA, layerState); Code_LayerLock l_sym(SYM, layerState); -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_minus(KEY_MINUS); diff --git a/tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino b/tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino index 1ba64d3..a0b5598 100644 --- a/tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino +++ b/tutorials/keybrd_3c_sublayerNull/keybrd_3c_sublayerNull.ino @@ -53,7 +53,7 @@ Thus groupState manages a layer group delineated by all layers in Key_LayeredKey */ LayerStateInterface& Key_LayeredKeys::refLayerState = groupState; -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_c(KEY_C); diff --git a/tutorials/keybrd_3d_sublayerNestedKeys/keybrd_3d_sublayerNestedKeys.ino b/tutorials/keybrd_3d_sublayerNestedKeys/keybrd_3d_sublayerNestedKeys.ino index 1088360..2cd3d1c 100644 --- a/tutorials/keybrd_3d_sublayerNestedKeys/keybrd_3d_sublayerNestedKeys.ino +++ b/tutorials/keybrd_3d_sublayerNestedKeys/keybrd_3d_sublayerNestedKeys.ino @@ -76,7 +76,7 @@ subgroupState manages a layer group delineated by all layers that are in Key_Lay */ LayerStateInterface& Key_LayeredKeys1::refLayerState = subgroupState; -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_c(KEY_C); diff --git a/tutorials/keybrd_3e_sublayerNestedScSc/keybrd_3e_sublayerNestedScSc.ino b/tutorials/keybrd_3e_sublayerNestedScSc/keybrd_3e_sublayerNestedScSc.ino index 1e64205..c885b14 100644 --- a/tutorials/keybrd_3e_sublayerNestedScSc/keybrd_3e_sublayerNestedScSc.ino +++ b/tutorials/keybrd_3e_sublayerNestedScSc/keybrd_3e_sublayerNestedScSc.ino @@ -60,7 +60,7 @@ subgroupState manages a layer group delineated by all layers that are in Key_Lay */ LayerStateInterface& Key_LayeredScSc::refLayerState = subgroupState; -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_c(KEY_C); diff --git a/tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino b/tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino index e1f3127..1bb64ed 100644 --- a/tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino +++ b/tutorials/keybrd_3f_autoShift/keybrd_3f_autoShift.ino @@ -45,7 +45,7 @@ enum layerIds { NORMAL, FN }; LayerState layerState; Code_LayerHold l_fn(FN, layerState); -/* ---------------- SCAN CODES ----------------- +/* ----------------- SCANCODES ----------------- The "Sc" in Code_Sc means "scancode". When a Code_Sc is pressed, it sends its scancode. */ diff --git a/tutorials/keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino b/tutorials/keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino index ccb146a..2b8e98d 100644 --- a/tutorials/keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino +++ b/tutorials/keybrd_3g_shift_pairings/keybrd_3g_shift_pairings.ino @@ -46,7 +46,7 @@ LayerState layerState; Code_Shift s_shift(MODIFIERKEY_LEFT_SHIFT); Code_LayerHoldShift l_shift(SHIFT, layerState, s_shift); -/* ---------------- SCAN CODES ----------------- +/* ----------------- SCANCODES ----------------- The "Sc" in Code_Sc means "scancode". When a Code_Sc is pressed, it sends its scancode. */ diff --git a/tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino b/tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino index 08f4814..75a4fc1 100644 --- a/tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino +++ b/tutorials/keybrd_5a_LED_on_uC/keybrd_5a_LED_on_uC.ino @@ -55,7 +55,7 @@ LayerState_LED layerState(prtsLayerLEDs); 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. 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. diff --git a/tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino b/tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino index 43a3d48..66c77e9 100644 --- a/tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino +++ b/tutorials/keybrd_5b_LED_on_IOE/keybrd_5b_LED_on_IOE.ino @@ -68,7 +68,7 @@ LayerState_LED layerState(prtsLayerLEDs); Code_LayerHold l_fn(FN, layerState); -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_c(KEY_C); diff --git a/tutorials/keybrd_7b_mapping_multi-layer/keybrd_7b_mapping_multi-layer.ino b/tutorials/keybrd_7b_mapping_multi-layer/keybrd_7b_mapping_multi-layer.ino index 9dc6f55..946e301 100644 --- a/tutorials/keybrd_7b_mapping_multi-layer/keybrd_7b_mapping_multi-layer.ino +++ b/tutorials/keybrd_7b_mapping_multi-layer/keybrd_7b_mapping_multi-layer.ino @@ -41,7 +41,7 @@ LayerState layerState; Code_LayerHold l_fn(FN, layerState); -// ---------------- SCAN CODES ----------------- +// ----------------- SCANCODES ----------------- Code_Sc s_a(KEY_A); Code_Sc s_b(KEY_B); Code_Sc s_minus(KEY_MINUS);