From 48374e17850a6bfa14b77343ce2ce4d57001686c Mon Sep 17 00:00:00 2001 From: Jakub Delicat Date: Tue, 19 Nov 2024 08:44:50 +0000 Subject: [PATCH] README update and comment delete Signed-off-by: Jakub Delicat --- README.md | 2 +- panther_docking/README.md | 2 +- panther_docking/package.xml | 2 -- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a61cfcda..f64a4118 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ Launch arguments are largely common to both simulation and physical robot. Howev | 🤖🖥️ | `use_ekf` | Enable or disable EKF.
***bool:*** `True` | | 🤖🖥️ | `use_sim` | Whether simulation is used.
***bool:*** `False` | | 🤖🖥️ | `user_led_animations_file` | Path to a YAML file with a description of the user-defined animations.
***string:*** `''` | -| 🤖🖥️ | `panther_charging_dock.use_wibotic_info` | Use readings from `wibotic_info` topics to ensure that a robot is charging.
**bool**: `True` | +| 🤖🖥️ | `use_wibotic_info` |Whether Wibotic information is used.
**bool**: `True` | | 🤖🖥️ | `wheel_config_path` | Path to wheel configuration file.
***string:*** [`{wheel_type}.yaml`](./panther_description/config) | | 🤖🖥️ | `wheel_type` | Type of wheel. If you choose a value from the preset options ('WH01', 'WH02', 'WH04'), you can ignore the 'wheel_config_path' and 'controller_config_path' parameters. For custom wheels, please define these parameters to point to files that accurately describe the custom wheels.
***string:*** `WH01` (choices: `WH01`, `WH02`, `WH04`, `custom`) | | 🖥️ | `x` | Initial robot position in the global 'x' axis.
***float:*** `0.0` | diff --git a/panther_docking/README.md b/panther_docking/README.md index 0e3059cd..54d16899 100644 --- a/panther_docking/README.md +++ b/panther_docking/README.md @@ -51,5 +51,5 @@ The package contains a `PantherChargingDock` plugin for the [opennav_docking](ht - `panther_charging_dock.docking_yaw_threshold` [*double*, default: **0.3**]: A threshold of a difference of yaw angles between a robot pose and a dock pose to declare if docking succeed. - `panther_charging_dock.staging_x_offset` [*double*, default: **-0.7**]: A staging pose is defined by offsetting a dock pose in axis X. - `panther_charging_dock.filter_coef` [*double*, default: **0.1**]: A key parameter that influences the trade-off between the filter's responsiveness and its smoothness, balancing how quickly it reacts to new pose data pose how much it smooths out fluctuations. -- `panther_charging_dock.use_wibotic_info` [*bool*, default: **True**]: Use readings from `wibotic_info` topics to ensure that a robot is charging. +- `panther_charging_dock.use_wibotic_info` [*bool*, default: **True**]: Whether Wibotic information is used. - `panther_charging_dock.wibotic_info_timeout` [*double*, default: **1.5**]: A timeout in seconds to receive wibotic_info. diff --git a/panther_docking/package.xml b/panther_docking/package.xml index eb9ece00..11351ff4 100644 --- a/panther_docking/package.xml +++ b/panther_docking/package.xml @@ -28,8 +28,6 @@ tf2_ros wibotic_msgs - - nav2_lifecycle_manager python3-imageio wibotic_connector_can