English guide done.

README.md

@@ -0,0 +1,177 @@
+# Musec Pico - MUSECA Style Mini Controller
+[点这里可以切换到中文版](README_CN.md)
+
+<img src="doc/main.jpg" width="80%">
+
+Features:
+* It's small but closely replicates the feel of the arcade controller.
+* Built-in "spacebar" pedal.
+* External pedal support through the 3.5mm jack.
+* Full HID light support.
+* Command line for configurations.
+* All source files open.
+
+Thanks to many respectful guys/companies who made their tools or materials free or open source (KiCad, OnShape, InkScape, Raspberry things).
+
+Special thanks to community projects and developers.
+
+* RP_Silicon_KiCad: https://github.com/HeadBoffin/RP_Silicon_KiCad
+* Type-C: https://github.com/ai03-2725/Type-C.pretty
+
+## Notes
+You can check out my other cool projects.
+
+<img src="https://github.com/whowechina/popn_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/iidx_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/iidx_teeny/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/chu_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/mai_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/diva_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/aic_pico/raw/main/doc/main.gif" height="100px">
+<img src="https://github.com/whowechina/groove_pico/raw/main/doc/main.gif" height="100px">
+<img src="https://github.com/whowechina/geki_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/musec_pico/raw/main/doc/main.jpg" height="100px">
+
+
+* Popn Pico: https://github.com/whowechina/popn_pico
+* IIDX Pico: https://github.com/whowechina/iidx_pico
+* IIDX Teeny: https://github.com/whowechina/iidx_teeny
+* Chu Pico: https://github.com/whowechina/chu_pico
+* Mai Pico: https://github.com/whowechina/mai_pico
+* Diva Pico: https://github.com/whowechina/diva_pico
+* AIC Pico: https://github.com/whowechina/aic_pico
+* Groove Pico: https://github.com/whowechina/groove_pico
+* Geki Pico: https://github.com/whowechina/geki_pico
+* Musec Pico: https://github.com/whowechina/musec_pico
+
+This Musec Pico project:  
+* Heavily depends on 3D printing, you need a 3D printer.
+* Requires skills to solder tiny components.
+
+## **Disclaimer** ##
+I made this project in my personal time with no financial benefit or sponsorship. I will continue to improve the project. I have done my best to ensure that everything is accurate and functional, there's always a chance that mistakes may occur. I cannot be held responsible for any loss of your time or money that may result from using this open source project. Thank you for your understanding.
+
+## About the License
+It's CC-NC. So DIY for yourself and for your friend, don't make money from it. And plagiarism that doesn’t even dare to mention the original author is not acceptable.
+
+If you're interested in some kind of commercial use, please contact me (Discord, QQ group, Wechat group or leave your contact in issue section).
+
+## HOW TO BUILD
+### PCB and Components
+* Go JLCPCB and make order with the gerber zip files (latest `Production\PCB\musec_main_xxx.zip` and `Procution\PCB\musec_pedal_xxx.zip`), regular FR-4 board, black or white color, **1.6mm** thickness.  
+  <img src="doc/pcb.jpg" width="60%">
+* 1x Rasberry Pico Pi Pico or pin-to-pin compatible clones (U1).  
+  https://www.raspberrypi.com/products/raspberry-pi-pico
+* 1x USB Type-C socket (918-418K2023S40001 or KH-TYPE-C-16P)
+* 28x WS2812B-3528 RGB LEDs (all RGB LEDs).
+* 6x TMAG5273A1 or TMAG5273A2, in SOT23-6 (U3 to U7).  
+* 12x 0603 0.1uF (0.1~1uF all fine) capacitors (all Capacitors).
+* 2x 0603 5.1kohm resistors (R1, R2) for the USB.
+* 2x 0603 10ohm resistor, (1-20ohm all work fine) (R3, R4).
+* 2x PJ-313 through-hole 3.5mm audio jacks (J2, J3).  
+* 12x JST-SH1.0 4-pin connectors (JA1 to JA5, JB1 to JB5, Pedal, J1 on pedal board).  
+  https://www.amazon.com/Kidisoii-Connector-Mounting-Vertical-SH1-0-SMT-Ver/dp/B0CXMZ3J1Y?th=1
+* 6x JST-SH1.0 dual-end 4-pin cables, 50-100mm length.
+   The connector footprint on PCB also supports hand soldering. So if you can't find the connectors or the cables, you can solder the wires directly to the PCB.1
+   RC hobby sites often have SH1.0 4P silicone cables, but with only one end connector. You can solder the other end to the PCB. It's still a good choice.
+* 7x Kailh Choc v1. Choose heavy ones (70gf), I think the yellow with 70g force is the best.  
+  <img src="doc/choc_v1_heavy.jpg" width="70%">
+* 1x MX Switch, I personally use Gateron POM CJ BOX.
+* 1x Plate-mounting stabilizer for the MX switch, 6.25U.
+  https://www.amazon.com/GATERON-Stabilizer-Mechanical-Keyboard-Satellite/dp/B0C137DG5Q/
+
+* This is how it looks after soldering.  
+  <img src="doc/pcb_solder_1.jpg" width="90%">  
+  <img src="doc/pcb_solder_2.jpg" width="90%">
+* Becareful of 2 pin holes. It's a common oversight to either forget to solder them or to leave air bubbles during the process. To avoid this, solder slowly from one side of the hole, using minimal solder wire and a generous amount of flux.  
+  <img src="doc/pcb_solder_usb_txrx.jpg" width="60%">
+
+### Test the PCB
+  * You can test the PCB now, put the firmware in.
+  * All RGB LEDs should light up in a rainbow pattern.
+  * LEDs responds to the button presses.
+  * Musec Pico should be recognized as a USB HID device, here's the test page.  
+    https://greggman.github.io/html5-gamepad-test/
+  * Move a magnetic screwdriver tip close to the TMAG5273 sensor, you'll notice the corresponding axis move in the test page. Please check all 5 sensors.
+### Sensor PCB Separation
+  * If everthing works fine. You can cut off the 5 small sensor boards from the main board.  
+    <img src="doc/pcb_cut.jpg" width="80%">
+
+### 3D Printing
+* Printing parameters  
+  * PLA or PETG.
+  * Layer height: 0.2mm
+  * Support: Yes, always.
+  * Glue on bed: Yes, it prevents corner warping.
+  * Files are always in milimeter unit, not inch.
+
+#### 5x Spinner Parts
+  <img src="doc/print_orientation_1.jpg" width="30%"><img src="doc/print_orientation_2.jpg" width="40%">
+
+* Keycap: `Production\3DPrint\musec_pico_keycap.stl`, white. If you have multi-color system, print the 4 triangle marks on the top in gray. 
+* Bearing Fixer: `Production\3DPrint\musec_pico_bearing_fixer.stl`, clear transparent.
+* Shaft End: `Production\3DPrint\musec_pico_shaft_end.stl`, clear transparent.
+* Lever: `Production\3DPrint\musec_pico_lever.stl`, clear transparent.
+* Pad: `Production\3DPrint\musec_pico_pad.stl`, white, gray or black (so it won't affect the LED color).
+
+#### Housing Parts
+* Housing Bottom: `Production\3DPrint\musec_pico_bottom.stl`, black, use special support material for nicer screw hole surface.
+* Housing Top: `Production\3DPrint\musec_pico_top.3mf`, gray, print up-side-down. If you have multi-color system, print the logo and lines in black.
+
+#### Other Parts
+* Pedal: `Production\3DPrint\musec_pico_pedal.stl`, white, print upside down.
+* Aux Buttons: `Production\3DPrint\musec_pico_aux.stl`, clear transparent, print upside down.
+
+### Assembly
+* Other components needed
+  * 5x **M2.5\*6mm screws** for fixing the keycap to the bearing.
+  * 30x **M2\*(6-8mm) screws** for fixing the bearing and the sensor PCB to the lever.
+  * 15x **M3\*8mm screws** for fixing button pads to the bottom housing.
+  * 16x **M3\*(10-12mm) screws** for fixing the top and bottom housing and the pedal board to the bottom housing.
+  * 5x 6700zz (10x15x4mm) bearings for the spinner, just buy cheapest ones.
+    https://www.amazon.com/uxcell-6700ZZ-Groove-Bearings-Shielded/dp/B082PPYZQX/
+  * 5x round magnets with 5mm diameter (3mm or 4mm also works if you glue it well), 1.5mm or 2mm tall, MUST be radially/diametrically magnetized (N-S poles on the curved side).
+    https://wargameportal.com/products/special-diametrically-magnetized-50pcs-5mm-x-2mm-3-16-x-1-16-disc-magnets?variant=49014932209942
+  * 5x 25mm length 2mm diameter steel shafts for the lever.
+    https://www.walmart.com/ip/Unique-Bargains-RC-Toy-Car-Frame-Part-Stainless-Steel-Round-Rod-Shaft-25mm-x-2mm-40-Pcs/108734138?wmlspartner=wlpa&selectedSellerId=571
+  * Some good tape (such as acetate tape or high-temp teflon tape) to fix the magnets in place.
+  * PTFE or UHMW tape for the sliding surfaces.
+  * Silicone anti-slip pads for the bottom.  
+    <img src="doc/anti_slip_pads.jpg" width="60%">
+
+* Steps
+  1. We'll start with the spinner part.  
+    <img src="doc/assemble_1.jpg" width="80%">
+  2. Put the bearing into the bearing fixer, you'll need to bend the fixer a little bit to insert the bearing. Don't worry if the small connection part of the fixer breaks, it's fine. Then screw the bearing fixer to the lever.  
+    <img src="doc/assemble_2.jpg" width="80%">
+  3. Screw the keycap using M2.5 screws mentioned earlier.  
+    <img src="doc/assemble_3.jpg" width="80%">
+  4. Now insert the magnet into the slot at the center. It will be attracted to the screw head. But we still need some tape to fix it in place.  
+    <img src="doc/assemble_4.jpg" width="45%"><img src="doc/assemble_5.jpg" width="45%">
+  5. Screw the sensor PCB to the lever and put a small piece of thin PTFE/UHMW tape on the surface. And lastly insert the shaft into the lever.  
+    <img src="doc/assemble_6.jpg" width="80%">
+  6. Connect 5 SH1.0 cables to the main PCB. Install the main PCB and the pedal PCB to the bottom housing. Use another SH1.0 cable to connect the pedal PCB and the main PCB. The screwholes on pedal board is adjustable. Normally you need to install the pedal board a little higher.    
+    <img src="doc/assemble_7.jpg" width="80%">
+  7. Connect the SH1.0 cables which are already connected to the main board to the sensor PCBs. And then push the lever shafts into the stands on the bottom housing.      
+    <img src="doc/assemble_8.jpg" width="80%">
+  8. Install the button pads using M3*8mm screws.  
+    <img src="doc/assemble_9.jpg" width="80%">
+  9. Install the top housing, you need to screw many M3 screws.  
+    <img src="doc/assemble_10.jpg" width="80%">
+  10. Put the anti-slip pads on the bottom, right on top of the screws.  
+
+### Firmware
+* UF2 file is in `Production\Firmware` folder.
+* For the new build, hold the BOOTSEL button while connect the USB to a PC, there will be a disk named "RPI-RP2" showed up. Drag the UF2 firmware binary file into it. That's it. There's a small hole at the bottom side of the Musec Pico, it is facing right to the BOOTSEL button.
+* If it's already running Musec Pico firmware, you can either use "update" in command line or hold down at least 4 buttons while connecting to USB to enter update mode.
+* To access the command line, you can use this Web Serial Terminal to connect to the USB serial port of the Musec Pico. (Note: "?" is for help)  
+  https://googlechromelabs.github.io/serial-terminal/
+
+
+### Usage
+* It's very simple. Just plug it in and play.
+* You can set spin sensivity by "spin rate" command.
+
+## CAD Source File
+I'm using OnShape free subscription. It's powerful but it can't archive original designs to local, so I can only share the link here. STL/DXF/DWG files are exported from this online document.  
+  https://cad.onshape.com/documents/841383e62eb719d8b384c2c8/w/8c9b3131eb80c219de824619/e/8a5d9f0dffe483e0bce3630a?renderMode=0&uiState=670e5234ff55f3754d0e6c56

README_CN.md

@@ -0,0 +1,54 @@
+# Musec Pico - MUSECA 风格的迷你控制器
+[Click here for the English version of this guide.](README.md)
+
+<img src="doc/main.jpg" width="80%">
+
+特性:
+* 它很小，但尽量还原街机控制器的感觉。
+* 内置 "空格键" 踏板。
+* 可以通过 3.5mm 插孔连接外部踏板。
+* 完整的 HID 灯光支持。
+* 命令行配置。
+* 所有源文件开放。
+
+感谢许多尊敬的爱好者和公司将他们的工具或材料免费或开源（KiCad，OnShape，InkScape，Raspberry 相关工具, 嘉立创，等）。
+
+特别感谢社区项目和开发者的帮助。
+* RP_Silicon_KiCad: https://github.com/HeadBoffin/RP_Silicon_KiCad
+* Type-C: https://github.com/ai03-2725/Type-C.pretty
+
+## 其他项目
+你也可以查看我其他的酷炫项目。
+
+<img src="https://github.com/whowechina/popn_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/iidx_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/iidx_teeny/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/chu_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/mai_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/diva_pico/raw/main/doc/main.jpg" height="100px">
+<img src="https://github.com/whowechina/aic_pico/raw/main/doc/main.gif" height="100px">
+<img src="https://github.com/whowechina/groove_pico/raw/main/doc/main.gif" height="100px">
+<img src="https://github.com/whowechina/musec_pico/raw/main/doc/main.jpg" height="100px">
+
+* Popn Pico: https://github.com/whowechina/popn_pico
+* IIDX Pico: https://github.com/whowechina/iidx_pico
+* IIDX Teeny: https://github.com/whowechina/iidx_teeny
+* Chu Pico: https://github.com/whowechina/chu_pico
+* Mai Pico: https://github.com/whowechina/mai_pico
+* Diva Pico: https://github.com/whowechina/diva_pico
+* AIC Pico: https://github.com/whowechina/aic_pico
+* Groove Pico: https://github.com/whowechina/groove_pico
+* Musec Pico: https://github.com/whowechina/musec_pico
+
+这个 Musec Pico 项目：
+* 大量依赖 3D 打印，所以你需要一个 3D 打印机。
+* 需要具备焊接细小元器件的能力。
+
+## **声明** ##
+我在个人时间内制作了这个项目，没有任何经济利益或赞助。我将继续改进这个项目。我已尽我所能确保所有内容的准确性和功能性，但总有可能出现错误。如果你因使用这个开源项目而造成时间或金钱的损失，我不能负责。感谢你的理解。
+
+## 关于许可证
+它是 CC-NC 授权。所以你只能给自己和你的朋友 DIY，不能利用这个项目赚钱，比如收费的代做，出售整机等，连源作者都不敢提的抄袭或者稍微改改换个名字来打擦边球就更不可以了。
+如果希望商用授权，请联系我（Discord，QQ 群，微信群或者在 issue 区留下你的联系方式）。
+
+## 后面还没写，个人时间有限，大家等等，或者先看英文版。