5
mirror of https://github.com/FrameworkComputer/InputModules.git synced 2026-04-12 01:05:49 +00:00
2026-01-15 15:25:01 -08:00

96 lines
5.0 KiB
Markdown

# Framework One Key Module
![OneKeyModule](/OneKeyModule/Assets/framework_one_key_module_create.png)
The [One Key Module](https://frame.work/products/one-key-module) is a modular building block for the Framework Laptop 16 input system. It allows developers to create custom keyboard layouts, macropads, or individual input triggers using a standardized mechanical and electrical footprint.
This module is designed to be mounted underneath a rigid carrier PCB, with electrical and mechanical connections made via castellated pads soldered upwards into the lattice and secured using four mechanical solder lugs.
> [!WARNING]
> This documentation is subject to change before the One Key Module launches.
## License
One Key Modules © 2025 by Framework Computer Inc is licensed under CC BY 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/
## Technical Specifications
### Mechanical
<div style="display: flex; gap: 10px;">
<img src="/OneKeyModule/Assets/one_key_module_layout.png" alt="OneKeyModuleSize" height="300"/>
<img src="/OneKeyModule/Assets/framework_one_key_module_front.jpg" alt="OneKeyModuleSize" height="300"/>
<img src="/OneKeyModule/Assets/framework_one_key_module_back.jpg" alt="OneKeyModuleSize" height="300"/>
</div>
* **Key Pitch/Area:** 19.20mm * 19.20mm
* **Keycap Size:** 15.76mm * 15.76mm
* **Key Travel:** 1.50mm +/- 0.2mm
* **PCB Thickness:** 0.15mm
* **Backlight:** 1x White mini-LED
* **Max Z-Height:** 3.65mm (including Mylar).
* Note: To ensure the laptop closes correctly, the total height of the switch and PCB must not exceed 3.70mm. Please refer to [here](/Mechanical/Small/Module/c1_design_space_ref.pdf).
* **3D Reference:** `One_Key_Module_CAD.stp`
### Electrical
* **Switch Type:** Membrane Switch.
* **Backlight:** Integrated LED support with a dedicated 5V rail and PWM-capable brightness control (`BL_LOW`).
* **Connectivity:** Designed for **Signal Chaining**
### Pinout and Signal Mapping
<img src="/OneKeyModule/Assets/one_key_module_interface.png" alt="OneKeyModulePinout" height="400"/>
The module features a 10-pin interface designed for daisy chaining multiple keys into a larger keyboard matrix.
| Pin | Signal | Description |
| :--- | :--- | :--- |
| 1 | **COL in** | Matrix Column Input |
| 2 | **GND** | Ground |
| 3 | **ROW in** | Matrix Row Input |
| 4 | **ROW Out** | Matrix Row Pass-through |
| 5 | **LED_5V** | 5V Backlight Power |
| 6 | **LED_5V** | 5V Backlight Power |
| 7 | **BL_LOW** | Backlight Control |
| 8 | **BL_LOW** | Backlight Control |````
| 9 | **COL Out** | Matrix Column Pass-through |
| 10 | **GND** | Ground |
## Mounting & Assembly
<img src="/OneKeyModule/Assets/one_key_module_mounting.png" alt="OneKeyModuleMounting" height="400"/>
### Direct-Solder Lattice Method
This module is designed for a **PCB-over-module** assembly:
1. **Alignment:** The module is positioned underneath a rigid carrier PCB.
2. **Mechanical Retention:** Four **mechanical solder lugs** lock into the carrier board to provide structural stability.
3. **Soldering:** The 10 castellated signal pads and the 4 mechanical lugs(optional) are soldered "upwards." This creates a shared electrical and mechanical bond.
4. **Signal Chaining:** Use the `ROW Out` and `COL Out` signals to daisy-chain multiple modules across the carrier PCB to form a complete keyboard scanning matrix. LEDs will be parallel.
## Adding Legends / Key Markings
There are several methods to add custom legends or graphics to the One Key Module (OKM) keycap.
### 1. 1064 nm Laser Engraving
<div align="center" style="display: flex; gap: 10px;">
<img src="/OneKeyModule/Assets/laser_okm.png" alt="LED OFF" height="300"/>
<img src="/OneKeyModule/Assets/led_laser_okm.png" alt="LED ON" height="300"/>
</div>
* **Equipment:** 2W 1064 nm Infrared Laser.
* **Settings:** 1% Power, 4000 mm/s Speed (fastest speed).
* **Process:** Run approximately 7 passes.
* **Result:** This combination effectively ablates the black coating to expose the translucent material underneath, allowing the backlight to shine through without melting the keycap.
> [!NOTE]
> **Lighting & Diffusion:** For large engraved patterns, the LED underneath may not diffuse evenly. Additionally, **5V** input may be too bright for these legends. We recommend running the LEDs at **3V** if you plan to use laser engraved graphics.
> [!CAUTION]
> Do not use a standard diode laser (blue light). Only proceed with this method if you are experienced with laser equipment.
---
### 2. UV Printing
Direct UV printing allows for durable, high-resolution, and full-color legends.
### 3. Paint
For manual customization, you can use model paints (acrylic or enamel) applied with a fine brush or stencils. We recommend applying a clear matte or satin topcoat after painting to protect the design from finger oils and abrasion.
### 4. Stickers / Decals
High-quality vinyl stickers or waterslide decals are an accessible, non-destructive way to add legends. Ensure the keycap surface is thoroughly cleaned with isopropyl alcohol before application to ensure the best adhesion.