# Keeb TKL Functions
11/7/2023

Keeb includes the following functions:
1. Firmware Animations
2. LED Streaming (10-15ms)
3. Dual Rollers (Rotary Encoders) FW/SW Mode
4. Game Mode
5. Key Assignments/Mappings
* 2 Profiles (4 Layers per Profile)
6. Macros
* 2 Profiles (16 Macros per Profile)
7. Key Matrix Tester
8. Settings


Keeb includes a total of:
* 93 Keys (includes 87 keys + 5 media keys + 1 button between the rotary encoders)
* 2 Dual Rollers (rotary encoders)
* 155 qRGB Pixels (includes 87 keys + 4 for the space bar + 5 media keys + 9 for the Dual Rollers + 50 on the bottom)

---
### 1. Firmware Animations (6 Types)
There are 6 types of firmware animations for users to select from in Nexus software, each of which contains different parameters defined below that can be adjusted by users


| Type | Brightness | Speed | Select Color | Direction |
| -------- | ---------- | ----- | ------------ | --- |
| Static | Yes | No | Yes | No |
| Breathing | Yes | Yes | Yes | No |
| Rainbow | Yes | Yes | No (preset rainbow) | No |
| Wave | Yes | Yes | No (preset rainbow) | Yes |
| Flow | Yes | Yes | Yes | Yes |
| PingPong | Yes | Yes | Yes | Yes|

* Speed (1-5): 1 is fastest and 5 is slowest
* Each animation can select up to 8 colors (static will only display the latest color)

### 2. LED Streaming (155 qRGB Pixels)
* Lighting Widget
* Reactive Keys

### 3. Dual Roller Assignments

==! notice that the **Dual Roller middle button** should be configured in key assignments==
#### Firmware Mode (Limited Functionality)
Dual Roller firmware mode will be stored to the PCB
* Volume Adjustment
* Brightness Adjustment
* Scaling
* Application Switching (Alt + Tab)
* Tab Switching (Ctrl + Tab)
* Vertical Scrolling
* Horizontal Scrolling
* Wave (Animation) Scrolling
* Key Combination (can combine up to 3 standard keys)


#### Software Mode (Unlimited Functionality)
Software mode can be configured per application, and auto-detect the active software to switch to the corresponding profile

**UI Control**
* Button to switch between firmware/software mode when Nexus is running
* Application dropdown to configure Dual Roller functionality with all applications on user's PC
* Function indicator when switching to different applications with a semi-transparent UI for indicating the current Dual Roller configuration
* Disable/Enable

**Basic Functions (For All Applications)**
* Screen Brightness
* App Switching
* Volume Adjustment
* *Per App Volume (SW Mode)
* Magnification or Scaling (Ctrl + Mouse Scroll)
* Vertical Scroll Wheel
* Horizontal Scroll Wheel
* Microphone Volume
* Self Defined (Shortcuts / Macros)
* Tab Switching (Ctrl + Tab)
* Default Lighting Timeline Shifting
* Default RGB Mode Switching

**Adobe Integration**
Photoshop
* Image Adjustment
* Scaling
* Brightness
* Contrast
* Saturation
* Brush Size
* Scrolling Through Function (Tool) List
* Undo/Redo

Illustrator
* Image Adjustment
* Scaling
* Brightness
* Contrast
* Saturation
* Brush Size
* Scrolling Through Function List
* Undo/Redo

Premiere & After Effects
* Timeline Scrolling (Per Frame)
* Timeline Navigation

WebPage Integration
* Tab Switching

Music Player App Integration (Spotify)
* Volume Control
* Next/Previous Track
* Track Scrolling/Scrubbing

**Office Integration**
* Default
* Change Theme Style
* Change Theme Color
* Change Theme Font
* Change Slide Style
* Text
* Change Font Size
* Bold Toggle
* Change Paragraph Position
* Image
* Change Image Size
* Rotation

**Settings**
* Sensitivity Slider
* Acceleration

### 4. Game Mode
Can enble and disable the following 4 key/shortcuts in FW:
* **Windows Key** Enable/Disable
* **Shift + Tab** Enable/Disable
* **Alt + F4** Enable/Disable
* **Alt + Tab** Enable/Disable

### 5. Key Assignments
Keeb can store 2 onboard profiles with each profile containing:
* 4 Layers of Key Mappings (includes media keys, but not Dual Rollers)
* 16 Macros


**UI Controls**
* Profile dropdown
* Clickable keyboard model which the user can interact with to assign keys
* Auto select the next key after the user assigns the previous key
* Undo/Redo button
* Hover state
* Hover on a key to show the current assigned function
* Hover on a function to show the explanation of that function
* Drag and drop or click on the function to assign keys
* Type on the keyboard to assign a character
* Layer button (click on the button to change to different later for mapping)
* Reset to default button

### Key Functions
* Standard Keys
* Mouse Keys
* Media Keys
* Multi-Media Keys
* System Keys
* Macro Keys
* Key Combinations
* RGB Keys
* Layer Keys
* Special Keys
* Software Keys

#### Standard Keys
* None
* Pass Through (same as previous layer)
--
* A
* B
* C
* D
* E
* F
* G
* H
* I
* J
* K
* L
* M
* N
* O
* P
* Q
* R
* S
* T
* U
* V
* W
* X
* Y
* Z
--
* ESC
* 1!
* 2@
* 3#
* 4$
* 5%
* 6^
* 7&
* 8*
* 9(
* 0\)
* -_
* =+
* BackSpace
* Tab
* [{
* ]}
* \\|
* :;
* '"
* Caps Lock
* Enter
* Left Shift
* ,<
* .>
* /?
* Right Shift
* Left ctrl
* Left Win
* Right Win
* Left Alt
* Space
* Right Alt
* Fn
* Right ctrl
--
* Up
* Down
* Right
* Left
--
* Print Screen
* Scroll Lock
* Insert
* Delete
* Home
* End
* PageUp
* PageDown
* Num Lock
* Pause
--
* 1 (num pad)
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 0
* /
* \*
* \-
* \+
* .
* Num Enter
--
* `~
* F1
* F2
* F3
* F4
* F5
* F6
* F7
* F8
* F9
* F10
* F11
* F12
* F13
* F14
* F15
* F16
* F17
* F18
* F19
* F20
* F21
* F22
* F23
* F24
* =
* ,
* Menu

#### Mouse Keys
* L Button
* R Button
* M Button
* 4 Button
* 5 Button
* Scrollwheel Up
* Scrollwheel Down
* Scrollwheel Left
* Scrollwheel Right
* Mouse Move Up
* Mouse Move Down
* Mouse Move Left
* Mouse Move Right

#### Media Keys
* Fast Forward
* Rewind
* Scan Next Track
* Scan Previous Track
* Stop
* Play/Pause
* Mute
* Volume Up
* Volume Down
* Media Select (launch media player)

#### Multi-Media Keys
* Mail
* Calculator
* My Computer
* Web Search
* Web Home
* Web Back
* Web Forward
* Web Stop
* Web Refresh
* Web Favorite

#### System Keys
* Power
* Sleep
* Wake

#### Macro Keys
* 16 macros

#### Key Combinations (3 Keys)
Can combine up to 3 standard keys

#### RGB Keys
* Effect On/Off
* Effect Loop
* Effect Value
* Brightness Increase
* Brightness Decrease
* Speed Loop
* Speed Increase
* Speed Decrease
* Color Loop (static color)
* Color Increase (static color)
* Color Decrease (static color)
* Option Loop (direction)
* Option Value (direction)

#### Layer Keys
* MO(MO1/MO2/MO3/MO4) - Momentary turn layer on
* TG(TG1/TG2/TG3/TG4) - Toggle layer on/off
* TO(TO1/TO2/TO3/TO4) - Turn layer on when pressed
* DF(DF1/DF2/DF3/DF4) - Set layer as default

#### Special Keys
* Profile +
* Profile -
* Profile + loop
* Profile Value

#### Software Keys
* Emojis/Symbols
* Launch Nexus
* Launch Software
* Launch Website
* Open File
* Nexus Control
* Change fan speed profile
* Change lighting profile
* Keyboard typing statistics on Y70 touch
* Which key you type the most
* Key combination to move Q60 pages (not just our keyboard)
* Shortcuts to turn on/off Q60/Y70 screen
* Widget miniview to show your keyboard current layer and profile
* Combo keys (push two keys to do something else) - not sure if this is doable
* Set time

### 6. Macros

* Each profile can store **16 macros**.
* Record Mode
* Keyboard action
* Standard key
* Mouse action
* Click
* Scroll
* Macro Playback
* Play count
* Press and play
* Repeat (till any button click)
* Delay
* Record Delay
* Custom Delay (minimum 1ms)

**UI Controls**
* Input
* Copy and paste a paragraph of text to store as macro (with default delay 1ms)
* Record
* Adjust
* Drag and drop to change macro action sequence
* Auto detect if macro action is logical (key press and key release sequence)
* Adjust delay
* Delete action

### 7. Key Matrix Tester
* Key Tester (test key input/key code)
* Matrix Tester (test key switch position)

### 8. Settings
In the settings widget, keeb should have the following functions:
* Layout Info
* Polling Rate (1000hz)
* Firmware Update
* FAQ
* Manual Download