{"id":15608344,"url":"https://github.com/rschenk/re-gret","last_synced_at":"2025-08-21T15:33:33.697Z","repository":{"id":245635052,"uuid":"818820999","full_name":"rschenk/re-gret","owner":"rschenk","description":"34 key choc hotswap keyboard, wireless","archived":false,"fork":false,"pushed_at":"2024-10-24T22:32:33.000Z","size":4091,"stargazers_count":49,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-10T10:12:03.919Z","etag":null,"topics":["ergogen","keyboard","kicad","pcb","zmk"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/rschenk.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":"2024-06-23T01:03:56.000Z","updated_at":"2024-10-24T22:32:34.000Z","dependencies_parsed_at":"2024-06-23T04:58:50.891Z","dependency_job_id":"308f27f7-5522-4238-b3d6-7a554176f040","html_url":"https://github.com/rschenk/re-gret","commit_stats":null,"previous_names":["rschenk/re-gret"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rschenk%2Fre-gret","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rschenk%2Fre-gret/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rschenk%2Fre-gret/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rschenk%2Fre-gret/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rschenk","download_url":"https://codeload.github.com/rschenk/re-gret/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230520391,"owners_count":18238948,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ergogen","keyboard","kicad","pcb","zmk"],"created_at":"2024-10-03T05:20:25.196Z","updated_at":"2025-08-21T15:33:33.685Z","avatar_url":"https://github.com/rschenk.png","language":"JavaScript","readme":"# Re-gret Keyboard\n\nThe Re-gret is a 34 key remix of my [Egret](https://github.com/rschenk/egret) keyboard.\n\nFeaturing: 34 keys, Choc spacing, Choc v1 hot swappable, Seeed Xiao MCU, wireless compatible, RGB undeglow when plugged in, and a silicone gasket sandwich stackup.\n\nCompared to the original Egret, besides having two thumb buttons per side, the Re-gret has a more angle between the halves, and the ring and pinky fingers have more stagger and more splay. It also has a Xiao MCU which is cheaper and cuter than a Nice Nano. Certainly a more re-fined re-mix that I have no re-grets about making.\n\n![Re-gret Bluetooth Mode](images/IMG_0805.jpeg)\n\n![Re-gret Underglow](images/IMG_0812.jpeg)\n\n## Build guide\n\nCheck the docs for a [PCB Build Guide](docs/pcb_build_guide.md) and [Case Build Guide](docs/case_build_guide.md).\n\n## RGB Underglow\n\nI powered the RGB underglow directly from the USB 5v, so it will automagically turn itself off when in wireless bluetooth mode. There's no need for ZMK's [External Power Control](https://zmk.dev/docs/behaviors/power#external-power-control) because you physically can't run the LEDs from battery power even if you wanted to. There's a [clever trick](https://hackaday.com/2017/01/20/cheating-at-5v-ws2812-control-to-use-a-3-3v-data-line/) using a diode that allows the 5v LEDs to be controlled by the Xiao's 3.3v logic.\n\n## Firmware\n\n### ZMK\n\nI've published the firmware for Re-gret as a ZMK module: [rschenk/zmk-keyboard-re-gret](https://github.com/rschenk/zmk-keyboard-re-gret), which is (probably?) the preferred method for adding the keyboard in ZMK.\n\nIf you don't use modules, or prefer the old school way, then copy the contents of `firmware/zmk/config/boards/shields/regret/` into `[your-zmk-config]/config/boards/shields/regret/`\n\nBe advised that right now the underglow only works on the XIAO nRF52840 board, and does not work on the XIAO RP2040 (although it [might in the future](https://github.com/zmkfirmware/zmk/issues/1085)). The original XIAO SAMD21 should work but I haven't tested it.\n\n| Board                 | Chip     | USB Wired          | Bluetooth Wireless | RGB Underglow      | Comments                                                     |\n| --------------------- | -------- | ------------------ | ------------------ | ------------------ | ------------------------------------------------------------ |\n| XIAO                  | SAMD21   | :white_check_mark: | :x:                | :x:                | Should work but untested                                     |\n| XIAO BLE              | nRF52840 | :white_check_mark: | :white_check_mark: | :white_check_mark: |                                                              |\n| XIAO RP2040           | RP2040   | :white_check_mark: | :x:                | :x: for now        | Underglow [maybe someday](https://github.com/zmkfirmware/zmk/issues/1085) |\n\n### QMK\n\nCopy the contents of `firmware/qmk/keyboards/re_gret` into `[your_qmk_firmware]/keyboards/re_gret`, since I have not put the Re-gret firmware into the official QMK repo.\n\nOnly the XIAO RP2040 is supported. The Adafruit QT Py RP2040 might possibly work but I don't think the reset button will function.\n\n| Board                 | Chip     | USB Wired          | RGB Underglow      | Comments                                                     |\n| --------------------- | -------- | ------------------ | ------------------ | ------------------------------------------------------------ |\n| XIAO RP2040           | RP2040   | :white_check_mark: | :white_check_mark: |  |\n\n## Related\n\n* I cribbed the Xiao footprint, pogo pin idea, and battery from the [revxlp](https://gitlab.com/lpgalaxy/revxlp)\n* I based the QMK shift register matrix code on [Sadek's](https://github.com/sadekbaroudi/qmk_firmware)\n* My original 36 key [Egret](https://github.com/rschenk/egret) was the starting point\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frschenk%2Fre-gret","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frschenk%2Fre-gret","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frschenk%2Fre-gret/lists"}