generate separate front and back layouts for 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 pipx libfuse2 libegl1
+          sudo apt install -y --install-recommends kicad pipx libfuse2 libegl1 poppler-utils
 
       - name: Install latest mdbook
         run: |

docs/generate_docs.sh

@@ -36,9 +36,9 @@ cp -r ../hardware/plot src
 echo "Generating plot includes"
 rm -rf src/inc_dispensy_sch.md
 echo "<script src=\"js/svg-pan-zoom.js\" charset=\"UTF-8\"></script>" >> src/inc_dispensy_sch.md
-for f in `ls src/plot/dispensy_sch.svg/*.svg | sort -r`; do
+for f in `ls src/plot/dispensy.kicad_sch.svg/*.svg | sort -r`; do
     file=`echo $f | sed 's:src/:./:g'`
-    name=`echo $f | sed 's:src/plot/dispensy_sch.svg/::g' | sed 's:.svg::g'`
+    name=`echo $f | sed 's:src/plot/dispensy.kicad_sch.svg/::g' | sed 's:.svg::g'`
     echo $name
     echo "<h2>$name</h2>" >> src/inc_dispensy_sch.md
     echo "<div style=\"background-color: white; border: 1px solid black;\">" >> src/inc_dispensy_sch.md

docs/src/main_board_pcb.md

@@ -2,21 +2,51 @@
 
 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).
+You can also view the [Main-Board PCB layout as PDF](./plot/dispensy.kicad_pcb.pdf).
 
 ## 2D PCB Layout
 
+### Front & Back
+
+<script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
+<div style="background-color: white; border: 1px solid black;">
+    <embed type="image/svg+xml" src="./plot/dispensy.kicad_pcb.svg/0_both.svg" id="pz_dispensy0" style="width: 100%;"/>
+    <script>
+        document.getElementById('pz_dispensy0').addEventListener('load', function(){
+            svgPanZoom(document.getElementById('pz_dispensy0'), {controlIconsEnabled: true, minZoom: 1.0});
+        })
+    </script>
+</div>
+
+[Direct link to this file](./plot/dispensy.kicad_pcb.svg/0_both.svg).
+
+### Front
+
+<script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
+<div style="background-color: white; border: 1px solid black;">
+    <embed type="image/svg+xml" src="./plot/dispensy.kicad_pcb.svg/1_front.svg" id="pz_dispensy1" style="width: 100%;"/>
+    <script>
+        document.getElementById('pz_dispensy1').addEventListener('load', function(){
+            svgPanZoom(document.getElementById('pz_dispensy1'), {controlIconsEnabled: true, minZoom: 1.0});
+        })
+    </script>
+</div>
+
+[Direct link to this file](./plot/dispensy.kicad_pcb.svg/1_front.svg).
+
+### Back
+
 <script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
 <div style="background-color: white; border: 1px solid black;">
-    <embed type="image/svg+xml" src="./plot/dispensy_pcb.svg" id="pz_dispensy" style="width: 100%;"/>
+    <embed type="image/svg+xml" src="./plot/dispensy.kicad_pcb.svg/2_back.svg" id="pz_dispensy2" style="width: 100%;"/>
     <script>
-        document.getElementById('pz_dispensy').addEventListener('load', function(){
-            svgPanZoom(document.getElementById('pz_dispensy'), {controlIconsEnabled: true, minZoom: 1.0});
+        document.getElementById('pz_dispensy2').addEventListener('load', function(){
+            svgPanZoom(document.getElementById('pz_dispensy2'), {controlIconsEnabled: true, minZoom: 1.0});
         })
     </script>
 </div>
 
-[Direct link to this file](./plot/dispensy_pcb.svg).
+[Direct link to this file](./plot/dispensy.kicad_pcb.svg/2_back.svg).
 
 ## 3D PCB Model
 
@@ -28,7 +58,7 @@ You can also view the [Main-Board PCB layout as PDF](./plot/dispensy_pcb.pdf).
     var info = document.getElementById('3d_info');
     import * as View from './js/modelview.js';
     View.init(view, info);
-    const file = './plot/dispensy_pcb.3mf';
+    const file = './plot/dispensy.3mf';
     var xhttp = new XMLHttpRequest();
     xhttp.responseType = 'arraybuffer';
     xhttp.onload = function() {
@@ -51,4 +81,4 @@ You can also view the [Main-Board PCB layout as PDF](./plot/dispensy_pcb.pdf).
     xhttp.send();
 </script>
 
-[Direct link to this file](./plot/dispensy_pcb.3mf).
+[Direct link to this file](./plot/dispensy.3mf).

docs/src/main_board_sch.md

@@ -2,6 +2,6 @@
 
 This page shows the current version of the schematics as SVG graphics.
 
-You can also view the [Main-Board schematics as PDF](./plot/dispensy_sch.pdf).
+You can also view the [Main-Board schematics as PDF](./plot/dispensy.kicad_sch.pdf).
 
 {{#include inc_dispensy_sch.md}}

hardware/generate_plot.sh

@@ -26,42 +26,93 @@
 # | source.                                                                      |
 #  ------------------------------------------------------------------------------
 
-cd "$(dirname "$0")"
-
+INSCH="dispensy.kicad_sch"
+INPCB="dispensy.kicad_pcb"
 OUTDIR="plot"
-LAYER="F.Cu,B.Cu,F.Mask,B.Mask,F.Paste,B.Paste,F.Silkscreen,B.Silkscreen,Edge.Cuts,User.Drawings"
+LAYER_F="F.Cu,F.Mask,F.Paste,F.Silkscreen,Edge.Cuts,User.Drawings"
+LAYER_B="B.Cu,B.Mask,B.Paste,B.Silkscreen,Edge.Cuts,User.Drawings"
 
+cd "$(dirname "$0")"
 rm -rf $OUTDIR
 mkdir -p $OUTDIR
 
-for VAR in pdf svg
+#  --------------
+# | 2D Schematic |
+#  --------------
+
+for IN in $INSCH
 do
-    echo "Exporting schematic $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 $OUTDIR/dispensy_pcb.$VAR
-    kicad-cli pcb export $VAR \
-        -t "KiCad Classic"  \
-        -l $LAYER \
-        -o $OUTDIR/dispensy_pcb.$VAR \
-        dispensy.kicad_pcb
-    echo
+    echo "Exporting schematic $IN"
+
+    for TYPE in pdf svg
+    do
+        echo "Exporting schematic $TYPE"
+        rm -rf $OUTDIR/$IN.$TYPE
+        kicad-cli sch export $TYPE \
+            -t "KiCad Default" \
+            -o $OUTDIR/$IN.$TYPE \
+            $IN
+        echo
+    done
 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
+for IN in $INPCB
+do
+    echo "Exporting board $IN"
+
+    #  -----------
+    # | 2D Layout |
+    #  -----------
+
+    for TYPE in pdf svg
+    do
+        rm -rf $OUTDIR/$IN.$TYPE
+        mkdir -p $OUTDIR/$IN.$TYPE
 
-echo "Converting step to 3mf"
-rm -rf $OUTDIR/dispensy_pcb.3mf
-prusa-slicer --export-3mf $OUTDIR/dispensy_pcb.step
+        echo "Exporting board $TYPE"
+        kicad-cli pcb export $TYPE \
+            -t "KiCad Classic"  \
+            -l $LAYER_F,$LAYER_B \
+            -o $OUTDIR/$IN.$TYPE/0_both.$TYPE \
+            $IN
+        echo
 
-echo "Deleting step file"
-rm -rf $OUTDIR/dispensy_pcb.step
+        echo "Exporting board front $TYPE"
+        kicad-cli pcb export $TYPE \
+            -t "KiCad Classic"  \
+            -l $LAYER_F \
+            -o $OUTDIR/$IN.$TYPE/1_front.$TYPE \
+            $IN
+        echo
+
+        echo "Exporting board back $TYPE"
+        kicad-cli pcb export $TYPE \
+            -t "KiCad Classic"  \
+            -l $LAYER_B \
+            -o $OUTDIR/$IN.$TYPE/2_back.$TYPE \
+            $IN
+        echo
+    done
+
+    echo "Concatenating board PDFs"
+    mv $OUTDIR/$IN.pdf $OUTDIR/$IN.tmp
+    pdfunite $OUTDIR/$IN.tmp/*.pdf $OUTDIR/$IN.pdf
+    rm -rf $OUTDIR/$IN.tmp
+
+    #  -----------
+    # | 3D Export |
+    #  -----------
+
+    echo "Exporting board step file"
+    rm -rf $OUTDIR/$IN.step
+    kicad-cli pcb export step \
+        -o $OUTDIR/$IN.step \
+        $IN
+
+    echo "Converting step to 3mf"
+    rm -rf $OUTDIR/$IN.3mf
+    prusa-slicer --export-3mf $OUTDIR/$IN.step
+
+    echo "Deleting step file"
+    rm -rf $OUTDIR/$IN.step
+done