Create a diagram for documentation of the approach

osrf / ros2_serial_example

70 stars 15 forks source link

Create a diagram for documentation of the approach #4

Open tfoote opened 5 years ago

tfoote commented 5 years ago

A diagram would be helpful for sharing the approach.

Probably a simple block diagram in svg or dot would be helpful to explain how things are working.

clalancette commented 5 years ago

Good point. I'll need to write some documentation and adding a diagram would help. Definitely on my radar once I get the next set of changes in.

tfoote commented 5 years ago

If you get to it first that would be great.

clalancette commented 5 years ago

I've done a much more detailed round of documentation in https://github.com/osrf/ros2_serial_example/pull/64 . But I haven't made a diagram, so I'll leave this open for now and either you can tackle it or I can.

What exactly were you thinking of diagramming?

tfoote commented 5 years ago

My though was a block diagram showing devices, serial link, and referencing the type of thing running on each side, aka agent and deidcated intreface etc. With ROS2 on the other side of the agent.