generate pcb 3d files and visualize in docs

.github/workflows/docs.yml

@@ -54,7 +54,7 @@ jobs:
         run: |
           sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases
           sudo apt update
-          sudo apt install -y --install-recommends kicad
+          sudo apt install -y --install-recommends kicad prusa-slicer
 
       - name: Install latest mdbook
         run: |

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "docs/svg-pan-zoom"]
 	path = docs/svg-pan-zoom
 	url = https://github.com/bumbu/svg-pan-zoom
+[submodule "docs/modelview"]
+	path = docs/modelview
+	url = https://github.com/jschobben/modelview

README.md

@@ -13,6 +13,7 @@ This project is licensed under the [CERN Open Hardware Licence Version 2 - Stron
 
 The docs are built using [mdbook](https://github.com/rust-lang/mdBook), licensed as `MPL-2.0`.
 The PCB SVG files in the documentation are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as `BSD-2-Clause`.
+The 3D PCB files in the documentation are displayed using [modelview](https://github.com/jschobben/modelview), licensed as `MIT`.
 
 Please also take a look at the `README.md` files in the subfolders of this project for more info.
 

docs/.gitignore

@@ -1,3 +1,4 @@
 book
 src/plot
 src/inc_*.md
+src/js/deps

docs/README.md

@@ -6,6 +6,7 @@ This file is intended for contributors that want to modify this website!
 ## Dependencies
 
 The PCB SVG files are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as `BSD-2-Clause`.
+The 3D PCB files are displayed using [modelview](https://github.com/jschobben/modelview), licensed as `MIT`.
 Fetch the included git submodules after cloning this repository before working on the docs.
 
     git submodule update --init

docs/generate_docs.sh

@@ -52,6 +52,14 @@ for f in `ls src/plot/dispensy_sch.svg/*.svg | sort -r`; do
     echo >> src/inc_dispensy_sch.md
 done
 
+echo "Preparing modelview dependencies"
+cd modelview
+sed -i 's/info\.inner/info_elem\.inner/g' modelview.js
+./fetch_deps.sh
+cd ..
+rm -rf src/js/deps
+cp -r modelview/deps src/js
+
 echo "Generating docs"
 if [ "$1" = "serve" ] ; then
     mdbook serve --open

docs/modelview

@@ -0,0 +1 @@
+Subproject commit d3f2ffd2cd04e263b4db3910023b6c028bd0eb64

docs/src/js/modelview.js

@@ -0,0 +1 @@
+../../modelview/modelview.js

docs/src/main_board_pcb.md

@@ -4,12 +4,47 @@ This page shows the current version of the PCB layout as SVG graphics.
 
 You can also view the [Main-Board PCB layout as PDF](./plot/dispensy_pcb.pdf).
 
+## 2D PCB Layout
+
 <script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
 <div style="background-color: white;">
-    <embed type="image/svg+xml" src="./plot/dispensy_pcb.svg" id="pz_dispensy" style="width:100%;"/>
+    <embed type="image/svg+xml" src="./plot/dispensy_pcb.svg" id="pz_dispensy" style="width: 100%;"/>
     <script>
         document.getElementById('pz_dispensy').addEventListener('load', function(){
             svgPanZoom(document.getElementById('pz_dispensy'), {controlIconsEnabled: true});
         })
     </script>
 </div>
+
+## 3D PCB Model
+
+<p>Status: "<span id="3d_info">Preparing 3D model...</span>"</p>
+<div id="3d_viewer" style="width: 100%; height: 100%;" />
+<script type="module">
+    var view = document.getElementById('3d_viewer');
+    view.style.height = (view.clientWidth / 2) + "px";
+    var info = document.getElementById('3d_info');
+    import * as View from './js/modelview.js';
+    View.init(view, info);
+    const file = './plot/dispensy_pcb.3mf';
+    var xhttp = new XMLHttpRequest();
+    xhttp.responseType = 'arraybuffer';
+    xhttp.onload = function() {
+        if (this.status != 200) {
+            info.textContent = "Download of " + file + " failed: " + this.status + " " + this.statusText;
+            return;
+        }
+        info.textContent = "Downloaded: " + file;
+        var file_parts = file.split(".");
+        var ext = file_parts.pop().toLowerCase();
+        if (ext == "zip") {
+            ext = file_parts.pop().toLowerCase();
+        }
+        info.textContent = "Loaded file with extension: " + ext;
+        var model_data = this.response;
+        View.view(ext, model_data);
+    };
+    info.textContent = "Fetching: " + file;
+    xhttp.open("GET", file);
+    xhttp.send();
+</script>

hardware/generate_plot.sh

@@ -37,14 +37,14 @@ mkdir -p $OUTDIR
 for VAR in pdf svg
 do
     echo "Exporting schematic $VAR"
-    rm -rf dispensy_sch.$VAR
+    rm -rf $OUTDIR/dispensy_sch.$VAR
     kicad-cli sch export $VAR \
         -t "KiCad Default" \
         -o $OUTDIR/dispensy_sch.$VAR \
         dispensy.kicad_sch
 
     echo "Exporting board $VAR"
-    rm -rf dispensy_pcb.$VAR
+    rm -rf $OUTDIR/dispensy_pcb.$VAR
     kicad-cli pcb export $VAR \
         -t "KiCad Classic"  \
         -l $LAYER \
@@ -52,3 +52,16 @@ do
         dispensy.kicad_pcb
     echo
 done
+
+echo "Exporting board step file"
+rm -rf $OUTDIR/dispensy_pcb.step
+kicad-cli pcb export step \
+    -o $OUTDIR/dispensy_pcb.step \
+    dispensy.kicad_pcb
+
+echo "Converting step to 3mf"
+rm -rf $OUTDIR/dispensy_pcb.3mf
+prusa-slicer --export-3mf $OUTDIR/dispensy_pcb.step
+
+echo "Deleting step file"
+rm -rf $OUTDIR/dispensy_pcb.step