Merge branch 'master' of github.com:UltimateHackingKeyboard/firmware

Extend the behavior of keys upon layer changes to keymap changes

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to the [UHK Versioning](VERSIONING.md) conventions.
 
+## [8.5.2] - 2018-10-06
+
+Device Protocol: 4.5.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0
+
+- Don't suppress keys upon keymap change.
+
 ## [8.5.1] - 2018-10-04
 
 Device Protocol: 4.5.0 | Module Protocol: 4.0.0 | User Config: 4.1.0 | Hardware Config: 1.0.0

ISSUE_TEMPLATE

@@ -1 +1,8 @@
-If you're using Karabiner Elements on your Mac, then stop here! Make sure to close Karabiner Elements, then try to reproduce the issue again, even if you think that Karabiner Elements shouldn't be the cause. Karabiner Elements is the source of numerous problems, and we don't want to receive any more reports it causes.
+Before submitting a new issue, make sure to do the following:
+
+1. If you're using Karabiner Elements on your Mac, close it!
+2. Install the latest Agent:
+   https://github.com/UltimateHackingKeyboard/agent/releases/latest
+3. Use Agent to update to the latest firmware:
+   https://github.com/UltimateHackingKeyboard/firmware/releases/latest
+4. Try to reproduce the issue, and only report it if it still persists.

right/src/keymap.c

@@ -5,7 +5,6 @@
 #include "config_parser/parse_keymap.h"
 #include "config_parser/config_globals.h"
 #include "macros.h"
-#include "usb_report_updater.h"
 
 keymap_reference_t AllKeymaps[MAX_KEYMAP_NUM] = {
     {
@@ -25,7 +24,6 @@ void SwitchKeymapById(uint8_t index)
     ValidatedUserConfigBuffer.offset = AllKeymaps[index].offset;
     ParseKeymap(&ValidatedUserConfigBuffer, index, AllKeymapsCount, AllMacrosCount);
     LedDisplay_UpdateText();
-    KeymapChanged = true;
 }
 
 bool SwitchKeymapByAbbreviation(uint8_t length, char *abbrev)

right/src/usb_report_updater.c

@@ -25,8 +25,7 @@ static uint16_t DoubleTapSwitchLayerReleaseTimeout = 200;
 
 static bool activeMouseStates[ACTIVE_MOUSE_STATES_COUNT];
 bool TestUsbStack = false;
-bool KeymapChanged = false;
-static uint8_t layerCache[SLOT_COUNT][MAX_KEY_COUNT_PER_MODULE];
+static key_action_t actionCache[SLOT_COUNT][MAX_KEY_COUNT_PER_MODULE];
 
 volatile uint8_t UsbReportUpdateSemaphore = 0;
 
@@ -335,8 +334,6 @@ static void updateActiveUsbReports(void)
     if (layerChanged) {
         stickyModifiers = 0;
     }
-    bool keymapChangedLastCycle = KeymapChanged;
-    KeymapChanged = false;
     LedDisplay_SetLayer(activeLayer);
 
     if (TestUsbStack) {
@@ -383,16 +380,14 @@ static void updateActiveUsbReports(void)
                     secondaryRoleState = SecondaryRoleState_Triggered;
                     keyState->current = false;
                 } else {
-                    layerCache[slotId][keyId] = activeLayer;
+                    actionCache[slotId][keyId] = CurrentKeymap[activeLayer][slotId][keyId];
                 }
             }
 
-            action = &CurrentKeymap[layerCache[slotId][keyId]][slotId][keyId];
+            action = &actionCache[slotId][keyId];
 
             if (keyState->current) {
-                if ((KeymapChanged || keymapChangedLastCycle) && keyState->previous) {
-                    keyState->suppressed = true;
-                } else if (action->type == KeyActionType_Keystroke && action->keystroke.secondaryRole) {
+                if (action->type == KeyActionType_Keystroke && action->keystroke.secondaryRole) {
                     // Press released secondary role key.
                     if (!keyState->previous && secondaryRoleState == SecondaryRoleState_Released) {
                         secondaryRoleState = SecondaryRoleState_Pressed;

right/src/usb_report_updater.h

@@ -74,7 +74,6 @@
     extern uint32_t UsbReportUpdateCounter;
     extern volatile uint8_t UsbReportUpdateSemaphore;
     extern bool TestUsbStack;
-    extern bool KeymapChanged;
 
 // Functions:
 

scripts/package.json

@@ -15,7 +15,7 @@
     "commander": "^2.11.0",
     "shelljs": "^0.7.8"
   },
-  "firmwareVersion": "8.5.1",
+  "firmwareVersion": "8.5.2",
   "deviceProtocolVersion": "4.5.0",
   "moduleProtocolVersion": "4.0.0",
   "userConfigVersion": "4.1.0",

shared/versions.h

@@ -20,7 +20,7 @@
 
     #define FIRMWARE_MAJOR_VERSION 8
     #define FIRMWARE_MINOR_VERSION 5
-    #define FIRMWARE_PATCH_VERSION 1
+    #define FIRMWARE_PATCH_VERSION 2
 
     #define DEVICE_PROTOCOL_MAJOR_VERSION 4
     #define DEVICE_PROTOCOL_MINOR_VERSION 5