Skip to content

Commit

Permalink
phrasing adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
Noy-Zini committed Nov 20, 2024
1 parent 0867a71 commit d9b6788
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
22 changes: 11 additions & 11 deletions tools/dds/dds-config/readme.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# dds-config tool

## Goal
This tool is used to configer DDS based 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.
This tool is used to configure Ethernet based devices.

## Description
The dds-config tool allows users to prioritize either the DDS or USB connection and configure network parameters for the device.
It also provides information about the connected devices when executed.
The dds-config tool offers connection configuration information for connected devices and allows users to manage connection priorities.
It enables the selection of the preferred connection method, whether Ethernet or USB, when both options are available, and provides the ability to set network parameters.

## Command Line Parameters
| Flag | Description |
|---|---|
|-h --help|Show command line help menu|
|--usb-first|Prioritize USB before Ethernet|
|-h --help|Show command line help menu with all available options|
|--version|Displays version information|
|--usb-first|Prioritize USB and fall back to Ethernet after link timeout|
|--eth-first|Prioritize Ethernet and fall back to USB after link timeout|
|--dynamic-priority|Dynamically prioritize the last-working connection method (the default)|
|--version|Displays version information and exits|
|--serial-number <S/N>|Device serial-number to use, if more than one device is available|
|--reset|Hardware reset without making any changes|
|--link-timeout <milliseconds>|Milliseconds before --eth-first link times out and falls back to USB|
|--dhcp <on/off>|DHCP dynamic IP discovery 'on' or 'off'|
|--ip <address>|Device static IP address to use when DHCP is off|
|--mask <1.2.3.4>|Device static IP network mask to use when DHCP is off|
|--gateway <1.2.3.4>|Gateway to use when DHCP is off|
|--domain-id <0-232>|DDS Domain ID to use (default is 0), note:this is the device domain ID not librealsense domain ID|
|--golden| Show R/O golden values vs. current; mutually exclusive with any changes|
|--factory-reset|Reset settings back to the --golden values|
|--dhcp-timeout <seconds>|Seconds before DHCP times out and falls back to a static IP|
|--mask <1.2.3.4>|Device static IP network mask to use when DHCP is off|
|--gateway <1.2.3.4>|Displays version information and exits|
|--no-reset|Do not hardware reset after changes are made|
|--golden| Show R/O golden values vs. current; mutually exclusive with any changes|
|--factory-reset|Reset settings back to the --golden values|

## Usage example
Prioritize Ethernet connection by using `rs-dds-config.exe --eth-first`:
Expand Down
6 changes: 3 additions & 3 deletions tools/dds/dds-config/rs-dds-config.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -151,19 +151,19 @@ try

cli::flag quiet_arg( "quiet", "Suppress regular informational (-I-) messages" );
cli::flag reset_arg( "reset", "Hardware reset without making any changes" );
cli::flag disable_arg( "disable", "Disable DDS in all librealsense examples & tools by default and exit" );
cli::flag disable_arg( "disable", "Disable DDS in all librealsense examples & tools by default" );
cli::flag no_reset_arg( "no-reset", "Do not hardware reset after changes are made" );
cli::flag golden_arg( "golden", "Show R/O golden values vs. current; mutually exclusive with any changes" );
cli::flag factory_reset_arg( "factory-reset", "Reset settings back to the --golden values" );
cli::value< std::string > sn_arg( "serial-number", "S/N", "", "Device serial-number to use, if more than one device is available" );
cli::value< std::string > ip_arg( "ip", "address", "", "Device static IP address to use when DHCP is off" );
cli::value< std::string > mask_arg( "mask", "1.2.3.4", "", "Device static IP network mask to use when DHCP is off" );
cli::value< std::string > gateway_arg( "gateway", "1.2.3.4", "", "Device static IP network mask to use when DHCP is off" );
cli::value< std::string > gateway_arg( "gateway", "1.2.3.4", "", "Gateway to use when DHCP is off" );
cli::value< std::string > dhcp_arg( "dhcp", "on/off", "on", "DHCP dynamic IP discovery 'on' or 'off'" );
cli::value< uint32_t > dhcp_timeout_arg( "dhcp-timeout", "seconds", 30, "Seconds before DHCP times out and falls back to a static IP" );
cli::value< uint32_t > link_timeout_arg( "link-timeout", "milliseconds", 4000, "Milliseconds before --eth-first link times out and falls back to USB" );
cli::value< int > domain_id_arg( "domain-id", "0-232", 0, "DDS Domain ID to use (default is 0)" );
cli::flag usb_first_arg( "usb-first", "Prioritize USB before Ethernet" );
cli::flag usb_first_arg( "usb-first", "Prioritize USB and fall back to Ethernet after link timeout" );
cli::flag eth_first_arg( "eth-first", "Prioritize Ethernet and fall back to USB after link timeout" );
cli::flag dynamic_priority_arg( "dynamic-priority", "Dynamically prioritize the last-working connection method (the default)" );

Expand Down

0 comments on commit d9b6788

Please sign in to comment.