fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-04-14 10:07:39 +08:00
Code Issues Packages Projects Releases Wiki Activity
PX4-Autopilot/docs/en/middleware/uorb_graph.md
Hamish Willee 88d623bedb
Move PX4 Guide source into /docs (#24490) 
* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2025-03-13 16:08:27 +11:00

1.7 KiB
Raw Blame History

uORB Publication/Subscription Graph

This page provides a uORB publication/subscription graph that shows the communication between modules. It is based on information that is extracted directly from the source code. Usage instructions are provided below.

Graph Properties

The graph has the following properties:

  • Modules are shown in gray with rounded corners while topics are displayed as coloured rectangular boxes.
  • Associated modules and topics are connected by lines. Dashed lines indicate that the module publishes the topic, solid lines indicate that the module subscribes to the topic, while dot-dashed lines indicate that the module both publishes and subscribes to the topic.
  • Some modules and topics are excluded:
    • Topics that are subscribed/published by many modules: parameter_update, mavlink_log and log_message.
    • The set of logged topics.
    • Topics that have no subscriber or no publisher.
    • Modules in src/examples.
  • Hovering over a module/topic highlights all its connections.
  • Double-clicking on a topic opens its message definition.
  • Make sure your browser window is wide enough to display the full graph (the sidebar menu can be hidden with the icon in the top-left corner). You can also zoom the image.
  • The Preset selection list allows you to refine the list of modules that are shown.
  • The Search box can be used to find particular modules/topics (topics that are not selected by the search are greyed-out).