Giter VIP home page Giter VIP logo

zmk's Introduction

ZMK Fork Optimized for Sofle Keyboards

This is a zmk fork that improves encoder, display and underglow support of zmk.

While it's been optimized for and tested with a sofle choc keyboard, it can be benificial for and should work with any split keyboard that is using encoders and displays.

It adds the following features and fixes:

  • Adds underglow (used for backlight) support to Sofle shield (PR #1188)
  • Fixes split side encoder not working (PR #728)
  • Fixes display not working if you toggle external power off and then on again (Issue #674)
  • Adds automatic disabling and enabling of external power when USB is disconnected or connected (PR #1184)
  • Adds automatic disabling of backlight if the keyboard is idle (PR #1179)

Most of these fixes and features have not made it into the official zmk yet, because they don't meet the (very resaonable and completely understandable) code standards of the zmk maintainers.

However, while these fixes and features may not meet the quality standards of the official project, they work well enough to be used until these features get properly implemented.

How to use

Adjust your zmk-config's west.yml

If you already have an existing sofle config, you can adjust your config/west.yml file to use this fork instead of the official version.

Use this commit as an example of how to do it.

Refer to this .conf file and this .keymap file for config options.

Use zmk-config-sofle

Alternatively, you can also use my zmk-config-sofle repo as a starting point for your config.

zmk's People

Contributors

aaron-nunley avatar bcat avatar bortoz avatar brainwart avatar caksoylar avatar careyk007 avatar chenkevinh avatar crossr avatar davidphilipbarr avatar dependabot[bot] avatar dxmh avatar idan avatar infused-kim avatar innovaker avatar jaygreco avatar joelspadin avatar kingcoinless avatar kurtis-lew avatar lownightsnack avatar mcrosson avatar megamind4089 avatar mveerd avatar na-cly avatar nicell avatar okke-formsma avatar petejohanson avatar pluskid avatar reizero00 avatar tominabox1 avatar tsquash 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.