Merge pull request #949 from gedankenexperimenter/t/qukeys
Add some basic Qukeys testcasespull/950/head
Jesse Vincent
4 years ago
committed by
GitHub
commit
daaad86852
@ -0,0 +1,31 @@
|
|||||||
|
// -*- mode: c++ -*-
|
||||||
|
|
||||||
|
/* Kaleidoscope - Firmware for computer input devices
|
||||||
|
* Copyright (C) 2020 Keyboard.io, Inc.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it under
|
||||||
|
* the terms of the GNU General Public License as published by the Free Software
|
||||||
|
* Foundation, version 3.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||||
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||||
|
* details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along with
|
||||||
|
* this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
|
namespace kaleidoscope {
|
||||||
|
namespace testing {
|
||||||
|
|
||||||
|
constexpr uint16_t QUKEYS_HOLD_TIMEOUT = 200;
|
||||||
|
constexpr uint8_t QUKEYS_OVERLAP_THRESHOLD = 90;
|
||||||
|
constexpr uint8_t QUKEYS_MINIMUM_HOLD_TIME = 10;
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,98 @@
|
|||||||
|
/* -*- mode: c++ -*-
|
||||||
|
* Copyright (C) 2020 Keyboard.io, Inc.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it under
|
||||||
|
* the terms of the GNU General Public License as published by the Free Software
|
||||||
|
* Foundation, version 3.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||||
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||||
|
* details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along with
|
||||||
|
* this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <Kaleidoscope.h>
|
||||||
|
#include <Kaleidoscope-Qukeys.h>
|
||||||
|
#include <Kaleidoscope-Macros.h>
|
||||||
|
|
||||||
|
#include "./shared.h"
|
||||||
|
|
||||||
|
enum { MACRO_TOGGLE_QUKEYS };
|
||||||
|
|
||||||
|
// *INDENT-OFF*
|
||||||
|
KEYMAPS(
|
||||||
|
[0] = KEYMAP_STACKED
|
||||||
|
(
|
||||||
|
Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey,
|
||||||
|
Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab,
|
||||||
|
Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G,
|
||||||
|
Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape,
|
||||||
|
|
||||||
|
Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift,
|
||||||
|
Key_Q,
|
||||||
|
|
||||||
|
M(MACRO_TOGGLE_QUKEYS), Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip,
|
||||||
|
Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals,
|
||||||
|
Key_H, SFT_T(J), CTL_T(K), ALT_T(L), GUI_T(Semicolon), Key_Quote,
|
||||||
|
Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus,
|
||||||
|
|
||||||
|
Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl,
|
||||||
|
LT(1,E)
|
||||||
|
),
|
||||||
|
[1] = KEYMAP_STACKED
|
||||||
|
(
|
||||||
|
___, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
|
||||||
|
Key_1, Key_2, Key_3, Key_4,
|
||||||
|
___,
|
||||||
|
|
||||||
|
|
||||||
|
___, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F,
|
||||||
|
Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
|
||||||
|
|
||||||
|
Key_1, Key_2, Key_3, Key_4,
|
||||||
|
___
|
||||||
|
),
|
||||||
|
)
|
||||||
|
// *INDENT-ON*
|
||||||
|
|
||||||
|
// Defining a macro (on the "any" key: see above) to toggle Qukeys on and off
|
||||||
|
const macro_t *macroAction(uint8_t macro_index, uint8_t key_state) {
|
||||||
|
switch (macro_index) {
|
||||||
|
case MACRO_TOGGLE_QUKEYS:
|
||||||
|
if (keyToggledOn(key_state))
|
||||||
|
Qukeys.toggle();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
return MACRO_NONE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use Qukeys
|
||||||
|
KALEIDOSCOPE_INIT_PLUGINS(Qukeys, Macros);
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
QUKEYS(
|
||||||
|
kaleidoscope::plugin::Qukey(0, KeyAddr(2, 1), Key_LeftGui), // A/cmd
|
||||||
|
kaleidoscope::plugin::Qukey(0, KeyAddr(2, 2), Key_LeftAlt), // S/alt
|
||||||
|
kaleidoscope::plugin::Qukey(0, KeyAddr(2, 3), Key_LeftControl), // D/ctrl
|
||||||
|
kaleidoscope::plugin::Qukey(0, KeyAddr(2, 4), Key_LeftShift), // F/shift
|
||||||
|
kaleidoscope::plugin::Qukey(0, KeyAddr(3, 6), ShiftToLayer(1)) // Q/layer-shift (on `fn`)
|
||||||
|
)
|
||||||
|
Qukeys.setHoldTimeout(kaleidoscope::testing::QUKEYS_HOLD_TIMEOUT);
|
||||||
|
Qukeys.setOverlapThreshold(kaleidoscope::testing::QUKEYS_OVERLAP_THRESHOLD);
|
||||||
|
Qukeys.setMinimumHoldTime(kaleidoscope::testing::QUKEYS_MINIMUM_HOLD_TIME);
|
||||||
|
|
||||||
|
Kaleidoscope.setup();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
Kaleidoscope.loop();
|
||||||
|
}
|
||||||
@ -0,0 +1,215 @@
|
|||||||
|
/* -*- mode: c++ -*-
|
||||||
|
* Copyright (C) 2020 Keyboard.io, Inc.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it under
|
||||||
|
* the terms of the GNU General Public License as published by the Free Software
|
||||||
|
* Foundation, version 3.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||||
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||||
|
* details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along with
|
||||||
|
* this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "testing/setup-googletest.h"
|
||||||
|
|
||||||
|
#include "../shared.h"
|
||||||
|
|
||||||
|
SETUP_GOOGLETEST();
|
||||||
|
|
||||||
|
namespace kaleidoscope {
|
||||||
|
namespace testing {
|
||||||
|
namespace {
|
||||||
|
|
||||||
|
constexpr KeyAddr key_addr_A{2, 1};
|
||||||
|
constexpr KeyAddr key_addr_S{2, 2};
|
||||||
|
constexpr KeyAddr key_addr_D{2, 3};
|
||||||
|
constexpr KeyAddr key_addr_F{2, 4};
|
||||||
|
constexpr KeyAddr key_addr_X{3, 2};
|
||||||
|
|
||||||
|
using ::testing::IsEmpty;
|
||||||
|
|
||||||
|
class QukeysBasic : public VirtualDeviceTest {
|
||||||
|
protected:
|
||||||
|
std::set<uint8_t> expected_keycodes_ = {};
|
||||||
|
std::unique_ptr<State> state_ = nullptr;
|
||||||
|
};
|
||||||
|
|
||||||
|
TEST_F(QukeysBasic, TapQukeyAlone) {
|
||||||
|
|
||||||
|
// Press `A`
|
||||||
|
sim_.Press(key_addr_A);
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0)
|
||||||
|
<< "There should be no HID report after the qukey is pressed";
|
||||||
|
sim_.RunForMillis(20);
|
||||||
|
// Release `A`
|
||||||
|
sim_.Release(key_addr_A);
|
||||||
|
|
||||||
|
sim_.RunCycles(2);
|
||||||
|
state_ = RunCycle();
|
||||||
|
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 2)
|
||||||
|
<< "There should be two HID reports after the release of a tapped qukey";
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_A.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The first report should include only `A`";
|
||||||
|
|
||||||
|
expected_keycodes_.erase(Key_A.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(1).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The second report should be empty";
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(QukeysBasic, HoldQukeyAlone) {
|
||||||
|
|
||||||
|
// Press `A`
|
||||||
|
sim_.Press(key_addr_A);
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0);
|
||||||
|
|
||||||
|
uint32_t t0 = Kaleidoscope.millisAtCycleStart();
|
||||||
|
|
||||||
|
// To test the hold timeout, we check after every cycle to see if there's new
|
||||||
|
// HID report. We can't just call `RunForMillis()` because we care about when
|
||||||
|
// that report was sent.
|
||||||
|
do {
|
||||||
|
state_ = RunCycle();
|
||||||
|
} while (state_->HIDReports()->Keyboard().size() == 0 &&
|
||||||
|
(Kaleidoscope.millisAtCycleStart() - t0 < QUKEYS_HOLD_TIMEOUT + 1));
|
||||||
|
|
||||||
|
uint32_t t1 = Kaleidoscope.millisAtCycleStart();
|
||||||
|
|
||||||
|
EXPECT_THAT(t1 - t0, ::testing::Ge(QUKEYS_HOLD_TIMEOUT))
|
||||||
|
<< "The HID report should be sent after the hold timeout has elapsed";
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_LeftGui.getKeyCode());
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 1)
|
||||||
|
<< "There should be only one HID report";
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The HID report should contain just `Key_LeftGui`";
|
||||||
|
|
||||||
|
sim_.RunForMillis(100);
|
||||||
|
|
||||||
|
sim_.Release(key_addr_A);
|
||||||
|
sim_.RunCycles(2);
|
||||||
|
state_ = RunCycle();
|
||||||
|
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 1)
|
||||||
|
<< "There should be a HID report immediately after the key is released";
|
||||||
|
|
||||||
|
expected_keycodes_.erase(Key_LeftGui.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The HID report should be empty at this point";
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(QukeysBasic, FullOverlap) {
|
||||||
|
|
||||||
|
sim_.Press(key_addr_F);
|
||||||
|
sim_.RunForMillis(20);
|
||||||
|
sim_.Press(key_addr_X);
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0)
|
||||||
|
<< "After both keys are pressed, there should still be no reports";
|
||||||
|
|
||||||
|
sim_.RunForMillis(50);
|
||||||
|
sim_.Release(key_addr_X);
|
||||||
|
sim_.RunCycles(3);
|
||||||
|
state_ = RunCycle();
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_LeftShift.getKeyCode());
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 3)
|
||||||
|
<< "After the subsequent key is released, we should get 3 reports";
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The first report should contain the qukey's altername keycode";
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_X.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(1).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The second report should add the subsequent key";
|
||||||
|
|
||||||
|
expected_keycodes_.erase(Key_X.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(2).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The third report should be the release of the subsequent key";
|
||||||
|
|
||||||
|
sim_.Release(key_addr_F);
|
||||||
|
sim_.RunCycles(3);
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 1)
|
||||||
|
<< "After the qukey is release, we should get one report";
|
||||||
|
expected_keycodes_.erase(Key_LeftShift.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The HID report should now be empty";
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(QukeysBasic, RolloverPrimary) {
|
||||||
|
|
||||||
|
sim_.Press(key_addr_F);
|
||||||
|
sim_.RunForMillis(20);
|
||||||
|
sim_.Press(key_addr_X);
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0)
|
||||||
|
<< "After both keys are pressed, there should still be no reports";
|
||||||
|
|
||||||
|
sim_.RunForMillis(50);
|
||||||
|
sim_.Release(key_addr_F);
|
||||||
|
sim_.RunForMillis(50);
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 3)
|
||||||
|
<< "After the qukey is released, and the overlap threshold is exceeded, there should be 3 reports";
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_F.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The first report should contain the qukey's primary value";
|
||||||
|
|
||||||
|
expected_keycodes_.insert(Key_X.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(1).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The second report should contain the subsequent (normal) key";
|
||||||
|
|
||||||
|
expected_keycodes_.erase(Key_F.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(2).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The third report should contain the release of the qukey";
|
||||||
|
|
||||||
|
sim_.Release(key_addr_X);
|
||||||
|
sim_.RunCycles(3);
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 1)
|
||||||
|
<< "After the normal key is released, we should get one report";
|
||||||
|
expected_keycodes_.erase(Key_X.getKeyCode());
|
||||||
|
EXPECT_THAT(state_->HIDReports()->Keyboard(0).ActiveKeycodes(),
|
||||||
|
::testing::ElementsAreArray(expected_keycodes_))
|
||||||
|
<< "The HID report should now be empty";
|
||||||
|
|
||||||
|
state_ = RunCycle();
|
||||||
|
ASSERT_EQ(state_->HIDReports()->Keyboard().size(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace
|
||||||
|
} // namespace testing
|
||||||
|
} // namespace kaleidoscope
|
||||||
Loading…
Reference in new issue