[+] Basic documentation

2023-04-20 20:18:42 -04:00
parent 22d619234a
commit 2855d257c8
3 changed files with 47 additions and 1 deletions
@@ -1,4 +1,7 @@
 .pio
 CMakeListsPrivate.txt
 cmake-build-*/ 
-.idea
+.idea
+
+.DS_Store
+._*
@@ -0,0 +1,43 @@
+# Taiko-stick / 太鼓槌
+
+A pair of drumsticks that can be used to play Taiko no Tatsujin on any surface.
+
+一对可以在任何表面上打太鼓达人的鼓槌.
+
+## 1. Build / 制作
+
+### Materials Required / 材料
+
+* 2x Thick-enough drumsticks  
+(The one I used: [taobao link](https://item.taobao.com/item.htm?id=665108049486))
+* 2x Piezo sensors (压电/蜂鸣陶瓷片)
+* 2x 1MΩ resistors
+* 1x Arduino Nano  
+(or any other dev board, just change the platformio config)
+* Many wires
+
+### Tools Required / 工具
+
+* Either a breadboard, SPL2 solder-less connectors, or a soldering kit
+* A computer
+
+### Connections / 连接
+
+![img.png](doc/img.png)
+
+## 2. Run / 运行
+
+### Flash Firmware / 烧录固件
+
+1. Install PlatformIO Core ([Guide](https://platformio.org/install/cli))
+2. Connect the Arduino Nano to your computer
+3. Upload firmware using `platformio run --target upload`
+
+### Run Backend / 运行后端
+
+I'm too lazy to write a HID device driver, so I'm using a python script to read the serial output from the Arduino and send keystrokes to the computer.
+
+1. Install Python 3.11+ ([Guide](https://www.python.org/downloads/))
+2. Install dependencies using `pip install -r requirements.txt`
+3. Run `python reader.py`
+4. Use `Ctrl+C` to exit.