HHKB Pro 2 with ZMK firmware

This project provides an out-of-tree Zephyr module and shield definition for the HHKB Pro2 daugther board.

The hhkb_pro2 shield defines the default HHKB keymap and zmk,kscan chosen. Any board can use the hhkb_pro2 shield by defining the hhkb_pro2_connector gpio nexus node. Examples can be find in custom_pro2.overlay and whkb_pro2.dts.

Customizing

Clone this repository then add your keymap overlay to the custom_pro2 shield. You can also create more complex customization by creating entirely new boards or shields.

The default Github Actions will build the firmware using the build.yml definition.

📢 If you build some custom boards or configs, please share a picture and tips to the discussion thread!

Build locally

Follow the steps in the official ZMK document to setup build environment.

Setup Zephyr

west init -l config
west update

To build nice_nano_v2 based board:

west build -s zmk/app -p -b nice_nano_v2 -- \
    -DSHIELD="hhkb_pro2 custom_pro2" \
    -DZMK_CONFIG=$PWD/config

or to build WHKB Pro2:

west build -s zmk/app -p -b whkb_pro2 -- \
    -DSHIELD=hhkb_pro2 \
    -DZMK_CONFIG=$PWD/config

The finished UF2 file is at build/zephyr/zmk.uf2

Soldering a custom board

The default configuration in custom_pro2 is based on the nice_nano_v2 board. It only uses the pins on the left side. The pins' order is upside down so the wires can be bend easily under the case.

It take advantages of the high drive capability of nRF52 GPIO to power the HHKB Pro2 daughter board.

3D Printed Mount

The 3D printed mount (@oldmanz) is designed to fit in the HHKB Pro2 case in place of the main board. It holds the Nice!Nano, a connector for the daughter board, a reset button, and a toggle switch for power.

3D Models are in the 3d_models directory.

The usb port will need to be filed a bit to fit usb-c.
The switch was something I had laying around, so I am unsure of its part number.
The reset button is behind a 3D Printed Cap, by alienman82. A hole is drilled through it.
- https://github.com/robotmaxtron/HHKB-usb-dust-covers

Wake up from deep sleep does not work

On HHKB2 Pro custom build,

with

CONFIG_ZMK_IDLE_TIMEOUT=5000
CONFIG_ZMK_SLEEP=y
CONFIG_ZMK_IDLE_SLEEP_TIMEOUT=900000
CONFIG_ZMK_BLE=y
CONFIG_ZMK_EXT_POWER=n
CONFIG_ZMK_BATTERY_REPORT_INTERVAL=3600

hhkb_pro2_connector: hhkb_pro2_connector {
        compatible = "zmk,hhkb-pro2-header";	        compatible = "zmk,hhkb-pro2-header";
        #gpio-cells = <2>;	        #gpio-cells = <2>;
        gpio-map-mask = <0xffffffff 0xffffffc0>;	        gpio-map-mask = <0xffffffff 0xffffffc0>;
        gpio-map-pass-thru = <0 0x3f>;	        gpio-map-pass-thru = <0 0x3f>;
        gpio-map = <0 0 &gpio1 6 NRF_GPIO_DRIVE_S0H1>,	        gpio-map = <0 0 &gpio1 6 NRF_GPIO_DRIVE_S0H1>,
                   <1 0 &gpio1 4 0>,	                   <1 0 &gpio1 4 0>,
                   <2 0 &gpio0 11 0>,	                   <2 0 &gpio0 11 0>,
                   <3 0 &gpio1 0 0>,	                   <3 0 &gpio1 0 0>,
                   <4 0 &gpio0 24 0>,	                   <4 0 &gpio0 24 0>,
                   <5 0 &gpio0 22 0>,	                   <5 0 &gpio0 22 0>,
                   <6 0 &gpio0 20 0>,	                   <6 0 &gpio0 20 0>,
                   <7 0 &gpio0 17 0>,	                   <7 0 &gpio0 17 0>,
                   <8 0 &gpio0 8 0>,	                   <8 0 &gpio0 8 0>,
                   <9 0 &gpio0 6 0>;	                   <9 0 &gpio0 6 0>,
                   <10 0 &gpio0 9 0>,     /* D10/A10 */
                   <19 0 &gpio0 2 0>;     /* D19/A1 */
    };	    };

, and

pm_wake_sensor {
        compatible = "zmk,pm-wake-sensor";
        status = "okay";
        power-gpios = <&hhkb_pro2_connector 19 GPIO_ACTIVE_HIGH>;
        sensor-gpios = <&hhkb_pro2_connector 10 (GPIO_ACTIVE_LOW|GPIO_PULL_DOWN)>;
    };

It doesn't wake up hhkb from sleep.

kanru / hhkb-zmk Goto Github PK

hhkb-zmk's Introduction

HHKB Pro 2 with ZMK firmware

Customizing

Build locally

Soldering a custom board

3D Printed Mount

hhkb-zmk's People

Contributors

Stargazers

Watchers

Forkers

hhkb-zmk's Issues

Build failed

Less power efficiency than estimations by ZMK Power Profiler

Wake up from deep sleep does not work

I have a build failure problem

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent