Add UML Diagram for External Intfs

UBCSailbot / custom_interfaces

UBC Sailbot's custom interfaces ROS package

MIT License

0 stars 0 forks source link

Add UML Diagram for External Intfs #29

Closed hhenry01 closed 11 months ago

hhenry01 commented 11 months ago

Description

Resolves #22
Blocked by https://github.com/UBCSailbot/sailbot_workspace/pull/212 and #28
Also removed Local Transceiver as one of the subscribers for filtered_wind_sensors because I think it's an unnecessary extra amount of data we'd need to transmit over satellite (more $$$)
I think uploading the rendered diagram to github and rendering it in the README is helpful.

Verification

Renders as:

Resources

https://plantuml.com/state-diagram

hhenry01 commented 11 months ago

There's currently some confusion over the status of the global_path topic using a msg or a service, so I'm waiting on that to resolve before continuing.

hhenry01 commented 11 months ago

I'm guessing the other interface tables are simple enough to understand without a diagram. Alternatively we could make one of the members do the other diagrams.

hhenry01 commented 11 months ago

It does not render on the docs site.