NAME

zerodds-ros2-shim - ROS-2 RMW shim and diagnostics

SYNOPSIS

zerodds-ros2-shim SUBCOMMAND [--config FILE] [--set PATH=VALUE]... [--check-config] [--domain ID] [-V | -h]

DESCRIPTION

zerodds-ros2-shim is the diagnostics tool of rmw_zerodds_cpp, the RMW implementation that lets ROS-2 nodes use ZeroDDS as their middleware. It is not a daemon: rcl loads the RMW library into each node. The tool reads what the RMW reads — the runtime configuration (zerodds.yaml, its drop-ins, include:, the environment) with its ros2 section, see zerodds-ros2.yaml(5) — and shows the mangling, the QoS profiles and overrides, discovery and security as a node would get them. Implements docs/specs/zerodds-ros2-bridge-1.0.md.

SUBCOMMANDS

info: Show the RMW-Compat-Level and the active mangling.
topics: List the configured topic overrides.
topic ROS_TOPIC: Show the DDS topic for the given ROS topic under the configured mangling, and its override, if any.
qos PROFILE: Show a profile of ros2.qos_profiles: default, sensor_data, services, parameters, parameter_events, or one the configuration adds. A field the profile leaves out keeps what the application requests.
enclaves: Show the SROS2 enclave the RMW uses (security.enclave_dir, env ZERODDS_SECURITY_DIR).
validate FILE: Validate FILE as a runtime base with its sibling FILE.d directory, as the RMW would read it from the system directory.
selftest: Round-trip test (mangle + qos lookup).
catalog: Print the JSON catalog (Spec §5.2).
metrics: Print the Prometheus metric-name catalog (§8.2).
doctor: Diagnose the RMW, environment, discovery and security setup.
graph: Show the local participant and topic graph.

OPTIONS

--config=FILE: The runtime base, with drop-ins in its sibling FILE.d directory. Without it, zerodds.yaml and zerodds.d in the system configuration directory (/etc/zerodds on Linux) are read, as the RMW reads them; a missing file there means the built-in defaults. The RMW itself takes no flag; this option checks a file before it is installed.
--set PATH=VALUE: One setting above every file, repeatable: a runtime setting or a ros2 key.
--check-config: Validate the runtime configuration and its ros2 section, print every value with its origin, then exit (0 valid, 1 invalid).

--runtime-config, --log-level and --enclave are refused with where the value belongs: --config, --ros-args --log-level, security.enclave_dir.

--domain=ID: Override ROS_DOMAIN_ID.
-V, --version: Print version.
-h, --help: Show the option synopsis.

ENVIRONMENT

RMW_IMPLEMENTATION: Set to rmw_zerodds_cpp to route the rcl-stack through ZeroDDS.
ROS_DOMAIN_ID: Standard ROS-2 domain id; mapped 1:1 onto DDS-Domain-ID.

FILES

/etc/zerodds/zerodds.yaml, /etc/zerodds/zerodds.d/.

AUTHORS

ZeroDDS Contributors.

BEZEICHNUNG

zerodds-ros2-shim - ROS-2-RMW-Shim und Diagnose

ÜBERSICHT

zerodds-ros2-shim UNTERBEFEHL [--config DATEI] [--set PFAD=WERT]... [--check-config] [--domain ID] [-V | -h]

BESCHREIBUNG

zerodds-ros2-shim ist das Diagnosewerkzeug von rmw_zerodds_cpp, der RMW-Implementierung, mit der ROS-2-Knoten ZeroDDS als Middleware verwenden. Es ist kein Daemon: rcl lädt die RMW-Bibliothek in jeden Knoten. Das Werkzeug liest, was die RMW liest — die Laufzeitkonfiguration (zerodds.yaml, ihre Drop-ins, include:, die Umgebung) mit ihrem Abschnitt ros2, siehe zerodds-ros2.yaml(5) — und zeigt das Mangling, die QoS-Profile und Überschreibungen, Discovery und Security so, wie ein Knoten sie bekäme. Implementiert docs/specs/zerodds-ros2-bridge-1.0.md.

UNTERBEFEHLE

info: Zeigt den RMW-Compat-Level und das aktive Mangling.
topics: Listet die konfigurierten Topic-Überschreibungen.
topic ROS_TOPIC: Zeigt das DDS-Topic zum angegebenen ROS-Topic unter dem konfigurierten Mangling und seine Überschreibung, falls es eine gibt.
qos PROFIL: Zeigt ein Profil aus ros2.qos_profiles: default, sensor_data, services, parameters, parameter_events oder eines, das die Konfiguration hinzufügt. Ein Feld, das das Profil auslässt, behält, was die Anwendung anfordert.
enclaves: Zeigt die SROS2-Enclave, die die RMW verwendet (security.enclave_dir, Umgebungsvariable ZERODDS_SECURITY_DIR).
validate DATEI: Prüft DATEI als Laufzeit-Basis mit ihrem danebenliegenden Verzeichnis DATEI.d, so wie die RMW sie aus dem Systemverzeichnis lesen würde.
selftest: Rundlauftest (Mangling + QoS-Nachschlagen).
catalog: Gibt den JSON-Katalog aus (Spec §5.2).
metrics: Gibt den Katalog der Prometheus-Metriknamen aus (§8.2).
doctor: Diagnostiziert RMW, Umgebung, Discovery und Security-Einrichtung.
graph: Zeigt den lokalen Teilnehmer- und Topic-Graphen.

OPTIONEN

--config=DATEI: Die Laufzeit-Basis, mit Drop-ins im danebenliegenden Verzeichnis DATEI.d. Ohne diese Option werden zerodds.yaml und zerodds.d im System-Konfigurationsverzeichnis (/etc/zerodds unter Linux) gelesen, so wie die RMW sie liest; fehlt die Datei dort, gelten die eingebauten Standardwerte. Die RMW selbst nimmt keine Option; diese Option prüft eine Datei, bevor sie installiert wird.
--set PFAD=WERT: Eine Einstellung über allen Dateien, wiederholbar: eine Laufzeit-Einstellung oder ein Schlüssel aus ros2.
--check-config: Prüft die Laufzeitkonfiguration und ihren Abschnitt ros2, gibt jeden Wert mit seiner Herkunft aus, dann Ende (0 gültig, 1 ungültig).

--runtime-config, --log-level und --enclave werden abgelehnt, mit dem Ort, an den der Wert gehört: --config, --ros-args --log-level, security.enclave_dir.

--domain=ID: Überschreibt ROS_DOMAIN_ID.
-V, --version: Gibt die Version aus.
-h, --help: Zeigt die Übersicht der Optionen.

UMGEBUNGSVARIABLEN

RMW_IMPLEMENTATION: Auf rmw_zerodds_cpp setzen, um den rcl-Stack über ZeroDDS zu führen.
ROS_DOMAIN_ID: Standard-Domain-ID von ROS 2; wird 1:1 auf die DDS-Domain-ID abgebildet.

DATEIEN