Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added architecture diagram #594

Merged
merged 6 commits into from
Oct 13, 2023
Merged

added architecture diagram #594

merged 6 commits into from
Oct 13, 2023

Conversation

victorjarlow
Copy link
Collaborator

Draft at a architecture diagram for use when communicating features and functions in the ATOS ecosystem

@victorjarlow
Copy link
Collaborator Author

@RI-SE/night-team please provide some feedback on the figure. Is it clear enough? is it well structured? Is info missing? What improvements are needed?

@samuelthoren
Copy link
Contributor

Looks good! I just have some minor questions or clarifications.

  • Should there be more text in the EsminiAdapter box? It looks like the text suddenly ends.
  • I might be mistaken here, but do the external systems use JournalControl?
  • PointcloudPublisher publishes once on init, not periodically.
  • Maybe you can specify what type of data is sent using the MQTT-bridge
  • Specify what resetting test actors means in BackToStart.
  • The isoObject-box is quite empty, maybe we can write some things there?
  • The letter D in the legend, specify what type of dynamic input.

Otherwise it looks really good, nice overview of ATOS!

@victorjarlow
Copy link
Collaborator Author

victorjarlow commented Oct 3, 2023

Looks good! I just have some minor questions or clarifications.

  • Should there be more text in the EsminiAdapter box? It looks like the text suddenly ends.

Added!

  • I might be mistaken here, but do the external systems use JournalControl?

In my mind, the filesystem is an external system that gets test reports provided to it. I didn't want to explicitly list all data-sinks, but instead keep it "high-level"

  • PointcloudPublisher publishes once on init, not periodically.

Thanks for the clarification!

  • Maybe you can specify what type of data is sent using the MQTT-bridge

To avoid having to change this diagram constantly, I think it's better to keep it high-level.

  • Specify what resetting test actors means in BackToStart.

Done

  • The isoObject-box is quite empty, maybe we can write some things there?

Added some text

  • The letter D in the legend, specify what type of dynamic input.

I'm not sure how I could describe the dynamic data in such a way that it fits all three modules (esminiAdapter - triggers and actions, DirectControl - steering signals, TrajectoryletStreamer - trajectory chunks).
I don't want to introduce too much detail in this diagram such that we have to modify it constantly. Also, I think that a user could go to our docs page for a specific module if they want to know in more detail.

@Robert108
Copy link
Collaborator

Nice to have a diagram like this! I would put the image in the res folder in the docs folder and link it from there.
I think it could be nice to write just a few words also on how you should go about updating this diagram if you need to.

docs/ATOS_architecture Outdated Show resolved Hide resolved
@samuelthoren
Copy link
Contributor

Can I merge this @victorjarlow?

@victorjarlow
Copy link
Collaborator Author

Can I merge this @victorjarlow?

I've not moved the document as Robert suggested yet..

@victorjarlow victorjarlow merged commit 3c7eec0 into dev Oct 13, 2023
@victorjarlow victorjarlow deleted the feature_architectureDiagram branch October 13, 2023 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants