{"id":13992915,"url":"https://github.com/FrameworkComputer/InputModules","last_synced_at":"2025-07-22T16:32:49.639Z","repository":{"id":148607843,"uuid":"565703470","full_name":"FrameworkComputer/InputModules","owner":"FrameworkComputer","description":"Reference designs and documentation for the Input Module system in the Framework Laptop 16","archived":false,"fork":false,"pushed_at":"2024-11-19T03:22:31.000Z","size":14786,"stargazers_count":158,"open_issues_count":10,"forks_count":11,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-11-19T04:24:40.481Z","etag":null,"topics":["framework","frameworklaptop"],"latest_commit_sha":null,"homepage":"https://frame.work/laptop-16","language":null,"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/FrameworkComputer.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":"2022-11-14T06:25:07.000Z","updated_at":"2024-11-15T21:08:57.000Z","dependencies_parsed_at":"2024-09-06T18:50:34.072Z","dependency_job_id":null,"html_url":"https://github.com/FrameworkComputer/InputModules","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameworkComputer%2FInputModules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameworkComputer%2FInputModules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameworkComputer%2FInputModules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameworkComputer%2FInputModules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FrameworkComputer","download_url":"https://codeload.github.com/FrameworkComputer/InputModules/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227133936,"owners_count":17735830,"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":["framework","frameworklaptop"],"created_at":"2024-08-09T14:02:10.492Z","updated_at":"2024-11-29T13:31:35.375Z","avatar_url":"https://github.com/FrameworkComputer.png","language":null,"readme":"# Framework Laptop 16 Input Modules\n![InputModules](https://user-images.githubusercontent.com/28994301/226249081-ab193cfe-4da4-4c47-93ec-c6024edf4fbc.png)\n\nThis repository includes mechanical and electrical documentation for the Input Module system in the \nFramework Laptop 16.  Input Modules are hot-swappable USB 2.0-interfaced devices that enable deep\ncustomization of the input system on the Framework Laptop 16.  It's also possible to use these as \nstandalone USB 2.0 devices with a simple adapter for development purposes.\n\nInput Modules come in three sizes, each of which has the same electrical interface:\n 1. Keyboard-sized modules (283.16mm wide)\n 2. Numpad-sized modules (67.85mm wide)\n 3. Half-sized modules (33.825mm wide)\n\nFor reference firmware for different types of modules, check out these additional repositories:\n * [QMK firmware](https://github.com/frameworkcomputer/qmk_firmware) for the keyboard and numpad modules\n * [inputmodule-rs](https://github.com/FrameworkComputer/inputmodule-rs) firmware and application for other input modules\n\n**Warning:** the documentation here is pretty early, so there may be minor adjustments in the mechanical or electrical designs\nbefore the Framework Laptop 16 launches.  We'll let you know when the design is locked for production.\n \n## License\nInput Modules © 2023 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/\n\n## Mechanical\n\nIn the Mechanical folder, we have 2D drawings of the different Input Module sizes.  Note that there are two version of each:\n 1. A version with full mechanical structure with a separate interface PCB and brackets.  This is what our production modules are based on.\n 2. A simplified version that allows the PCB to be used as the mechanical structure of the module, making it much cheaper and easier to make.\n    Note that to make the PCB attach securely in the system, you'll need to solder SMT nuts like Keystone\t24929 or to adhere a steel plate to attract to\n    the magnets in the system. \n\n## Electrical\n\nIn the Electrical folder, we have a reference version of a minimal RP2040-based Input Module, made in KiCAD.\n\n### Pinout\n\n| Pin | Function | Note                                                              |\n|-----|----------|-------------------------------------------------------------------|\n| 1   | GND      |                                                                   |\n| 2   | VCC_5V   | 5V, power supply from the system.                                 |\n| 3   | USB_DN   | USB D-                                                            |\n| 4   | BOARD_ID | Pull to GND through BOARD_ID resistor defined below               |\n| 5   | USB_DP   | USB D+                                                            |\n| 6   | SLEEP#   | 3.3V if the host is in S0.  0V if the host is in S0ix, S3, S4, S5 |\n| 7   | GND      |                                                                   |\n| 8   | VCC_3V3  | 3.3V, power supply from the system.                               |\n\nViewed from top:\n\n![image](https://user-images.githubusercontent.com/28994301/223607129-ab8e1dcf-dd1f-49f1-9e67-03e9ca072348.png)\n\n### BOARD_ID values\n\n| Module Type           | ID | Pulldown Resistor (on module) |\n|-----------------------|----|-------------------------------|\n| Short                 | 0  | NA                            |\n| Reserved              | 1  | 10000                         |\n| Reserved              | 2  | 18000                         |\n| Reserved              | 3  | 27000                         |\n| Reserved              | 4  | 39000                         |\n| Reserved              | 5  | 56000                         |\n| Generic full width    | 6  | 68000                         |\n| Reserved              | 7  | 82000                         |\n| Generic keyboard size | 8  | 120000                        |\n| Generic medium size   | 9  | 150000                        |\n| Generic small size    | 10 | 180000                        |\n| Medium size keypad    | 11 | 270000                        |\n| Keyboard              | 12 | 330000                        |\n| Touchpad              | 13 | 560000                        |\n| Reserved              | 14 | 820000                        |\n| Not installed         | 15 | NA                            |\n\n### Power\n\nEach Input Module supports up to 500mA on the 5V rail and 100mA on the 3.3V rail when active.\n\nWhen SLEEP# is low or USB is in Selective Suspend mode, modules should drop below 500uA on each rail.  This will typically occur when the\nsystem enters an S0ix state.  In S3/S4/S5 or when the laptop lid is closed, the power rails will typically be off.\n\nThe Framework Laptop 16 has a protection scheme in place to prevent Input Modules from powering on unless the input deck is fully populated.\nModule detection is done using the BOARD_ID pin. It is possible to override this setting on the system, but at the risk of shorting the system\nor modules.\n\n## Touchpad Module\n\nThis section describes the Touchpad Module connection on the **system** side, including the pin define and the pin map of the connector.\n\nPins on the connector have ESD protection to meet IEC 61000-4-2 Level 4 protection.\n\n| Pin | Function | Note                                                |\n|-----|----------|-----------------------------------------------------|\n| 1   | GND      |                                                     |\n| 2   | VCC_5V   | 5V, power supply from the system.                   |\n| 3   | I2C_SCL  | I2C Serial Clock Line                               |\n| 4   | BOARD_ID | Pull to GND through BOARD_ID resistor defined below |\n| 5   | I2C_SDA  | I2C Serial Data Line                                |\n| 6   | TP_INT_1 | Secondary interrupt for touchpad future features    |\n| 7   | VCC_3V3  | 3.3V, power supply from the system.                 |\n| 8   | TP_INT_0 | Main interrupt for touchpad                         |\n\n![image](https://github.com/FrameworkComputer/InputModules/assets/28994301/720e272d-1239-40ba-8b62-a537b74ff71a)\n\n### Touchpad Module layout requirements\n\nThe contacts on the Touchpad should be designed so that the ground pins engage first when the Touchpad is sliding in.\nPin 7 should be 0.5mm longer than the other pins to ensure it engages first. \n\nThe below picture for pads is shown in perspective. The view angle is on top of the PCB.\n\nAround the signal pads there should be a ground fill keepout to prevent the pogo connectors from shorting the pads\nto ground or other signals when sliding in if the solder mask is scraped away.\n\n![image](https://github.com/FrameworkComputer/InputModules/assets/28994301/e8d65dad-9d55-4d5a-b97c-3ccbd33e1fb6)\n\n### Touchpad I2C Protocol\n\nThe I2C bus from the touchpad is connected to the CPU for HID over I2C and\nimplements the [Precision Touchpad Protocol](https://learn.microsoft.com/en-us/windows-hardware/design/component-guidelines/touchpad-protocol-implementation).\n\nIt's also connected to the EC. This is used when booting without a touchpad.\nIf the Windows driver tries to connect to an I2C device but finds it does not respond, it will disable that device.\nSo we make the [EC pretend](https://github.com/FrameworkComputer/EmbeddedController/commit/9d49389919c36e44e451514b8278b9eb7ee6ed1e)\nto be the touchpad and send the same HID report descriptor as the touchpad would.\n\n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrameworkComputer%2FInputModules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFrameworkComputer%2FInputModules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrameworkComputer%2FInputModules/lists"}