kmk_firmware/hardware/README.md
Ryan Rotter dfa73a8cca add backtick quotes for code snippets
* Added for keycodes, pin numbers, and code snippets. Mostly in tables.
* Enhance documentation readability
* Make automated spell checking easier - aspell automatically ignores these snippets
* fix invalid markdown table in mouse_keys.md
2022-04-25 16:53:22 +00:00

49 lines
2.5 KiB
Markdown

# KMK Hardware: Devices for use with KMK
## ItsyBitsy to Pro Micro pinout adapter
This board adapts the pinout of a Circuit Python compatible [Adafruit ItsyBitsy M4 Express](https://www.adafruit.com/product/3800) to that of the [SparkFun Pro Micro](https://www.sparkfun.com/products/12640) to allow the ItsyBitsy to be used with the many keyboards that support the footprint of the Pro Micro.
## Pin mapping
| Pro Micro Pin | ItsyBitsy Pin |
|-----------------|-----------------|
| `TX0/PD3` | `TX` |
| `RX1/PD2` | `RX` |
| `GND` | `GND` |
| `GND` | `GND` |
| `2/PD1` | `SDA` |
| `3/PD0` | `SCL` |
| `4/PD4` | `D13` |
| `5/PC6` | `D12` |
| `6/PD7` | `D11` |
| `7/PE6` | `D10` |
| `8/PB4` | `D9` |
| `9/PB5` | `D7` |
| `Raw` | |
| `GND` | `GND` |
| `RST` | `RST` |
| `VCC` | `USB` |
| `A3/PF4` | `A0` |
| `A2/PF5` | `A1` |
| `A1/PF6` | `A2` |
| `A0/PF7` | `A3` |
| `15/PB1` | `A4` |
| `14/PB3` | `A5` |
| `16/PB2` | `SCK` |
## So how do I use it?
1. The pads for the Pro Micro footprint are circled on the underside of the board. Solder male headers into these pads on the underside of the board (the same side as the markings) so that the pins extend "downward" so that they can be plugged into the keyboard.
2. The remaining pads are for the ItsyBitsy. Assuming height is a concern, rather than soldering male headers into the ItsyBitsy and female headers into the adapter board, instead place the long side of male headers through the ItsyBitsy pads from underneath the board so that they protrude through he pads on the top of the board and solder them in place. Make sure to keep the headers perpendicular to the surface of the board.
3. Once soldered, place the ItsyBitsy board over the headers that are now protruding upwards so that the headers go through the pads of the ItsyBitsy and solder in place.
4. Trim the ItsyBitsy headers as needed with flush cutters.
## License, Copyright, and Legal
The files in this directory are licensed
[CC BY-SA 4.0](https://tldrlegal.com/license/creative-commons-attribution-sharealike-4.0-international-(cc-by-sa-4.0))
while the tl;dr is linked, the full license text is included in `LICENSE.md` in this directory.