afiqzudinhadi/zmk-config-archive
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

cleanup

Browse source
This commit is contained in:
KeebMaker 2026-06-19 17:10:32 -06:00
parent f7929181ae
commit 62e0b65610
14 changed files with 106 additions and 973 deletions
Download patch file Download diff file Expand all files Collapse all files

16
.github/FUNDING.yml vendored
View file

@ -1,16 +0,0 @@
# These are supported funding model platforms
# WebSite: https://www.youtube.com/c/mctechnology17
github: mctechnology17 # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Open Collective username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom:
- https://www.paypal.com/paypalme/mctechnology17
- https://buymeacoffee.com/mctechnology17
- https://revolut.me/mctechnology17
# Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

354
Makefile
View file

@ -1,354 +0,0 @@
# ========================================
# FileName: Makefile
# Date: 07.03.2023
# Author: Marcos Chow Castro
# Email: mctechnology170318@gmail.com
# GitHub: https://github.com/mctechnology17
# Brief: Makefile for ZMK firmware with Docker
# Shields: corne sofle splitkb_aurora_sofle
# Boards: nice_nano_v2 puchi_ble_v1 seeeduino_xiao_ble
# =========================================
# ╔═╦═╦═╗
# ╔════╗ ║║║║║╔╝
# ║╔╗╔╗║ ║║║║║╚╗
# ╚╝║║╚╝ ║╠═╩╩═╝
# ║╠═╦═╣╚╦═╦╦═╦╗╔═╦═╦╦╗
# ║║╩╣═╣║║║║║╬║╚╣╬║╬║║║
# ╚╩═╩═╩╩╩╩═╩═╩═╩═╬╗╠╗║
# ╚═╩═╝
# to update the branch
# https://hub.docker.com/r/zmkfirmware/zmk-dev-arm/tags
# https://github.com/zmkfirmware/zmk/blob/main/.devcontainer/Dockerfile
# docker pull zmkfirmware/zmk-dev-arm:3.2-branch
#
# CUSTOM BRANCH EXAMPLE:
# git clone https://github.com/petejohanson/zmk -b v3.4.0+zmk-fixes
#
# WIDGET BRANCH ANIMATED
# cmake-args: -DKEYMAP_FILE=../../config/other-corne.keymap -DCONFIG_ZMK_KEYBOARD_NAME=\"other-corne\" -DEXTRA_CONF_FILE=../../config/other-corne.conf
# /Users/marcos/zmk-privat/config/config_ready/nice/oled_rgb/corne.conf
# -DKEYMAP_FILE=../../config/other-corne.keymap -DCONFIG_ZMK_KEYBOARD_NAME=\"other-corne\" -DEXTRA_CONF_FILE=../../config/other-corne.conf
# module:
# https://github.com/caksoylar/zmk-rgbled-widget
### config
# extra_conf_file_oled_rgb= -DEXTRA_CONF_FILE=${PWD}/config/config_ready/nice/oled_rgb/corne.conf
extra_modules_dir=${PWD}
extra_modules= -DZMK_EXTRA_MODULES="/boards"
config=${PWD}/config
nice_mount=/Volumes/NICENANO
puchi_mount=/Volumes/NRF52BOOT
xiao_mount=/Volumes/XIAO-SENSE
zmk_image=zmkfirmware/zmk-dev-arm:3.5
nice=nice_nano_v2
puchi=puchi_ble_v1
xiao=seeeduino_xiao_ble
urob=zmk-codebase_urob
default=zmk-codebase_default
# --name zmk-$@ is for codebase_urob, for example: zmk-codebase_urob
docker_opts= \
--interactive \
--tty \
--name zmk-$@ \
--workdir /zmk \
--volume "${config}:/zmk-config:Z" \
--volume "${PWD}/zmk:/zmk:Z" \
--volume "${extra_modules_dir}:/boards:Z" \
${zmk_image}
### name
keyboard_name_nice= '-DCONFIG_ZMK_KEYBOARD_NAME="Nice_Corne_View"'
keyboard_name_nice_oled= '-DCONFIG_ZMK_KEYBOARD_NAME="Nice_Corne_Oled"'
keyboard_name_nice_dongle= '-DCONFIG_ZMK_KEYBOARD_NAME="Nice_Dongle"'
keyboard_name_nice_dongle_oled= '-DCONFIG_ZMK_KEYBOARD_NAME="Nice_Dongle_O"'
keyboard_name_nice_dongle_view= '-DCONFIG_ZMK_KEYBOARD_NAME="Nice_Dongle_V"'
keyboard_name_puchi_view= '-DCONFIG_ZMK_KEYBOARD_NAME="Puchi_Corne_View"'
keyboard_name_puchi_oled= '-DCONFIG_ZMK_KEYBOARD_NAME="Puchi_Corne_Oled"'
keyboard_name_puchi_dongle= '-DCONFIG_ZMK_KEYBOARD_NAME="Puchi_Dongle"'
keyboard_name_puchi_dongle_oled= '-DCONFIG_ZMK_KEYBOARD_NAME="Puchi_Dongle_O"'
keyboard_name_puchi_dongle_view= '-DCONFIG_ZMK_KEYBOARD_NAME="Puchi_Dongle_V"'
keyboard_name_xiao_dongle= '-DCONFIG_ZMK_KEYBOARD_NAME="Xiao_Dongle"'
keyboard_name_xiao_dongle_oled= '-DCONFIG_ZMK_KEYBOARD_NAME="Xiao_Dongle_O"'
keyboard_name_xiao_dongle_view= '-DCONFIG_ZMK_KEYBOARD_NAME="Xiao_Dongle_V"'
### west
west_built_puchi= \
west build /zmk/app \
--pristine --board "${puchi}"
west_built_nice= \
west build /zmk/app \
--pristine --board "${nice}"
west_built_xiao= \
west build /zmk/app \
--pristine --board "${xiao}"
### shields
shield_settings_reset= \
-- -DSHIELD="settings_reset" -DZMK_CONFIG="/zmk-config"
shield_corne_left= \
-- -DSHIELD="corne_left" -DZMK_CONFIG="/zmk-config"
shield_corne_right_view= \
-- -DSHIELD="corne_right nice_view_adapter nice_view" \
-DZMK_CONFIG="/zmk-config"
shield_corne_right= \
-- -DSHIELD="corne_right" -DZMK_CONFIG="/zmk-config"
shield_corne_left_view= \
-- -DSHIELD="corne_left nice_view_adapter nice_view" \
-DZMK_CONFIG="/zmk-config"
shield_xiao_corne_dongle_xiao= \
-- -DSHIELD="corne_dongle_xiao" -DZMK_CONFIG="/zmk-config"
shield_xiao_corne_dongle_xiao_dongle_display= \
-- -DSHIELD="corne_dongle_xiao dongle_display" \
-DZMK_CONFIG="/zmk-config"
shield_xiao_corne_dongle_xiao_rgbled_adapter= \
-- -DSHIELD="corne_dongle_xiao rgbled_adapter" \
-DZMK_CONFIG="/zmk-config"
shield_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter= \
-- -DSHIELD="corne_dongle_xiao dongle_display rgbled_adapter" \
-DZMK_CONFIG="/zmk-config"
shield_corne_left_peripheral_view= \
-- -DSHIELD="corne_left_peripheral nice_view_adapter nice_view" \
-DZMK_CONFIG="/zmk-config"
shield_corne_left_peripheral_oled= \
-- -DSHIELD="corne_left_peripheral" \
-DZMK_CONFIG="/zmk-config"
shield_corne_dongle_pro_micro= \
-- -DSHIELD="corne_dongle_pro_micro" -DZMK_CONFIG="/zmk-config"
shield_corne_dongle_pro_micro_dongle_display= \
-- -DSHIELD="corne_dongle_pro_micro dongle_display" -DZMK_CONFIG="/zmk-config"
### uf2
uf2_copy_puchi_corne_settings_reset=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_settings_reset.uf2
uf2_copy_puchi_corne_left=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_left.uf2
uf2_copy_puchi_corne_right=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_right.uf2
uf2_copy_puchi_corne_left_peripheral_view=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_left_peripheral.uf2
uf2_copy_niceuf2_copy_puchi_corne_dongle_pro_micro=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_dongle_pro_micro.uf2
uf2_copy_puchi_corne_dongle_pro_micro_dongle_display=/zmk/build/zephyr/zmk.uf2 \
firmware/puchi_corne_dongle_pro_micro_dongle_display.uf2
uf2_copy_nice_corne_settings_reset=/zmk/build/zephyr/zmk.uf2 \
firmware/nice_corne_settings_reset.uf2
uf2_copy_nice_corne_left=/zmk/build/zephyr/zmk.uf2 firmware/nice_corne_left.uf2
uf2_copy_nice_corne_right=/zmk/build/zephyr/zmk.uf2 firmware/nice_corne_right.uf2
uf2_copy_nice_corne_left_peripheral_view=/zmk/build/zephyr/zmk.uf2 \
firmware/nice_corne_left_peripheral.uf2
uf2_copy_nice_corne_left_peripheral_oled=/zmk/build/zephyr/zmk.uf2 \
firmware/nice_corne_left_peripheral.uf2
uf2_copy_nice_corne_dongle_pro_micro=/zmk/build/zephyr/zmk.uf2 \
firmware/nice_corne_dongle_pro_micro.uf2
uf2_copy_nice_corne_dongle_pro_micro_dongle_display=/zmk/build/zephyr/zmk.uf2 \
firmware/nice_corne_dongle_pro_micro_dongle_display.uf2
uf2_copy_xiao_corne_dongle_xiao=/zmk/build/zephyr/zmk.uf2 \
firmware/xiao_corne_dongle_xiao.uf2
uf2_copy_xiao_corne_settings_reset=/zmk/build/zephyr/zmk.uf2 \
firmware/xiao_corne_settings_reset.uf2
uf2_copy_xiao_corne_dongle_xiao_dongle_display=/zmk/build/zephyr/zmk.uf2 \
firmware/xiao_corne_dongle_xiao_dongle_display.uf2
uf2_copy_xiao_corne_dongle_xiao_rgbled_adapter=/zmk/build/zephyr/zmk.uf2 \
firmware/xiao_corne_dongle_xiao_rgbled_adapter.uf2
uf2_copy_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter=/zmk/build/zephyr/zmk.uf2 \
firmware/xiao_corne_dongle_xiao_dongle_display_rgbled_adapter.uf2
### chmod
uf2_chmod_puchi_corne_settings_reset=chmod go+wrx \
firmware/puchi_corne_settings_reset.uf2
uf2_chmod_puchi_corne_left=chmod go+wrx firmware/puchi_corne_left.uf2
uf2_chmod_puchi_corne_right=chmod go+wrx firmware/puchi_corne_right.uf2
uf2_chmod_puchi_corne_left_peripheral_view=chmod go+wrx firmware/puchi_corne_left_peripheral.uf2
uf2_chmod_puchi_corne_dongle_pro_micro=chmod go+wrx firmware/puchi_corne_dongle_pro_micro.uf2
uf2_chmod_puchi_corne_dongle_pro_micro_dongle_display=chmod go+wrx firmware/puchi_corne_dongle_pro_micro_dongle_display.uf2
uf2_chmod_nice_corne_settings_reset=chmod go+wrx \
firmware/nice_corne_settings_reset.uf2
uf2_chmod_nice_corne_left=chmod go+wrx firmware/nice_corne_left.uf2
uf2_chmod_nice_corne_right=chmod go+wrx firmware/nice_corne_right.uf2
uf2_chmod_nice_corne_left_peripheral_view=chmod go+wrx firmware/nice_corne_left_peripheral.uf2
uf2_chmod_nice_corne_left_peripheral_oled=chmod go+wrx firmware/nice_corne_left_peripheral.uf2
uf2_chmod_nice_corne_dongle_pro_micro=chmod go+wrx firmware/nice_corne_dongle_pro_micro.uf2
uf2_chmod_nice_corne_dongle_pro_micro_dongle_display=chmod go+wrx firmware/nice_corne_dongle_pro_micro_dongle_display.uf2
uf2_chmod_xiao_corne_dongle_xiao=chmod go+wrx firmware/xiao_corne_dongle_xiao.uf2
uf2_chmod_xiao_corne_settings_reset=chmod go+wrx \
firmware/xiao_corne_settings_reset.uf2
uf2_chmod_xiao_corne_dongle_xiao_dongle_display=chmod go+wrx firmware/xiao_corne_dongle_xiao_dongle_display.uf2
uf2_chmod_xiao_corne_dongle_xiao_rgbled_adapter=chmod go+wrx firmware/xiao_corne_dongle_xiao_rgbled_adapter.uf2
uf2_chmod_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter=chmod go+wrx firmware/xiao_corne_dongle_xiao_dongle_display_rgbled_adapter.uf2
clone_zmk_default:
if [ ! -d zmk ]; then git clone https://github.com/zmkfirmware/zmk; fi
codebase_default: clone_zmk_default
docker run ${docker_opts} sh -c '\
west init -l /zmk/app/; \
west update'
clone_zmk_urob:
if [ ! -d zmk ]; then git clone https://github.com/urob/zmk; fi
codebase_urob: clone_zmk_urob
docker run ${docker_opts} sh -c '\
west init -l /zmk/app/; \
west update'
### CODEBASE_UROB START
only_nice_corne_left_view_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_left_view} \
${keyboard_name_nice} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_left}
${uf2_chmod_nice_corne_left}
only_nice_corne_right_view_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_right_view} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_right}
${uf2_chmod_nice_corne_right}
only_puchi_corne_left_view_urob:
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_left_view} \
${keyboard_name_puchi} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_left}
${uf2_chmod_puchi_corne_left}
only_puchi_corne_right_view_urob:
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_right} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_right}
${uf2_chmod_puchi_corne_right}
only_nice_corne_left_peripheral_view_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_left_peripheral_view} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_left_peripheral_view}
${uf2_chmod_nice_corne_left_peripheral_view}
only_puchi_corne_left_peripheral_view_urob:
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_left_peripheral_view} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_left_peripheral_view}
${uf2_chmod_puchi_corne_left_peripheral_view}
only_nice_corne_dongle_pro_micro_dongle_display_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_dongle_pro_micro_dongle_display} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_dongle_pro_micro_dongle_display}
${uf2_chmod_nice_corne_dongle_pro_micro_dongle_display}
only_puchi_corne_dongle_pro_micro_dongle_display_urob:
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_dongle_pro_micro_dongle_display} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_dongle_pro_micro_dongle_display}
${uf2_chmod_puchi_corne_dongle_pro_micro_dongle_display}
only_corne_xiao_corne_dongle_xiao_dongle_display_urob:
docker run --rm ${docker_opts} \
${west_built_xiao} ${shield_xiao_corne_dongle_xiao_dongle_display} ${extra_modules}
docker cp ${urob}:${uf2_copy_xiao_corne_dongle_xiao_dongle_display}
${uf2_chmod_xiao_corne_dongle_xiao_dongle_display}
only_nice_settings_reset_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_settings_reset}
docker cp ${urob}:${uf2_copy_nice_corne_settings_reset}
${uf2_chmod_nice_corne_settings_reset}
only_puchi_settings_reset_urob:
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_settings_reset}
docker cp ${urob}:${uf2_copy_puchi_corne_settings_reset}
${uf2_chmod_puchi_corne_settings_reset}
only_xiao_settings_reset_urob:
docker run --rm ${docker_opts} \
${west_built_xiao} ${shield_settings_reset}
docker cp ${urob}:${uf2_copy_xiao_corne_settings_reset}
${uf2_chmod_xiao_corne_settings_reset}
### MC: TODO: excluded for the moment START
only_corne_left_peripheral_oled_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_left_peripheral_oled} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_left_peripheral_oled}
${uf2_chmod_nice_corne_left_peripheral_oled}
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_left_peripheral_oled} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_left_peripheral_oled}
${uf2_chmod_puchi_corne_left_peripheral_oled}
only_corne_dongle_pro_micro_urob:
docker run --rm ${docker_opts} \
${west_built_nice} ${shield_corne_dongle_pro_micro} ${extra_modules}
docker cp ${urob}:${uf2_copy_nice_corne_dongle_pro_micro}
${uf2_chmod_nice_corne_dongle_pro_micro}
docker run --rm ${docker_opts} \
${west_built_puchi} ${shield_corne_dongle_pro_micro} ${extra_modules}
docker cp ${urob}:${uf2_copy_puchi_corne_dongle_pro_micro}
${uf2_chmod_puchi_corne_dongle_pro_micro}
only_corne_xiao_corne_dongle_xiao_urob:
docker run --rm ${docker_opts} \
${west_built_xiao} ${shield_xiao_corne_dongle_xiao} ${extra_modules}
docker cp ${urob}:${uf2_copy_xiao_corne_dongle_xiao}
${uf2_chmod_xiao_corne_dongle_xiao}
### MC: TODO: excluded for the moment END
### MC: rgbled_adapter TODO: START
only_corne_xiao_corne_dongle_xiao_rgbled_adapter_urob:
docker run --rm ${docker_opts} \
${west_built_xiao} ${shield_xiao_corne_dongle_xiao_rgbled_adapter} ${extra_modules}
docker cp ${urob}:${uf2_copy_xiao_corne_dongle_xiao_rgbled_adapter}
${uf2_chmod_xiao_corne_dongle_xiao_rgbled_adapter}
only_corne_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter_urob:
docker run --rm ${docker_opts} \
${west_built_xiao} ${shield_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter} ${extra_modules}
docker cp ${urob}:${uf2_copy_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter}
${uf2_chmod_xiao_corne_dongle_xiao_dongle_display_rgbled_adapter}
### MC: rgbled_adapter TODO: END
only_corne_left_view_urob: only_nice_corne_left_view_urob \
only_puchi_corne_left_view_urob
only_corne_right_view_urob: only_nice_corne_right_view_urob \
only_puchi_corne_right_view_urob
only_corne_left_peripheral_view_urob: only_nice_corne_left_peripheral_view_urob \
only_puchi_corne_left_peripheral_view_urob
only_corne_dongle_pro_micro_dongle_display_urob: only_nice_corne_dongle_pro_micro_dongle_display_urob \
only_puchi_corne_dongle_pro_micro_dongle_display_urob
settings_reset_urob: only_nice_settings_reset_urob \
only_puchi_settings_reset_urob \
only_xiao_settings_reset_urob
corne_urob: only_corne_left_view_urob \
only_corne_right_view_urob \
only_corne_left_peripheral_view_urob \
only_corne_dongle_pro_micro_dongle_display_urob \
only_corne_xiao_corne_dongle_xiao_dongle_display_urob \
settings_reset_urob
### CODEBASE_UROB END
# Open a shell within the ZMK environment
shell:
docker run --rm ${docker_opts} /bin/bash
# Flash the appropriate firmware to the bootloader
nice_corne_flash_left:
@ printf "Waiting for ${nice} bootloader to appear at ${nice_mount}.."
@ while [ ! -d ${nice_mount} ]; do sleep 1; printf "."; done; printf "\n"
cp -av firmware/nice_corne_left.uf2 ${nice_mount}
nice_corne_flash_right:
@ printf "Waiting for ${nice} bootloader to appear at ${nice_mount}.."
@ while [ ! -d ${nice_mount} ]; do sleep 1; printf "."; done; printf "\n"
cp -av firmware/nice_corne_right.uf2 ${nice_mount}
puchi_corne_flash_left:
@ printf "Waiting for ${puchi} bootloader to appear at ${puchi_mount}.."
@ while [ ! -d ${puchi_mount} ]; do sleep 1; printf "."; done; printf "\n"
cp -av firmware/puchi_corne_left.uf2 ${puchi_mount}
puchi_corne_flash_right:
@ printf "Waiting for ${puchi} bootloader to appear at ${puchi_mount}.."
@ while [ ! -d ${puchi_mount} ]; do sleep 1; printf "."; done; printf "\n"
cp -av firmware/puchi_corne_right.uf2 ${puchi_mount}
clean_firmware:
find firmware/*.uf2 -type f -delete
clean_zmk:
if [ -d zmk ]; then rm -rfv zmk; fi
clean: clean_zmk
docker ps -aq --filter name='^zmk' | xargs -r docker container rm
docker volume list -q --filter name='zmk' | xargs -r docker volume rm
clean_all: clean clean_firmware
@echo "cleaning all"
# vim: set ft=make fdm=marker:

678
README.md
View file

@ -1,625 +1,127 @@
# MC Technology's zmk-config for corne - sofle - lily58 # zmk-config
[![MC Technology](https://github.com/mctechnology17/mctechnology17/blob/main/src/mctechnology_extendido.GIF)](https://www.youtube.com/channel/UC_mYh5PYPHBJ5YYUj8AIkcw) ZMK firmware configuration for a Corne, Lily58, Sofle, and Sweep, built via GitHub Actions.
<div align="center"> - [Quick start](#quick-start)
- [Repo layout](#repo-layout)
[<img align="center" alt="MC Technology | YouTube" width="22px" src="https://github.com/mctechnology17/mctechnology17/blob/main/src/youtube.png" />][youtube] - [Keyboards](#keyboards)
[<img align="center" alt="MC Technology17 | Facebook" width="22px" src="https://github.com/mctechnology17/mctechnology17/blob/main/src/facebook.png" />][facebook] - [Display](#display)
[<img align="center" alt="MC Technology17 | Reddit" width="22px" src="https://github.com/mctechnology17/mctechnology17/blob/main/src/reddit.png" />][reddit] - [RGB underglow](#rgb-underglow)
- [Dongle / peripheral templates](#dongle--peripheral-templates)
</div> - [ZMK Studio](#zmk-studio)
<br> - [Modules](#modules)
- [Useful tips](#useful-tips)
- [Credits](#credits)
- [INTRO](#INTRO)
- [QUICK START](#QUICK-START)
- [keymap corne](#keymap-corne)
- [keymap sofle](#keymap-sofle)
- [keymap splitkb_aurora_sofle](#keymap-splitkb_aurora_sofle)
- [keymap lily58](#keymap-lily58)
- [LOCAL INSTALLATION](#LOCAL-INSTALLATION)
- [DISPLAY](#DISPLAY)
- [RGB](#RGB)
- [rgb with niceview](#rgb-with-niceview)
- [rgb with niceview in two step](#rgb-with-niceview-in-two-step)
- [DONGLE](#DONGLE)
- [USEFUL TIPS](#USEFUL-TIPS)
- [ZMK STUDIO](#ZMK-STUDIO)
- [MODULE INTEGRATION](#MODULE-INTEGRATION)
- [modules used in this repository](#modules-used-in-this-repository)
- [list of useful modules](#list-of-useful-modules)
- [THIS REPOSITORY AS A MODULE](#THIS-REPOSITORY-AS-A-MODULE)
- [INSPIRATIONS](#INSPIRATIONS)
- [MY OTHER PROJECTS](#MY-OTHER-PROJECTS)
- [RELATED PROJECTS](#RELATED-PROJECTS)
- [DONGLE DESIGNS](#DONGLE-DESIGNS)
---- ----
- If you already have your corne - sofle - lily58 configured with this repository and want to make ## Quick start
a modification to your keymap, you can do it with the online [ZMK-STUDIO](https://zmk.studio/).
- If you already have your corne - sofle - lily58 configured with this repository and want to make 1. Fork this repository.
a modification to your keymap, you can do it with the online [keymap-editor](https://nickcoutsos.github.io/keymap-editor/). 2. Edit the keymap for your board in `config/<keyboard>.keymap` (or use the online [keymap-editor] / [ZMK Studio Web](https://zmk.studio/)).
3. Commit and push.
4. On GitHub, go to **Actions → Build → (latest run) → Artifacts** and download the firmware zip for your board.
5. Flash the `.uf2` files to each half:
- `nice_corne_left_oled_rgb.uf2` / `nice_corne_right_oled_rgb.uf2`
- `nice_lily58_left_oled.uf2` / `nice_lily58_right_oled.uf2`
- `nice_sofle_left_rgb_oled.uf2` / `nice_sofle_right_rgb_oled.uf2`
- `nice_sweep_left.uf2` / `nice_sweep_right.uf2`
- `nice_settings_reset.uf2` — flash to both halves if they ever desync; see [Useful tips](#useful-tips).
6. Connect each half to the PC and drag-and-drop the corresponding `.uf2` onto the drive that appears after double-tapping reset.
- If you already have a repository and you want only the dongle option of this repository with support for `zmk-studio`, just add this repository as a module to your configuration, look the section [THIS REPOSITORY AS A MODULE](#THIS-REPOSITORY-AS-A-MODULE). Disable any board you don't need by commenting out its block in [build.yaml](./build.yaml).
# INTRO ## Repo layout
> [!CAUTION]
>
> I AM NOT RESPONSIBLE FOR ANY DAMAGE THIS CODE MAY CAUSE, USE IT AT YOUR OWN
> RISK.
> [!NOTE]
>
>
> FEEL FREE TO MODIFY THE CODE TO YOUR LIKING OR USE WHATEVER YOU NEED. I
> DECIDED TO REVOKE MANY CHANGES AND RETURN TO THE BASE MAPPING, SO THAT
> ADVANCED AND NON-ADVANCED USERS CAN USE THIS REPOSITORY AS A BASE FOR THEIR
> CONFIGURATIONS. IF YOU HAVE ANY QUESTIONS, DON'T HESITATE TO ASK. IF YOU HAVE
> ANY SUGGESTIONS, FEEL FREE TO SUGGEST.
The objective of this repository is to serve as a base for configuring your
corne - sofle - lily58 keyboard with the firmware [ZMK firmware] in a simple and fast way.
without having to configure everything from scratch. Many of us are fascinated
by customizing our keyboards, but sometimes we don't have the time or
experience to do it. That is why I have decided to create this repository so
that you can have a base configuration and you can modify it to your liking.
This base includes the most recent corne - sofle - lily58 configurations, featuring a setup for
the corne - sofle - lily58 dongle with/without an OLED screen.
You can also use your keyboard WITH / WITHOUT a dongle of course. with any of the
plates or screens you have.
Tested with **[puchi_ble_v1]** (used as a dongle and as
peripherals), **[nice_nano_v2]** (used as a dongle and as peripherals),
**clones of nice_nano_v2** (used as a dongle and as peripherals), and the
**[seeeduino_xiao_ble]** (used only as a dongle).
| Main Pros |
|-------------------------------------------------------------------------------------------------|
| mobility and flexibility |
| reduction of tension and fatigue (ergonomic and ortholinear) |
| improved productivity |
| bluetooth and usb-c connection |
| Highly customizable programmable with [ZMK firmware]. |
| compatibility with linux, windows, macos, android, ios and more |
| completely wireless between the two halves and with the PC |
| ultra-low consumption. extends battery life to the limit |
| drag and drop thanks to the included uf2 bootloader |
| no additional software required for flashing |
| support for multiple devices (up to 5) |
| mouse keys |
| rgb |
| macros |
| tap dance |
| combos |
| up to 1 week of use without charger (with 100mah) |
| support [nice-view] screen and oled screen |
| online editor for keymap. see [keymap-editor] |
| 100% open source |
| support for puchi-ble dongle, nice!nano v2, nice!nano v2 clones, seeeduino xiao ble and more... |
| support with dongle with display 128x32, 128x64 and 128x128 |
| and more... |
# QUICK START
> [!NOTE]
>
> 1. With this configuration you can use the corne - sofle - lily58 keyboard practically
> immediately, you just have to follow the following steps and that's it.
>
> 2. If you need precompiled files you can download them from the [firmware
> folder](./firmware)
>
> 3. If you have any problems, you just have to flash the reset firmwares that
> are in the [firmware](./firmware) folder and that's it.
>
> 4. Disable the builds you don't need in the file [build.yaml](./build.yaml),
> by default they are all activated.
### zmk-studio (quick start)
This repository includes the necessary configuration to use zmk-studio without
the need to configure anything else. You just have to follow the steps below:
- fork this repository y flash the firmware to the keyboard with the uf2 files (see as below en normal procedure)
- connect the master (dongle or central) to the PC
- Modify the keyboard mapping on the go with [ZMK Studio
Web](https://zmk.studio/) and enjoy the changes!
### normal procedure
1. Fork this repository (I appreciate if you follow me on [github] and [youtube])
2. Modify the keyboard mapping with [keymap-editor]. If you want to read about
the features of this editor you can do so here: [ZMK Studio Web](https://zmk.studio/) or [keymap-editor](https://github.com/nickcoutsos/keymap-editor).
3. Save changes and commit (optional)
4. Go to actions on github and download the artifacts
- Actions(click) -> All Workflows (click)-> Initial User Config. (here you
scroll to the bottom and click)
- Here is something called artifacts, click to download the file, it is a .zip
- now go to download on your computer (or wherever you have downloads by default):
- unzip the .zip file
- Connect the nice!nano v2 microcontroller to the USB-C port of your computer
- the microcontroller is recognized as a storage device
5. Flash the firmware to the keyboard with the uf2 files (drag and drop and WITH dongle)
- xiao_corne_dongle_xiao_dongle_display.uf2 for [seeeduino_xiao_ble] as a dongle
- nice_corne_left_peripheral.uf2 for [nice_nano_v2] as a peripheral
- nice_corne_right.uf2 for [nice_nano_v2] as a peripheral
6. Flash the firmware to the keyboard with the uf2 files (drag and drop and WITHOUT dongle)
- nice_corne_left.uf2 for [nice_nano_v2] as a master side
- nice_corne_right.uf2 for [nice_nano_v2] as a peripheral
7. If you need help, you can ask in the [ZMK Discord]
8. Enjoy your new keyboard
# LOCAL INSTALLATION
Before making any modifications, please see the [ZMK documentation]
documentation.
Example of an advanced configuration hier -> [^4]
1. Clone _your fork_ of this repository.
```bash
# Replace `mctechnology17` with your username
git clone https://github.com/mctechnology17/zmk-config.git
```
2. Enter the repository.
```bash
cd zmk-config
```
Here you have a preview of how the repository is organized:
```bash
zmk-config # main folder
├── LICENSE # license
├── Makefile # file for compilation
├── README.md # readme this file
├── build.yaml # config file for compilation on the github server
│   boards
│   ├── ... # other boards
│   ├── nice_nano_v2.overlay
│   ├── puchi_ble_v1.overlay
│   └── shields
│   ├── corne
│   │   ├── Kconfig.defconfig # modify if you want to add a new shield
│   │   ├── Kconfig.shield # modify if you want to add a new shield
│   │   ├── boards
│   │   │   ├── ... # other boards
│   │   ├── corne.conf # general configurations of the corne
│   │   ├── corne.dtsi # default dtsi
│   │   ├── corne.keymap # default keymap
│   │   ├── corne.zmk.yml # modify if you want to add a new shield
│   │   ├── corne_dongle_pro_micro.conf # conf dongle pro_micro pinout
│   │   ├── corne_dongle_pro_micro.overlay # properties/displays dongle
│   │   ├── corne_dongle_xiao.conf # conf dongle xiao pinout
│   │   ├── corne_dongle_xiao.overlay # properties/displays dongle
│   │   ├── corne_left.conf # conf left
│   │   ├── corne_left_peripheral.conf # config left peripheral
│   │   ├── corne_right.conf # conf right
│   │   ├── ... # other files
│   └── dongle_display
│      ├── ... # here you can modify the screen widgets
│      └── widgets
│      └── # here you can modify the screen widgets
│ config # configuration folder
│   ├── config_keymap-drawer.yaml # config file keymap-drawer
│   ├── corne.conf # general configurations of the corne
│   ├── corne.keymap # your keymap file
│   ├── keymap_german_mac_iso_zmk.h # example of definition for german mac iso
│   └── west.yml # conf to connect with the repository
├── firmware
│   └── *.uf2 # all the firmwares
├── keymap-drawer # folder with the keymap-drawer
│   ├── corne.svg # img of the keymap
│   └── corne.yaml # keymap file yaml format for keymap-drawer
└── src
└── ... # other files
```
To compile with make, just run the following command:
> [!IMPORTANT]
>
> 1. You have to have [docker](https://www.docker.com/products/docker-desktop/)
> installed on your computer to use this command.
> 2. Check the [makefile](./makefile) file for build options.
```bash
make codebase_urob # clones urob's zmk firmware and initializes it
make corne_urob # compile all the *.uf2 of the corne and copy them to the firmware folder
```
# DISPLAY
1. ePAPER
- The nice!view is a SSD1306 OLED replacement boasting >1,000x power savings
while keeping a 30Hz refresh rate. It has a similar pinout to SSD1306
OLEDs with one extra pin making it easy to add on to existing boards.
- the [nice-view] screen is compiled by default in this repository.
2. OLED
- SSD1306 / sh1107 / sh1106 OLED displays are one of the most common in
mechanical keyboard kits. They're often used to display information about
your keyboard, such as which layer is active, or if any modifiers like
Caps Lock, Num Lock or Scroll Lock are on. Of course, you can display
anything you want, including images and animations.
- These displays work over I2C and should be powered with 5V. They are
compatible with Pro Micro-based kits.
- the oled screen for the dongle is enabled by default in this repository.
- If you want to enable the OLED screen for the halves, you can do so by
modifying the `.conf` files for their respective halves.
- Remember to disable the [nice-view] screens to avoid conflict in the compilation.
3. FULL COLOR LCD SCREEN
- [Prospector](https://github.com/carrefinho/prospector) is a desktop ZMK dongle with full color LCD screen.
> [!IMPORTANT]
>
> 1. To modify the dongle's OLED screen you can modify the `.overlay` file as follows for its respective board:
[corne_dongle_xiao.overlay](./config/boards/shields/corne/corne_dongle_xiao.overlay) and
[corne_dongle_pro_micro.overlay](./config/boards/shields/corne/corne_dongle_pro_micro.overlay). There you can find as a comment examples for the 128x32, 128x64, 128x128 screens and [nice-view] for the dongle screen.
> 3. For the 128x128 OLED screen model sh1107 there are no default drivers in Zephyr, so neither in ZMK, but you can add it yourself with this small tutorial (This tutorial is the same for the OLED screens mentioned above):
You just have to modify the following line:
```dts
// replace the following lines for the 128x64 screen by default
&pro_micro_i2c {
status = "okay";
oled: ssd1306@3c {
compatible = "solomon,ssd1306fb";
reg = <0x3c>;
width = <128>;
height = <64>;
segment-offset = <0>;
page-offset = <0>;
display-offset = <0>;
multiplex-ratio = <63>;
segment-remap;
com-invdir;
inversion-on;
prechargep = <0x22>;
};
};
// for this (i.e. just copy and paste) replace the 128x64 screen with the 128x128 sh1107 screen
&pro_micro_i2c {
status = "okay";
oled: sh1106@3c {
compatible = "sinowealth,sh1106";
reg = <0x3c>;
width = <120>;
height = <128>;
segment-offset = <0>;
page-offset = <0>;
display-offset = <0>;
multiplex-ratio = <119>;
segment-remap;
com-invdir;
inversion-on;
prechargep = <0x22>;
};
};
``` ```
zmk-config
# RGB ├── build.yaml # GitHub Actions build matrix
> [!WARNING] ├── boards/
> │ ├── nice_nano.overlay # RGB underglow (WS2812 over SPI) for nice!nano v1
> 1. If you use [nice-view] you cannot use rgb, since [nice-view] uses the same │ ├── nice_nano_v2.overlay # same, for nice!nano v2
> pinout as rgb. │ └── shields/
│ ├── corne/
If you are interested in using RGB on your keyboard you can see the │ ├── lily58/
configuration in the branch │ ├── sofle/
[power/domains-and-device-runtime](https://github.com/mctechnology17/zmk-config/tree/power/domains-and-device-runtime) │ └── sweep/
from this same repository. │ ├── Kconfig.shield / Kconfig.defconfig
│ ├── <name>.dtsi # matrix transform + kscan
Here is an example of what it looks like: │ ├── <name>.zmk.yml # shield metadata
[![rgb-demo](src/demo.GIF)](https://www.youtube.com/c/mctechnology17) │ ├── <name>_left.overlay / <name>_right.overlay
│ ├── <name>_left_peripheral.* # optional, unused template
## rgb with niceview │ └── <name>_dongle_xiao.* / <name>_dongle_pro_micro.* # optional, unused templates
Points to take into account if you want to use niceview with RGB: ├── config/
- In a nutshell, the problem is that the backlight and the nice!view display │ ├── west.yml # ZMK manifest (pinned revision, see comment in the file)
use the same pin on the pcb, causing conflicts. │ ├── config_keymap-drawer.yaml
- The common solution is to solder the backlight to pin 008 and set it to the keymap. │ └── <keyboard>.keymap / <keyboard>.conf
- However, this means that both the screen and backlight share the same power ├── keymap-drawer/ # auto-generated keymap diagrams (svg + yaml)
source, which can drain the battery quickly. └── snippets/
- There is no ideal solution, but some options include redesigning the boards └── rgb-config/ # shared RGB underglow Kconfig, used by corne/sofle/lily58
to separate the power or powering the display directly from a gpio pin.
## rgb with niceview in two step
1. solder the nice!view display to pin 008
2. set the display to use pin 008 in the keymap
3. recompile the firmware and enjoy the nice!view display with RGB
```c
&nice_view_spi {
cs-gpios = <&pro_micro 0 GPIO_ACTIVE_HIGH>; // use D0 (008) for CS (no 006)
};
``` ```
# DONGLE ## Keyboards
> [!TIP]
>
> 1. You can connect the display to the dongle directly to the i2c port of the
> handwired style dongle, or you can connect it to a usb-c port of the pcb
> style dongle.
> 2. You can see the connections in the following diagram for [seeeduino_xiao_ble](./src/pinout-seeeduino_xiao_ble.png) and for the boards with [pro_micro](./src/pinout-pro_micro.png) connections as the [nice_nano_v2] and the [puchi_ble_v1].
> 3. You can print a case for the dongle, you can see the designs below in the section [Dongle Designs](#Dongle-Designs).
> 4. You can print a pcb for the dongle, you can see the designs in the section [Dongle Designs](#Dongle-Designs).
> 5. You can program a macro that references the `&bootloader` action so that the dongle enters bootloader mode and you can flash the firmware again. The macros are executed on the master so this action causes the dongle to enter bootloader mode. Thanks @chadtrans for the tip!
In the following image you can see how you can connect the OLED screen to the | Keyboard | Shields | Display | RGB | Notes |
dongle: |----------|---------------------------|------------|-----|-------|
[![dongle-demo](src/dongle.jpg)](https://www.youtube.com/c/mctechnology17) | Corne | `corne_left`, `corne_right` | nice!oled | yes | |
| Lily58 | `lily58_left`, `lily58_right` | nice!oled | no | encoders supported in `lily58.dtsi`, not wired up in the default keymap |
| Sofle | `sofle_left`, `sofle_right` | nice!oled | yes | encoders supported |
| Sweep | `sweep_left`, `sweep_right` | none | no | 34-key direct-pin board (same PCB as the upstream ZMK `cradio` shield) |
Information about this image: Each keyboard's keymap lives at `config/<keyboard>.keymap`, with diagrams auto-generated to `keymap-drawer/<keyboard>.svg` on every push that touches a `.keymap` file (see [.github/workflows/keymap-drawer.yaml](./.github/workflows/keymap-drawer.yaml)). Sweep doesn't have a diagram yet — its custom physical layout isn't recognized by the keymap-drawer auto-detection.
- The photo shows a [seeeduino_xiao_ble] dongle with an OLED 128x128 sh1107 display connected to the handwired style i2c port. This dongle acts as master.
- The left side acts as peripheral in this case, the board is a [puchi_ble_v1].
- The right side acts as a peripheral in this case, the board is a [nice_nano_v2].
- The photo shows a clone [nice_nano_v2] dongle with an OLED display connected to a traditional i2c port in a pcb style. This dongle is only for sample photo and is not connected to any device shown in the photo.
Combo example to enter bootloader mode. On your `settings_reset` is ZMK's built-in shield for clearing a half's Bluetooth bonds — flash it to fix desynced halves (see [Useful tips](#useful-tips)).
[corne.keymap](./config/corne.keymap) file you can add the following combo (Thanks @VictorSCamargo for the tip!):
> [!TIP]
>
> 1. You can program this `combo` with the online editor [keymap-editor]
> 2. These examples were tested using a `corne` keyboard, so the numbers `0 1 2` correspond to the keys on the left of the first row of the keyboard and the numbers `9 10 11` correspond to the 3 right keys at the top of columns 3, 4 and 5. see the reference below `COMBO` for more details.
> 3. You can combine both forms of combos and in both cases the keyboard that is the master (dongle or central) is the one that executes the action, in this case the dongle or the left master enters bootloader mode.
1. This is the manual way to do it using `c` code: ## Display
```c Corne, Lily58, and Sofle use the [nice!oled] module (`zmk-nice-oled` in `config/west.yml`) for a 128x32 SSD1306 OLED on each half, enabled via the `nice_oled` shield in `build.yaml`. Sweep has no display.
// this is the manual way to do it
#define COMBO(NAME, BINDINGS, KEYPOS, LAYERS) \
combo_##NAME { \
bindings = <BINDINGS>; \
key-positions = <KEYPOS>; \
layers = <LAYERS>; \
};
// for the right side
// COMBO NAME = combo_bootloader_right,
// BINDINGS = &bootloader,
// KEYPOSITION = 9 10 11,
// LAYERS = 0
COMBO(combo_bootloader_right, &bootloader, 9 10 11, 0);
```
2. This is the manual way to do it using `dts` code: ## RGB underglow
```dts Corne and Sofle build with WS2812 underglow enabled via the `rgb-config` snippet (`snippets/rgb-config/rgb-config.conf`), which is applied through the `snippet:` field in their `build.yaml` entries. The actual LED strip wiring lives in `boards/nice_nano.overlay` / `boards/nice_nano_v2.overlay`.
// for the left side
combo_bootloader_left {
timeout-ms = <50>;
key-positions = <0 1 2>; // Pressing the 3 first keys on the keyboard will trigger &bootloader
bindings = <&bootloader>;
};
};
```
# USEFUL TIPS Lily58 and Sweep don't enable this snippet, so they build without RGB.
> [!TIP]
>
> Below are some useful tips for using your corne - sofle - lily58 keyboard with this
> configuration.
- You can add a reset key on each half, that's useful for when your halves disconnect/desynchronize, or something unusual happens. That way the firmware is loaded again. see reference in [corne.keymap](./config/corne.keymap) ## Dongle / peripheral templates
- You can add a bootloader activator on each half in case you don't have access to the bootloader button, it is useful in case your case is not optimized or you just want that option. see reference in [corne.keymap](./config/corne.keymap)
- If both halves were disconnected/unsynchronized, you just have to press the reset button on both halves 10 times in a row and they will reconnect.
- If you want to flash the firmware again you just have to connect the keyboard (that is, one half first, usually the left one) press the reset button 2 times in a row
and your device is recognized as a hard disk storage drive, then just drag the file to flash and that's it. do the same with the other half.
- Remember that if your corne - sofle - lily58 only has some functional RGB lights you can activate only the ones that you have functional, it is not necessary to activate all the lights. see reference in [led strip](./config/corne.keymap)
- You can combine the boards, for example: on the left you can have a [nice_nano_v2], on the right a [puchi_ble_v1] and on the dongle a [seeeduino_xiao_ble] or some clone [nice_nano_v2], or any combination you can think of.
# ZMK STUDIO `boards/shields/{corne,lily58,sofle}/` each include `_dongle_xiao`, `_dongle_pro_micro`, and `_left_peripheral` shield variants, and `config/west.yml` pulls in three more modules for them (`zmk-dongle-display`, `zmk-dongle-display-view`, `zmk-oled-adapter`). None of these are wired up in `build.yaml` right now — they're kept as a starting point if you want to build a dongle setup later, not something this repo currently builds or tests.
This repository includes the necessary configuration to use zmk-studio without ## ZMK Studio
the need to configure anything else. You just have to follow the steps below:
- fork this repository y flash the firmware to the keyboard with the uf2 files
- connect the master (dongle or central) to the PC
- Modify the keyboard mapping on the go with [ZMK Studio
Web](https://zmk.studio/) and enjoy the changes!
> [!TIP] ZMK Studio is enabled on every active build (`CONFIG_ZMK_STUDIO=y`, `CONFIG_ZMK_STUDIO_LOCKING=n`, and the `studio-rpc-usb-uart` snippet), so you can remap keys live from [zmk.studio](https://zmk.studio/) without recompiling:
> 1. Flash the firmware as usual.
> 1. For zmk-studio it is necessary to enable the `&studio_unlock` macro but you 2. Connect the central/master half to your PC.
> can skip this if you use `CONFIG_ZMK_STUDIO_LOCKING=n` in your zmk 3. Open [zmk.studio](https://zmk.studio/) and connect to your keyboard.
> configuration. This is enabled by default in this repository.
> 2. Remember that this has to be activated on the master and the dongle:
> `snippet: studio-rpc-usb-uart`
> 3. with the `cmake-args: -DCONFIG_ZMK_USB=y` flag you can activate the master
> (dongle or central) to connect always defaults to usb.
> 4. The zmk-studio only connects with USB on the web and only BLE in the app,
> it is useful to have a toggle key to switch between BLE and USB. (this is
> what I understood, if not, please correct me)
Useful links: ## Modules
- [ZMK Studio Web](https://zmk.studio/)
- [ZMK Studio Unlock Behavior](https://zmk.dev/docs/keymaps/behaviors/studio-unlock/)
- [ZMK Studio Testing Steps / click hier for more ...](https://discord.com/channels/719497620560543766/719544534500900886/1296241576263024641):
* [Set up ZMK Studio](https://zmk.dev/docs/development/hardware-integration/studio-setup) for your device, if needed.
* [Build with ZMK Studio enabled](https://zmk.dev/docs/features/studio) and flash to the device.
* Test ZMK Studio by loading https://zmk.studio/ or installing the app from the latest release at https://github.com/zmkfirmware/zmk-studio/releases/
### Reporting Declared in `config/west.yml`:
Please report any and all testing results, even successful results in [Discord | Module | Status | Purpose |
zmk-studio](https://discord.com/channels/719497620560543766/722441502948851741.) |--------|--------|---------|
If you have a genuine bug to report, please file a new [GitHub | [zmk-nice-oled] | active | OLED display widgets, used by Corne/Lily58/Sofle's `nice_oled` shield |
Issue](https://github.com/zmkfirmware/zmk-studio/issues/new/choose). With any | [zmk-dongle-display] | optional, unused | dongle battery/status display — only needed by the dongle template variants |
bugs or testing results, please include all the relevant details, including the | [zmk-dongle-display-view] | optional, unused | nice!view-style version of the above |
host OS, app/browser details, keyboard used, link to your config repo, etc. | [zmk-oled-adapter] | optional, unused | adapter for 128x32/64/128 OLEDs without modifying shield files |
# MODULE INTEGRATION ## Useful tips
> [!TIP]
>
> 1. Remember that animations consume energy, so if you want to conserve your battery, turn off the animations!
> 2. Please consult the documentation of each module that you are going to use, here I leave you the links for each one.
## modules used in this repository - If both halves desync (won't pair), flash `nice_settings_reset.uf2` to **both** halves, then reflash the actual firmware to each.
See module details here for more information and more configurations: - To re-flash a half, double-tap its reset button — it should mount as a USB drive — then drag the `.uf2` onto it.
- [**nice_view_gem**](https://github.com/M165437/nice-view-gem) a sleek customization for the nice!view shield
- [**nice_oled**](https://github.com/mctechnology17/zmk-nice-oled) vertical widgets for oled screens with zmk for split and non-split keyboards using the standard [oled screen](https://keycapsss.com/keyboard-parts/parts/80/0.91-oled-lcd-display-128x32-ssd1306-i2c) 128x32.
- [**zmk-dongle-display**](https://github.com/englmaxi/zmk-dongle-display) to show the peripheral battery percentage (and more!) on the display of the dongle.
- [**dongle_display!view**](https://github.com/mctechnology17/zmk-dongle-display-view) to show the peripheral battery percentage (and more!) on the display of the dongle using the nice!view display.
- [**oled Adapter**](https://github.com/mctechnology17/zmk-oled-adapter) to use the 128x32, 128x64 and 128x128 OLED screens on keyboards with ZMK without having to modify the shields of the keyboards.
## list of useful modules ## Credits
Additional features are provided by the following [modules](https://zmk.dev/docs/features/modules):
- [**zmk-antecedent-morph**](https://github.com/ssbb/zmk-antecedent-morph) to change the behavior of a key based on the previously pressed key. This is used to type `<=`, `>=`, `!=`, `=>`, `->`, `|>`, `./` and `#include ` more comfortably.
- [**zmk-locales**](https://github.com/joelspadin/zmk-locales) to provide key codes for non-US keyboard locales.
- [**zmk-rgbled-widgets**](https://github.com/caksoylar/zmk-rgbled-widget) to show the connection and battery status with the built-in LEDs of the Xiao BLE controller.
- [**zmk-led_indicator**](https://github.com/englmaxi/zmk-config/tree/main/boards/shields/led_indicator) to show the connection and battery status with the built-in LEDs to be used with the single LED of the nice!nano. Based on the [**zmk-rgbled-widgets**](https://github.com/caksoylar/zmk-rgbled-widget)
- [**zmk-tri-state**](https://github.com/urob/zmk-tri-state) to define a custom <kbd>swapper</kbd> and a <kbd>select-word</kbd> behavior.
- [**zmk-layer-listeners**](https://github.com/ssbb/zmk-layer-listeners) - call something on layer enter/leave. I use it for haptic feedback and to reset nav layer toggled keys on leave.
- [**zmk-deadkey-slayer**](https://github.com/ssbb/zmk-deadkey-slayer) - drop invalid keycodes. I use them quite a lot as a markers, way to reset sticky keys, etc. so they aren't sent to the host (in which case eg MacOS disconnects device after some limit)
- [**zmk-raw-hid**](https://github.com/zzeneg/zmk-raw-hid) - raw HID - Custom nice!view widget that adds time, layout and volume information. This data is received from host computer with companion app over HID interface (aka Raw HID from QMK).
- [**zmk-nice-view-hid**](https://github.com/zzeneg/zmk-nice-view-hid) - Custom nice!view widget that adds time, layout and volume information. This data is received from host computer with companion app over HID interface (aka Raw HID from QMK).
- [**zmk-hid-host**](https://github.com/zzeneg/qmk-hid-host) - HID host - Custom nice!view widget that adds time, layout and volume information. This data is received from host computer with companion app over HID interface (aka Raw HID from QMK).
# THIS REPOSITORY AS A MODULE
1. In the `config/west.yml` file, add a new remote and its related project.
```yaml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
# include corne with dongle pro_micro and xiao compatible
- name: mctechnology17
url-base: https://github.com/mctechnology17
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
# include corne with dongle pro_micro and xiao compatible
- name: zmk-config
remote: mctechnology17
revision: main
self:
path: config
```
2. In the `build.yaml` file, add the `corne_dongle_pro_micro` or the `corne_dongle_xiao` shield.
```yaml
---
include:
# example with xiao dongle without display
- board: seeeduino_xiao_ble
shield: corne_dongle_xiao
cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"Xiao_Dongle\" -DCONFIG_ZMK_STUDIO=y
artifact-name: xiao_corne_dongle_xiao
snippet: studio-rpc-usb-uart
# ... the rest of the shields
```
3. Build the firmware, flash it to your keyboard, and enjoy!
# INSPIRATIONS
This config was originally based on [mctechnology17/zmk-config](https://github.com/mctechnology17/zmk-config). General ZMK config inspiration also drawn from:
- [englmaxi/zmk-config](https://github.com/englmaxi/zmk-config) - [englmaxi/zmk-config](https://github.com/englmaxi/zmk-config)
- [caksoylar/zmk-config](https://github.com/caksoylar/zmk-config) - [caksoylar/zmk-config](https://github.com/caksoylar/zmk-config)
- [joelspadin/zmk-locale-generator](https://github.com/joelspadin/zmk-locale-generator)
- [minusfive/zmk-config](https://github.com/minusfive/zmk-config)
- [infused-kim/zmk-config](https://github.com/infused-kim/zmk-config)
- [urob/zmk-config](https://github.com/urob/zmk-config) - [urob/zmk-config](https://github.com/urob/zmk-config)
- [infused-kim/zmk-config](https://github.com/infused-kim/zmk-config)
# MY OTHER PROJECTS: Keymap diagrams generated with [keymap-drawer](https://github.com/caksoylar/keymap-drawer).
- [nice!oled](https://github.com/mctechnology17/zmk-nice-oled): nice_oled
vertical widgets for oled screens with zmk (for split and non-split
keyboards)
- [dongle_display!view](https://github.com/mctechnology17/zmk-dongle-display-view): This is a mix between display_dongle and nice!view that allows you to use the nice!view display with your dongle.
- [oled_adapter](https://github.com/mctechnology17/zmk-oled-adapter): This
module is an adapter for 128x32, 128x64 and 128x128 OLED screens, to be used
on keyboards with ZMK without having to modify the shields of the keyboards.
- [qmk-config] will be updated soon
- [qmk_userspace] will be updated soon
- [vimtools] swiss army knife for vim (features and settings that will make your life easier)
- [gm] cross-platform git manager with friendly user interface
- [vim-better-header] the best automated template
- [vim-executor] multilanguage code executor
If you enjoy my contributions, feel free to donate. I appreciate if you follow me on [github] and [youtube]
- [paypal]
- [sponsor]
# RELATED PROJECTS
I used this project as a reference to configure the dongles with OLED screen:
- [cygnus](https://github.com/rain2813/zmk-cygnus-oled.git) by @rain2813
- [zmk keyboard Macintosh dongle display](https://makerworld.com/en/models/403660) by @rain2813
- [corne with dongle](https://github.com/tomgroenwoldt/zmk-config.git) by @tomgroenwoldt
- [zmk-dongle-display](https://github.com/englmaxi/zmk-dongle-display.git) by @englmaxi
- [zmk-config for module](https://github.com/englmaxi/zmk-config/tree/master/boards/shields) by @englmaxi
- [zmk-config for dongle pro micro](https://github.com/joaopedropio/zmk-swoop/tree/dongle-sdd1306) by @joaopedropio
In the following animations created by @englmaxi you can see what the dongle
looks like with the 128x64 OLED screen:
![output](https://github.com/englmaxi/zmk-config/assets/43675074/8d268f23-1a4f-44c3-817e-c36dc96a1f8b)
In that animation you can see the connection or output with the computer, that
is, if it is through a USB or Bluetooth port. Also information about the status
of both batteries.
![mods](https://github.com/englmaxi/zmk-config/assets/43675074/af9ec3f5-8f61-4629-abed-14ba0047f0bd)
In this animation you can see the actions of the modifier keys, such as
control, shift, alt, windows/mac, etc.
# DONGLE DESIGNS
- [case1](https://github.com/englmaxi/zmk-dongle-display/raw/main/cases/case1.zip) by @englmaxi
- [case2](https://github.com/englmaxi/zmk-dongle-display/raw/main/cases/case2.zip) by @englmaxi
- [Cyberdeck](https://github.com/rafaelromao/keyboards/tree/main/stls/Dongle) by @rafaelromao
- [Dongle PCB](https://github.com/spe2/zmk_dongle_hardware) by @spe2
- [Macintosh](https://makerworld.com/en/models/403660) by @rain2813
- [Redox](https://makerworld.com/en/models/242951) by @rurounikexin
- [ZMK Display Dongle](https://makerworld.com/en/models/496738) by @yingeling
An example of Dongle Designs (by @rain2813):
[![dongle-designs-demo](src/macintosh.png)](https://www.youtube.com/c/mctechnology17)
# TODO
- [ ] Add more features to the repository
- [ ] Update the documentation
[^1]: Keymap-drawer, https://github.com/caksoylar/keymap-drawer https://keymap-drawer.streamlit.app/
[^2]: caksoylar zmk-config example for keymap-drawer https://github.com/caksoylar/zmk-config
[^3]: Install pipx, https://pipx.pypa.io/stable/
[^4]: Urob zmk-config, https://github.com/urob/zmk-config
[^5]: Urob ZMK Firmware: Personal fork, https://github.com/urob/zmk/
[qmk-config]: https://github.com/mctechnology17/qmk-config
[qmk_userspace]: https://github.com/mctechnology17/qmk_userspace
[github]: https://github.com/mctechnology17
[twitter]: https://twitter.com/mctechnology17
[youtube]: https://www.youtube.com/c/mctechnology17
[instagram]: https://www.instagram.com/mctechnology17/
[facebook]: https://m.facebook.com/mctechnology17/
[reddit]: https://www.reddit.com/user/mctechnology17
[nice-view]: https://nicekeyboards.com/nice-view
[puchi_ble_v1]: (https://keycapsss.com/keyboard-parts/mcu-controller/202/puchi-ble-wireless-microcontroller-pro-micro-replacement?number=KC10157_SWITCH&c=18)
[seeeduino_xiao_ble]: (https://keycapsss.com/keyboard-parts/mcu-controller/212/seeed-studio-xiao-nrf52840-rp2040-esp32c3?number=KC10167_NRF)
[nice_nano_v2]: (https://nicekeyboards.com/nice-nano)
[keymap-editor]: https://nickcoutsos.github.io/keymap-editor/ [keymap-editor]: https://nickcoutsos.github.io/keymap-editor/
[ZMK firmware]: https://github.com/zmkfirmware/zmk/ [nice!oled]: https://github.com/mctechnology17/zmk-nice-oled
[ZMK documentation]: https://zmk.dev/docs/user-setup [zmk-nice-oled]: https://github.com/mctechnology17/zmk-nice-oled
[ZMK keycodes]: https://zmk.dev/docs/codes [zmk-dongle-display]: https://github.com/englmaxi/zmk-dongle-display
[ZMK Discord]: https://zmk.dev/community/discord/invite [zmk-dongle-display-view]: https://github.com/mctechnology17/zmk-dongle-display-view
[git]: (https://github.com/git-guides/install-git) [zmk-oled-adapter]: https://github.com/mctechnology17/zmk-oled-adapter
[vim-executor]: https://github.com/mctechnology17/vim-executor
[vim-better-header]: https://github.com/mctechnology17/vim-better-header
[gm]: https://github.com/mctechnology17/gm
[vimtools]: https://github.com/mctechnology17/vimtools
[jailbreakrepo]: https://mctechnology17.github.io/
[uiglitch]: https://repo.packix.com/package/com.mctechnology.uiglitch/
[uiswitches]: https://repo.packix.com/package/com.mctechnology.uiswitches/
[uibadge]: https://repo.packix.com/package/com.mctechnology.uibadge/
[youtuberepo]: https://github.com/mctechnology17/youtube_repo_mc_technology
[sponsor]: https://github.com/sponsors/mctechnology17
[paypal]: https://www.paypal.me/mctechnology17
[readline]: https://github.com/PowerShell/PSReadLine/blob/master/README.md

24
build.yaml
View file

@ -91,17 +91,17 @@ include:
cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"Sweep\" cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"Sweep\"
artifact-name: nice_sweep_right artifact-name: nice_sweep_right
# ### LILY58 START ### ### LILY58 START ###
# # nice!oled lily58 # nice!oled lily58
# - board: nice_nano_v2 - board: nice_nano_v2
# shield: lily58_left nice_oled shield: lily58_left nice_oled
# cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"lily58_Oled\" -DCONFIG_ZMK_STUDIO=y -DCONFIG_ZMK_SLEEP=y -DCONFIG_ZMK_IDLE_TIMEOUT=60000 cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"lily58_Oled\" -DCONFIG_ZMK_STUDIO=y -DCONFIG_ZMK_SLEEP=y -DCONFIG_ZMK_IDLE_TIMEOUT=60000
# artifact-name: nice_lily58_left_oled artifact-name: nice_lily58_left_oled
# snippet: studio-rpc-usb-uart snippet: studio-rpc-usb-uart
# - board: nice_nano_v2 - board: nice_nano_v2
# shield: lily58_right nice_oled shield: lily58_right nice_oled
# cmake-args: -DCONFIG_ZMK_SLEEP=y -DCONFIG_ZMK_IDLE_TIMEOUT=60000 cmake-args: -DCONFIG_ZMK_SLEEP=y -DCONFIG_ZMK_IDLE_TIMEOUT=60000
# artifact-name: nice_lily58_right_oled artifact-name: nice_lily58_right_oled
# # peripheral_left # # peripheral_left
# - board: nice_nano_v2 # - board: nice_nano_v2
@ -115,7 +115,7 @@ include:
# cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"lily58Dongle_P\" -DCONFIG_ZMK_STUDIO=y -DCONFIG_ZMK_SLEEP=n -DCONFIG_ZMK_IDLE_TIMEOUT=60000 # cmake-args: -DCONFIG_ZMK_KEYBOARD_NAME=\"lily58Dongle_P\" -DCONFIG_ZMK_STUDIO=y -DCONFIG_ZMK_SLEEP=n -DCONFIG_ZMK_IDLE_TIMEOUT=60000
# artifact-name: nice_lily58_dongle_oled # artifact-name: nice_lily58_dongle_oled
# snippet: studio-rpc-usb-uart # snippet: studio-rpc-usb-uart
# ### LILY58 END ### ### LILY58 END ###
### SETTINGS_RESET START ### ### SETTINGS_RESET START ###
- board: nice_nano_v2 - board: nice_nano_v2

4
config/west.yml
View file

@ -9,6 +9,10 @@ manifest:
- name: mctechnology17 - name: mctechnology17
url-base: https://github.com/mctechnology17 url-base: https://github.com/mctechnology17
projects: projects:
# Pinned to v0.3.0 instead of `main`: ZMK main tracks Zephyr 4.1, whose
# board-model rewrite renamed `nice_nano_v2` (now `nice_nano//zmk`) and
# split the `WS2812_STRIP` Kconfig symbol per-driver. Bumping this back to
# `main` will break every build.yaml entry below until those are updated.
- name: zmk - name: zmk
remote: zmkfirmware remote: zmkfirmware
revision: v0.3.0 revision: v0.3.0

0
snippets/common-config/common-config.conf
View file

3
snippets/common-config/snippet.yml
View file

@ -1,3 +0,0 @@
name: common-config
append:
EXTRA_CONF_FILE: common-config.conf

BIN
src/demo.GIF
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 26 MiB

BIN
src/dongle.jpg
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 2.6 MiB

BIN
src/handwired_trackpoint.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 71 KiB

BIN
src/macintosh.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 1.6 MiB

BIN
src/niceview_pinout.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 58 KiB

BIN
src/pinout-v2.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 164 KiB

BIN
src/puchi-ble-pinout.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 122 KiB