Giter Club home page Giter Club logo

config-span-zmk's Introduction

Span Keyboard

This project is still being developed as I am polishing the keymap for something I really like. Comments and code might be unstructured or incorrect as changes are implemented.

Controlling my Span, a split wireless-only mechanical keyboard.

  • QWERTY base layout
  • Modified Miryoku layout
  • moved GUI key to lower row due to many false activations
  • Added a row of combos and hold/tap delays to make better use of the 36 key layout

Keyboard

keyboard image

Case

The files for the case can be found within the repository. The pcb sits flush to the upper edge of the case. I've added some standoffs to screw the PCB on with M2x4 screws. Ideally you'd use 5 per side, 4 will do just fine as well. Just note that cutouts are for cosmetic purposes only.

keyboard image

Keymap

keymap image

Building

Either generate the firmware via the GitHub action, or build locally by setting up the ZMK toolchain as described here. Given a directory structure like:

...
|-- config-temper/
|-- zephyr-sdk-0.16.5-1/
`-- zmk/
    |-- app
    `-- ...

Then from the zmk/app directory run the following command to build the firmware for the left hand board:

west build -b nice_nano_v2 -p -c -- -DSHIELD="temper_left nice_view_adapter nice_view_temper" -DZMK_CONFIG=../../config-temper-zmk/config -DZMK_EXTRA_MODULES=../../config-temper-zmk -DZephyr-sdk_DIR=../../zephyr-sdk-0.16.5-1/cmake

This will produce the file zmk/app/build/zephyr/zmk.utf. Put the board into bootloader mode by pressing the reset button twice, and copy this file to the board, which will show up as a USB drive when connected to your computer. Repeat for the right side board.

Keymap image

The keymap image is created using keymap-drawer. It can be regenerated with the commands:

keymap -c img/keymap_drawer.config.yaml parse -c 10 -z config/temper.keymap > img/temper.yaml
keymap -c img/keymap_drawer.config.yaml draw -k chocofi img/temper.yaml > img/temper.svg

Miscellaneous

In MacOS, when a key is held down while entering text, a popup is shown which lets you choose between various accented forms of the character. The following command will disable this behaviour.

defaults write -g ApplePressAndHoldEnabled -bool false

Resources

config-span-zmk's People

Contributors

kastentaco avatar tmcdonell avatar

Stargazers

 avatar Idan Kamara avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.