{"id":21013836,"url":"https://github.com/pyro2927/hhkb","last_synced_at":"2026-07-10T09:32:56.874Z","repository":{"id":66587829,"uuid":"79878646","full_name":"pyro2927/hhkb","owner":"pyro2927","description":null,"archived":false,"fork":false,"pushed_at":"2017-05-03T02:25:36.000Z","size":34,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-05-30T09:00:07.905Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyro2927.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-24T04:33:58.000Z","updated_at":"2017-01-24T16:23:19.000Z","dependencies_parsed_at":"2023-03-05T09:45:28.207Z","dependency_job_id":null,"html_url":"https://github.com/pyro2927/hhkb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pyro2927/hhkb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyro2927%2Fhhkb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyro2927%2Fhhkb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyro2927%2Fhhkb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyro2927%2Fhhkb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyro2927","download_url":"https://codeload.github.com/pyro2927/hhkb/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyro2927%2Fhhkb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35328278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-10T02:00:06.465Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T09:44:18.131Z","updated_at":"2026-07-10T09:32:56.856Z","avatar_url":"https://github.com/pyro2927.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"Alternative Controller for HHKB Pro\n===================================\nI wanted to add some features like vi cursor and mouse keys to my [HHKB][HHKB] but its controller is not programmable and firmware source code is not open, of course. This means customizing this keyboard needs to replace original controller with programmable one.\n\nThis controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.\n\nSee [this thread][AltController] in geekhack.org.\n\n[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/\n[AltController]: http://geekhack.org/index.php?topic=12047.0\n\n\n## Update\n* Bluetooth module RN-42 is supported.(2015/01)\n* V-USB and iWRAP are no longer supported now, but still it'll works with a little fix. See not_supported directory.(2015/01)\n\n\n## Features\n* Customizable keymap\n* More keymap layers(more Fn keys)\n* Mouse keys\n* USB NKRO\n* Bluetooth(RN-42)\n\nSee README of [tmk_keyboard] for more.\n\n[tmk_keyboard]: http://github.com/tmk/tmk_keyboard\n \n### Pros\n* No risks: Everything is all reversible\n* No need for PCB trace patching, case cutting or any other destructive mod\n* Can keep original controller intact\n* Can change all HHKB behavior as you like\n\n### Cons\n* Void your warranty\n* Lose USB hub function of Pro2\n\n## DISCLAIMER\nI'm not a professional of electronics nor MCU programming. This may damage your HHKB.\nAnd my English writing is poor, I'm not sure I can convey my notions accurately.\n\n\n## Documents\nSee [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.\n\n\n## Build Firmware \u0026 Program\nSee [this document](../../tmk_core/doc/build.md) first.\n\n### Configuration\nIf your target is **HHKB JP** you need to set `HHKB_JP` build option in `Makefile` or use `Makefile.jp` instead of `Makefile`.\n\nIf you use other than **TMK Alt Controller Board** set proper `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. At least PJRC Teensy requires changing `BOOTLOADER_SIZE` to 512.\n\n### Build \nSeveral version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:\n\n    $ make -f Makefile.\u003cjp|pjrc|rn42\u003e KEYMAP=(hasu|hhkb|spacefn|\u003cname\u003e)\n\nYou can omit `-f` option when you use `Makefile`. `Makefile` is used for **Pro2 and Pro**, `Makefile.jp` fits for **JP** model and `Makefile.rn42` supports Bluetooth module **RN-42**. `Makefile.pjrc` uses **PJRC** as output protocol instead of **LUFA**.\n\n\n### Program\nFirst, push reset button on board to start bootloader.\n\nThis command programs the controller with [dfu-programmer] if the tool is installed and configured properly.\n\n    $ make -f Makefile.\u003cvariant\u003e KEYMAP=\u003cname\u003e dfu\n\nOr you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.\n\n    $ make -f Makefile.\u003cvariant\u003e KEYMAP=\u003cname\u003e flip\n\nUse [Teensy Loader] if your controller is Teensy/Teensy++.\n\n\n## Keymap\nTo define your own keymap create file named `keymap_\u003cname\u003e.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.\n\n\n## Hardware\nYou have some options for hardware. Development boards with USB AVR family(ATMega32U4, AT90USB1286) like Teensy will work while MegaAVR with [V-USB] library is also cheaper option for DIY.\n\n### 1. TMK Alt Controller Board\nDesign files are available at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller) and see [Controller Distribution thread](http://geekhack.org/index.php?topic=56494.0) if you get an assembled one.\n\n\n### 2. PJRC Teensy\nSee [this thread](http://geekhack.org/index.php?topic=57008.0).\n\n\n### 3. V-USB version\nSee [V-USB controller for HHKB](doc/V-USB.md).\n\n\n[LUFA]: http://www.fourwalledcubicle.com/LUFA.php\n[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html\n[dfu-programmer]: http://dfu-programmer.sourceforge.net/\n[FLIP]: http://www.atmel.com/tools/FLIP.aspx\n[Teensy Loader]: http://www.pjrc.com/teensy/loader.html\n[V-USB]: http://www.obdev.at/products/vusb/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyro2927%2Fhhkb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyro2927%2Fhhkb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyro2927%2Fhhkb/lists"}