Skip to content

Commit c7ed481

Browse files
committed
WIP: Architecture overview graph
1 parent 3e7a2b0 commit c7ed481

File tree

3 files changed

+54
-11
lines changed

3 files changed

+54
-11
lines changed

doc/architecture.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
Library architecture
22
====================
33

4-
The image below shows a rough architecture overview that should help developers to use the different
5-
modules present in this library. Note that this is an incomplete view on the classes involved.
6-
7-
.. image:: images/dataflow.svg
8-
:width: 100%
9-
:alt: Data flow
10-
11-
12-
The core of this library is the ``UrDriver`` class which creates a
13-
fully functioning robot interface. For details on how to use it, please see the
14-
:ref:`example-driver` section.
4+
This library implements the bare communication protocols used to communicate with the robot, as
5+
well as a couple of standalone modules to directly use subsets of the library's functionality:
156

167
.. toctree::
178
:maxdepth: 1
@@ -23,3 +14,14 @@ fully functioning robot interface. For details on how to use it, please see the
2314
architecture/script_sender
2415
architecture/trajectory_point_interface
2516
architecture/ur_driver
17+
18+
19+
Dataflow overview with UrDriver
20+
-------------------------------
21+
22+
The image below shows a rough architecture overview that should help developers to use the different
23+
modules present in this library. Note that this is an incomplete view on the classes involved.
24+
25+
.. image:: images/urcl_architecture.svg
26+
:width: 100%
27+
:alt: architecture overview

doc/images/urcl_architecture.drawio

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<mxfile host="localhost" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36" version="24.7.17">
2+
<diagram name="Page-1" id="f_7MsYzxkcWwScyV1uhC">
3+
<mxGraphModel dx="2074" dy="1146" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
4+
<root>
5+
<mxCell id="0" />
6+
<mxCell id="1" parent="0" />
7+
<mxCell id="qigunUAiiPU7ou8LCX0M-1" value="UrDriver" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="1">
8+
<mxGeometry x="290" y="170" width="980" height="400" as="geometry" />
9+
</mxCell>
10+
<mxCell id="qigunUAiiPU7ou8LCX0M-2" value="ReverseInterface" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-1">
11+
<mxGeometry x="20" y="310" width="140" height="70" as="geometry" />
12+
</mxCell>
13+
<mxCell id="qigunUAiiPU7ou8LCX0M-3" value="Socket: 50001" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-2">
14+
<mxGeometry x="10" y="30" width="120" height="30" as="geometry" />
15+
</mxCell>
16+
<mxCell id="qigunUAiiPU7ou8LCX0M-5" value="ScriptSender" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-1">
17+
<mxGeometry x="170" y="310" width="140" height="70" as="geometry" />
18+
</mxCell>
19+
<mxCell id="qigunUAiiPU7ou8LCX0M-6" value="Socket: 50002" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-5">
20+
<mxGeometry x="10" y="30" width="120" height="30" as="geometry" />
21+
</mxCell>
22+
<mxCell id="qigunUAiiPU7ou8LCX0M-7" value="TrajectoryPointInterface" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-1">
23+
<mxGeometry x="320" y="310" width="160" height="70" as="geometry" />
24+
</mxCell>
25+
<mxCell id="qigunUAiiPU7ou8LCX0M-8" value="Socket: 50003" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-7">
26+
<mxGeometry x="20" y="30" width="120" height="30" as="geometry" />
27+
</mxCell>
28+
<mxCell id="qigunUAiiPU7ou8LCX0M-9" value="ScriptCommandInterface" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-1">
29+
<mxGeometry x="490" y="310" width="160" height="70" as="geometry" />
30+
</mxCell>
31+
<mxCell id="qigunUAiiPU7ou8LCX0M-10" value="Socket: 50004" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="qigunUAiiPU7ou8LCX0M-9">
32+
<mxGeometry x="20" y="30" width="120" height="30" as="geometry" />
33+
</mxCell>
34+
</root>
35+
</mxGraphModel>
36+
</diagram>
37+
</mxfile>

doc/images/urcl_architecture.svg

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)