Finished assembly

BenjaminPoilve · Oct 26, 2024 · d872fe7 · d872fe7
1 parent 0bea2d6
commit d872fe7
Show file tree

Hide file tree

Showing 24 changed files with 105 additions and 13 deletions.
diff --git a/Readme.md b/Readme.md
@@ -36,7 +36,7 @@ All software is provided under a 3-clause BSD License.
 In particular it contains: 
 - the [Hex firmware](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/firmware.hex)
 - the full [PlatformIO project](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware)
-- the [minicontrol software](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/mini_control)
+- the [minicontrol software](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/minicontrol)
 
 ## Media 
 

diff --git a/documentation/docs/assembly.md b/documentation/docs/assembly.md
@@ -648,9 +648,69 @@ Whether normal or transparent resin, it is possible to use GTC liquid dyes to dy
 </details>
 <hr>
 
-[TBD]
+## Marking the keycap 
 
-Note :
+The first row of keycaps need to be marked with the chord letters. If you have a CNC router, then it is possible to engrave the keycap with a 45° V cutter, using a V-carve mode. 
 
-* do the double sided tape between battery and PCB 
-* don't overtighten the screws ! its only plastic
+For Omron Keycap, I've found the following setting to be satisfying:
+
+* 300 mm/min feed rate; 
+* 150 mm/min plunge rate; 
+* 10 000 rpm.
+
+![CNC engraving](./ressources/CNC_routing.jpg "CNC engraving")
+
+Once the keycap are engraved, the engraving is filled using Markal "Lacquer fill-in" paint stick. The following steps are recommanded: 
+
+* "sharpen" the paintstick with an X-acto to have a pointy end;
+* overfill the engraving with color;
+* wait for at last 15 hours for the paint to start solidifying;
+* buff the surplus color out. Place a tissue paper flat on a table, and rub the keycap on it while maintaining it very flat to remove the color outside of the groove. You may need to do it in several passes, changing the tissue paper in between. To properly remove all remaining color, a few drops of isopropyl might help. 
+
+
+![keycaps](./ressources/keycap.jpg "keycaps")
+
+Alternatively, if you don't have a CNC router, you can look into UV DTF transfers. It is a cheap method to allow color tranfers that can work for details up to 0.5mm. 
+
+Once you engraved keycap are finished, you can install all the buttons on the main PCB. 
+
+The engraved buttons go on the first line, and the order is G/B/A/F/D/E/C.
+
+![all buttons installed](./ressources/all_buttons.jpg "all buttons installed")
+
+## Attaching the battery 
+
+The battery needs to be fixed on the pcb using double sided foam tape. The foam part is very important as it protect the soft pouch of the battery from being damaged by the possible sharp bits sticking out of the PCB. 
+
+To do so, use the X-acto to cut the double sided foam tape, and press it on the battery pouch. 
+
+
+![the scotched battery](./ressources/scotched_battery.jpg "the scotched battery")
+
+Then flip the pouch and press it onto the PCB. Use the picture to identify proper placement. 
+
+![attached pouch](./ressources/pouch_attached.jpg "the installed battery")
+
+
+## Assembling the enclosure
+
+Now the easiest step ! 
+
+![all components](./ressources/all_components.jpg "all components")
+
+
+First install the PCB in the bottom shell. Secure the PCB with the three small screws. Be sure to not overtighten the screws: once you feel a resistance, it is enough. 
+
+![bottom installed](./ressources/bottom_installed.jpg "bottom installed")
+
+No install the top shell. Make sure that all keycap are well-aligned with their respective holes. Once it is the case, it should be easy to push the top shell in place. 
+
+Secure the top shell with the six long screws. Be sure to not overtighten the screws: once you feel a resistance, it is enough. 
+
+![top installed](./ressources/top_installed.jpg "top installed")
+
+The last step is to install the touch zone PCB. Simply be carefull that the header are in their right place, and push it until it makes contact with the shell. 
+
+![finished](./ressources/finished.jpg "finished")
+
+That's it, your minichord is done! No to use it, please refer to the ["manual" section](/user_manual)
diff --git a/documentation/docs/ressources/CNC_routing.jpg b/documentation/docs/ressources/CNC_routing.jpg
diff --git a/documentation/docs/ressources/all_buttons.jpg b/documentation/docs/ressources/all_buttons.jpg
diff --git a/documentation/docs/ressources/all_components.jpg b/documentation/docs/ressources/all_components.jpg
diff --git a/documentation/docs/ressources/bottom_installed.jpg b/documentation/docs/ressources/bottom_installed.jpg
diff --git a/documentation/docs/ressources/finished.jpg b/documentation/docs/ressources/finished.jpg
diff --git a/documentation/docs/ressources/keycap.jpg b/documentation/docs/ressources/keycap.jpg
diff --git a/documentation/docs/ressources/pouch_attached.jpg b/documentation/docs/ressources/pouch_attached.jpg
diff --git a/documentation/docs/ressources/scotched_battery.jpg b/documentation/docs/ressources/scotched_battery.jpg
diff --git a/documentation/docs/ressources/top_installed.jpg b/documentation/docs/ressources/top_installed.jpg
diff --git a/documentation/docs/source.md b/documentation/docs/source.md
@@ -3,7 +3,7 @@
 
 > All software is provided under a 3-clause BSD License
 
-* [minicontrol software](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/mini_control)
+* [minicontrol software](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/minicontrol)
 * [Hex firmware](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/firmware.hex)
 * [PlatformIO project](https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware)
 * [Tutorial for PlatformIO Teensy usage](https://forum.pjrc.com/index.php?threads/tutorial-how-to-use-platformio-visual-code-studio-for-teensy.66674/)

diff --git a/documentation/site/assembly/index.html b/documentation/site/assembly/index.html
@@ -723,12 +723,44 @@ <h3 id="final-assembly"><strong>Final assembly</strong></h3>
 </details>
 <hr>
 
-<p>[TBD]</p>
-<p>Note :</p>
+<h4 id="marking-the-keycap">Marking the keycap</h4>
+<p>The first row of keycaps need to be marked with the chord letters. If you have a CNC router, then it is possible to engrave the keycap with a 45° V cutter, using a V-carve mode. </p>
+<p>For Omron Keycap, I've found the following setting to be satisfying:</p>
 <ul>
-<li>do the double sided tape between battery and PCB </li>
-<li>don't overtighten the screws ! its only plastic</li>
+<li>300 mm/min feed rate; </li>
+<li>150 mm/min plunge rate; </li>
+<li>10 000 rpm.</li>
 </ul>
+<p><img alt="CNC engraving" src="../ressources/CNC_routing.jpg" title="CNC engraving" /></p>
+<p>Once the keycap are engraved, the engraving is filled using Markal "Lacquer fill-in" paint stick. The following steps are recommanded: </p>
+<ul>
+<li>"sharpen" the paintstick with an X-acto to have a pointy end;</li>
+<li>overfill the engraving with color;</li>
+<li>wait for at last 15 hours for the paint to start solidifying;</li>
+<li>buff the surplus color out. Place a tissue paper flat on a table, and rub the keycap on it while maintaining it very flat to remove the color outside of the groove. You may need to do it in several passes, changing the tissue paper in between. To properly remove all remaining color, a few drops of isopropyl might help. </li>
+</ul>
+<p><img alt="keycaps" src="../ressources/keycap.jpg" title="keycaps" /></p>
+<p>Alternatively, if you don't have a CNC router, you can look into UV DTF transfers. It is a cheap method to allow color tranfers that can work for details up to 0.5mm. </p>
+<p>Once you engraved keycap are finished, you can install all the buttons on the main PCB. </p>
+<p>The engraved buttons go on the first line, and the order is G/B/A/F/D/E/C.</p>
+<p><img alt="all buttons installed" src="../ressources/all_buttons.jpg" title="all buttons installed" /></p>
+<h4 id="attaching-the-battery">Attaching the battery</h4>
+<p>The battery needs to be fixed on the pcb using double sided foam tape. The foam part is very important as it protect the soft pouch of the battery from being damaged by the possible sharp bits sticking out of the PCB. </p>
+<p>To do so, use the X-acto to cut the double sided foam tape, and press it on the battery pouch. </p>
+<p><img alt="the scotched battery" src="../ressources/scotched_battery.jpg" title="the scotched battery" /></p>
+<p>Then flip the pouch and press it onto the PCB. Use the picture to identify proper placement. </p>
+<p><img alt="attached pouch" src="../ressources/pouch_attached.jpg" title="the installed battery" /></p>
+<h4 id="assembling-the-enclosure">Assembling the enclosure</h4>
+<p>Now the easiest step ! </p>
+<p><img alt="all components" src="../ressources/all_components.jpg" title="all components" /></p>
+<p>First install the PCB in the bottom shell. Secure the PCB with the three small screws. Be sure to not overtighten the screws: once you feel a resistance, it is enough. </p>
+<p><img alt="bottom installed" src="../ressources/bottom_installed.jpg" title="bottom installed" /></p>
+<p>No install the top shell. Make sure that all keycap are well-aligned with their respective holes. Once it is the case, it should be easy to push the top shell in place. </p>
+<p>Secure the top shell with the six long screws. Be sure to not overtighten the screws: once you feel a resistance, it is enough. </p>
+<p><img alt="top installed" src="../ressources/top_installed.jpg" title="top installed" /></p>
+<p>The last step is to install the touch zone PCB. Simply be carefull that the header are in their right place, and push it until it makes contact with the shell. </p>
+<p><img alt="finished" src="../ressources/finished.jpg" title="finished" /></p>
+<p>That's it, your minichord is done! No to use it, please refer to the <a href="/user_manual">"manual" section</a></p>
 </section>
 
             </main>

diff --git a/documentation/site/ressources/CNC_routing.jpg b/documentation/site/ressources/CNC_routing.jpg
diff --git a/documentation/site/ressources/all_buttons.jpg b/documentation/site/ressources/all_buttons.jpg
diff --git a/documentation/site/ressources/all_components.jpg b/documentation/site/ressources/all_components.jpg
diff --git a/documentation/site/ressources/bottom_installed.jpg b/documentation/site/ressources/bottom_installed.jpg
diff --git a/documentation/site/ressources/finished.jpg b/documentation/site/ressources/finished.jpg
diff --git a/documentation/site/ressources/keycap.jpg b/documentation/site/ressources/keycap.jpg
diff --git a/documentation/site/ressources/pouch_attached.jpg b/documentation/site/ressources/pouch_attached.jpg
diff --git a/documentation/site/ressources/scotched_battery.jpg b/documentation/site/ressources/scotched_battery.jpg
diff --git a/documentation/site/ressources/top_installed.jpg b/documentation/site/ressources/top_installed.jpg
diff --git a/documentation/site/source/index.html b/documentation/site/source/index.html
@@ -206,7 +206,7 @@ <h3 id="software"><strong>Software</strong></h3>
 <p>All software is provided under a 3-clause BSD License</p>
 </blockquote>
 <ul>
-<li><a href="https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/mini_control">minicontrol software</a></li>
+<li><a href="https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware/minicontrol">minicontrol software</a></li>
 <li><a href="https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/firmware.hex">Hex firmware</a></li>
 <li><a href="https://github.com/BenjaminPoilve/MiniChord/tree/main/firmware">PlatformIO project</a></li>
 <li><a href="https://forum.pjrc.com/index.php?threads/tutorial-how-to-use-platformio-visual-code-studio-for-teensy.66674/">Tutorial for PlatformIO Teensy usage</a></li>
@@ -229,7 +229,7 @@ <h4 id="2d-files">2D files</h4>
 </ul>
 <h4 id="electronics">Electronics</h4>
 <ul>
-<li><a href="https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/full_BOM.pdf">Full BOM</a></li>
+<li><a href="https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/BOM/full_BOM.pdf">Full BOM</a></li>
 <li><a href="https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/miniChord_main_PCB/MiniChord.pdf">Main PCB schematics</a></li>
 <li><a href="https://github.com/BenjaminPoilve/MiniChord/tree/main/hardware/PCB/miniChord_main_PCB/gerber">Main PCB Gerber file</a></li>
 <li><a href="https://github.com/BenjaminPoilve/MiniChord/blob/main/hardware/PCB/additional%20PCB/touch_zone.pdf">Touch zone PCB schematics</a></li>

diff --git a/firmware/README.md b/firmware/README.md
@@ -12,7 +12,7 @@ In particular the it contains :
 - the `lib` folder containing the librairies for the chips used, the debouncing and the potentiometer logic 
 - the `include` folder containing all the Teensy audio architecture definition, as well as the hardware definitions and the `sysex_handler.h`file. 
 
-This last file is related to the "generator". To be able to simply modify parameters related to sound synthesis and have a coherent firmware and control software, those parameters are defined in a [parameters.json file](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/generator/parameters.json). By using the generation script, both the interface and necessary firmware file are generated. Note that the interface will be included in the minichord website by using the `build_site.sh` script in the documentation folder. 
+The next interesting folder is related to the "generator". To be able to simply modify parameters related to sound synthesis and have a coherent firmware and control software, those parameters are defined in a [parameters.json file](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/generator/parameters.json). By using the generation script, both the interface and necessary firmware file are generated. Note that the interface will be included in the minichord website by using the `build_site.sh` script in the documentation folder. 
 
 The resulting fimware itself is present at the root of the project : [firmware.hex](https://github.com/BenjaminPoilve/MiniChord/blob/main/firmware/firmware.hex).