Skip to content

Commit

Permalink
Update diagram and put architecture doc in a folder
Browse files Browse the repository at this point in the history
  • Loading branch information
BlakeFreer committed Nov 20, 2024
1 parent c3fdae1 commit ffc79ae
Show file tree
Hide file tree
Showing 6 changed files with 150 additions and 100 deletions.
93 changes: 0 additions & 93 deletions docs/docs/assets/architecture-chart.svg

This file was deleted.

70 changes: 70 additions & 0 deletions docs/docs/firmware/architecture/.$arch_diagram.drawio.bkp
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<mxfile host="Electron" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.7.8 Chrome/128.0.6613.36 Electron/32.0.1 Safari/537.36" version="24.7.8">
<diagram name="Page-1" id="AVefi_4B2r27eV40Z59U">
<mxGraphModel dx="819" dy="482" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="lLjQft1QgtvO7yPWeCVP-5" value="Project&lt;div&gt;Specific&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="140" y="205" width="90" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-6" value="Project&lt;br&gt;Independent" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="140" y="325" width="90" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-7" value="Platform Specific" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="520" y="130" width="120" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-8" value="Platform Independent" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="280" y="130" width="120" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-13" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#dae8fc;opacity=60;" vertex="1" parent="1">
<mxGeometry x="460" y="160" width="240" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-14" value="Bindings" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" vertex="1" parent="1">
<mxGeometry x="460" y="160" width="240" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-15" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Path:&lt;br&gt;&lt;br&gt;projects/Demo/Blink/platforms/stm32f767/bindings.cc&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="460" y="200" width="240" height="80" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-17" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#f8cecc;opacity=60;" vertex="1" parent="1">
<mxGeometry x="460" y="280" width="240" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-18" value="MCALs&lt;br&gt;&lt;font style=&quot;font-size: 12px;&quot;&gt;(Microcontoller Abstraction Layers)&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" vertex="1" parent="1">
<mxGeometry x="460" y="280" width="240" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-19" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Path:&lt;br&gt;&lt;br&gt;mcal/stm32f767/periph/adc.h&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="460" y="330" width="240" height="70" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-1" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#d5e8d4;opacity=60;" vertex="1" parent="1">
<mxGeometry x="220" y="160" width="240" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-9" value="Application Code" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" vertex="1" parent="1">
<mxGeometry x="220" y="160" width="240" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-10" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;projects/Demo/Blink/main.cc&lt;br style=&quot;font-size: 10px;&quot;&gt;projects/Demo/Blink/bindings.h&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;labelBackgroundColor=none;textShadow=0;labelBorderColor=none;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="220" y="200" width="240" height="80" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-21" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#fff2cc;opacity=60;" vertex="1" parent="1">
<mxGeometry x="220" y="280" width="240" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-22" value="Peripheral Interfaces&lt;div style=&quot;font-size: 14px;&quot;&gt;&amp;amp; Shared Code&amp;nbsp;&lt;br style=&quot;font-size: 14px;&quot;&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" vertex="1" parent="1">
<mxGeometry x="240" y="280" width="200" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-23" value="&lt;span style=&quot;font-weight: 400; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;shared/periph/adc.h&lt;/span&gt;&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;&lt;br style=&quot;font-size: 10px;&quot;&gt;shared/util/mappers/lookup_table.h&lt;br style=&quot;font-size: 10px;&quot;&gt;&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="240" y="330" width="200" height="70" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-26" value="" style="endArrow=block;html=1;rounded=0;startArrow=block;startFill=1;endFill=1;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="160" y="280" as="sourcePoint" />
<mxPoint x="720" y="280" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-27" value="" style="endArrow=block;html=1;rounded=0;startArrow=block;startFill=1;endFill=1;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="460" y="420" as="sourcePoint" />
<mxPoint x="460" y="130" as="targetPoint" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
70 changes: 70 additions & 0 deletions docs/docs/firmware/architecture/arch_diagram.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<mxfile host="Electron" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.7.8 Chrome/128.0.6613.36 Electron/32.0.1 Safari/537.36" version="24.7.8">
<diagram name="Page-1" id="AVefi_4B2r27eV40Z59U">
<mxGraphModel dx="989" dy="582" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="lLjQft1QgtvO7yPWeCVP-5" value="Project&amp;nbsp;&lt;span style=&quot;background-color: initial;&quot;&gt;Specific&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="280" y="130" width="120" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-6" value="Project Independent" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="500" y="130" width="160" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-7" value="Platform&lt;div&gt;Specific&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="140" y="330" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-8" value="Platform&lt;div&gt;Independent&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="135" y="210" width="80" height="30" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-13" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#dae8fc;opacity=60;" parent="1" vertex="1">
<mxGeometry x="210" y="280" width="250" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-14" value="Bindings" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" parent="1" vertex="1">
<mxGeometry x="220" y="280" width="230" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-15" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;&lt;/span&gt;&lt;span style=&quot;font-weight: 400;&quot;&gt;projects/Demo/Blink/platforms/stm32f767/bindings.cc&lt;/span&gt;&lt;div style=&quot;text-align: left;&quot;&gt;&lt;span style=&quot;font-weight: 400;&quot;&gt;projects/Demo/Blink/platforms/raspi/bindings.cc&lt;/span&gt;&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;&lt;br&gt;&lt;/span&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" parent="1" vertex="1">
<mxGeometry x="210" y="330" width="250" height="70" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-17" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#f8cecc;opacity=60;" parent="1" vertex="1">
<mxGeometry x="460" y="280" width="250" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-18" value="MCAL&lt;br&gt;&lt;font style=&quot;font-size: 12px;&quot;&gt;(MicroContoller Abstraction Layer)&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" parent="1" vertex="1">
<mxGeometry x="470" y="280" width="230" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-19" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;mcal/stm32f767/periph/adc.h&lt;br&gt;&lt;div style=&quot;text-align: left;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;mcal/raspi/periph/adc.h&lt;/span&gt;&lt;/div&gt;&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" parent="1" vertex="1">
<mxGeometry x="460" y="330" width="250" height="70" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-1" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#d5e8d4;opacity=60;" parent="1" vertex="1">
<mxGeometry x="210" y="160" width="250" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-9" value="Application Code" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" parent="1" vertex="1">
<mxGeometry x="220" y="160" width="230" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-10" value="&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;&lt;div style=&quot;text-align: left;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;projects/Demo/Blink/main.cc&lt;/span&gt;&lt;/div&gt;projects/Demo/Blink/bindings.h&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;labelBackgroundColor=none;textShadow=0;labelBorderColor=none;fontSize=10;" parent="1" vertex="1">
<mxGeometry x="220" y="210" width="240" height="75" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-21" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=none;fillColor=#fff2cc;opacity=60;" parent="1" vertex="1">
<mxGeometry x="460" y="160" width="250" height="120" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-22" value="Peripheral Interfaces&lt;div style=&quot;font-size: 14px;&quot;&gt;&amp;amp; Shared Code&amp;nbsp;&lt;br style=&quot;font-size: 14px;&quot;&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1;fontSize=14;" parent="1" vertex="1">
<mxGeometry x="470" y="160" width="230" height="40" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-23" value="&lt;span style=&quot;font-weight: 400; font-size: 10px;&quot;&gt;Example Paths:&lt;br&gt;&lt;br&gt;&lt;div style=&quot;text-align: left;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;shared/periph/adc.h&lt;/span&gt;&lt;/div&gt;&lt;/span&gt;&lt;span style=&quot;font-weight: normal; font-size: 10px;&quot;&gt;shared/util/mappers/lookup_table.h&lt;br style=&quot;font-size: 10px;&quot;&gt;&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=top;whiteSpace=wrap;rounded=0;fontStyle=3;fontFamily=Helvetica;fontSize=10;" parent="1" vertex="1">
<mxGeometry x="480" y="210" width="200" height="70" as="geometry" />
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-26" value="" style="endArrow=block;html=1;rounded=0;startArrow=block;startFill=1;endFill=1;" parent="1" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="160" y="280" as="sourcePoint" />
<mxPoint x="720" y="280" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="lLjQft1QgtvO7yPWeCVP-27" value="" style="endArrow=block;html=1;rounded=0;startArrow=block;startFill=1;endFill=1;" parent="1" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="460" y="420" as="sourcePoint" />
<mxPoint x="460" y="130" as="targetPoint" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added docs/docs/firmware/architecture/arch_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ffc79ae

Please sign in to comment.