{"id":22785482,"url":"https://github.com/imseanconroy/macro-keyboard","last_synced_at":"2025-10-05T22:15:09.965Z","repository":{"id":263504452,"uuid":"888650655","full_name":"ImSeanConroy/macro-keyboard","owner":"ImSeanConroy","description":"Minimal Layout, Maximum Efficiency — A collection of macro keyboard to boost your productivity without crowding your workspace.","archived":false,"fork":false,"pushed_at":"2025-06-28T12:06:19.000Z","size":6012,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-28T13:21:33.938Z","etag":null,"topics":["electronics","keyboard","kicad","macro-keyboard"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ImSeanConroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2024-11-14T19:07:53.000Z","updated_at":"2025-06-28T12:06:25.000Z","dependencies_parsed_at":"2024-11-19T06:30:28.296Z","dependency_job_id":"b1cd2a6e-0563-4282-aeec-14f2d805ad90","html_url":"https://github.com/ImSeanConroy/macro-keyboard","commit_stats":null,"previous_names":["imseanconroy/macro-keyboard"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ImSeanConroy/macro-keyboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fmacro-keyboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fmacro-keyboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fmacro-keyboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fmacro-keyboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ImSeanConroy","download_url":"https://codeload.github.com/ImSeanConroy/macro-keyboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fmacro-keyboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278528119,"owners_count":26001674,"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","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"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":["electronics","keyboard","kicad","macro-keyboard"],"created_at":"2024-12-11T23:06:24.449Z","updated_at":"2025-10-05T22:15:09.961Z","avatar_url":"https://github.com/ImSeanConroy.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Minimal Layout, Maximum Efficiency\n\nA collection of macro keyboards to boost your productivity without crowding your workspace.\n\n![Project Image](https://github.com/ImSeanConroy/macro-keyboard/blob/main/.github/repo-img.png)\n\n## Features and Development Roadmap\n\nThis project is considered complete for the time being, the following outlines the current features and potential future improvements:\n\n### Current Features\n- Compact Design: Space-saving with minimal desk footprint.\n- Customizable Macros: Assign any key functions to match your workflow.\n- Layout Variations: Supports various configurations (e.g., 1x1, 1x2, 1x4, 2x4, and 3x3).\n\n### Future Improvements\n- OLED Display: Add and test the inclusion of an OLED display.\n- Bluetooth Functionality: Add and test wireless connectivity.\n- Custom PCB Design: Move away from prebuilt Seeed Studio development boards. (A previous attempt was made, but limited electronics knowledge made debugging and identifying issues difficult.)\n\n## Getting Started\n\n1. **Open the Project** - Open the `.kicad_pro` file in KiCad to view the project.\n2. **Review the Design** - Inspect the schematic and PCB layout to ensure it meets your needs.\n3. **Customize or Export** - Make any modifications and export the Gerber files for fabrication.\n4. **Order the PCB** - Submit the Gerber files to your preferred PCB manufacturer.\n5. **Get the Components** - Purchase the components from the BOM and a compatible board.\n6. **3D Print the Case** - Download the STL files for your chosen configuration and print them on a 3D printer.\n7. **Assemble the Hardware** - Solder the components and assemble the board and case.\n8. **Upload the Firmware** - Connect the board via USB and upload the firmware.\n\n## Required Components\n\nThe following are the required components to build any of the macro keyboards:\n\n| Quantity | Component | Description | Source |\n| - | - | - | - |\n| 1 | Seeed XIAO SAMD21 | Microcontroller board | [PiHut](https://thepihut.com/products/seeed-xiao-samd21?srsltid=AfmBOopsKYftJU7zJh318_QIbgNfs8Iwz2q-IXUMCA7OXGZDiutoXrOy) |\n| 12 | Kailh Mechanical Key Switches | Tactile switches | [PiHut](https://thepihut.com/products/kailh-mechanical-key-switches-linear-red-12-pack?variant=40151684677827) |\n| 20 | Kailh Switch Sockets | For hot-swapping switches | [PiHut](https://thepihut.com/products/kailh-switch-sockets-for-mx-compatible-mechanical-keys-20-pack?variant=40019715588291) |\n| 12 | White DSA Keycaps | Keycap set | [PiHut](https://thepihut.com/products/white-dsa-keycaps-for-mx-compatible-switches-10-pack?variant=40000301301955) |\n| 12 | Orange DSA Keycaps | Keycap set | [PiHut](https://thepihut.com/products/orange-dsa-keycaps-for-mx-compatible-switches-10-pack?variant=40000347439299) |\n| 10 | Neon Green DSA Keycaps | Keycap set | [PiHut](https://thepihut.com/products/neon-green-dsa-keycaps-for-mx-compatible-switches-10-pack?variant=40000348520643) |\n\n## Contributing\n\nContributions are welcome. Please open an issue or submit a pull request for any enhancements or bug fixes.\n\n## License\n\nThis project is Distributed under the MIT License - see the [LICENSE](LICENSE) file for information.\n\n## Support\n\nIf you are having problems, please let me know by [raising a new issue](https://github.com/ImSeanConroy/macro-keyboard/issues/new/choose).\n\n## Acknowledgments\n\nThis project was made possible thanks to the following resources:\n\n- [Masterzen's Blog](https://www.masterzen.fr/) - Designing a keyboard from scratch\n- [Keyboard Designer Wiki](https://wiki.ai03.com/books/pcb-design/chapter/pcb-designer-guide) - PCB Designer Guide \n- [Seeed Studio Wiki](https://wiki.seeedstudio.com/Seeeduino-XIAO/#resourses) - Getting Started with Seeed Studio XIAO SAMD21","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimseanconroy%2Fmacro-keyboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimseanconroy%2Fmacro-keyboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimseanconroy%2Fmacro-keyboard/lists"}