From b542bc0023c89eea593d6715d055a1b37a33969e Mon Sep 17 00:00:00 2001 From: Noy-Zini Date: Tue, 19 Nov 2024 11:31:06 +0200 Subject: [PATCH] add dds-config tool readme --- tools/dds/dds-config/readme.md | 54 ++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 tools/dds/dds-config/readme.md diff --git a/tools/dds/dds-config/readme.md b/tools/dds/dds-config/readme.md new file mode 100644 index 00000000000..4aeb8324619 --- /dev/null +++ b/tools/dds/dds-config/readme.md @@ -0,0 +1,54 @@ +# dds-config tool + +## Goal +This tool is used to define a device as a DDS-compatible device and ensure it operates correctly within a DDS environment. +It allows users to manage connection priorities, enabling the selection of either DDS or USB as the preferred connection method when both options are available. + +## Description +Typically, the PC which the device needs to be connected to will have only one ethernet port. +However, two ethernet ports are required for the setup: +* One Ethernet port is needed to connect to the network - for remote access. +* The second Ethernet port is needed to connect to the device - for DDS communication. + +To enable this configuration, a USB to ethernet adapter can be used, allowing the network connection to be routed through a USB port. +The dds-config tool helps manage this setup by enabling users to prioritize either the USB or DDS connection, based on the specified parameters. It also provides information about the connected devices when executed. + +## Command Line Parameters +| Flag | Description | +|---|---| +|'-h --help'|Show command line help menu| +|'--usb-first'|Prioritize USB before Ethernet| +|'--eth-first'|Prioritize Ethernet and fall back to USB after link timeout| +|'--dynamic-priority'|Dynamically prioritize the last-working connection method (the default)| + +## Usage example +Prioritize Ethernet connection by using `rs-dds-config.exe --eth-first`: +``` +-I- Device: [USB] Intel RealSense D555 s/n 338522301774 +-I- MAC address: 98:4f:ee:19:cc:49 +-I- configured: 192.168.11.55 & 255.255.255.0 / 192.168.11.1 +-I- DDS: +-I- domain ID: 0 +-I- link: 1000 Mbps +-I- MTU, bytes: 9000 +-I- timeout, ms: 10000 +-I- priority: usb-first --> eth-first +-I- DHCP: OFF +-I- timeout, sec: 30 +-I- Successfully changed +-I- Resetting device... +``` +After running `rs-dds-config.exe` we can now see the device changed it's connection to DDS: +``` +-I- Device: [DDS] Intel RealSense D555 s/n 338522301774 +-I- MAC address: 98:4f:ee:19:cc:49 +-I- configured: 192.168.11.55 & 255.255.255.0 / 192.168.11.1 +-I- DDS: +-I- domain ID: 0 +-I- link: 1000 Mbps +-I- MTU, bytes: 9000 +-I- timeout, ms: 10000 +-I- priority: eth-first +-I- DHCP: OFF +-I- timeout, sec: 30 +``` \ No newline at end of file