Imported from GitHub: ImSeanConroy/macro-keyboard · commit b5c4869 · license MIT

Description

Minimal Layout, Maximum Efficiency — A collection of macro keyboard to boost your productivity without crowding your workspace.

README

Minimal Layout, Maximum Efficiency

A collection of macro keyboards to boost your productivity without crowding your workspace.

Features and Development Roadmap

This project is considered complete for the time being, the following outlines the current features and potential future improvements:

Current Features

• Compact Design: Space-saving with minimal desk footprint.
• Customizable Macros: Assign any key functions to match your workflow.
• Layout Variations: Supports various configurations (e.g., 1x1, 1x2, 1x4, 2x4, and 3x3).

Future Improvements

• OLED Display: Add and test the inclusion of an OLED display.
• Bluetooth Functionality: Add and test wireless connectivity.
• 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.)

Getting Started

1. Open the Project - Open the .kicad_pro file in KiCad to view the project.
2. Review the Design - Inspect the schematic and PCB layout to ensure it meets your needs.
3. Customize or Export - Make any modifications and export the Gerber files for fabrication.
4. Order the PCB - Submit the Gerber files to your preferred PCB manufacturer.
5. Get the Components - Purchase the components from the BOM and a compatible board.
6. 3D Print the Case - Download the STL files for your chosen configuration and print them on a 3D printer.
7. Assemble the Hardware - Solder the components and assemble the board and case.
8. Upload the Firmware - Connect the board via USB and upload the firmware.

Required Components

The following are the required components to build any of the macro keyboards:

Quantity	Component	Description	Source
1	Seeed XIAO SAMD21	Microcontroller board	PiHut
12	Kailh Mechanical Key Switches	Tactile switches	PiHut
20	Kailh Switch Sockets	For hot-swapping switches	PiHut
12	White DSA Keycaps	Keycap set	PiHut
12	Orange DSA Keycaps	Keycap set	PiHut
10	Neon Green DSA Keycaps	Keycap set	PiHut

Contributing

Contributions are welcome. Please open an issue or submit a pull request for any enhancements or bug fixes.

License

This project is Distributed under the MIT License - see the LICENSE file for information.

Support

If you are having problems, please let me know by raising a new issue.

Acknowledgments

This project was made possible thanks to the following resources:

• Masterzen's Blog - Designing a keyboard from scratch
• Keyboard Designer Wiki - PCB Designer Guide
• Seeed Studio Wiki - Getting Started with Seeed Studio XIAO SAMD21