Skip to content

Commit e55aeee

Browse files
committed
Architecture overview graph
1 parent 6a099c5 commit e55aeee

File tree

6 files changed

+356
-1536
lines changed

6 files changed

+356
-1536
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ jobs:
101101
run: |
102102
.github/helpers/check_urls.sh \
103103
-d ".git build CMakeModules debian" \
104-
-f "package.xml architecture_coarse.svg dataflow.graphml start_ursim.sh" \
104+
-f "package.xml urcl_architecture.svg trajectory_interface.svg dataflow.graphml start_ursim.sh" \
105105
-p "vnc\.html opensource\.org\/licenses\/BSD-3-Clause kernel\.org\/pub\/linux\/kernel"

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

0 commit comments

Comments
 (0)