Develop v2 (#27)

Author: bbrfkr

.github/workflows/build.yml

@@ -25,12 +25,12 @@ jobs:
       - name: build firmware
         run: >
           cd ../qmk_firmware &&
-          qmk compile -kb bbrfkr/dynamis -km via &&
+          qmk compile -kb bbrfkr/dynamis/v2 -km via &&
           cd -
       - name: gather artifacts
         run: >
           mkdir artifacts &&
-          cp ../qmk_firmware/.build/bbrfkr_dynamis_via.hex firmware/via/dynamis.json artifacts
+          cp ../qmk_firmware/.build/bbrfkr_dynamis_v2_via.hex firmware/via/v2/dynamis.json artifacts
       - uses: actions/upload-artifact@v3
         with:
           name: firmware

.gitignore

@@ -3,3 +3,4 @@ plate-backups
 sandwitch-backups
 *.FCStd1
 *.gbrjob
+*.zip

BOM-jp.md

@@ -0,0 +1,14 @@
+# PCBA - パーツリスト
+|名称|数量|説明|
+|---|---|---|
+|PCBA(半完成品)|1|[ガーバーファイル](https://github.com/bbrfkr/dynamis-keyboard/tree/main/gerbers)と[BOMリスト](https://github.com/bbrfkr/dynamis-keyboard/tree/main/bom.csv)、[ポジションファイル](https://github.com/bbrfkr/dynamis-keyboard/tree/main/dynamis-pos.csv)にしたがって注文してください|
+|スイッチソケット|76|MX互換品がサポートされています|
+|LED|5|SK6812MINI-Eがサポートされています|
+|トラックボールカップベース|1|[こちら](https://github.com/bbrfkr/dynamis-keyboard/blob/main/trackball-cup/trackball-cup.stl)をFDM 3Dプリントしてください|
+|セラミックボール 2mm|3|トラックボールの支持用|
+|M2ヒートインサート|4|長さ3mm|
+|M2なべネジ|4|長さ4mm|
+|ロータリエンコーダ|1|例えば、[EC12E24404A6](https://www.mouser.jp/datasheet/2/15/EC12E-1370769.pdf)など|
+|トラックボールセンサ（ミラー付き）|1|[PMW3360DM-T2QU](https://d3s5r33r268y59.cloudfront.net/datasheets/9604/2017-05-07-18-19-11/PMS0058-PMW3360DM-T2QU-DS-R1.50-26092016._20161202173741.pdf)がサポートされています|
+|エンコーダ用ノブ|1|-|
+|PCBマウント式のスタビライザ|(必要数)|MX互換品がサポートされています|

BOM.md

@@ -1,24 +1,15 @@
-# parts list for pcb
+# parts list for pcba
 
 |name|qty|description|
 |---|---|---|
-|3-state transceiver|5|[74LVC1T45GW,125](https://assets.nexperia.com/documents/data-sheet/74LVC_LVCH1T45.pdf) is supported|
-|capacitor 22 pF|2|smd. package 3216|
-|capacitor 0.1 uF|4|smd. package 3216|
-|capacitor 1 uF|3|smd. package 3216|
-|capacitor 4.7 uF|1|smd. package 3216|
-|capacitor 10 uF|1|smd. package 3216|
-|crystal|1|e.g. [FA238(16Mhz)](https://support.epson.biz/td/api/doc_check.php?dl=brief_FA-238)|
-|diode|68|smd. package 3216|
-|low-dropout regulator|1|[TLV70019DDCR](https://www.ti.com/lit/ds/symlink/tlv700.pdf) is supported|
-|microchip|1|[atmega32u4-au](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-7766-8-bit-AVR-ATmega16U4-32U4_Datasheet.pdf) is supported|
-|mx switch hot-swap socket|76|e.g. [CPG151101S11](http://www.kailh.com/en/Products/Ks/HPC/883.html)|
-|register 22 ohm|2|smd. package 3216|
-|register 39 ohm|1|smd. package 3216|
-|register 5.1k ohm|2|smd. package 3216|
-|register 10k ohm|4|smd. package 3216|
-|reset switch|1|[TS-1187A-B-A-B](https://datasheet.lcsc.com/lcsc/2002271431_XKB-Connectivity-TS-1187A-B-A-B_C318884.pdf) is supported|
+|dynamis pcba(semi-assembled)|1|Order by the following [gerbers](https://github.com/bbrfkr/dynamis-keyboard/tree/main/gerbers), [bom](https://github.com/bbrfkr/dynamis-keyboard/tree/main/bom.csv) and [position](https://github.com/bbrfkr/dynamis-keyboard/tree/main/dynamis-pos.csv) files|
+|switch socket|76|MX compatible one is supported|
+|LED|5|SK6812MINI-E is supported|
+|trackball cup base|1|FDM 3d printed by [this stl](https://github.com/bbrfkr/dynamis-keyboard/blob/main/trackball-cup/trackball-cup.stl)|
+|ceramic ball 2mm|3|For supporting trackball|
+|M2 heat insert|4|The length is 3mm|
+|M2 pan head screw|4|The length is 4mm|
 |rotary encoder|1|e.g. [EC12E24404A6](https://www.mouser.jp/datasheet/2/15/EC12E-1370769.pdf)|
 |trackball sensor (with mirror)|1|[PMW3360DM-T2QU](https://d3s5r33r268y59.cloudfront.net/datasheets/9604/2017-05-07-18-19-11/PMS0058-PMW3360DM-T2QU-DS-R1.50-26092016._20161202173741.pdf) is supported|
-|underglow led|10|[WS2812B](https://cdn-shop.adafruit.com/datasheets/WS2812B.pdf) is supported|
-|usb-c receptacle|1|[HRO_TYPE-C-31-M-12](https://datasheet.lcsc.com/lcsc/2205251630_Korean-Hroparts-Elec-TYPE-C-31-M-12_C165948.pdf) is supported|
+|encoder knob|1|-|
+|pcb mounted stabilizer|(qty you need)|MX compatible one is supported|

BUILD-jp.md

@@ -0,0 +1,34 @@
+# ビルドガイド for PCBA(PCB-Assembly)
+1. 部品を用意します。
+    ![pcba01](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba01.jpg?raw=true)
+1. LEDをはんだ付けします。 LEDの欠けた足がPCB上の白い点に近いパッドに乗るようにしてください。
+    ![pcba02](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba02.jpg?raw=true)
+    ![pcba03](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba03.jpg?raw=true)
+1. 少量のはんだをスイッチソケットのパッドすべてに乗せます。
+    ![pcba04](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba04.jpg?raw=true)
+1. スイッチソケットをはんだ付けします。片側のパッドだけすべてはんだ付けし、そのあとにもう片方をはんだ付けすると多少楽になります。
+    ![pcba05](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba05.jpg?raw=true)
+1. トラックボールセンサをレンズがスペースキーを向くように、PCBの裏側から差し込みます。そうしたらすべてのピンをはんだ付けします。
+    ![pcba06](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba06.jpg?raw=true)
+    ![pcba07](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba07.jpg?raw=true)
+1. ロータリエンコーダを配置し、はんだ付けします。
+    ![pcba08](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba08.jpg?raw=true)
+    ![pcba09](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba09.jpg?raw=true)
+1. ノブをおいて、ねじを締めます。
+    ![pcba10](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba10.jpg?raw=true)
+1. トラックボールカップについている三つのくぼみに2mmセラミックボールを配置して、押し込みます。トラックボールで軽く押し込むようにするとしっかり入ります。
+    ![pcba11](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba11.jpg?raw=true)
+    ![pcba12](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba12.jpg?raw=true)
+1. トラックボールの底面四隅の穴に、ヒートインサートをはんだごてで圧入します。
+    ![pcba13](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba13.jpg?raw=true)
+    ![pcba14](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba14.jpg?raw=true)
+1. センサミラーをトラックボールセンサの上に乗せます。
+    ![pcba15](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba15.jpg?raw=true)
+1. センサミラーを覆うようにトラックボールカップを取り付け、PCB裏側からM2ねじでねじ止めします。
+    ![pcba16](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba16.jpg?raw=true)
+    ![pcba17](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba17.jpg?raw=true)
+1. 写真と見比べて、作業内容を確認してください。
+    ![pcba18](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba18.jpg?raw=true)
+    ![pcba19](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba19.jpg?raw=true)
+1. 最後に、PCBマウント方式のスタビライザを取り付けて完了です。
+    ![pcba20](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba20.jpg?raw=true)

BUILD.md

@@ -0,0 +1,34 @@
+# build guide for pcba
+1. Prepare the parts.
+    ![pcba01](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba01.jpg?raw=true)
+1. Solder leds. Put the cut-off leg of led at the pad with a white dot.
+    ![pcba02](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba02.jpg?raw=true)
+    ![pcba03](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba03.jpg?raw=true)
+1. Put a little solder on the pads for switch sockets.
+    ![pcba04](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba04.jpg?raw=true)
+1. Solder switch sockets.
+    ![pcba05](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba05.jpg?raw=true)
+1. Put trackball sensor at the bottom of pcb such as the lens faces the direction of space key, and solder it.
+    ![pcba06](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba06.jpg?raw=true)
+    ![pcba07](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba07.jpg?raw=true)
+1. Put rotary encoder, and solder it.
+    ![pcba08](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba08.jpg?raw=true)
+    ![pcba09](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba09.jpg?raw=true)
+1. Put and screw knob to encoder.
+    ![pcba10](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba10.jpg?raw=true)
+1. Put and push ceramic balls to three caves of trackball cup.
+    ![pcba11](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba11.jpg?raw=true)
+    ![pcba12](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba12.jpg?raw=true)
+1. Push heat insert into the hole with the bottom of trackball cup by the solder iron.
+    ![pcba13](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba13.jpg?raw=true)
+    ![pcba14](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba14.jpg?raw=true)
+1. Put sensor mirror to trackball sensor.
+    ![pcba15](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba15.jpg?raw=true)
+1. Cover sensor mirror with trackball cup. Then, screw trackball cup from the bottom of pcb.
+    ![pcba16](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba16.jpg?raw=true)
+    ![pcba17](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba17.jpg?raw=true)
+1. Check your work.
+    ![pcba18](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba18.jpg?raw=true)
+    ![pcba19](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba19.jpg?raw=true)
+1. Finally, put your favorite pcb-mounted stabs.
+    ![pcba20](https://github.com/bbrfkr/dynamis-keyboard/blob/images/images/pcba20.jpg?raw=true)