Skip to content

#122 Add the per-timestep message flow diagrams#125

Open
YuSun-go wants to merge 2 commits intomainfrom
docs/#122
Open

#122 Add the per-timestep message flow diagrams#125
YuSun-go wants to merge 2 commits intomainfrom
docs/#122

Conversation

@YuSun-go
Copy link

@YuSun-go YuSun-go commented Mar 5, 2026

Summary

Add documentation describing the traffic–vehicle co-simulation message flow used in the FIXS framework.

This PR introduces a new documentation page that explains the interaction between the following components:

  • SUMO traffic simulation
  • Traffic layer (C++ / FIXS)
  • Python controller
  • Simulink high-fidelity vehicle dynamics model

The document also includes several message flow diagrams that illustrate:

  • The overall co-simulation architecture
  • The current implementation message flow
  • The baseline traffic-only model
  • The final target co-simulation architecture

These diagrams aim to make the system architecture easier to understand for developers and new contributors.


Related Issues / Tasks

PR 3 for #122


Type of Change

  • Bug fix
  • New feature
  • Maintenance / Refactor
  • Documentation
  • Test case / scenario update

Affected Modules / Components

Documentation under:

doc/FIXS_message_flow.md
doc/images/

New diagrams added:

  • FIXS_final_model.png
  • Message_flow_1.png
  • Message_flow_2.png
  • Message_flow_3.png

Test Cases

No runtime tests are required for this PR since it only introduces documentation and architecture diagrams.


Environment

Not applicable (documentation update only).


Checklist

  • Code compiles/runs as expected
  • Tests pass locally
  • Documentation is updated (if applicable)
  • Relevant issues are linked
  • Version-specific changes are noted (if any)

Additional Notes (optional)

The message flow diagrams are intended to clarify the data exchange between traffic simulation and high-fidelity vehicle dynamics in the co-simulation framework.

They also distinguish between:

  • the baseline traffic simulation setup, where vehicle does not obtain a speed command from the controller, and
  • the co-simulation framework, where vehicle commands are processed by a high-fidelity Simulink vehicle model before being fed back to the traffic simulator.

This documentation is meant to support future development and improve onboarding for contributors working on the co-simulation architecture.

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.

1 participant