Tutorials
Step-by-step guides for common use cases with ros2_medkit.
- Demos Overview
- Heuristic Runtime Discovery
- Manifest-Based Discovery
- Migration Guide: Runtime to Hybrid Mode
- Configuring Authentication
- Configuring HTTPS/TLS
- Resource Locking
- Diagnostic Scripts
- Configuring Snapshot Capture
- Configuring Fault Correlation
- Docker Deployment
- Development Container
- Integrating with Your ROS 2 System
- Customizing the Entity Hierarchy
- Web UI (ros2_medkit_web_ui)
- MCP Server for LLM Integration
- OpenAPI / Swagger
- Beacon Discovery Plugins
- Plugin System
- Linux Introspection Plugins
- Triggers Use Cases
Demos
- Demos Overview
Walkthroughs for running ros2_medkit with demo systems including the built-in sensor demo and TurtleBot3 simulation.
Discovery Tutorials
- Heuristic Runtime Discovery
Use heuristic discovery to automatically map ROS 2 nodes to SOVD Apps without any configuration.
Manifest Discovery
- Manifest-Based Discovery
Use YAML manifests to define your ROS 2 system structure with stable IDs, semantic groupings, and offline detection.
- Migration Guide: Runtime to Hybrid Mode
Migrate from runtime-only discovery to hybrid mode for better control over entity organization.
Basic Tutorials
- Configuring Authentication
Configure JWT-based authentication with role-based access control.
- Configuring HTTPS/TLS
Enable TLS/HTTPS for secure communication.
- Resource Locking
Use SOVD resource locking to prevent concurrent modification of entity resources.
- Diagnostic Scripts
Upload, execute, and manage diagnostic scripts on entities.
- Configuring Snapshot Capture
Configure snapshot capture for fault debugging.
- Configuring Fault Correlation
Configure fault correlation for root-cause analysis and noise reduction.
- Docker Deployment
Deploy ros2_medkit in Docker containers.
- Development Container
Set up a VS Code development container for ros2_medkit.
Companion Projects
- Web UI (ros2_medkit_web_ui)
ros2_medkit_web_ui — A web interface for browsing SOVD entity trees.
- MCP Server for LLM Integration
ros2_medkit_mcp — Connect LLMs to your ROS 2 system via MCP protocol.
- OpenAPI / Swagger
Explore and interact with the gateway’s self-describing OpenAPI spec and Swagger UI.
Advanced Tutorials
- Integrating with Your ROS 2 System
Integrate ros2_medkit with your existing ROS 2 system.
- Customizing the Entity Hierarchy
Customize the entity hierarchy for your robot architecture.
- Beacon Discovery Plugins
Use topic and parameter beacon plugins to enrich entities with runtime metadata from nodes.
- Plugin System
Extend the gateway with custom plugins for update backends, introspection, and REST endpoints.
- Linux Introspection Plugins
Enrich discovery with Linux process, systemd, and container metadata.
- Triggers Use Cases
Set up multi-trigger monitoring scenarios for OTA updates, thermal protection, and fleet diagnostics.