开源硬件Seaurchin/Qnithm/Laverita 控制器_C语言_代码_相关文件_下载_设计_文档

# OpeNITHM This repository contails files related to OpeNITHM. Firmware, schematics, board layout, and CAD files are included in this repo. Please see the CAD directory for the original 3d printed version, or the v2-cad directory for the laser cut version. ## List of Hardware In the `CAD\STL` folder, you will find numerous parts that must be 3D printed. Please check out [the wiki](https://github.com/veroxzik/OpeNITHM/wiki/File-Explanation) for more information. | Part | Qty | | --- |:---:| | Center Frame | 1 | | Right Frame | 1 | | Left Frame | 1 | | Key Dual 2.5mm **OR** Key Dual 3mm¹ | 16 | | LED Support Peg | 16 | | Sensor Rail | 2 | | Sensor Spacer Left² | 1 | | Sensor Base Left² **OR** Integrated Sensor Base Left² | 1 | | Sensor Cover Left² | 1 | | Integrated Frame Mount Left^2,3 | 1 | **NOTES:** 1. Use 2.5mm for 3/32" and 3mm for 1/8" acrylic. 2. Print out mirrored version of these parts as well. 3. Only print the frame mount if you are using the integrated sensor. The non-printed materials and hardware include: | Part | Qty | | --- |:---:| | 4-40 Flat Head Screw, length 3/16" to 5/16" will work **OR** M3 equivalent | 2 | | Top Acrylic Plate¹ (472mm x 112mm) | 1 | | Key Acrylic¹ (103.5mm x 26mm) | 16 | | Copper Tape, cut into rectangles 95mm x 26mm | 16 | **NOTES:** 1. Use 2.5mm (3/32") **OR** 3mm (1/8") acrylic. Use the same acrylic for top plate and keys. ## List of Electronics OpeNITHM is designed for the Teensy LC. #### Why use Teensy and not Arduino? The biggest reason is that Teensy has built in capacitive sensing, which is how OpeNITHM fuctions. You have to fake it on Arduino using very controlled analog reads, and it is nowhere near as sensitive. In my (VXZK's) experience, it was simply impossible to use an Arduino to do the capacitive sensing required for this project. I chose the Teensy LC as it is the lowest cost Teensy model available with capacitive sensing. The firmware and PCB are designed for this board alone; significant modifications may be required for any other version. There is an alternative build using an Arduino Pro Micro and 2 MPR121s as a branch in this repo, but it is not maintained and not recommended. You're on your own with that one! ### Teensy LC Build Links are mostly suggestions (except the Teensy, which is only officially available through the PJRC site and authorized resellers). (VXZK: I've heard a lot of trouble regarding good quality IR leds and phototransistors, so I've included specific links to the ones I purchased and has worked well for me.) The links below also assume you want to socket your Teensy and multiplexers for later use. You can solder them directly, if you'd like. If you are going to solder your sensors directly to the PCB, it is not necessary buy the 0.1" Pin Header, Right Angle. Otherwise, include female 0.1" sockets for your sensors (commonly referred to as Dupont connectors). | Part | Link | Qty | | --- | --- |:---:| | Teensy LC | https://www.pjrc.com/store/teensylc.html | 1 | | Teensy LC Breakout Board | this Github, Circuit-Teensy32 folder contains gerbers | 1 | | 74HC4051 Multiplexer Breakout Board | [Aliexpress][1] | 4 | | 0.1" Pin Header, 1 row, 40 pos | [Aliexpress (qty 10)][2] | 2 | | 0.1" Pin Header, Right Angle, 2 row, 24 pos | [LCSC][3] | 2 | | 0.1" Socket, Straight, 1 row, 14 pos | [LCSC][4] | 2 | | 0.1" Socket, Straight, 1 row, 5 pos | [LCSC][5] | 2 | | 0.1" Socket, Straight, 1 row, 11 pos | [LCSC][6] | 2 | | 0.1" Socket, Straight, 1 row, 8 pos | [LCSC][7] | 2 | | 51k ohm Resistor, 1/6W or 1/8W | LCSC or Aliexpress | 6 | | 33 ohm Resistor, 1/4W, 1/6W, or 1/8W | LCSC or Aliexpress | 3 | | 1m WS2812B RGB 5V LED Strip, 30LED Per Meter | [Aliexpress][8] | 1 | | IR LED and Phototransistor | [Ebay (Qty 20 pairs)][9] | 6 | [1]: https://www.aliexpress.com/item/32807771098.html [2]: https://www.aliexpress.com/item/665534073.html [3]: https://lcsc.com/product-detail/New-Arrivals_XFCN-PZ254R-12-24P_C492440.html [4]: https://lcsc.com/product-detail/Pin-Header-Female-Header_Boom-Precision-Elec-Female-header-2-54-1-14P_C52711.html [5]: https://lcsc.com/product-detail/Pin-Header-Female-Header_Boom-Precision-Elec-2-54mm-1-5p-Female-header_C50950.html [6]: https://lcsc.com/product-detail/Pin-Header-Female-Header_Changjiang-Connectors-A2541HWV-11P_C225508.html [7]: https://lcsc.com/product-detail/Pin-Header-Female-Header_Boom-Precision-Elec-2-54mm-1-8P-Straight-Female-header_C27438.html [8]: https://www.aliexpress.com/item/2036819167.html [9]: https://www.ebay.com/itm/40pcs-5mm-Infrared-LED-940nm-Emitter-Diode-and-IR-Receiver-Set/252235145540 ## Board Revision and Sensors As of 2020-07-17, the recommended board version is v2.1, which features inputs for 32 sensors. This best replicates the feeling of the arcade. Previous versions used 16 sensors. If you still wish to make a 16 key version, you can order the v2.1 but only populate two of the multiplexers. This is not really recommended. ## Installing on Teensy LC **NOTE:** This firmware is *only* written to work for the Teensy LC. Do *not* use Teensy 2.0 or Teensy 3.x Skip this section if you are using a Pro Micro. Locate your `arduino` folder (usually `C:\Program Files (x86)\arduino`). #### I have a fresh install of Teensyduino, or have never modified my USB profiles Copy `Firmware/Teensy/boards.txt` to `arduino\hardware\teensy\avr\` and overwrite the existing. Copy `Firmware/Teensy/teensy3` to `arduino\hardware\teensy\avr\cores\teensy3` and overwrite any conflicts. Copy `Firmware/FastLED/WS2812Serial.cpp` and `Firmware/FastLED/WS2812Serial.h` to `arduino\hardware\teensy\avr\libraries\WS2812Serial` and overwrite the existing. Copy `Firmware/FastLED/FastLED.cpp` and `Firmware/FastLED/FastLED.h` to `[My Documents]\Arduino\libraries\FastLED\` and overwrite the existing. #### I am applying the changes manually (It is easier to copy and paste from the files in `Firmware/Teensy` instead of through here, the below is just for reference.) Add `usb_nkro.c` and `usb_nkro.h` to `arduino\hardware\teensy\avr\cores\teensy3` In `arduino\hardware\teesny\avr\boards.txt` add lines 1175-1179 ```c 1175 teensyLC.menu.usb.nkrokeyboard=NKRO Keyboard 1176 teensyLC.menu.usb.nkrokeyboard.build.usbtype=USB_NKRO 1177 teensyLC.menu.usb.nkrokeyboard.fake_serial=teensy_gateway 1178 teensyLC.menu.usb.serialnkrokeyboard=Serial + NKRO Keyboard 1179 teensyLC.menu.usb.serialnkrokeyboard.build.usbtype=USB_SERIAL_NKRO In `arduino\hardware\teensy\avr\cores\teensy3\WProgram.h` add line 59 ```c 58 #include "usb_joystick.h" 59 #include "usb_nkro.h" 60 #include "usb_midi.h" ``` In `arduino\hardware\teensy\avr\cores\teensy3\usb_inst.cpp` add lines 75-77 ```c 72 usb_serial_class Serial; 73 #endif 74 75 #ifdef NKRO_INTERFACE 76 usb_nkro_class Nkro; 77 #endif 78 79 #else // F_CPU < 20 MHz ``` In `arduino\hardware\teensy\avr\cores\teensy3\usb_dev.h` add lines 93-98 ```c 90 extern volatile uint8_t keyboard_leds; 91 #endif 92 93 #ifdef NKRO_INTERFACE 94 extern uint8_t nkro_report_data[NKRO_SIZE]; 95 extern uint8_t nkro_protocol; 96 extern uint8_t nkro_idle_config; 97 extern uint8_t nkro_idle_count; 98 #endif 99 100 #ifdef MIDI_INTERFACE ``` In `arduino\hardware\teensy\avr\cores\teensy3\usb_desc.h` add lines 868-948 ```c 866 #define ENDPOINT15_CONFIG ENDPOINT_TRANSMIT_ONLY 867 868 #elif defined(USB_NKRO) 869 #define VENDOR_ID 0x16C0 870 #define PRODUCT_ID 0x04D0 871 #define MANUFACTURER_NAME {'T','e','e','n','s','y','d','u','i','n','o'} 872 #define MANUFACTURER_NAME_LEN 11 873 #define PRODUCT_NAME {'N','K','R','O',' ','K','e','y','b','o','a','r','d'} 874 #define