Skip to content

AJGamma/sheriff-keyboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🔫Sheriff: A Feature-rich Ergonomic Split Keyboard with Thumb Scroll Wheels

  • Double rotary encoder on the thumb cluster mapped to arrow keys by default, ideal for text editing
  • Higher keys on the num row, easier to reach
  • Similar layout to the more traditional keyboard on notebooks, less mental overload for switching between devices
  • Reversible PCB
  • Fully generated, including the case, allowing easy modifications
  • Configurable case generation
  • Both wired and wireless support
  • Generated with Ergogen

🎨 Gallery

Sheriff Sheriff

Sheriff

✨ Features

Rotary Encoders

a81b8baea62c3673949f0857280fe891.mp4

The core feature of the Sheriff is the easily accessible rotary encoders positioned on the thumb clusters.

Encoder behaviors

QMK version (custom_scroll_layers version)
Behavior Key Held Left Counter-clockwise Left Clockwise Right Counter-clockwise Right Clockwise
Arrow key None Left Right Down Up
Deletion Backspace Backspace Delete Backspace Delete
Mouse wheel Esc Volume-down Volume-up Mouse wheel down Mouse wheel up
Repeating Space Left Right Repeat last key Repeat last key's alternative
Mouse emulation V Mouse left Mouse right Mouse down Mouse up
Vim motion W b w } {
Vim motion E ge e Down Up
Vim undo/redo U u C-r C-r u
Undo/redo Y C-z C-y C-y C-z
Undo/redo Z C-z S-C-z S-C-z C-z
Speed up 8 Next activated behavior 8 times Next activated behavior 8 times Next activated behavior 8 times Next activated behavior 8 times
ZMK version
Behavior Key Held Left Counter-clockwise Left Clockwise Right Counter-clockwise Right Clockwise Description
Arrow key None Left Right Down Up
Deletion Backspace Backspace Delete Backspace Delete
Mouse wheel Esc Volume-down Volume-up Mouse wheel down Mouse wheel up Sym layer
Repeating Space Left Right Repeat last key Repeat last key's alternative Nav layer
Mouse emulation V Mouse left Mouse right Mouse down Mouse up Mouse layer
Vim motion W b w } {
Vim motion E ge e Down Up
Speed up 8 Left * 8 Right * 8 Down * 8 Up * 8

Configurable case generation

The case is generated with ergogen, and the config file was written with configurability in mind. There are multiple versions of the case, including flat, tented, sinfle-sided tented and lifted tented. The parameters are highly adjustable, and customization can easily be done. See the doc for more information.

Easier transitions

One of the motivations for this keyboard is to make the transition from a traditional keyboard to an ergonomic one easier. That's why the default layout is mostly the same as a traditional keyboard, with the only difference being the extra keys in thumb clusters. This way, when you switch back to a traditional keyboard and you reach for the thumb cluster mods, they are simply not there, eliminating any chance of pressing the wrong key.

Higher up num row

The key caps on the num row are higher up, making them easier to reach.

num_row

Both wired and wireless support

The PCB has both trrs jacks and battery pins, allowing for both wired and wireless connections.

Both ZMK(wireless) and QMK(wired) firmware are implemented; however, I've encountered several issues with the ZMK firmware, including:

  • Two halves unable to pair(swapping boards did not help, neither did flashing reset firmware, and I'm 90% sure nothing's wrong with the firmware)
  • Rotary encoder motions sometimes skipped

It's worth noting that I'm not using the official nice!nano boards, but rather the Pro Micro NRF52840 nice!nano v2 compatible boards, which might be the cause of the issues.

Firmware

Supports wired usage with QMK firmware. Repository here

Wireless usage is supported with ZMK. Repository here. I couldn't get it to work properly though, detail here.

Layout

Default layer:

default layer

Layer 1:

Layer 1

Layer 2:

Layer 2

Layer 3:

Layer 3

💡 Inspirations

Future work

  • Build guide
  • Screen
  • LEDs
  • More intuitive scroll wheel position and orientation
  • New logo
  • 3D-printed key caps
  • More acquirable scroll wheel

About

Feature-rich ergonomic keyboard with scroll wheels

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors