Add Flowchart to explain Omnibus system overall

[zangjiucheng]

As TITLE

---

This change is 

Summary by CodeRabbit

• Documentation
  • Added a visual diagram to the introduction to help illustrate the Omnibus system.
  • Included a note with a link to detailed Omnibus documentation below the diagram.

[coderabbitai]

Walkthrough

An image reference to omnibus-abstract.svg was inserted into the README.md following the introductory paragraph about the Omnibus system. A note linking to detailed Omnibus documentation was added below the image. No other content or code changes were made.

Changes

File(s)	Change Summary
README.md	Added image reference and a documentation link note after intro paragraph

Poem

A picture now graces the README’s face,
Omnibus shown in a visual embrace.
Buses and data, all neatly aligned,
In SVG strokes, their purpose defined.
With diagrams clear, our docs now delight—
A hop and a skip, the future looks bright!
🐰🖼️

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca22034 and 2654ab4.

📒 Files selected for processing (1)

• README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 842df98 and c261f0c.

⛔ Files ignored due to path filters (1)

• omnibus-abstract.svg is excluded by !**/*.svg

📒 Files selected for processing (1)

• README.md (1 hunks)

[Joe-Joe-Joe-Joe]

These are my thoughts as someone who uses omnibus but does not actively develop it. Make of them what you will

• Don't call it the DAQ server if the server can be run from any node
• Don't understand the path from TIMESTAMP.log to Other Sources?
• Why do Sources run through Parsley? Parsley is itself a source?
  • structure should be smth like Rocket bus->DAQ CAN support/logger board->Parsley->Sources
• "RTOS" is misleading, most of omnibus runs on a regular Windows machine afaik
• RLCS is missing entirely even though it is one the most important sources
• How many sinks are there? I feel like you could just list every sink. Same with sources
• Does it use ZMQ between the sources and server as well? I assume so?

[Joe-Joe-Joe-Joe]

Eventually, it would be nice to have lower level diagrams of the key components like parsley. I realize this may not make sense if you are planning a large rewrite in a couple months, but as you do the rewrite, it would be good to think about.

[zangjiucheng]

Thanks @Joe-Joe-Joe-Joe for pointing out the confusing part. I crafted this based on my experience, so it doesn't have an overall structure. All you mention is useful, I will fix that asap.

Here is the link to the file: https://drive.google.com/file/d/1xVqHo8uYOuc05B5DGjRMrLu2a0MYKW2g/view?usp=drive_link

[zangjiucheng]

Parsley won't be rewritten as far as I know, but yes, parsley is a blank page for knowledge transfer. That's the only part not on the docs, also don't have a detailed document at this moment.

I will consider making a low-level diagram on that, but to be honest, parsley, I believe, is the simplest module in the omnibus system.

[zangjiucheng]

Don't call it the DAQ server if the server can be run from any node

Fixed to "Omnibus Server", yes, it can start from anywhere.

Don't understand the path from TIMESTAMP.log to Other Sources?

Fixed, it will go to the replay_log used to replay the message on ZMQ.

Why do Sources run through Parsley? Parsley is itself a source?
structure should be smth like Rocket bus->DAQ CAN support/logger board->Parsley->Sources

Yes, that sounds clearer.

"RTOS" is misleading, most of omnibus runs on a regular Windows machine afaik

Fixed to "Data Stream"

RLCS is missing entirely even though it is one the most important sources

I will try to draft something here, but maybe I need help from @Joe-Joe-Joe-Joe and @JasonBrave to check on this. I don't have any experience with RLCS system, sorry :(

How many sinks are there? I feel like you could just list every sink. Same with sources

There are a total of 6, but gpsd is deprecated instead to use interamap, I have add the other two.
In the diagram, I really cannot show how each command works. I added a note on each of them, and based on that, for end-user will know which tool they need and look up the docs for more details.

Does it use ZMQ between the sources and server as well? I assume so?

No, here is directly connected, so no ZMQ come in here.

I will post a fixed diagram here to give more information. Also, I will add the docs link to the README. I think that will be useful.

[zangjiucheng]