Giter VIP home page Giter VIP logo

adv360-meta-configs's Introduction

adv360-meta-configs

Repository containing the keymaps and other modifications to adv360 keyboard.

Setup

The individual command could change due to upstream toolchain update. Refer to official docs for the latest command.

git clone https://github.com/cvcore/adv360-meta-configs.git
git submodule update --init --recursive

Then, open this repository in VSCode devcontainer. Inside the container, do:

cd $WORKSPACE_DIR/zmk
west init
west update
../scripts/build_in_docker.sh

Afterwards, find the firmwares in $WORKSPACE_DIR/firmware. Flash them with:

cd firmware
rsync (ls -t *-left.uf2 | head -n 1 | tee) /Volumes/ADV360PRO/  # for left split
rsync (ls -t *-left.uf2 | head -n 1 | tee) /Volumes/ADV360PRO/  # for right split

Directory Structure

  • adv360-pro-zmk: folder containing the configurations. These include keymaps, switches to certain behaviors and etc and controls the compilation of zmk.
  • zmk: folder containing the zmk firmware source code. zmk is an application layer built on top of the Zephyr RTOS specifically for customized keyboards. It uses the west command to manage the builds and dependencies.

Why Doing this at all?

Adv360 is a great key board, until you try to customize it and to reflash the firmware. From my past experiences, upstream changes to the zmk firmware can cause undesired behavior of the keyboard, and some of those are hard to be reproduced.

Due to this reason, I decided to open this repository to track my own configuration together with their associated zmk version. And they are maintained with git submodules. The goal is, given specific versions of zmk, adv360-pro-zmk and Zephyr version (linked by zmk), the compiled firmware should have identical functionality, which helps to track down potential issues introduced by upstream changes.

Disclaimer

Since there could be minor differences between hardwares, I cannot guarantee that this will work for every Adv360. Use this repo at your own risk.

adv360-meta-configs's People

Contributors

cvcore 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.