Max/skogaby_OpeNITHM
1
0
Fork 0
mirror of https://github.com/skogaby/OpeNITHM.git synced 2026-09-22 22:58:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
skogaby
2020-09-10 13:41:27 -05:00
parent 8b252c7aff
commit 946f389f51
1 changed files with 58 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+58 -16
View File
@@ -4,25 +4,69 @@ 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<sup>1</sup> | 16 |
| LED Support Peg | 16 |
| Sensor Rail | 2 |
| Sensor Spacer Left<sup>2</sup> | 1 |
| Sensor Base Left<sup>2</sup> **OR** Integrated Sensor Base Left<sup>2</sup> | 1 |
| Sensor Cover Left<sup>2</sup> | 1 |
| Integrated Frame Mount Left<sup>2,3</sup> | 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<sup>1</sup> (472mm x 112mm) | 1 |
| Key Acrylic<sup>1</sup> (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 two different processors in mind: the Pro Micro and the Teensy LC.
Based on testing, it seems the Teensy LC is easier to set up and calibrate, but either should work with enough tuning.
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).
(VXKZ: 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).
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-Teensy folder contains gerbers | 1 |
| 74HC4051 Multiplexer Breaking Board | [Aliexpress][1] | 2 |
| 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, 16 pos | [LCSC][3] | 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 |
@@ -30,23 +74,21 @@ If you are going to solder your sensors directly to the PCB, it is not necessary
| 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 | [Ebay (Qty 100)][9] | 6 |
| IR Phototransistor | [Ebay (Qty 100)][10] | 6 |
| 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/Pin-Header-Female-Header_Changjiang-Connectors-A2541WR-2x8P_C239339.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/100pcs-5mm-IR-Infrared-LED-940nm-Lamp-High-Power-Wide-Angle-Long-Range/251565825589
[10]: https://www.ebay.com/itm/100pcs-5mm-940nm-IR-LED-Infrared-Beams-Detector-Sensor-Black-Phototransistor/251816201528
[9]: https://www.ebay.com/itm/40pcs-5mm-Infrared-LED-940nm-Emitter-Diode-and-IR-Receiver-Set/252235145540
## Note on wiring:
## Board Revision and Sensors
Until a new PCB design is made (should be fairly soon), in order to take full advantage of the firmware (or use it at all), you'll need to manually bridge pins 17 and 24 on your Teensy LC. This will be addressed in a future PCB revision, but it maximizes RGB LED throughput.
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