https://github.com/andrew--r/ergonaut-zmk-config

https://github.com/andrew--r/ergonaut-zmk-config

Last synced: about 6 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/andrew--r/ergonaut-zmk-config
• Owner: andrew--r
• Created: 2024-05-09T17:09:24.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-05-28T16:58:52.000Z (6 months ago)
• Last Synced: 2024-05-29T07:02:48.252Z (6 months ago)
• Size: 45.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](http://www.keyboard-layout-editor.com/#/gists/13d0f7ae7a8b5835efcd23d61f50336a)

Below representation was generated with [`keymap-drawer`](https://github.com/caksoylar/keymap-drawer) – check out the automatically generated layouts using the [automated Github workflow](https://github.com/caksoylar/keymap-drawer/tree/main#setting-up-an-automated-drawing-workflow) for each keyboard in the [`keymap-drawer` folder](keymap-drawer/), which is always up to date with the config.

![Keymap Representation](./keymap-drawer/ergonaut_one.svg?raw=true "Keymap Representation")

## FAQ

- [FAQ](#faq)

  - [How to change the keymap?](#how-to-change-the-keymap)

  - [How to flash the keyboard?](#how-to-flash-the-keyboard)

  - [How to pair halves?](#how-to-pair-halves)

  - [Problems](#problems)

    - [I'm getting File Transfer Error after copying firmware to the keyboard](#im-getting-file-transfer-error-after-copying-firmware-to-the-keyboard)

### 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](https://nickcoutsos.github.io/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](config/boards/shields/ergonaut_one/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