GithubHelp home page GithubHelp logo

zmk-config-ergonaut-one's Introduction

ZMK Firmware for Ergonaut One keyboard

This is a repository for a ZMK Firmware for Ergonaut One keyboard.

Default keymap

Visual representation of the default keymap in keyboard-layout-editor: KLE

Below representation was generated with keymap-drawer โ€“ check out the automatically generated layouts using the automated Github workflow for each keyboard in the keymap-drawer folder, which is always up to date with the config.

Keymap Representation

This layout is heavily inspired from Watchman 42-key layout

FAQ

How to change the keymap?

  1. Fork or use this repository as a template https://github.com/ergonautkb/one-zmk-config.
  2. Enable Github Actions for your repository.

You have two options on how to configure your desired keymap:

Option 1. Keymap Editor

  1. Open Keymap Editor.
  2. Connect it to your Github account and give an access to your repository to Keymap Editor's app.
  3. Make changes to your keymap and press Save - it will trigger software build. Wait for it to complete.
  4. Grab the firmware.zip archive.

Option 2. Manual

  1. Make changes to the ergonaut_one.keymap file using your favorite text editor.
  2. Commit changes to your repository.
  3. Go to Actions tab in your Github repository, locate the latest build and wait for it to complete.
  4. Grab the firmware.zip archive

How to flash the keyboard?

  1. Obtain firmware.zip
  2. Unzip firmware.zip - you should have ergonaut_one_left-seeeduino_xiao_ble-zmk.uf2 and ergonaut_one_right-seeeduino_xiao_ble-zmk.uf2 files
  3. Turn off the power for selected halve (move slider to position OFF)
  4. Connect selected halve to the PC via USB-C cable
  5. Press RESET button twice to enter DFU mode - you should see new USB device in your file manager
  6. Copy the corresponding firmware to the root directory of the new USB device
  7. Disconnect selected halve from the PC
  8. Repeat steps 3-7 for the other halve

How to pair halves?

  1. Turn off the power for both halves (move slider to position OFF)
  2. Turn on the power for both halves (move slider to position ON)
  3. Press RESET button once on both halves simultaneously

Problems

I'm getting File Transfer Error after copying firmware to the keyboard

It's OK. Proof: https://zmk.dev/docs/troubleshooting#file-transfer-error

zmk-config-ergonaut-one's People

Contributors

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