aloharobotics / seabee3-ros-pkg

Automatically exported from code.google.com/p/seabee3-ros-pkg
0 stars 0 forks source link

make detailed software diagram #27

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Make a fully-detailed software diagram that includes all information about 
seabee's software architecture from the high-level down to the low-level. This 
will be used as a quick visual reference for developers as well as a design 
utility when adding/updating packages. 

Original issue reported on code.google.com by ekaszub...@gmail.com on 26 Jul 2011 at 2:46

GoogleCodeExporter commented 9 years ago
Started work; experimented with Inkscape, Google Drawings, Open Office Draw, 
and Dia. Settled on Dia.

Original comment by ekaszub...@gmail.com on 2 Aug 2011 at 4:05

GoogleCodeExporter commented 9 years ago
Description:

First version of software diagram completed. Dashed connectors are service 
paths (bi-directional). Solid connectors are message paths. Nodes are shown as 
a group of services, input topics, and output topics inside a namespace (dashed 
box around nodes). Input topics are below and to the left of the node name. 
Output topics are below and to the right of the node name. Services are 
centered above the node name.

Still to do:

-Add visualization for launch files
-Add visualization for params/dynamic_reconfigure
-Add visualization for viewable non-text debug content

Please comment/review.

Original comment by ekaszub...@gmail.com on 3 Aug 2011 at 12:34

Attachments:

GoogleCodeExporter commented 9 years ago
Attached dia file.

Original comment by ekaszub...@gmail.com on 3 Aug 2011 at 12:37

Attachments:

GoogleCodeExporter commented 9 years ago
Updated software diagram. Color-coded nodes based on the following 
classifications: drivers, low-level vision, high-level vision, planning, 
controls, data conversion. Added message dependency diagram. Fixed spelling 
errors. Added Temperature message type to seabee3_driver. Added 
tritech_micron_driver with scanline_converter and tritech_micron_node. 
Color-coded connectors based on expected bandwidth; from low to high: green, 
yellow, orange, red.

Original comment by ekaszub...@gmail.com on 5 Aug 2011 at 5:12

Attachments: