ZMK Taipo Implementation
This repo contains the ZMK Taipo implementation and pre-built firmware for boards that have been setup to use Taipo by the core Taipo development team.
Prebuilt Firmware
The Releases
area of this repository contains the latest builds of the ZMK Taipo implementation. You can click on the most recent release and download the appropriate artifact for your MCU + board combination. Inside the zip file will be the necessary file for flashing your MCU.
Firmware Files
Inside the firmware zip file will be 4 files
taipo.dtsi
: The Taipo definition that was used for the build- A file with
.dts.pre.tmp
at the end that is the generated DTS file used for the build (this is for any required troubleshooting) - A file with
-zmk-taipo.hex
at the end that is the hex firmware image that can be used to flash your MCU - A file with
-zmk-taipo.uf2
at the end that is the uf2 firmware image that can be used to flash your MCU
Please Note: the hex
and uf2
files may or may not be present depending on your MCU + board combo. PLEASE use the proper file for flashing your board.
We are NOT responsible for any failed firmware flashes!
Layout
The official layout can be found on the Inclusive Keyboards Taipo Page. This configuration also includes some extra keybindings which use both thumb keys together.
Input Output Inner Outer Both
#--- r R >
----
-#-- s S } -
----
--#- n N ] -
----
---# i I ) -
----
---- a A < -
#---
---- o O { -
-#--
---- t T [ -
--#-
---- e E ( -
---#
##-- b B 9 F9
----
--## y Y 5 F5
----
---- l L 4 F4
##--
---- h H 0 F10
--##
---- u U 2 F2
-##-
-##- p P 7 F7
----
#-#- z Z 8 F8
----
-#-# f F 6 F6
----
---- q Q 3 F3
#--#
---- c C 1 F1
-#-#
---- d D @ F11
#--#
#--# g G # F12
----
#--- x X ^ -
--#-
---# k K + -
-#--
-#-- v V * -
---#
--#- j J = -
#---
#--- m M $ -
---#
---# w W & -
#---
-#-- / \ | -
--#-
--#- - _ % -
-#--
#--- ; :
-#--
---# ? !
--#-
--#- , . ~
---#
-#-- ' " `
#---
-### Tab Del Fn
----
---- Enter Esc AltGr
-###
#--- Gui Right PgUp
#---
-#-- Alt Up Home
-#--
--#- Ctrl Down End
--#-
---# Shift Left PgDn
---#
Adding Taipo Support
If you'd like to add Taipo support to a board that supports ZMK but is not built by this repo. Please follow the standard ZMK docs on how to add a new shield but using this repo as your zmk-config
and open a Pull Request.
Also, update the .github/workflows/build.yml
file for the new board being submitted.
Note: This repo is setup with github actions so you can work directly via GitHub Actions similar to how the ZMK documentation outlines.
Docker development
Setup and build
./docker-image.sh
./docker-dev.sh
west init -l config
west update
west zephyr-export
west build -s zmk/app -b nice_nano_v2 -- -DSHIELD="cradio_taipo_left" -DZMK_CONFIG="$PWD/config"
Resume after quitting
docker start -i zmk-taipo-dev
Clean up
docker rm zmk-taipo-dev
Licensing
Unless otherwise stated all source code is licensed under the Apache 2 License.
Unless otherwise stated the non source code contents of this repository are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License