diff --git a/README.md b/README.md index b22c244a..ef8f4303 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# zmk-config \ No newline at end of file +# ZMK Firmware for Dao keyboard + +## Default keymap + + +### Dao44 + +Visual representation of the default keymap in keyboard-layout-editor: [KLE](http://www.keyboard-layout-editor.com/#/gists/c6ba0634e5b92366be9f324775394e66) + +This layout is heavily inspired by [this](https://github.com/KGOH/Jian-Info) + +### Dao42 + +Visual representation of the default keymap in keyboard-layout-editor: [KLE](http://www.keyboard-layout-editor.com/#/gists/67a81f6b83c65abcda5e7f32989a1688) + +Because of current ZMK limitations, Dao42 keymap is in the branch [dao42](https://github.com/yumagulovrn/dao-zmk-config/tree/dao42) + +This layout is heavily inspired by [this](https://github.com/aroum/Watchman-layouts) + +## Documentation + +Answers to frequently asked questions can be found in [FAQ](docs/FAQ.md) diff --git a/build.yaml b/build.yaml new file mode 100644 index 00000000..565b933d --- /dev/null +++ b/build.yaml @@ -0,0 +1,5 @@ +include: + - board: dao_left + - board: dao_right + - board: nice_nano_v2 + shield: settings_reset diff --git a/config/boards/arm/dao/Kconfig b/config/boards/arm/dao/Kconfig new file mode 100644 index 00000000..4bc7e0de --- /dev/null +++ b/config/boards/arm/dao/Kconfig @@ -0,0 +1,8 @@ +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +config BOARD_ENABLE_DCDC + bool "Enable DCDC mode" + select SOC_DCDC_NRF52X + default y + depends on (BOARD_DAO_LEFT || BOARD_DAO_RIGHT) diff --git a/config/boards/arm/dao/Kconfig.board b/config/boards/arm/dao/Kconfig.board new file mode 100644 index 00000000..accc3e29 --- /dev/null +++ b/config/boards/arm/dao/Kconfig.board @@ -0,0 +1,12 @@ +# Dao board configuration + +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +config BOARD_DAO_LEFT + bool "dao_left" + depends on SOC_NRF52840_QIAA + +config BOARD_DAO_RIGHT + bool "dao_right" + depends on SOC_NRF52840_QIAA diff --git a/config/boards/arm/dao/Kconfig.defconfig b/config/boards/arm/dao/Kconfig.defconfig new file mode 100644 index 00000000..f4297434 --- /dev/null +++ b/config/boards/arm/dao/Kconfig.defconfig @@ -0,0 +1,46 @@ +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +if BOARD_DAO_LEFT + + config ZMK_KEYBOARD_NAME + default "Dao56" + + config ZMK_SPLIT_BLE_ROLE_CENTRAL + default y + +endif # BOARD_DAO_LEFT + +if BOARD_DAO_RIGHT + + config ZMK_KEYBOARD_NAME + default "Dao56 Right" + +endif # BOARD_DAO_RIGHT + + +if BOARD_DAO_LEFT || BOARD_DAO_RIGHT + +config BOARD + default "dao" + +config ZMK_SPLIT + default y + +config BT_CTLR + default BT + +config ZMK_BATTERY_VOLTAGE_DIVIDER + default y + +if USB + +config USB_NRFX + default y + +config USB_DEVICE_STACK + default y + +endif # USB + +endif # BOARD_DAO_LEFT || BOARD_DAO_RIGHT diff --git a/config/boards/arm/dao/board.cmake b/config/boards/arm/dao/board.cmake new file mode 100644 index 00000000..677997f2 --- /dev/null +++ b/config/boards/arm/dao/board.cmake @@ -0,0 +1,8 @@ +# +# Copyright (c) 2020 The ZMK Contributors +# SPDX-License-Identifier: MIT +# + +board_runner_args(nrfjprog "--nrf-family=NRF52" "--softreset") +include(${ZEPHYR_BASE}/boards/common/nrfjprog.board.cmake) +include(${ZEPHYR_BASE}/boards/common/blackmagicprobe.board.cmake) diff --git a/config/boards/arm/dao/dao.dtsi b/config/boards/arm/dao/dao.dtsi new file mode 100644 index 00000000..ef06d89e --- /dev/null +++ b/config/boards/arm/dao/dao.dtsi @@ -0,0 +1,138 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +/dts-v1/; +#include + +#include + + +/ { + model = "dao"; + compatible = "dao"; + + chosen { + zephyr,code-partition = &code_partition; + zephyr,sram = &sram0; + zephyr,flash = &flash0; + zmk,kscan = &kscan0; + zmk,matrix_transform = &default_transform; + zmk,battery = &vbatt; + }; + + default_transform: keymap_transform_0 { + compatible = "zmk,matrix-transform"; + columns = <12>; + rows = <5>; + + // | SW19 | SW1 | SW2 | SW3 | SW4 | SW5 | SW6 | | SW6 | SW5 | SW4 | SW3 | SW2 | SW1 | SW19 | + // | | SW7 | SW8 | SW9 | SW10 | SW11 | SW12 | | SW12 | SW11 | SW10 | SW9 | SW8 | SW7 | | + // | | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 | | SW18 | SW17 | SW16 | SW15 | SW14 | SW13 | | + // | | | | | SW20 | SW21 | SW22 | | SW22 | SW21 | SW20 | | | | | + map = < + RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5) RC(4,11) RC(4,10) RC(4,9) RC(4,8) RC(4,7) RC(4,6) + RC(3,0) RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5) RC(0,11) RC(0,10) RC(0,9) RC(0,8) RC(0,7) RC(0,6) RC(3,6) + RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5) RC(1,11) RC(1,10) RC(1,9) RC(1,8) RC(1,7) RC(1,6) + RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,11) RC(2,10) RC(2,9) RC(2,8) RC(2,7) RC(2,6) + RC(3,3) RC(3,4) RC(3,5) RC(3,11) RC(3,10) RC(3,9) + >; + }; + + kscan0: kscan { + compatible = "zmk,kscan-gpio-matrix"; + label = "KSCAN"; + + diode-direction = "col2row"; + row-gpios + = <&gpio0 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 4 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 22 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 24 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 26 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + ; + }; + + vbatt: vbatt { + compatible = "zmk,battery-voltage-divider"; + label = "VBATT"; + io-channels = <&adc 7>; + output-ohms = <2000000>; + full-ohms = <(2000000 + 820000)>; + }; + +}; + + +&adc { + status = "okay"; +}; + +&gpiote { + status = "okay"; +}; + +&gpio0 { + status = "okay"; +}; + +&gpio1 { + status = "okay"; +}; + +&usbd { + status = "okay"; +}; + +&uart0 { + compatible = "nordic,nrf-uarte"; + status = "okay"; + current-speed = <115200>; + tx-pin = <19>; + rx-pin = <21>; + rts-pin = <23>; + cts-pin = <25>; +}; + + +&flash0 { + /* + * For more information, see: + * http://docs.zephyrproject.org/latest/devices/dts/flash_partitions.html + */ + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + sd_partition: partition@0 { + label = "softdevice"; + reg = <0x00000000 0x00026000>; + }; + code_partition: partition@26000 { + label = "code_partition"; + reg = <0x00026000 0x000c6000>; + }; + + /* + * The flash starting at 0x000ec000 and ending at + * 0x000f3fff is reserved for use by the application. + */ + + /* + * Storage partition will be used by FCB/LittleFS/NVS + * if enabled. + */ + storage_partition: partition@ec000 { + label = "storage"; + reg = <0x000ec000 0x00008000>; + }; + + boot_partition: partition@f4000 { + label = "adafruit_boot"; + reg = <0x000f4000 0x0000c000>; + }; + }; +}; \ No newline at end of file diff --git a/config/boards/arm/dao/dao.keymap b/config/boards/arm/dao/dao.keymap new file mode 100644 index 00000000..8176aa78 --- /dev/null +++ b/config/boards/arm/dao/dao.keymap @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include +#include +#include + +#define DEF 0 +#define LWR 1 +#define RSE 2 +#define ADJ 3 + +< { quick_tap_ms = <200>; }; +&mt { quick_tap_ms = <200>; }; + +/ { + keymap { + compatible = "zmk,keymap"; + + default_layer { +// ----------------------------------------------------------------------------------------- +// | GUI | ~ | Q | W | E | R | T | | Y | U | I | O | P | [ | GUI/] | +// | CTRL | A | S | D | F | G | | H | J | K | L | ; |CTRL/'| +// | LALT | Z | X | C | V | B | | N | M | , | . | / | RALT | +// | RSE | SPC | LWR | | LWR | BKSP | RSE | + bindings = < + &kp GRAVE &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &kp MINUS + &kp LWIN &kp GRAVE &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp LBKT &mt RWIN RBKT + &kp LCTRL &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &mt RCTRL SQT + &kp LALT &kp Z &kp X &kp C &kp V &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &mt RALT BSLH + < RSE TAB &mt LSHFT SPACE < LWR RET < LWR ESC &mt RSHFT BSPC < RSE DEL + >; + }; + lower_layer { +// ----------------------------------------------------------------------------------------- +// | | _ | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 | F12 | +// | + | ! | @ | # | $ | % | | ^ | & | * | ( | ) | - | +// | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | | +// | GUI | | SPC | | ENT | | ALT | + bindings = < + &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans + &trans &kp UNDER &kp F1 &kp F2 &kp F3 &kp F4 &kp F5 &kp F6 &kp F7 &kp F8 &kp F9 &kp F10 &kp F11 &mt RGUI F12 + &mt LCTRL PLUS &kp EXCL &kp AT &kp HASH &kp DLLR &kp PRCNT &kp CARET &kp AMPS &kp STAR &kp LPAR &kp RPAR &mt RCTRL MINUS + &mt LALT EQUAL &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &trans + < ADJ TAB &trans &trans &trans &trans < ADJ DEL + >; + }; + + raise_layer { +// ----------------------------------------------------------------------------------------- +// | | NMLK | / | 7 | 8 | 9 | - | | VOLU| HOME| PRSC| PGUP| SCLK| CLCK| | +// | CTRL | * | 4 | 5 | 6 | + | | MUT | LEFT| UP | RGHT| INS | APP | +// | | 0 | 1 | 2 | 3 | . | | VOLD| END | DOWN| PGDN| PAUS| | +// | | | ADJ | | ADJ | | | + bindings = < + &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans + &trans &kp KP_NUM &kp KP_SLASH &kp KP_N7 &kp KP_N8 &kp KP_N9 &kp KP_MINUS &kp C_VOL_UP &kp HOME &kp PSCRN &kp PG_UP &kp SLCK &kp CAPS &trans + &mt LCTRL EQUAL &kp KP_MULTIPLY &kp KP_N4 &kp KP_N5 &kp KP_N6 &kp KP_PLUS &kp C_MUTE &kp LEFT &kp UP &kp RIGHT &kp INS &mt RCTRL K_APP + &trans &kp KP_N0 &kp KP_N1 &kp KP_N2 &kp KP_N3 &kp KP_DOT &kp C_VOL_DN &kp END &kp DOWN &kp PG_DN &kp PAUSE_BREAK &trans + &trans &trans < ADJ RET < ADJ ESC &trans &trans + >; + }; + adjust_layer { +// ----------------------------------------------------------------------------------------- +// | RST | BLDR | | | | | | | | | | | | BLDR | RST | +// | BTCLR| BT0 | BT1 | BT2 | BT3 | BT4 | | BT4 | BT3 | BT2 | BT1 | BT0 | BTCLR| +// | | | | | | | | | | | | | | +// | | | | | | | | + bindings = < + &none &none &none &none &none &none &none &none &none &none &none &none + &reset &bootloader &none &none &none &none &none &none &none &none &none &none &bootloader &reset + &bt BT_CLR &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &bt BT_SEL 4 &bt BT_SEL 3 &bt BT_SEL 2 &bt BT_SEL 1 &bt BT_SEL 0 &bt BT_CLR + &none &none &none &none &none &none &none &none &none &none &none &none + &trans &none &trans &trans &none &trans + >; + }; + }; +}; diff --git a/config/boards/arm/dao/dao.yaml b/config/boards/arm/dao/dao.yaml new file mode 100644 index 00000000..755b0c90 --- /dev/null +++ b/config/boards/arm/dao/dao.yaml @@ -0,0 +1,18 @@ +identifier: dao +name: Dao +type: keyboard +arch: arm +toolchain: + - zephyr + - gnuarmemb + - xtools +supported: + - adc + - usb_device + - ble + - ieee802154 + - pwm + - watchdog + - kscan + - nvs + - can diff --git a/config/boards/arm/dao/dao_left.dts b/config/boards/arm/dao/dao_left.dts new file mode 100644 index 00000000..9bb7b6b3 --- /dev/null +++ b/config/boards/arm/dao/dao_left.dts @@ -0,0 +1,18 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.dtsi" + +&kscan0 { + col-gpios + = <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 8 GPIO_ACTIVE_HIGH> + , <&gpio0 13 GPIO_ACTIVE_HIGH> + , <&gpio0 15 GPIO_ACTIVE_HIGH> + , <&gpio0 20 GPIO_ACTIVE_HIGH> + ; +}; diff --git a/config/boards/arm/dao/dao_left.keymap b/config/boards/arm/dao/dao_left.keymap new file mode 100644 index 00000000..cf881d3b --- /dev/null +++ b/config/boards/arm/dao/dao_left.keymap @@ -0,0 +1,7 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.keymap" diff --git a/config/boards/arm/dao/dao_left_defconfig b/config/boards/arm/dao/dao_left_defconfig new file mode 100644 index 00000000..ffc2ebe3 --- /dev/null +++ b/config/boards/arm/dao/dao_left_defconfig @@ -0,0 +1,44 @@ +# SPDX-License-Identifier: MIT + +CONFIG_ZMK_SPLIT_ROLE_CENTRAL=y + +CONFIG_SOC_SERIES_NRF52X=y +CONFIG_SOC_NRF52840_QIAA=y +CONFIG_BOARD_DAO_LEFT=y +CONFIG_ZMK_SPLIT=y +CONFIG_ZMK_SLEEP=y + +# Enable MPU +CONFIG_ARM_MPU=y + +# enable GPIO +CONFIG_GPIO=y + +# Enable writing to flash +CONFIG_USE_DT_CODE_PARTITION=y +CONFIG_MPU_ALLOW_FLASH_WRITE=y +CONFIG_NVS=y +CONFIG_SETTINGS_NVS=y +CONFIG_FLASH=y +CONFIG_FLASH_PAGE_LAYOUT=y +CONFIG_FLASH_MAP=y + +# Enable external crystal +CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_30PPM=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_ZMK_USB_LOGGING=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_LOG=y +# CONFIG_ZMK_LOG_LEVEL_DBG=y + +# Turn on uf2 build +CONFIG_BUILD_OUTPUT_UF2=y + +# Increase transmit power level +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y + +CONFIG_ZMK_USB=y +CONFIG_ZMK_BLE=y diff --git a/config/boards/arm/dao/dao_right.dts b/config/boards/arm/dao/dao_right.dts new file mode 100644 index 00000000..68d8f71a --- /dev/null +++ b/config/boards/arm/dao/dao_right.dts @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.dtsi" + +&default_transform { + col-offset = <6>; +}; + +&kscan0 { + col-gpios + = <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 8 GPIO_ACTIVE_HIGH> + , <&gpio0 13 GPIO_ACTIVE_HIGH> + , <&gpio0 15 GPIO_ACTIVE_HIGH> + , <&gpio0 20 GPIO_ACTIVE_HIGH> + ; +}; diff --git a/config/boards/arm/dao/dao_right.keymap b/config/boards/arm/dao/dao_right.keymap new file mode 100644 index 00000000..cf881d3b --- /dev/null +++ b/config/boards/arm/dao/dao_right.keymap @@ -0,0 +1,7 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.keymap" diff --git a/config/boards/arm/dao/dao_right_defconfig b/config/boards/arm/dao/dao_right_defconfig new file mode 100644 index 00000000..d09372c6 --- /dev/null +++ b/config/boards/arm/dao/dao_right_defconfig @@ -0,0 +1,42 @@ +# SPDX-License-Identifier: MIT + +CONFIG_SOC_SERIES_NRF52X=y +CONFIG_SOC_NRF52840_QIAA=y +CONFIG_BOARD_DAO_RIGHT=y +CONFIG_ZMK_SPLIT=y +CONFIG_ZMK_SLEEP=y + +# Enable MPU +CONFIG_ARM_MPU=y + +# enable GPIO +CONFIG_GPIO=y + +# Enable writing to flash +CONFIG_USE_DT_CODE_PARTITION=y +CONFIG_MPU_ALLOW_FLASH_WRITE=y +CONFIG_NVS=y +CONFIG_SETTINGS_NVS=y +CONFIG_FLASH=y +CONFIG_FLASH_PAGE_LAYOUT=y +CONFIG_FLASH_MAP=y + +# Enable external crystal +CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_30PPM=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_ZMK_USB_LOGGING=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_LOG=y +# CONFIG_ZMK_LOG_LEVEL_DBG=y + +# Turn on uf2 build +CONFIG_BUILD_OUTPUT_UF2=y + +# Increase transmit power level +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y + +CONFIG_ZMK_USB=y +CONFIG_ZMK_BLE=y diff --git a/config/dao.json b/config/dao.json new file mode 100644 index 00000000..9d9523e6 --- /dev/null +++ b/config/dao.json @@ -0,0 +1,71 @@ +{ + "id": "dao", + "name": "dao", + "layouts": { + "LAYOUT": { + "layout": [ + { "label": "4,0", "row": 0, "col": 1, "x": 1, "y": 0.75 }, + { "label": "4,1", "row": 0, "col": 2, "x": 2, "y": 0.625 }, + { "label": "4,2", "row": 0, "col": 3, "x": 3, "y": 0.25 }, + { "label": "4,3", "row": 0, "col": 4, "x": 4, "y": 0 }, + { "label": "4,4", "row": 0, "col": 5, "x": 5, "y": 0.25 }, + { "label": "4,5", "row": 0, "col": 6, "x": 6, "y": 0.38 }, + { "label": "4,11", "row": 0, "col": 8, "x": 10, "y": 0.38 }, + { "label": "4,10", "row": 0, "col": 9, "x": 11, "y": 0.25 }, + { "label": "4,9", "row": 0, "col": 10, "x": 12, "y": 0 }, + { "label": "4,8", "row": 0, "col": 11, "x": 13, "y": 0.25 }, + { "label": "4,7", "row": 0, "col": 12, "x": 14, "y": 0.625 }, + { "label": "4,6", "row": 0, "col": 13, "x": 15, "y": 0.75 }, + + { "label": "3,0", "row": 1, "col": 0, "x": 0, "y": 2.5 }, + { "label": "0,0", "row": 1, "col": 1, "x": 1, "y": 1.75 }, + { "label": "0,1", "row": 1, "col": 2, "x": 2, "y": 1.625 }, + { "label": "0,2", "row": 1, "col": 3, "x": 3, "y": 1.25 }, + { "label": "0,3", "row": 1, "col": 4, "x": 4, "y": 1 }, + { "label": "0,4", "row": 1, "col": 5, "x": 5, "y": 1.25 }, + { "label": "0,5", "row": 1, "col": 6, "x": 6, "y": 1.38 }, + { "label": "0,11", "row": 1, "col": 8, "x": 10, "y": 1.38 }, + { "label": "0,10", "row": 1, "col": 9, "x": 11, "y": 1.25 }, + { "label": "0,9", "row": 1, "col": 10, "x": 12, "y": 1 }, + { "label": "0,8", "row": 1, "col": 11, "x": 13, "y": 1.25 }, + { "label": "0,7", "row": 1, "col": 12, "x": 14, "y": 1.625 }, + { "label": "0,6", "row": 1, "col": 13, "x": 15, "y": 1.75 }, + { "label": "3,6", "row": 1, "col": 14, "x": 16, "y": 2.5 }, + + { "label": "1,0", "row": 2, "col": 1, "x": 1, "y": 2.75 }, + { "label": "1,1", "row": 2, "col": 2, "x": 2, "y": 2.625 }, + { "label": "1,2", "row": 2, "col": 3, "x": 3, "y": 2.25 }, + { "label": "1,3", "row": 2, "col": 4, "x": 4, "y": 2 }, + { "label": "1,4", "row": 2, "col": 5, "x": 5, "y": 2.25 }, + { "label": "1,5", "row": 2, "col": 6, "x": 6, "y": 2.38 }, + { "label": "1,11", "row": 2, "col": 8, "x": 10, "y": 2.38 }, + { "label": "1,10", "row": 2, "col": 9, "x": 11, "y": 2.25 }, + { "label": "1,9", "row": 2, "col": 10, "x": 12, "y": 2 }, + { "label": "1,8", "row": 2, "col": 11, "x": 13, "y": 2.25 }, + { "label": "1,7", "row": 2, "col": 12, "x": 14, "y": 2.625 }, + { "label": "1,6", "row": 2, "col": 13, "x": 15, "y": 2.75 }, + + { "label": "2,0", "row": 3, "col": 1, "x": 1, "y": 3.75 }, + { "label": "2,1", "row": 3, "col": 2, "x": 2, "y": 3.625 }, + { "label": "2,2", "row": 3, "col": 3, "x": 3, "y": 3.25 }, + { "label": "2,3", "row": 3, "col": 4, "x": 4, "y": 3 }, + { "label": "2,4", "row": 3, "col": 5, "x": 5, "y": 3.25 }, + { "label": "2,5", "row": 3, "col": 6, "x": 6, "y": 3.38 }, + { "label": "2,11", "row": 3, "col": 8, "x": 10, "y": 3.38 }, + { "label": "2,10", "row": 3, "col": 9, "x": 11, "y": 3.25 }, + { "label": "2,9", "row": 3, "col": 10, "x": 12, "y": 3 }, + { "label": "2,8", "row": 3, "col": 11, "x": 13, "y": 3.25 }, + { "label": "2,7", "row": 3, "col": 12, "x": 14, "y": 3.625 }, + { "label": "2,6", "row": 3, "col": 13, "x": 15, "y": 3.75 }, + + { "label": "3,3", "row": 4, "col": 4, "x": 4.5, "y": 4.25 }, + { "label": "3,4", "row": 4, "col": 5, "x": 4.5, "y": 4.25, "r": 15, "rx": 5, "ry": 8.982 }, + { "label": "3,5", "row": 4, "col": 6, "x": 4.5, "y": 3.75, "r": 30, "rx": 5, "ry": 8.982, "h": 1.5 }, + { "label": "3,11", "row": 4, "col": 8, "x": 11.5, "y": 3.75, "r": -30, "rx": 12, "ry": 8.982, "h": 1.5 }, + { "label": "3,10", "row": 4, "col": 9, "x": 11.5, "y": 4.25, "r": -15, "rx": 12, "ry": 8.982 }, + { "label": "3,9", "row": 4, "col": 10, "x": 11.5, "y": 4.25 } + ] + } + }, + "sensors": [] +} \ No newline at end of file diff --git a/config/dao.keymap b/config/dao.keymap new file mode 100644 index 00000000..6ef708c9 --- /dev/null +++ b/config/dao.keymap @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include +#include +#include + +#define DEF 0 +#define LWR 1 +#define RSE 2 +#define ADJ 3 + +< { + quick_tap_ms = <200>; +}; + +&mt { + quick_tap_ms = <200>; +}; + +/ { + keymap { + compatible = "zmk,keymap"; + + default_layer { + // ----------------------------------------------------------------------------------------- + // | GUI | ~ | Q | W | E | R | T | | Y | U | I | O | P | [ | GUI/] | + // | CTRL | A | S | D | F | G | | H | J | K | L | ; |CTRL/'| + // | LALT | Z | X | C | V | B | | N | M | , | . | / | RALT | + // | RSE | SPC | LWR | | LWR | BKSP | RSE | + + bindings = < + &kp GRAVE &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &kp MINUS +&kp LWIN &kp GRAVE &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp LBKT &mt RWIN RBKT + &kp LCTRL &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &mt RCTRL SQT + &kp LALT &kp Z &kp X &kp C &kp V &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &mt RALT BSLH + < 2 TAB &mt LSHFT SPACE < 1 RET < 1 ESC &mt RSHFT BSPC < 2 DEL + >; + }; + + lower_layer { + // ----------------------------------------------------------------------------------------- + // | | _ | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 | F12 | + // | + | ! | @ | # | $ | % | | ^ | & | * | ( | ) | - | + // | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | | + // | GUI | | SPC | | ENT | | ALT | + + bindings = < + &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans +&trans &kp UNDER &kp F1 &kp F2 &kp F3 &kp F4 &kp F5 &kp F6 &kp F7 &kp F8 &kp F9 &kp F10 &kp F11 &mt RGUI F12 + &mt LCTRL PLUS &kp EXCL &kp AT &kp HASH &kp DLLR &kp PRCNT &kp CARET &kp AMPS &kp STAR &kp LPAR &kp RPAR &mt RCTRL MINUS + &mt LALT EQUAL &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &trans + < 3 TAB &trans &trans &trans &trans < 3 DEL + >; + }; + + raise_layer { + // ----------------------------------------------------------------------------------------- + // | | NMLK | / | 7 | 8 | 9 | - | | VOLU| HOME| PRSC| PGUP| SCLK| CLCK| | + // | CTRL | * | 4 | 5 | 6 | + | | MUT | LEFT| UP | RGHT| INS | APP | + // | | 0 | 1 | 2 | 3 | . | | VOLD| END | DOWN| PGDN| PAUS| | + // | | | ADJ | | ADJ | | | + + bindings = < + &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans +&trans &kp KP_NUM &kp KP_SLASH &kp KP_N7 &kp KP_N8 &kp KP_N9 &kp KP_MINUS &kp C_VOL_UP &kp HOME &kp PSCRN &kp PG_UP &kp SLCK &kp CAPS &trans + &mt LCTRL EQUAL &kp KP_MULTIPLY &kp KP_N4 &kp KP_N5 &kp KP_N6 &kp KP_PLUS &kp C_MUTE &kp LEFT &kp UP &kp RIGHT &kp INS &mt RCTRL K_APP + &trans &kp KP_N0 &kp KP_N1 &kp KP_N2 &kp KP_N3 &kp KP_DOT &kp C_VOL_DN &kp END &kp DOWN &kp PG_DN &kp PAUSE_BREAK &trans + &trans &trans < 3 RET < 3 ESC &trans &trans + >; + }; + + adjust_layer { + // ----------------------------------------------------------------------------------------- + // | RST | BLDR | | | | | | | | | | | | BLDR | RST | + // | BTCLR| BT0 | BT1 | BT2 | BT3 | BT4 | | BT4 | BT3 | BT2 | BT1 | BT0 | BTCLR| + // | | | | | | | | | | | | | | + // | | | | | | | | + + bindings = < + &none &none &none &none &none &none &none &none &none &none &none &none +&sys_reset &bootloader &none &none &none &none &none &none &none &none &none &none &bootloader &sys_reset + &bt BT_CLR &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &bt BT_SEL 4 &bt BT_SEL 3 &bt BT_SEL 2 &bt BT_SEL 1 &bt BT_SEL 0 &bt BT_CLR + &none &none &none &none &none &none &none &none &none &none &none &none + &trans &none &trans &trans &none &trans + >; + }; + }; +}; diff --git a/config/west.yml b/config/west.yml new file mode 100644 index 00000000..379d2919 --- /dev/null +++ b/config/west.yml @@ -0,0 +1,11 @@ +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + projects: + - name: zmk + remote: zmkfirmware + revision: main + import: app/west.yml + self: + path: config diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 00000000..43fe6a00 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,40 @@ +# 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 the repository https://github.com/yumagulovrn/dao-zmk-config +2. Make changes to the [dao.keymap](../config/boards/arm/dao/dao.keymap) file in your repository +3. Commit changes to your repository +4. Go to `Actions` tab in your repository +5. Wait for the GitHub Action to complete +6. Grab `firmware.zip` file - it contains firmware for both of your halves + +## How to flash the keyboard? + +1. Obtain `firmware.zip` +2. Unzip `firmware.zip` - you should have `dao_left.uf2` and `dao_right.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