Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
c8bc384
docs: fix version consistency - update to 0.1.0
bburda Feb 1, 2026
da884a3
docs: add server configuration reference
bburda Feb 1, 2026
227ff4f
docs: add REST API reference documentation
bburda Feb 1, 2026
a06d47e
docs: add companion projects tutorials
bburda Feb 1, 2026
641d2ec
docs: improve getting_started with discovery modes and cross-refs
bburda Feb 1, 2026
a6f339e
docs: add glossary with SOVD/ros2_medkit terminology
bburda Feb 1, 2026
9f36629
docs: add changelog for v0.1.0 release
bburda Feb 1, 2026
0a9f9a3
docs: add screenshots and demo tutorials
bburda Feb 1, 2026
142729b
docs: fix REST API directive errors and broken references
bburda Feb 1, 2026
602dea0
docs: add message definitions and component configuration
bburda Feb 1, 2026
cff242a
docs: fix requirement tag filters in coverage report
bburda Feb 1, 2026
fda0fd7
docs: add all SOVD spec categories to coverage report
bburda Feb 1, 2026
9206292
docs: fix demo screenshots - move TurtleBot3 screenshots to correct t…
bburda Feb 1, 2026
eb86914
docs: rewrite sensor demo to describe sensor_diagnostics from selfpat…
bburda Feb 1, 2026
e9b1d40
docs: add quick start demo with progressive complexity path
bburda Feb 1, 2026
28baf9f
feat(verification): auto-update requirement status to 'verified' when…
bburda Feb 1, 2026
de0f6bb
docs: fix API examples and demo documentation
bburda Feb 1, 2026
7403829
docs: clarify Components vs Apps distinction
bburda Feb 1, 2026
1165f54
docs: Fix documentation issues from user feedback and PR review
bburda Feb 1, 2026
bd67e7c
fix(docs): Fix invalid JSON syntax in getting_started.rst
bburda Feb 1, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/images/00_ui_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/01a_connection_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/02_entity_tree_collapsed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/03_entity_tree_expanded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/04_app_entity_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/05_data_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/06_topic_data_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/07_operations_panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/08_operations_execution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/09_configurations_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/10_configuration_edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/12_curl_health.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/13_curl_areas_turtlebot3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/14_curl_topic_odom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/15_postman_collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/16_turtlebot_gazebo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/21_sensor_demo_ui_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
104 changes: 104 additions & 0 deletions docs/api/cpp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
C++ API Reference
=================

This section contains the automatically generated API documentation for the ros2_medkit C++ codebase.

.. note::

This documentation is generated from source code comments using Doxygen and Breathe.
Run the "Docs: Build Doxygen" VS Code task or ``doxygen Doxyfile`` in the docs/ directory
before building Sphinx locally. In CI, Doxygen XML is generated automatically.

ros2_medkit_gateway
-------------------

The HTTP/REST gateway that exposes ROS 2 graph via SOVD-compatible API.

Classes
~~~~~~~

.. doxygenclass:: ros2_medkit_gateway::GatewayNode
:members:

.. doxygenclass:: ros2_medkit_gateway::DiscoveryManager
:members:

.. doxygenclass:: ros2_medkit_gateway::DataAccessManager
:members:

.. doxygenclass:: ros2_medkit_gateway::OperationManager
:members:

.. doxygenclass:: ros2_medkit_gateway::ConfigurationManager
:members:

Data Models
~~~~~~~~~~~

.. doxygenstruct:: ros2_medkit_gateway::QosProfile
:members:

.. doxygenstruct:: ros2_medkit_gateway::TopicEndpoint
:members:

.. doxygenstruct:: ros2_medkit_gateway::TopicConnection
:members:

.. doxygenstruct:: ros2_medkit_gateway::Area
:members:

.. doxygenstruct:: ros2_medkit_gateway::Component
:members:

ros2_medkit_fault_manager
-------------------------

Central fault storage and management node.

.. doxygenclass:: ros2_medkit_fault_manager::FaultManagerNode
:members:

.. doxygenclass:: ros2_medkit_fault_manager::FaultStorage
:members:

.. doxygenclass:: ros2_medkit_fault_manager::InMemoryFaultStorage
:members:

ros2_medkit_fault_reporter
--------------------------

Client library for reporting faults to the fault manager.

.. doxygenclass:: ros2_medkit_fault_reporter::FaultReporter
:members:

.. doxygenclass:: ros2_medkit_fault_reporter::LocalFilter
:members:

ros2_medkit_diagnostic_bridge
-----------------------------

Bridge node that converts ROS 2 /diagnostics messages to FaultManager faults.

.. doxygenclass:: ros2_medkit_diagnostic_bridge::DiagnosticBridgeNode
:members:

ros2_medkit_serialization
-------------------------

Runtime JSON ↔ ROS 2 message serialization library.

.. doxygenclass:: ros2_medkit_serialization::JsonSerializer
:members:

.. doxygenclass:: ros2_medkit_serialization::TypeCache
:members:

.. doxygenclass:: ros2_medkit_serialization::SerializationError
:members:

.. doxygenclass:: ros2_medkit_serialization::TypeNotFoundError
:members:

.. doxygenclass:: ros2_medkit_serialization::JsonConversionError
:members:
116 changes: 22 additions & 94 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,103 +1,31 @@
C++ API Reference
=================
API Reference
=============

This section contains the automatically generated API documentation for the ros2_medkit C++ codebase.
This section contains API documentation for ros2_medkit.

.. note::
.. toctree::
:maxdepth: 2

This documentation is generated from source code comments using Doxygen and Breathe.
The Doxygen XML is generated during the documentation build process.
rest
messages
cpp

ros2_medkit_gateway
-------------------

The HTTP/REST gateway that exposes ROS 2 graph via SOVD-compatible API.

Classes
~~~~~~~

.. doxygenclass:: ros2_medkit_gateway::GatewayNode
:members:

.. doxygenclass:: ros2_medkit_gateway::DiscoveryManager
:members:

.. doxygenclass:: ros2_medkit_gateway::DataAccessManager
:members:

.. doxygenclass:: ros2_medkit_gateway::OperationManager
:members:

.. doxygenclass:: ros2_medkit_gateway::ConfigurationManager
:members:

Data Models
~~~~~~~~~~~

.. doxygenstruct:: ros2_medkit_gateway::QosProfile
:members:

.. doxygenstruct:: ros2_medkit_gateway::TopicEndpoint
:members:

.. doxygenstruct:: ros2_medkit_gateway::TopicConnection
:members:

.. doxygenstruct:: ros2_medkit_gateway::Area
:members:

.. doxygenstruct:: ros2_medkit_gateway::Component
:members:

ros2_medkit_fault_manager
-------------------------
REST API
--------

Central fault storage and management node.
:doc:`rest`
Complete REST API reference with request/response schemas, error codes,
and usage examples.

.. doxygenclass:: ros2_medkit_fault_manager::FaultManagerNode
:members:

.. doxygenclass:: ros2_medkit_fault_manager::FaultStorage
:members:

.. doxygenclass:: ros2_medkit_fault_manager::InMemoryFaultStorage
:members:

ros2_medkit_fault_reporter
--------------------------

Client library for reporting faults to the fault manager.

.. doxygenclass:: ros2_medkit_fault_reporter::FaultReporter
:members:

.. doxygenclass:: ros2_medkit_fault_reporter::LocalFilter
:members:

ros2_medkit_diagnostic_bridge
-----------------------------

Bridge node that converts ROS 2 /diagnostics messages to FaultManager faults.

.. doxygenclass:: ros2_medkit_diagnostic_bridge::DiagnosticBridgeNode
:members:

ros2_medkit_serialization
-------------------------

Runtime JSON ↔ ROS 2 message serialization library.

.. doxygenclass:: ros2_medkit_serialization::JsonSerializer
:members:

.. doxygenclass:: ros2_medkit_serialization::TypeCache
:members:
Message Definitions
-------------------

.. doxygenclass:: ros2_medkit_serialization::SerializationError
:members:
:doc:`messages`
ROS 2 message and service interfaces for fault reporting, querying,
and event notifications.

.. doxygenclass:: ros2_medkit_serialization::TypeNotFoundError
:members:
C++ API
-------

.. doxygenclass:: ros2_medkit_serialization::JsonConversionError
:members:
:doc:`cpp`
Doxygen-generated C++ class reference for extending ros2_medkit.
Loading