Browse Source

handbook: fix encoding and some missing links

pull/8/head
mntmn 1 month ago
parent
commit
4688fe3214
5 changed files with 27 additions and 7 deletions
  1. +4
    -1
      reform2-handbook/build.sh
  2. +6
    -6
      reform2-handbook/system-diagram.dot
  3. BIN
      reform2-handbook/system-diagram.pdf
  4. +15
    -0
      reform2-handbook/system-diagram.svg
  5. +2
    -0
      reform2-handbook/system.html

+ 4
- 1
reform2-handbook/build.sh View File

@@ -3,7 +3,10 @@
function build {
dot -Tsvg system-diagram.dot -o system-diagram.svg
rsvg-convert -f pdf -o system-diagram.pdf system-diagram.svg
kramdown system.md >system.html

echo '<!DOCTYPE html><html lang="en"><meta charset="UTF-8">' >system.html
kramdown system.md >>system.html
echo '</html>' >>system.html
sed -i 's/width="[^"]*"/width="100%"/' system-diagram.svg
sed -i 's/height="[^"]*"//' system-diagram.svg


+ 6
- 6
reform2-handbook/system-diagram.dot View File

@@ -121,9 +121,9 @@ digraph G {
cells [label="8x LiFePO4 18650 Batteries" shape=rectangle href="system.html#cells"];
supply [label="24V Power Supply\nfrom Barrel Jack" shape=rectangle href="system.html#barreljack"];
enabchg [label="Charge On" shape=diamond style=filled color=lightgrey];
enab5v [label="On" shape=diamond style=filled color=lightgrey];
enab3v3 [label="On" shape=diamond style=filled color=lightgrey];
enabchg [label="Charge On" shape=diamond style=filled color=lightgrey href="system.html#lpc"];
enab5v [label="On" shape=diamond style=filled color=lightgrey href="system.html#lpc"];
enab3v3 [label="On" shape=diamond style=filled color=lightgrey href="system.html#lpc"];
}

subgraph cluster_power_rails {
@@ -200,7 +200,7 @@ digraph G {
tsens [label="Motion Sensor" href="system.html#tbsensor"];
ti2c [label="I2C" shape=diamond style=filled color=lightgrey href="system.html#i2c"];
tgpio [label="GPIO" shape=diamond style=filled color=lightgrey];
tgpio [label="GPIO" shape=diamond style=filled color=lightgrey href="system.html#tbctrl"];
tkeys [label="5 Buttons" href="system.html#kbkeys"];
}
@@ -217,8 +217,8 @@ digraph G {
oled [label="OLED Display 128x32" href="system.html#oled"];
ki2c [label="I2C" shape=diamond style=filled color=lightgrey href="system.html#i2c"];
kuart [label="UART" shape=diamond style=filled color=lightgrey href="system.html#kbctrl"];
kgpio [label="GPIO" shape=diamond style=filled color=lightgrey];
kuart [label="UART" shape=diamond style=filled color=lightgrey href="system.html#kbctrl"];
kgpio [label="GPIO" shape=diamond style=filled color=lightgrey href="system.html#kbctrl"];
kkeys [label="Key Matrix" href="system.html#kbkeys"];
}
}


BIN
reform2-handbook/system-diagram.pdf View File


+ 15
- 0
reform2-handbook/system-diagram.svg View File

@@ -688,8 +688,11 @@
<!-- enabchg -->
<g id="node44" class="node">
<title>enabchg</title>
<g id="a_node44"><a xlink:href="system.html#lpc" xlink:title="Charge On" target="_top">
<polygon fill="lightgrey" stroke="lightgrey" points="1545.5,-722 1464.73,-704 1545.5,-686 1626.27,-704 1545.5,-722"/>
<text text-anchor="middle" x="1545.5" y="-700.3" font-family="Inter,Roboto,Helvetica,Helvetica Neue,Open Sans,Arial,sans-serif" font-size="14.00">Charge On</text>
</a>
</g>
</g>
<!-- lpc&#45;&gt;enabchg -->
<g id="edge5" class="edge">
@@ -700,8 +703,11 @@
<!-- enab5v -->
<g id="node45" class="node">
<title>enab5v</title>
<g id="a_node45"><a xlink:href="system.html#lpc" xlink:title="On" target="_top">
<polygon fill="lightgrey" stroke="lightgrey" points="1865.5,-445 1829.5,-427 1865.5,-409 1901.5,-427 1865.5,-445"/>
<text text-anchor="middle" x="1865.5" y="-423.3" font-family="Inter,Roboto,Helvetica,Helvetica Neue,Open Sans,Arial,sans-serif" font-size="14.00">On</text>
</a>
</g>
</g>
<!-- lpc&#45;&gt;enab5v -->
<g id="edge11" class="edge">
@@ -712,8 +718,11 @@
<!-- enab3v3 -->
<g id="node46" class="node">
<title>enab3v3</title>
<g id="a_node46"><a xlink:href="system.html#lpc" xlink:title="On" target="_top">
<polygon fill="lightgrey" stroke="lightgrey" points="1955.5,-445 1919.5,-427 1955.5,-409 1991.5,-427 1955.5,-445"/>
<text text-anchor="middle" x="1955.5" y="-423.3" font-family="Inter,Roboto,Helvetica,Helvetica Neue,Open Sans,Arial,sans-serif" font-size="14.00">On</text>
</a>
</g>
</g>
<!-- lpc&#45;&gt;enab3v3 -->
<g id="edge13" class="edge">
@@ -989,8 +998,11 @@
<!-- tgpio -->
<g id="node69" class="node">
<title>tgpio</title>
<g id="a_node69"><a xlink:href="system.html#tbctrl" xlink:title="GPIO" target="_top">
<polygon fill="lightgrey" stroke="lightgrey" points="883.5,-722 837.58,-704 883.5,-686 929.42,-704 883.5,-722"/>
<text text-anchor="middle" x="883.5" y="-700.3" font-family="Inter,Roboto,Helvetica,Helvetica Neue,Open Sans,Arial,sans-serif" font-size="14.00">GPIO</text>
</a>
</g>
</g>
<!-- tmcu&#45;&gt;tgpio -->
<g id="edge49" class="edge">
@@ -1056,8 +1068,11 @@
<!-- kgpio -->
<g id="node75" class="node">
<title>kgpio</title>
<g id="a_node75"><a xlink:href="system.html#kbctrl" xlink:title="GPIO" target="_top">
<polygon fill="lightgrey" stroke="lightgrey" points="1143.5,-722 1097.58,-704 1143.5,-686 1189.42,-704 1143.5,-722"/>
<text text-anchor="middle" x="1143.5" y="-700.3" font-family="Inter,Roboto,Helvetica,Helvetica Neue,Open Sans,Arial,sans-serif" font-size="14.00">GPIO</text>
</a>
</g>
</g>
<!-- kmcu&#45;&gt;kgpio -->
<g id="edge53" class="edge">


+ 2
- 0
reform2-handbook/system.html View File

@@ -1,3 +1,4 @@
<!DOCTYPE html><html lang="en"><meta charset="UTF-8">
<h1 id="mnt-reform-20d-4-electronic-system-components">MNT Reform 2.0D-4 Electronic System Components</h1>

<iframe src="system-diagram.svg" width="75%" height="100%"></iframe>
@@ -469,3 +470,4 @@ iframe {
<li><a href="https://enerprof.de/akkus/akkus-lifepo4/akkuzellen-lifepo4/akkuzellen-lifepo4-18650/32/enerpower-18650-lifepo4-3-2v-1800-mah?c=26">ENERpower</a></li>
<li><a href="https://www.18650batterystore.com/Lithium-Werks-p/lithiumwerks-apr18650m1b.htm">Lithium Werks</a></li>
</ul>
</html>

Loading…
Cancel
Save